Skip to content

homematicip.home

AutoNameEnum

Bases: str, Enum

auto() will generate the name of the attribute as value

from_str classmethod

from_str

this function will create the enum object based on its string value

Args: text(str): the string value of the enum default(AutoNameEnum): a default value if text could not be used Returns: the enum object or None if the text is None or the default value

Group

Bases: HomeMaticIPObject

this class represents a group

Home

Bases: AsyncHome

this class represents the 'Home' of the homematic ip

HomeMaticIPObject

This class represents a generic homematic ip object to make basic requests to the access point

fire_remove_event

fire_remove_event

Trigger the method tied to _on_remove

fire_update_event

fire_update_event

Trigger the method tied to _on_update

from_json

from_json

this method will parse the homematicip object from a json object

Parameters:

Name Type Description Default

js

the json object to parse

required

fromtimestamp

fromtimestamp

internal helper function which will create a datetime object from a timestamp

on_remove

on_remove

Adds an event handler to the remove method. Fires when a device is removed.

on_update

on_update

Adds an event handler to the update method. Fires when a device is updated.

remove_callback

remove_callback

Remove event handler.

set_attr_from_dict

set_attr_from_dict

this method will add the value from dict to the given attr name

Args: attr(str): the attribute which value should be changed dict(dict): the dictionary from which the value should be extracted type(AutoNameEnum): this will call type.from_str(value), if a type gets provided dict_attr: the name of the attribute in the dict. Set this to None(default) to use attr addToStrOutput(str): should the attribute be returned via str()

str_from_attr_map

str_from_attr_map

this method will return a string with all key/values which were added via the set_attr_from_dict method

MetaGroup

Bases: Group

a meta group is a "Room" inside the homematic configuration

SecurityEvent

Bases: HomeMaticIPObject

this class represents a security event

SecurityZoneEvent

Bases: SecurityEvent

This class will be used by other events which are just adding "securityZoneValues"