Bases: SabotageDevice
HMIP-ASIR (Alarm Siren)
Bases: HomeMaticIPObject
this class represents the 'Home' of the homematic ip
async
activate_absence_permanent_async
activates the absence forever
async
activate_absence_with_duration_async
activates the absence mode for a given time
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
int
|
the absence duration in minutes |
required |
async
activate_absence_with_period_async
activates the absence mode until the given time
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
datetime
|
the time when the absence should automatically be disabled |
required |
async
activate_vacation_async
activates the vacation mode until the given time
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
datetime
|
the time when the vacation mode should automatically be disabled |
required |
|
float
|
the settemperature during the vacation mode |
required |
async
deactivate_absence_async
deactivates the absence mode immediately
async
deactivate_vacation_async
deactivates the vacation mode immediately
delete_group
deletes the given group from the cloud
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
Group
|
the group to delete |
required |
async
disable_events_async
Stop Websocket Connection
async
download_configuration_async
downloads the current configuration from the cloud
Returns the downloaded configuration as json
Raises: HomeNotInitializedError: if the home is not initialized Exception: if the download fails
async
enable_events
Connect to Websocket and listen for events
fire_channel_event
Trigger the method tied to _on_channel_event
fire_create_event
Trigger the method tied to _on_create
async
get_current_state_async
downloads the current configuration and parses it into self
Args: clear_config(bool): if set to true, this function will remove all old objects from self.devices, self.client, ... to have a fresh config instead of reparsing them
get_functionalHome
gets the specified functionalHome
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
type
|
the type of the functionalHome which should be returned |
required |
Returns:
| Type | Description |
|---|---|
FunctionalHome | None
|
the FunctionalHome or None if it couldn't be found |
get_security_zones_activation
async
init_async
Initializes the home with the given access point id and auth token
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the access point id |
required | |
|
str | None
|
the auth token |
None
|
|
if set to true, the urls will be looked up |
True
|
|
|
if set to true, the connection will be rate limited |
True
|
on_channel_event
Adds an event handler to the channel event method. Fires when a channel event is received.
on_create
Adds an event handler to the create method. Fires when a device is created.
remove_callback
Remove event handler.
remove_channel_event_handler
Remove event handler.
search_channel
searches a channel by given deviceID and channelIndex.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the device to search for |
required | |
|
the channel to search for |
required |
Returns:
| Type | Description |
|---|---|
FunctionalChannel | None
|
the FunctionalChannel object or None if it couldn't find a channel |
search_client_by_id
searches a client by given id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the client to search for |
required |
Returns:
| Type | Description |
|---|---|
Client | None
|
the client object or None if it couldn't find a client |
search_device_by_id
searches a device by given id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the device to search for |
required |
Returns:
| Type | Description |
|---|---|
Device | None
|
the Device object or None if it couldn't find a device |
search_group_by_id
searches a group by given id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the group to search for |
required |
Returns:
| Type | Description |
|---|---|
Group | None
|
the group object or None if it couldn't find a group |
search_rule_by_id
searches a rule by given id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the rule to search for |
required |
Returns:
| Type | Description |
|---|---|
Rule | None
|
the rule object or None if it couldn't find a rule |
set_auth_token
Sets the auth token for the connection. This is only necessary, if not already set in init function
async
set_intrusion_alert_through_smoke_detectors_async
activate or deactivate if smoke detectors should "ring" during an alarm
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
bool
|
True will let the smoke detectors "ring" during an alarm |
True
|
set_on_connected_handler
Sets a callback that is called when the WebSocket connection is established.
set_on_disconnected_handler
Sets a callback that is called when the WebSocket connection is closed.
set_on_reconnect_handler
Sets a callback that is called when the WebSocket connection is trying to reconnect after a disconnect.
async
set_pin_async
async
set_security_zones_activation_async
this function will set the alarm system to armed or disable it
Examples: arming while being at home home.set_security_zones_activation(False,True)
arming without being at home home.set_security_zones_activation(True,True)
disarming the alarm system home.set_security_zones_activation(False,False)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
activates/deactivates the internal zone |
True
|
|
|
activates/deactivates the external zone |
True
|
async
set_silent_alarm_async
this function will set the silent alarm for internal or external
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
activates/deactivates the silent alarm for internal zone |
True
|
|
|
activates/deactivates the silent alarm for the external zone |
True
|
async
set_timezone_async
sets the timezone for the AP. e.g. "Europe/Berlin"
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
the new timezone |
required |
async
set_zones_device_assignment_async
sets the devices for the security zones
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the devices which should be used for the internal zone |
required | |
|
the devices which should be used for the external(hull) zone |
required |
Returns:
| Type | Description |
|---|---|
dict
|
the result of the call |
async
start_inclusion_async
start inclusion mode for specific device
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
sgtin of device |
required |
update_home
parse a given json configuration into self. This will update the whole home including devices, clients and groups.
Args: json_state(dict): the json configuration as dictionary clear_config(bool): if set to true, this function will remove all old objects from self.devices, self.client, ... to have a fresh config instead of reparsing them
update_home_only
parse a given home json configuration into self. This will update only the home without updating devices, clients and groups.
Args: js_home(dict): the json configuration as dictionary clear_config(bool): if set to true, this function will remove all old objects from self.devices, self.client, ... to have a fresh config instead of reparsing them
websocket_is_connected
returns if the websocket is connected.
auto() will generate the name of the attribute as value
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
Bases: HomeMaticIPObject
Base device class. This is the foundation for homematicip and external (hue) devices
load_functionalChannels
this function will load the functionalChannels into the device
Bases: Shutter
Base class for blind devices
set_slats_level
sets the slats and shutter level
Args: slatsLevel(float): the new level of the slats. 0.0 = open, 1.0 = closed shutterLevel(float): the new level of the shutter. 0.0 = open, 1.0 = closed, None = use the current value channelIndex(int): the channel to control Returns: the result of the _restCall
async
set_slats_level_async
sets the slats and shutter level
Args: slatsLevel(float): the new level of the slats. 0.0 = open, 1.0 = closed, shutterLevel(float): the new level of the shutter. 0.0 = open, 1.0 = closed, None = use the current value channelIndex(int): the channel to control Returns: the result of the _restCall
Bases: FunctionalChannel
this is the representative of the BLIND_CHANNEL channel
set_shutter_level
sets the shutter level
Args: level(float): the new level of the shutter. 0.0 = open, 1.0 = closed channelIndex(int): the channel to control Returns: the result of the _restCall
set_shutter_stop
stops the current operation Returns: the result of the _restCall
set_slats_level
sets the slats and shutter level
Args: slatsLevel(float): the new level of the slats. 0.0 = open, 1.0 = closed, shutterLevel(float): the new level of the shutter. 0.0 = open, 1.0 = closed, None = use the current value channelIndex(int): the channel to control Returns: the result of the _restCall
stop
stops the current shutter operation
Returns: the result of the _restCall
Bases: Device
HMIP-HDM1 (Hunter Douglas & erfal window blinds)
async
stop
stops the current operation Returns: the result of the _restCall
async
stop_async
stops the current operation Returns: the result of the _restCall
Bases: Switch
ELV-SH-BS2 (ELV Smart Home ARR-Bausatz Schaltaktor für Markenschalter – 2-fach powered by Homematic IP)
Bases: Switch
HMIP-BSL (Switch Actuator for brand switches – with signal lamp)
set_rgb_dim_level
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX
Returns: the result of the _restCall
async
set_rgb_dim_level_async
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX
Returns: the result of the _restCall
set_rgb_dim_level_with_time
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX onTime(float): rampTime(float): Returns: the result of the _restCall
async
set_rgb_dim_level_with_time_async
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX onTime(float): rampTime(float): Returns: the result of the _restCall
Bases: FunctionalChannel
this is the representative of the CODE_PROTECTED_PRIMARY_ACTION_CHANNEL channel (HmIP-WKP)
Bases: FunctionalChannel
this is the representative of the CODE_PROTECTED_SECONDARY_ACTION_CHANNEL channel (HmIP-WKP)
Bases: SabotageDevice
HMIP-SCI (Contact Interface Sensor)
Bases: DeviceBaseChannel
this is the representative of the DEVICE_BASE_FLOOR_HEATING channel
set_minimum_floor_heating_valve_position
sets the minimum floot heating valve position
Args: minimumFloorHeatingValvePosition(float): the minimum valve position. must be between 0.0 and 1.0
Returns: the result of the _restCall
Bases: DeviceOperationLockChannel
this is the representation of the DeviceOperationLockChannelWithSabotage channel
Bases: DeviceSabotageChannel
this is the representative of the DEVICE_RECHARGEABLE_WITH_SABOTAGE channel
Bases: Dimmer
HMIP-DRDI3 (Dimming Actuator Inbound 230V – 3x channels, 200W per channel) electrical DIN rail
Bases: FunctionalChannel
This respresents of the DoorLockChannel
async
async_set_lock_state
sets the door lock state
Args: doorLockState(float): the state of the door. See LockState from base/enums.py pin(string): Pin, if specified. channelIndex(int): the channel to control. Normally the channel from DOOR_LOCK_CHANNEL is used. Returns: the result of the _restCall
set_lock_state
sets the door lock state
Args: doorLockState(float): the state of the door. See LockState from base/enums.py pin(string): Pin, if specified. channelIndex(int): the channel to control. Normally the channel from DOOR_LOCK_CHANNEL is used. Returns: the result of the _restCall
Bases: OperationLockableDevice
HmIP-DLD
set_lock_state
sets the door lock state
Args: doorLockState(float): the state of the door. See LockState from base/enums.py pin(string): Pin, if specified. channelIndex(int): the channel to control. Normally the channel from DOOR_LOCK_CHANNEL is used. Returns: the result of the _restCall
async
set_lock_state_async
sets the door lock state
Args: doorLockState(float): the state of the door. See LockState from base/enums.py pin(string): Pin, if specified. channelIndex(int): the channel to control. Normally the channel from DOOR_LOCK_CHANNEL is used. Returns: the result of the _restCall
Bases: FunctionalChannel
this represents the EXTERNAL_BASE_CHANNEL function-channel for external devices
Bases: FunctionalChannel
this represents the EXTERNAL_UNIVERSAL_LIGHT_CHANNEL function-channel for external devices
async
set_dim_level_async
Set the dim level of the light channel.
async
set_dim_level_with_time_async
Set the dim level of the light channel with a specified time.
Bases: Device
HMIP-FALMOT-C12 (Floor Heating Actuator – 12x channels, motorised)
set_minimum_floor_heating_valve_position
sets the minimum floot heating valve position
Args: minimumFloorHeatingValvePosition(float): the minimum valve position. must be between 0.0 and 1.0
Returns: the result of the _restCall
async
set_minimum_floor_heating_valve_position_async
sets the minimum floot heating valve position
Args: minimumFloorHeatingValvePosition(float): the minimum valve position. must be between 0.0 and 1.0
Returns: the result of the _restCall
Bases: FunctionalChannel
this is the representative of the FLOOR_TERMINAL_BLOCK_LOCAL_PUMP_CHANNEL channel
Bases: FunctionalChannel
this is the representative of the class FLOOR_TERMINAL_BLOCK_MECHANIC_CHANNEL(FunctionalChannel) channel
Bases: Shutter
HMIP-FROLL (Shutter Actuator - flush-mount) / HMIP-BROLL (Shutter Actuator - Brand-mount)
Bases: HomeMaticIPObject
this is the base class for the functional channels
add_on_channel_event_handler
Adds an event handler to the update method. Fires when a device is updated.
fire_channel_event
Trigger the methods tied to _on_channel_event
from_json
this function will load the functional channel object from a json object and the given groups
Args: js(dict): the json object groups(Iterable[Group]): the groups for referencing
Bases: OperationLockableDevice
HMIP-eTRV (Radiator Thermostat)
Bases: SabotageDevice
HMIP-eTRV-C (Heating-thermostat compact without display)
Bases: OperationLockableDevice
HMIP-eTRV-E (Heating-thermostat new evo version)
This class represents a generic homematic ip object to make basic requests to the access point
fire_remove_event
Trigger the method tied to _on_remove
fire_update_event
Trigger the method tied to _on_update
from_json
this method will parse the homematicip object from a json object
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
the json object to parse |
required |
fromtimestamp
internal helper function which will create a datetime object from a timestamp
on_remove
Adds an event handler to the remove method. Fires when a device is removed.
on_update
Adds an event handler to the update method. Fires when a device is updated.
remove_callback
Remove event handler.
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
this method will return a string with all key/values which were added via the set_attr_from_dict method
Bases: FunctionalChannel
this is the representation of the IMPULSE_OUTPUT_CHANNEL
send_start_impulse
Toggle Wall mounted Garage Door Controller.
Bases: SabotageDevice
HMIP-SMI (Motion Detector with Brightness Sensor - indoor)
Bases: MotionDetectorOutdoor
HMIP-SMI55 (Motion Detector with Brightness Sensor and Remote Control - 2-button)
Bases: DimmerChannel, SwitchChannel
this is the representative of the NOTIFICATION_LIGHT_CHANNEL channel
async
async_set_optical_signal
sets the signal type for the leds
Args: opticalSignalBehaviour(OpticalSignalBehaviour): LED signal behaviour rgb(RGBColorState): Color dimLevel(float): usally 1.01. Use set_dim_level instead
Returns: Result of the _restCall
async
async_set_rgb_dim_level_with_time
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX onTime(float): rampTime(float): Returns: the result of the _restCall
set_rgb_dim_level
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX
Returns: the result of the _restCall
Bases: SabotageDevice
HMIP-SPDR (Passage Detector)
Bases: SabotageDevice
HMIP-SPI (Presence Sensor - indoor)
Bases: SabotageDevice
HMIP-SRH
Bases: HomeMaticIPObject
this class represents the automation rule
set_label
sets the label of the rule
async
set_label_async
sets the label of the rule
Bases: SecurityEvent
This class will be used by other events which are just adding "securityZoneValues"
Bases: FunctionalChannel
this is the representative of the SHADING_CHANNEL channel
async
async_set_shutter_stop
stops the current operation Returns: the result of the _restCall
Bases: Device
Base class for shutter devices
set_shutter_level
sets the shutter level
Args: level(float): the new level of the shutter. 0.0 = open, 1.0 = closed channelIndex(int): the channel to control Returns: the result of the _restCall
async
set_shutter_level_async
sets the shutter level
Args: level(float): the new level of the shutter. 0.0 = open, 1.0 = closed channelIndex(int): the channel to control Returns: the result of the _restCall
set_shutter_stop
stops the current shutter operation
Args: channelIndex(int): the channel to control Returns: the result of the _restCall
async
set_shutter_stop_async
stops the current shutter operation
Args: channelIndex(int): the channel to control Returns: the result of the _restCall
Bases: FunctionalChannel
this is the representative of the SHUTTER_CHANNEL channel
async
async_set_shutter_level
sets the shutter level
Args: level(float): the new level of the shutter. 0.0 = open, 1.0 = closed Returns: the result of the _restCall
async
async_set_shutter_stop
stops the current shutter operation
Args: channelIndex(int): the channel to control Returns: the result of the _restCall
Bases: SabotageDevice
HMIP-SWDO (Door / Window Contact - optical) / HMIP-SWDO-I (Door / Window Contact Invisible - optical)
Bases: Rule
This class represents a "Simple" automation rule
disable
disables the rule
async
disable_async
disables the rule
enable
enables the rule
async
enable_async
enables the rule
set_rule_enabled_state
enables/disables this rule
async
set_rule_enabled_state_async
enables/disables this rule
Bases: FunctionalChannel
This is the representative of the SOIL_MOISTURE_SENSOR_INTERFACE_CHANNEL channel.
from_json
Update the channel attributes from a JSON dictionary.
Bases: FunctionalChannel
this is the representative of the TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL channel
Bases: FunctionalChannel
this is the representative of the UniversalActuatorChannel UNIVERSAL_ACTUATOR_CHANNEL
Bases: FunctionalChannel
Represents Universal Light Channel.
async
set_dim_level_async
Set the dim level of the light channel.
async
set_dim_level_with_time_async
Set the dim level of the light channel with a specified time.
async
start_light_scene_async
Start a light scene.
Bases: Device
HmIP-WGC Wall mounted Garage Door Controller
send_start_impulse
Toggle Wall mounted Garage Door Controller.
async
send_start_impulse_async
Toggle Wall mounted Garage Door Controller.
Bases: TemperatureHumiditySensorDisplay, OperationLockableDevice
HMIP-WTH, HMIP-WTH-2 (Wall Thermostat with Humidity Sensor) / HMIP-BWTH (Brand Wall Thermostat with Humidity Sensor)
Bases: FunctionalChannel
this is the representative of the WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL channel
Bases: WallMountedThermostatProChannel
this is the representative of the WALL_MOUNTED_THERMOSTAT_WITH_CARBON_DIOXIDE_SENSOR_CHANNEL channel
Bases: ClimateSensorChannel
this is the representative of the WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL channel
Bases: FunctionalChannel
this is the representative of the WATERING_ACTUATOR_CHANNEL channel
async
reset_water_volume_async
Resets the water volume counter of the specified device.
async
set_watering_switch_state_async
Sets the watering switch state of the specified device.
async
set_watering_switch_state_with_time_async
async
toggle_watering_state_async
Toggles the watering state of the specified device.
Bases: WeatherSensorPlusChannel
this is the representative of the WEATHER_SENSOR_PRO_CHANNEL channel
Bases: PushButton
HmIPW-WRC6 and HmIPW-WRC2
set_dim_level
sets the signal type for the leds Args: channelIndex(int): Channel which is affected dimLevel(float): usally 1.01. Use set_dim_level instead
Returns: Result of the _restCall
async
set_dim_level_async
sets the signal type for the leds Args: channelIndex(int): Channel which is affected dimLevel(float): usally 1.01. Use set_dim_level instead
Returns: Result of the _restCall
set_optical_signal
sets the signal type for the leds
Args: channelIndex(int): Channel which is affected opticalSignalBehaviour(OpticalSignalBehaviour): LED signal behaviour rgb(RGBColorState): Color dimLevel(float): usally 1.01. Use set_dim_level instead
Returns: Result of the _restCall
async
set_optical_signal_async
sets the signal type for the leds
Args: channelIndex(int): Channel which is affected opticalSignalBehaviour(OpticalSignalBehaviour): LED signal behaviour rgb(RGBColorState): Color dimLevel(float): usally 1.01. Use set_dim_level instead
Returns: Result of the _restCall