homematicip.commands.functional_channel_commands¶

homematicip.commands.functional_channel_commands ¶

pull_latch_async `async` ¶

pull_latch_async

Trigger the latch of a door opening device by activating the switching output of the target device channel for its configured impulse duration.

Both the requesting client and the target device channel must belong to the same access authorization. Used for ACCESS_AUTHORIZATION_CHANNEL channels with role DOOR_OPENER_ACTUATOR (e.g. on HmIP-FLC, HmIP-DLD).

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index of the access-authorization channel.	required
`pin` ¶	`str \| None`	The authorization PIN (optional, only required if a PIN is configured on the access authorization profile). The cloud requires the field to be a string, so `None` is sent as an empty string.	`None`

Returns:

Type	Description
`dict`	The response from the cloud.

reset_energy_counter_async `async` ¶

reset_energy_counter_async

Reset the energy counter for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required

Returns:

Type	Description
`dict`	The response from the cloud.

reset_water_volume_async `async` ¶

reset_water_volume_async

Resets the water volume counter of the specified device.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required

send_door_command_async `async` ¶

send_door_command_async

Send a door command.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`door_command` ¶	`str`	The door command as string. Possible values are defined in the DoorCommand enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acceleration_sensor_event_filter_period_async `async` ¶

set_acceleration_sensor_event_filter_period_async

Set the event filter period for the acceleration sensor.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`period` ¶	`float`	The event filter period in seconds.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acceleration_sensor_mode_async `async` ¶

set_acceleration_sensor_mode_async

Set the mode for the acceleration sensor.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`mode` ¶	`str`	The mode as string. Possible values are defined in the AccelerationSensorMode enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acceleration_sensor_neutral_position_async `async` ¶

set_acceleration_sensor_neutral_position_async

Set the neutral position for the acceleration sensor.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`neutral_position` ¶	`str`	The neutral position as string. Possible values are defined in the AccelerationSensorNeutralPosition enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acceleration_sensor_sensitivity_async `async` ¶

set_acceleration_sensor_sensitivity_async

Set the sensitivity for the acceleration sensor.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`sensitivity` ¶	`str`	The sensitivity as string. Possible values are defined in the AccelerationSensorSensitivity enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acceleration_sensor_trigger_angle_async `async` ¶

set_acceleration_sensor_trigger_angle_async

Set the trigger angle for the acceleration sensor.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`angle` ¶	`int`	The trigger angle in degrees.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acoustic_alarm_signal_async `async` ¶

set_acoustic_alarm_signal_async

Set the acoustic alarm signal.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`acoustic_alarm_signal` ¶	`str`	The acoustic alarm signal as string. Possible values are defined in the AcousticAlarmSignal enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acoustic_alarm_timing_async `async` ¶

set_acoustic_alarm_timing_async

Set the acoustic alarm timing.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`acoustic_alarm_timing` ¶	`str`	The acoustic alarm timing as string. Possible values are defined in the AcousticAlarmTiming enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_acoustic_water_alarm_trigger_async `async` ¶

set_acoustic_water_alarm_trigger_async

Set the acoustic water alarm trigger.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`acoustic_water_alarm_trigger` ¶	`str`	The acoustic water alarm trigger as string. Possible values are defined in the WaterAlarmTrigger enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_color_temperature_dim_level_async `async` ¶

set_color_temperature_dim_level_async

Set the color temperature and dim level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`color_temperature` ¶	`int`	The desired color temperature in Kelvin. Between 1000 K(Kelvin) to 10000 K	required
`dim_level` ¶	`float`	The desired dim level (0.0 to 1.0).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_color_temperature_dim_level_with_time_async `async` ¶

set_color_temperature_dim_level_with_time_async

Set the color temperature and dim level with time for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`color_temperature` ¶	`int`	The desired color temperature in Kelvin. Between 1000 K(Kelvin) to 10000 K	required
`dim_level` ¶	`float`	The desired dim level (0.0 to 1.0).	required
`on_time` ¶	`float`	The on time in seconds.	required
`ramp_time` ¶	`float`	The ramp time in seconds.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_dim_level_async `async` ¶

set_dim_level_async

Set the dim level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`dim_level` ¶	`float`	The desired dim level.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_dim_level_with_time_async `async` ¶

set_dim_level_with_time_async

Set the dim level with time for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`dim_level` ¶	`float`	The desired dim level.	required
`on_time` ¶	`float`	The on time in seconds.	required
`ramp_time` ¶	`float`	The ramp time in seconds.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_display_async `async` ¶

set_display_async

Set the climate control display.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`display` ¶	`str`	The display as string. Possible values are defined in the ClimateControlDisplay enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_door_lock_active_async `async` ¶

set_door_lock_active_async

Hold a door permanently released ("always open"), or end that state.

Sets doorLockActive on the DOOR_SWITCH_CHANNEL with role DOOR_LOCK_ACTUATOR. Note the polarity: True is the released state, although the vendor documentation describes the field as activating the locking of the door.

Without a PIN the plain endpoint applies, which takes the DOOR_SWITCH_CHANNEL. A client outside the access authorization gets CLIENT_ACCESS_DENIED and needs the ...WithAuthorization variant, which takes the ACCESS_AUTHORIZATION_CHANNEL with role DOOR_LOCK_ACTUATOR instead. Pass pin="" when that authorization has no PIN. The authorization variant is untested, see issue #685.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index of the door switch channel.	required
`door_lock_active` ¶	`bool`	`True` releases the door permanently ("always open"), `False` returns it to normal locking.	required
`pin` ¶	`str \| None`	The authorization PIN. `None` selects the plain endpoint, a string (including an empty one) selects the authorization endpoint.	`None`

Returns:

Type	Description
`dict`	The response from the cloud.

set_favorite_shading_position `async` ¶

set_favorite_shading_position

Set the favorite shading position for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_hue_saturation_dim_level_async `async` ¶

set_hue_saturation_dim_level_async

Set the hue, saturation, and dim level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`hue` ¶	`int`	The desired hue (0-360).	required
`saturation_level` ¶	`float`	The desired saturation level (0.0 to 1.0).	required
`dim_level` ¶	`float`	The desired dim level (0.0 to 1.0).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_hue_saturation_dim_level_with_time_async `async` ¶

set_hue_saturation_dim_level_with_time_async

Set the hue, saturation, and dim level with time for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`hue` ¶	`int`	The desired hue (0 to 359).	required
`saturation_level` ¶	`float`	The desired saturation level (0.0 to 1.0).	required
`dim_level` ¶	`float`	The desired dim level (0.0 to 1.0).	required
`on_time` ¶	`float`	The on time in seconds.	required
`ramp_time` ¶	`float`	The ramp time in seconds.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_inapp_water_alarm_trigger_async `async` ¶

set_inapp_water_alarm_trigger_async

Set the in-app water alarm trigger.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`inapp_water_alarm_trigger` ¶	`str`	The in-app water alarm trigger as string. Possible values are defined in the WaterAlarmTrigger enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_lock_state_async `async` ¶

set_lock_state_async

Set the door lock state.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`lock_state` ¶	`str`	The lock state as string. Possible values are defined in the LockState enum.	required
`pin` ¶	`str \| None`	The authorization pin (optional).	`None`

Returns:

Type	Description
`dict`	The response from the cloud.

set_minimum_floor_heating_valve_position_async `async` ¶

set_minimum_floor_heating_valve_position_async

Set the minimum floor heating valve position.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`position` ¶	`float`	The desired minimum valve position.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_motion_detection_active_async `async` ¶

set_motion_detection_active_async

Set the motion detection active state for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`motion_detection_active` ¶	`bool`	Whether motion detection is active (True) or not (False).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_notification_sound_type_async `async` ¶

set_notification_sound_type_async

Set the notification sound type.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`sound_type` ¶	`str`	The sound type as string. Possible values are defined in the AcousticAlarmSignal enum.	required
`is_high_to_low` ¶	`bool`	Whether the signal is high to low.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_operation_lock_async `async` ¶

set_operation_lock_async

Set the operation lock for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`operation_lock` ¶	`bool`	The desired operation lock state (True for locked, False for unlocked).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_optical_signal_async `async` ¶

set_optical_signal_async

Set the signal type for the LEDs.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`optical_signal_behaviour` ¶	`str`	The optical signal behaviour as string. Possible values are defined in the OpticalSignalBehaviour enum.	required
`rgb` ¶	`str`	The RGB color as string. Possible values are defined in the RGBColorState enum.	required
`dim_level` ¶	`float`	The dim level (usually 1.01). Use set_dim_level instead.	`1.01`

Returns:

Type	Description
`dict`	The response from the cloud.

set_optical_signal_with_time_async `async` ¶

set_optical_signal_with_time_async

Set the optical signal with time for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`optical_signal_behaviour` ¶	`str`	The optical signal behaviour as string. Possible values are defined in the OpticalSignalBehaviour enum.	required
`simple_rgb_color_state` ¶	`str`	The RGB color as string. Possible values are defined in the RGBColorState enum.	required
`on_time` ¶	`float`	The on time in seconds.	required
`ramp_time` ¶	`float`	The ramp time in seconds.	required
`dim_level` ¶	`float`	The dim level (usually 1.01). Use set_dim_level instead.	`1.01`

Returns:

Type	Description
`dict`	The response from the cloud.

set_primary_shading_level_async `async` ¶

set_primary_shading_level_async

Set the primary shading level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`primary_shading_level` ¶	`float`	The desired primary shading level.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_secondary_shading_level_async `async` ¶

set_secondary_shading_level_async

Set the secondary shading level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`primary_shading_level` ¶	`float`	The desired primary shading level.	required
`secondary_shading_level` ¶	`float`	The desired secondary shading level.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_shutter_level_async `async` ¶

set_shutter_level_async

Set the shutter level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`shutter_level` ¶	`float`	The desired shutter level.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_shutter_stop_async `async` ¶

set_shutter_stop_async

Stop the shutter for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_simple_rgb_color_dim_level_async `async` ¶

set_simple_rgb_color_dim_level_async

Set the simple RGB color and dim level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`simple_rgb_color_state` ¶	`str`	The RGB color as string. Possible values are defined in the RGBColorState enum.	required
`dim_level` ¶	`float`	The desired dim level (0.0 to 1.0).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_simple_rgb_color_dim_level_with_time_async `async` ¶

set_simple_rgb_color_dim_level_with_time_async

Set the RGB color and dim level with on and ramp time for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`simple_rgb_color_state` ¶	`str`	The RGB color as string. Possible values are defined in the RGBColorState enum.	required
`dim_level` ¶	`float`	The desired dim level (0.0 to 1.0).	required
`on_time` ¶	`float`	The on time in seconds.	required
`ramp_time` ¶	`float`	The ramp time in seconds.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_siren_water_alarm_trigger_async `async` ¶

set_siren_water_alarm_trigger_async

Set the siren water alarm trigger.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`siren_water_alarm_trigger` ¶	`str`	The siren water alarm trigger as string. Possible values are defined in the WaterAlarmTrigger enum.	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_slats_level_async `async` ¶

set_slats_level_async

Set the slats level for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`slats_level` ¶	`float`	The desired slats level.	required
`shutter_level` ¶	`float`	The desired shutter level (optional).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_sound_file_volume_level_async `async` ¶

set_sound_file_volume_level_async

Set the sound file and volume level for a MP3 notification channel (HmIP-MP3P).

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`sound_file` ¶	`str`	The sound file to play. Possible values: INTERNAL_SOUNDFILE, SOUNDFILE_001 through SOUNDFILE_252, RANDOM_SOUNDFILE, DISABLE_ACOUSTIC_SIGNAL.	required
`volume_level` ¶	`float`	The desired volume level (0.0 to 1.0).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_switch_state_async `async` ¶

set_switch_state_async

Set the switch state for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`on` ¶	`bool`	The desired switch state (True for ON, False for OFF).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_watering_switch_state_async `async` ¶

set_watering_switch_state_async

Set the watering switch state for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`watering_active` ¶	`bool`	The desired watering state (True for active, False for inactive).	required

Returns:

Type	Description
`dict`	The response from the cloud.

set_watering_switch_state_with_time_async `async` ¶

set_watering_switch_state_with_time_async

Set the watering switch state for a functional channel with a specific watering time.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`watering_active` ¶	`bool`	The desired watering state (True for active, False for inactive).	required
`watering_time` ¶	`float`	The watering time in seconds.	required

Returns:

Type	Description
`dict`	The response from the cloud.

start_impulse_async `async` ¶

start_impulse_async

Toggle Wall mounted Garage Door Controller.

start_light_scene_async `async` ¶

start_light_scene_async

Start a light scene for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required
`scene_id` ¶	`int`	The ID of the light scene.	required
`dim_level` ¶	`float`	The desired dim level (0.0 to 1.0).	required

Returns:

Type	Description
`dict`	The response from the cloud.

toggle_watering_state_async `async` ¶

toggle_watering_state_async

Toggle the watering state for a functional channel.

Parameters:

Name	Type	Description	Default
`rest_connection` ¶	`RestConnection`	The REST connection instance.	required
`device_id` ¶	`str`	The device ID.	required
`channel_index` ¶	`int`	The channel index.	required

Returns:

Type	Description
`dict`	The response from the cloud.

homematicip.commands.functional_channel_commands¶

homematicip.commands.functional_channel_commands ¶

pull_latch_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

pin ¶

reset_energy_counter_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

reset_water_volume_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

send_door_command_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

door_command ¶

set_acceleration_sensor_event_filter_period_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

period ¶

set_acceleration_sensor_mode_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

mode ¶

set_acceleration_sensor_neutral_position_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

neutral_position ¶

set_acceleration_sensor_sensitivity_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

sensitivity ¶

set_acceleration_sensor_trigger_angle_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

angle ¶

set_acoustic_alarm_signal_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

acoustic_alarm_signal ¶

set_acoustic_alarm_timing_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

acoustic_alarm_timing ¶

set_acoustic_water_alarm_trigger_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

acoustic_water_alarm_trigger ¶

set_color_temperature_dim_level_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

color_temperature ¶

dim_level ¶

set_color_temperature_dim_level_with_time_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

color_temperature ¶

dim_level ¶

on_time ¶

ramp_time ¶

set_dim_level_async async ¶

rest_connection ¶

device_id ¶

channel_index ¶

dim_level ¶

set_dim_level_with_time_async async ¶

pull_latch_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`pin` ¶

reset_energy_counter_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

reset_water_volume_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

send_door_command_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`door_command` ¶

set_acceleration_sensor_event_filter_period_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`period` ¶

set_acceleration_sensor_mode_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`mode` ¶

set_acceleration_sensor_neutral_position_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`neutral_position` ¶

set_acceleration_sensor_sensitivity_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`sensitivity` ¶

set_acceleration_sensor_trigger_angle_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`angle` ¶

set_acoustic_alarm_signal_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`acoustic_alarm_signal` ¶

set_acoustic_alarm_timing_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`acoustic_alarm_timing` ¶

set_acoustic_water_alarm_trigger_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`acoustic_water_alarm_trigger` ¶

set_color_temperature_dim_level_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`color_temperature` ¶

`dim_level` ¶

set_color_temperature_dim_level_with_time_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`color_temperature` ¶

`dim_level` ¶

`on_time` ¶

`ramp_time` ¶

set_dim_level_async `async` ¶

`rest_connection` ¶

`device_id` ¶

`channel_index` ¶

`dim_level` ¶

set_dim_level_with_time_async `async` ¶

`rest_connection` ¶

`device_id` ¶