Trigger the latch via this access-authorization channel.

Only meaningful for channels with role DOOR_OPENER_ACTUATOR. See :func:homematicip.commands.functional_channel_commands.pull_latch_async.

activates the absence forever

activates the absence mode for a given time

Parameters:

activates the absence mode until the given time

Parameters:

activates the vacation mode until the given time

Parameters:

deactivates the absence mode immediately

deactivates the vacation mode immediately

deletes the given group from the cloud

Parameters:

Stop Websocket Connection

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

Connect to Websocket and listen for events

Trigger the method tied to _on_channel_event

Trigger the method tied to _on_create

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

Refresh state with exponential backoff retry on transient errors.

Wraps :meth:get_current_state_async with a retry loop intended for post-reconnect recovery in long-running clients (e.g. Home Assistant).

• HmipAuthenticationError is re-raised immediately so the caller can trigger reauth.
• HomeNotInitializedError is re-raised immediately because it signals a programmer error (calling this before init).
• asyncio.CancelledError is re-raised to propagate cancellation.
• All other exceptions, including HmipConnectionError subclasses and unforeseen errors, trigger a retry with exponential backoff (initial_delay doubling up to max_delay seconds).

Args: clear_config: forwarded to :meth:get_current_state_async. initial_delay: seconds to wait before the first retry. max_delay: cap on the backoff delay between retries.

gets the specified functionalHome

Parameters:

Returns:

returns the blocking channels as [{"deviceId": .., "channelIndex": ..}]

Pass them to set_security_zones_activation_with_ignore_list_async to name what may be ignored.

Parameters:

returns what blocked an activation as {device label: [reason]}

Unknown devices keep their raw "deviceId:channelIndex" key.

Parameters:

returns devices with a low battery in the given (or all active) zones

Parameters:

returns the value of the security zones if they are armed or not

Returns:

Initializes the home with the given access point id and auth token

Parameters:

Adds an event handler to the channel event method. Fires when a channel event is received.

Adds an event handler to the create method. Fires when a device is created.

Wait (best-effort) for websocket reconnect, then refresh state with retry.

Convenience wrapper combining :meth:wait_for_websocket_connection_async and :meth:get_current_state_async_with_retry. The websocket wait is best-effort: if it times out, the state refresh proceeds anyway, since the REST call is independent and may still recover state.

Re-raises HmipAuthenticationError, HomeNotInitializedError, and asyncio.CancelledError immediately. All other errors trigger retry.

Intended for post-reconnect recovery flows in long-running clients.

Remove event handler.

Remove event handler.

searches a channel by given deviceID and channelIndex.

Parameters:

Returns:

searches a client by given id

Parameters:

Returns:

searches a device by given id

Parameters:

Returns:

searches a group by given id

Parameters:

Returns:

searches a rule by given id

Parameters:

Returns:

Sets the auth token for the connection. This is only necessary, if not already set in init function

activate or deactivate if smoke detectors should "ring" during an alarm

Parameters:

Sets a callback that is called when the WebSocket connection is established.

Sets a callback that is called when the WebSocket connection is closed.

Sets a callback that is called when the WebSocket connection is trying to reconnect after a disconnect.

Sets a callback that is called when the WebSocket reports connected but has not received a message past the configured thresholds.

Handler signature: handler(severity: str, seconds_since: float). See :meth:WebsocketHandler.add_on_stale_handler for details.

sets a new pin for the home

Parameters:

Returns:

this function will set the alarm system to armed or disable it

On a request-based panel a blocked activation does not arm. The result is marked unsuccessful then, and get_security_zone_activation_problems names the sensors. Use set_security_zones_activation_with_ignore_list to arm anyway.

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:

arms the alarm system even though sensors report problems

Leaves the blocking entry points unmonitored, so call it only on an explicit user decision, never as an automatic fallback. Note that the access point arms regardless of what ignorable_device_channels names, so it does not protect against an entry point that opened after the check.

Parameters:

this function will set the silent alarm for internal or external

Parameters:

sets the timezone for the AP. e.g. "Europe/Berlin"

Parameters:

sets the devices for the security zones

Parameters:

Returns:

start inclusion mode for specific device

Parameters:

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

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

Wait up to timeout seconds for the websocket to report connected.

Polls :meth:websocket_is_connected every poll_interval seconds. If still not connected after warning_threshold seconds, emits a single WARNING log line. Returns True once connected, or False if timeout elapses first.

Designed for post-reconnect recovery in long-running clients (e.g. Home Assistant). Callers typically proceed with a state refresh even on timeout, since a REST call may still recover state.

Args: timeout: maximum total wait, in seconds. poll_interval: how often to check :meth:websocket_is_connected. Must be > 0. warning_threshold: emit a "still waiting" warning once this many seconds have elapsed without a connection.

Raises: ValueError: if poll_interval is not positive.

returns if the websocket is connected.

Returns the last websocket disconnect or reconnect reason.

Returns the loop timestamp of the last received websocket message.

Returns the number of received websocket messages.

Returns the number of reconnect attempts in the current outage.

Returns the seconds since the last received websocket message.

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

Return the loaded functional channel matching the given type and optional index.

this function will load the functionalChannels into the device

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

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

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

stops the current operation Returns: the result of the _restCall

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

stops the current shutter operation

Returns: the result of the _restCall

stops the current operation Returns: the result of the _restCall

stops the current operation Returns: the result of the _restCall

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

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

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

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

Register a handler for code-state push events emitted by this device.

Fired with a :class:CodeStateEvent when the cloud reports a DEVICE_CODE_STATE_EVENT for this device (HmIP-WKP keypad).

Invoke all registered code-state handlers.

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

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

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

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

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

Hold the door released ("always open") with True, lock it with False.

See :func:homematicip.commands.functional_channel_commands.set_door_lock_active_async.

Set the dim level of the light channel.

Set the dim level of the light channel with a specified time.

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

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

Hold the door released ("always open") with True, lock it with False.

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

Trigger the methods tied to _on_channel_event

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

Trigger the method tied to _on_remove

Trigger the method tied to _on_update

this method will parse the homematicip object from a json object

Parameters:

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

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

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

Remove event handler.

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

Args: attr(str): the attribute which value should be changed data(dict): the dictionary from which the value should be extracted enum_type(AutoNameEnum): this will call enum_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()

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

Toggle Wall mounted Garage Door Controller.

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

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

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

Update the channel attributes from a JSON dictionary.

Set LED color and brightness.

Args: rgb_color_state: The RGB color state from RGBColorState enum: BLACK, BLUE, GREEN, TURQUOISE, RED, PURPLE, YELLOW, WHITE dim_level: The dim/brightness level (0.0 to 1.0). Default 1.0.

Play specified sound file at given volume.

Args: sound_file: The sound file to play. Possible values: INTERNAL_SOUNDFILE - Built-in system sound SOUNDFILE_001 through SOUNDFILE_252 - User sounds on SD card RANDOM_SOUNDFILE - Random selection DISABLE_ACOUSTIC_SIGNAL - Stop/no sound volume_level: The volume level (0.0 to 1.0). Default 1.0.

Stop current sound playback by setting volume to 0.

Turn off both LED and sound.

sets the label of the rule

sets the label of the rule

stops the current operation Returns: the result of the _restCall

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

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

stops the current shutter operation

Args: channelIndex(int): the channel to control Returns: the result of the _restCall

stops the current shutter operation

Args: channelIndex(int): the channel to control Returns: the result of the _restCall

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

stops the current shutter operation

Args: channelIndex(int): the channel to control Returns: the result of the _restCall

disables the rule

disables the rule

enables the rule

enables the rule

enables/disables this rule

enables/disables this rule

Update the channel attributes from a JSON dictionary.

Set the dim level of the light channel.

Set the dim level of the light channel with a specified time.

Start a light scene.

Toggle Wall mounted Garage Door Controller.

Toggle Wall mounted Garage Door Controller.

Resets the water volume counter of the specified device.

Sets the watering switch state of the specified device.

Sets the watering switch state of the specified device with a specified time.

Parameters:

Toggles the watering state of the specified device.

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

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

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

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