Skip to content

homematicip.base.functionalChannels

homematicip.base.functionalChannels

AccelerationSensorChannel

Bases: FunctionalChannel

this is the representative of the ACCELERATION_SENSOR_CHANNEL channel

AccessAuthorizationChannel

Bases: FunctionalChannel

this represents ACCESS_AUTHORIZATION_CHANNEL channel

pull_latch 

pull_latch

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.

AccessControllerChannel

Bases: DeviceBaseChannel

this is the representative of the ACCESS_CONTROLLER_CHANNEL channel

AccessControllerWiredChannel

Bases: DeviceBaseChannel

this is the representative of the ACCESS_CONTROLLER_WIRED_CHANNEL channel

AlarmSirenChannel

Bases: FunctionalChannel

this is the representative of the ALARM_SIREN_CHANNEL channel

AnalogOutputChannel

Bases: FunctionalChannel

this is the representative of the ANALOG_OUTPUT_CHANNEL channel

AnalogRoomControlChannel

Bases: FunctionalChannel

this is the representative of the ANALOG_ROOM_CONTROL_CHANNEL channel

AutoNameEnum

Bases: StrEnum

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

BlindChannel

Bases: FunctionalChannel

this is the representative of the BLIND_CHANNEL channel

set_shutter_level 

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 

set_shutter_stop

stops the current operation Returns: the result of the _restCall

set_slats_level 

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 

stop

stops the current shutter operation

Returns: the result of the _restCall

CarbonDioxideSensorChannel

Bases: FunctionalChannel

Representation of the CarbonDioxideSensorChannel Channel

ChangeOverChannel

Bases: FunctionalChannel

this is the representative of the CHANGE_OVER_CHANNEL channel

ClimateSensorChannel

Bases: FunctionalChannel

this is the representative of the CLIMATE_SENSOR_CHANNEL channel

CodeProtectedPrimaryActionChannel

Bases: FunctionalChannel

this is the representative of the CODE_PROTECTED_PRIMARY_ACTION_CHANNEL channel (HmIP-WKP)

CodeProtectedSecondaryActionChannel

Bases: FunctionalChannel

this is the representative of the CODE_PROTECTED_SECONDARY_ACTION_CHANNEL channel (HmIP-WKP)

CodeProtectedSingleActionChannel

Bases: FunctionalChannel

this is the representative of the CODE_PROTECTED_SINGLE_ACTION_CHANNEL channel (HmIP-FWI)

ContactInterfaceChannel

Bases: ShutterContactChannel

this is the representative of the CONTACT_INTERFACE_CHANNEL channel

DehumidifierDemandChannel

Bases: FunctionalChannel

this is the representative of the DEHUMIDIFIER_DEMAND_CHANNEL channel

DeviceBaseChannel

Bases: FunctionalChannel

this is the representative of the DEVICE_BASE channel

DeviceBaseFloorHeatingChannel

Bases: DeviceBaseChannel

this is the representative of the DEVICE_BASE_FLOOR_HEATING channel

set_minimum_floor_heating_valve_position 

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

DeviceBlockingChannel

Bases: FunctionalChannel

this is the representative of the DEVICE_BLOCKING channel

DeviceBlockingWithTeachableCodeChannel

Bases: DeviceBlockingChannel

this is the representative of the DEVICE_BLOCKING_WITH_TEACHABLE_CODE channel

DeviceGlobalPumpControlChannel

Bases: DeviceBaseChannel

this is the representative of the DEVICE_GLOBAL_PUMP_CONTROL channel

DeviceIncorrectPositionedChannel

Bases: DeviceBaseChannel

this is the representative of the DEVICE_INCORRECT_POSITIONED channel

DeviceOperationLockChannel

Bases: DeviceBaseChannel

this is the representative of the DEVICE_OPERATIONLOCK channel

DeviceOperationLockChannelWithSabotage

Bases: DeviceOperationLockChannel

this is the representation of the DeviceOperationLockChannelWithSabotage channel

DevicePermanentFullRxChannel

Bases: DeviceBaseChannel

this is the representative of the DEVICE_PERMANENT_FULL_RX channel

DeviceRechargeableWithSabotage

Bases: DeviceSabotageChannel

this is the representative of the DEVICE_RECHARGEABLE_WITH_SABOTAGE channel

DeviceSabotageChannel

Bases: DeviceBaseChannel

this is the representative of the DEVICE_SABOTAGE channel

DimmerChannel

Bases: FunctionalChannel

this is the representative of the DIMMER_CHANNEL channel

DoorChannel

Bases: FunctionalChannel

this is the representative of the DoorChannel channel

DoorLockChannel

Bases: FunctionalChannel

This respresents of the DoorLockChannel

async_set_lock_state 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 

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

DoorLockProChannel

Bases: DoorLockChannel

This represents the DOOR_LOCK_PRO_CHANNEL channel (HmIP-DLP)

DoorLockSensorBaseChannel

Bases: FunctionalChannel

This represents the DOOR_LOCK_SENSOR_BASE_CHANNEL channel

DoorLockSensorChannel

Bases: FunctionalChannel

This respresents of the DoorLockSensorChannel

DoorSwitchChannel

Bases: FunctionalChannel

this is the representative of the DOOR_SWITCH_CHANNEL channel

set_door_lock_active 

set_door_lock_active

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

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

EnergySensorInterfaceChannel

Bases: FunctionalChannel

EnergySensorInterfaceChannel

ExternalBaseChannel

Bases: FunctionalChannel

this represents the EXTERNAL_BASE_CHANNEL function-channel for external devices

ExternalSwitchChannel

Bases: SwitchChannel

this is the representative of the EXTERNAL_SWITCH_CHANNEL channel

ExternalUniversalLightChannel

Bases: FunctionalChannel

this represents the EXTERNAL_UNIVERSAL_LIGHT_CHANNEL function-channel for external devices

set_dim_level_async async 

set_dim_level_async

Set the dim level of the light channel.

set_dim_level_with_time_async async 

set_dim_level_with_time_async

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

FloorTeminalBlockChannel

Bases: FunctionalChannel

this is the representative of the FLOOR_TERMINAL_BLOCK_CHANNEL channel

FloorTerminalBlockLocalPumpChannel

Bases: FunctionalChannel

this is the representative of the FLOOR_TERMINAL_BLOCK_LOCAL_PUMP_CHANNEL channel

FloorTerminalBlockMechanicChannel

Bases: FunctionalChannel

this is the representative of the class FLOOR_TERMINAL_BLOCK_MECHANIC_CHANNEL(FunctionalChannel) channel

FunctionalChannel

Bases: HomeMaticIPObject

this is the base class for the functional channels

add_on_channel_event_handler 

add_on_channel_event_handler

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

fire_channel_event 

fire_channel_event

Trigger the methods tied to _on_channel_event

from_json 

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

GenericInputChannel

Bases: FunctionalChannel

this is the representative of the GENERIC_INPUT_CHANNEL channel

HeatDemandChannel

Bases: FunctionalChannel

this is the representative of the HEAT_DEMAND_CHANNEL channel

HeatingThermostatChannel

Bases: FunctionalChannel

this is the representative of the HEATING_THERMOSTAT_CHANNEL channel

ImpulseOutputChannel

Bases: FunctionalChannel

this is the representation of the IMPULSE_OUTPUT_CHANNEL

send_start_impulse 

send_start_impulse

Toggle Wall mounted Garage Door Controller.

InternalSwitchChannel

Bases: FunctionalChannel

this is the representative of the INTERNAL_SWITCH_CHANNEL channel

LightSensorChannel

Bases: FunctionalChannel

this is the representative of the LIGHT_SENSOR_CHANNEL channel

MagneticDoorSensorChannel

Bases: FunctionalChannel

This represents the MAGNETIC_DOOR_SENSOR_CHANNEL channel

MainsFailureChannel

Bases: FunctionalChannel

this is the representative of the MAINS_FAILURE_CHANNEL channel

MotionDetectionChannel

Bases: FunctionalChannel

this is the representative of the MOTION_DETECTION_CHANNEL channel

MultiModeInputBlindChannel

Bases: BlindChannel

this is the representative of the MULTI_MODE_INPUT_BLIND_CHANNEL channel

MultiModeInputChannel

Bases: FunctionalChannel

this is the representative of the MULTI_MODE_INPUT_CHANNEL channel

MultiModeInputDimmerChannel

Bases: DimmerChannel

this is the representative of the MULTI_MODE_INPUT_DIMMER_CHANNEL channel

MultiModeInputSwitchChannel

Bases: SwitchChannel

this is the representative of the MULTI_MODE_INPUT_SWITCH_CHANNEL channel

MultiModeLockInputChannel

Bases: MultiModeInputChannel

this is the representative of the MULTI_MODE_LOCK_INPUT_CHANNEL channel

NotificationLightChannel

Bases: DimmerChannel, SwitchChannel

this is the representative of the NOTIFICATION_LIGHT_CHANNEL channel

async_set_optical_signal 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_set_rgb_dim_level_with_time 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 

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

NotificationMp3SoundChannel

Bases: FunctionalChannel

This is the representative of the NOTIFICATION_MP3_SOUND_CHANNEL channel.

This channel is used by combination signalling devices like the HmIP-MP3P which can play MP3 sounds and show optical signals for various alarm conditions.

from_json 

from_json

Update the channel attributes from a JSON dictionary.

set_rgb_dim_level_async async 

set_rgb_dim_level_async

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.

set_sound_file_volume_level_async async 

set_sound_file_volume_level_async

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_sound_async async 

stop_sound_async

Stop current sound playback by setting volume to 0.

turn_off_async async 

turn_off_async

Turn off both LED and sound.

OpticalSignalChannel

Bases: FunctionalChannel

this class represents the OPTICAL_SIGNAL_CHANNEL

OpticalSignalGroupChannel

Bases: FunctionalChannel

this class represents the OPTICAL_SIGNAL_GROUP_CHANNEL

ParticulateMatterSensorChannel

Bases: FunctionalChannel

Representation of the PARTICULATE_MATTER_SENSOR_CHANNEL channel

PassageDetectorChannel

Bases: FunctionalChannel

this is the representative of the PASSAGE_DETECTOR_CHANNEL channel

PresenceDetectionChannel

Bases: FunctionalChannel

this is the representative of the PRESENCE_DETECTION_CHANNEL channel

RainDetectionChannel

Bases: FunctionalChannel

this is the representative of the TILT_VIBRATION_SENSOR_CHANNEL channel

RotaryHandleChannel

Bases: ShutterContactChannel

this is the representative of the ROTARY_HANDLE_CHANNEL channel

RotaryWheelChannel

Bases: FunctionalChannel

this is the representative of the ROTARY_WHEEL_CHANNEL channel.

HmIP-WRCR exposes two ROTARY_WHEEL_CHANNEL instances, one per rotation direction (CLOCK_WISE / COUNTER_CLOCK_WISE).

ShadingChannel

Bases: FunctionalChannel

this is the representative of the SHADING_CHANNEL channel

async_set_shutter_stop async 

async_set_shutter_stop

stops the current operation Returns: the result of the _restCall

ShutterChannel

Bases: FunctionalChannel

this is the representative of the SHUTTER_CHANNEL channel

async_set_shutter_level 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_set_shutter_stop async 

async_set_shutter_stop

stops the current shutter operation

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

ShutterContactChannel

Bases: FunctionalChannel

this is the representative of the SHUTTER_CONTACT_CHANNEL channel

SingleKeyChannel

Bases: FunctionalChannel

this is the representative of the SINGLE_KEY_CHANNEL channel

SmokeDetectorChannel

Bases: FunctionalChannel

this is the representative of the SMOKE_DETECTOR_CHANNEL channel

SoilMoistureSensorInterfaceChannel

Bases: FunctionalChannel

This is the representative of the SOIL_MOISTURE_SENSOR_INTERFACE_CHANNEL channel.

from_json 

from_json

Update the channel attributes from a JSON dictionary.

SwitchChannel

Bases: FunctionalChannel

this is the representative of the SWITCH_CHANNEL channel

SwitchMeasuringChannel

Bases: SwitchChannel

this is the representative of the SWITCH_MEASURING_CHANNEL channel

TemperatureDifferenceSensor2Channel

Bases: FunctionalChannel

this is the representative of the TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL channel

TemperatureSensorChannel

Bases: FunctionalChannel

this is the representative of the TEMPERATURE_SENSOR_CHANNEL channel

TiltVibrationSensorChannel

Bases: FunctionalChannel

this is the representative of the TILT_VIBRATION_SENSOR_CHANNEL channel

UniversalActuatorChannel

Bases: FunctionalChannel

this is the representative of the UniversalActuatorChannel UNIVERSAL_ACTUATOR_CHANNEL

UniversalLightChannel

Bases: FunctionalChannel

Represents Universal Light Channel.

set_dim_level_async async 

set_dim_level_async

Set the dim level of the light channel.

set_dim_level_with_time_async async 

set_dim_level_with_time_async

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

start_light_scene_async async 

start_light_scene_async

Start a light scene.

UniversalLightChannelGroup

Bases: UniversalLightChannel

Universal-Light-Channel-Group.

WallMountedThermostatProChannel

Bases: FunctionalChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL channel

WallMountedThermostatWithCarbonChannel

Bases: WallMountedThermostatProChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_WITH_CARBON_DIOXIDE_SENSOR_CHANNEL channel

WallMountedThermostatWithoutDisplayChannel

Bases: ClimateSensorChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL channel

WaterSensorChannel

Bases: FunctionalChannel

this is the representative of the WATER_SENSOR_CHANNEL channel

WateringActuatorChannel

Bases: FunctionalChannel

this is the representative of the WATERING_ACTUATOR_CHANNEL channel

reset_water_volume_async async 

reset_water_volume_async

Resets the water volume counter of the specified device.

set_watering_switch_state_async async 

set_watering_switch_state_async

Sets the watering switch state of the specified device.

set_watering_switch_state_with_time_async async 

set_watering_switch_state_with_time_async

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

Parameters:

Name Type Description Default

on

bool

True to turn on, False to turn off.

 required

seconds

int

The watering time in seconds.

 required

toggle_watering_state_async async 

toggle_watering_state_async

Toggles the watering state of the specified device.

WeatherSensorChannel

Bases: FunctionalChannel

this is the representative of the WEATHER_SENSOR_CHANNEL channel

WeatherSensorPlusChannel

Bases: WeatherSensorChannel

this is the representative of the WEATHER_SENSOR_PLUS_CHANNEL channel

WeatherSensorProChannel

Bases: WeatherSensorPlusChannel

this is the representative of the WEATHER_SENSOR_PRO_CHANNEL channel