Skip to content

homematicip.class_maps

homematicip.class_maps

AccelerationSensor

Bases: Device

HMIP-SAM (Contact Interface flush-mount – 1 channel)

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

AlarmSirenIndoor

Bases: SabotageDevice

HMIP-ASIR (Alarm Siren)

AlarmSirenOutdoor

Bases: AlarmSirenIndoor

HMIP-ASIR-O (Alarm Siren Outdoor)

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

BaseDevice

Bases: HomeMaticIPObject

Base device class. This is the foundation for homematicip and external (hue) devices

get_functional_channel 

get_functional_channel

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

load_functionalChannels 

load_functionalChannels

this function will load the functionalChannels into the device

Blind

Bases: Shutter

Base class for blind devices

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

set_slats_level_async 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

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

BlindModule

Bases: Device

HMIP-HDM1 (Hunter Douglas & erfal window blinds)

stop async 

stop

stops the current operation Returns: the result of the _restCall

stop_async async 

stop_async

stops the current operation Returns: the result of the _restCall

BrandBlind

Bases: FullFlushBlind

HMIP-BBL (Blind Actuator for brand switches)

BrandDimmer

Bases: Dimmer

HMIP-BDT Brand Dimmer

BrandPushButton

Bases: PushButton

HMIP-BRC2 (Remote Control for brand switches – 2x channels)

BrandSwitch2

Bases: Switch

ELV-SH-BS2 (ELV Smart Home ARR-Bausatz Schaltaktor für Markenschalter – 2-fach powered by Homematic IP)

BrandSwitchNotificationLight

Bases: Switch

HMIP-BSL (Switch Actuator for brand switches – with signal lamp)

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

set_rgb_dim_level_async 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 

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_with_time_async 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

CarbonDioxideSensor

Bases: Switch

HmIP-SCTH230

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)

CombinationSignallingDevice

Bases: Device

HmIP-MP3P (Combination Signalling Device)

A device that can play MP3 sounds and show optical signals for various alarm and notification conditions.

ContactInterface

Bases: SabotageDevice

HMIP-SCI (Contact Interface Sensor)

ContactInterfaceChannel

Bases: ShutterContactChannel

this is the representative of the CONTACT_INTERFACE_CHANNEL channel

DaliGateway

Bases: Device

HmIP-DRG-DALI Dali Gateway device.

DehumidifierDemandChannel

Bases: FunctionalChannel

this is the representative of the DEHUMIDIFIER_DEMAND_CHANNEL channel

Device

Bases: BaseDevice

this class represents a generic homematic ip device

add_on_code_state_event_handler 

add_on_code_state_event_handler

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).

fire_code_state_event 

fire_code_state_event

Invoke all registered code-state handlers.

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

Dimmer

Bases: Device

Base dimmer device class

DimmerChannel

Bases: FunctionalChannel

this is the representative of the DIMMER_CHANNEL channel

DinRailBlind4

Bases: Blind

HmIP-DRBLI4 (Blind Actuator for DIN rail mount – 4 channels)

DinRailDimmer3

Bases: Dimmer

HMIP-DRDI3 (Dimming Actuator Inbound 230V – 3x channels, 200W per channel) electrical DIN rail

DinRailSwitch

Bases: FullFlushInputSwitch

HMIP-DRSI1 (Switch Actuator for DIN rail mount – 1x channel)

DinRailSwitch4

Bases: Switch

HMIP-DRSI4 (Homematic IP Switch Actuator for DIN rail mount – 4x channels)

DoorBellButton

Bases: PushButton

HmIP-DBB

DoorBellContactInterface

Bases: Device

HMIP-DSD-PCB (Door Bell Contact Interface)

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

DoorLockDrive

Bases: OperationLockableDevice

HmIP-DLD

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

set_lock_state_async 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

DoorLockDrivePro

Bases: DoorLockDrive

HmIP-DLP

DoorLockProChannel

Bases: DoorLockChannel

This represents the DOOR_LOCK_PRO_CHANNEL channel (HmIP-DLP)

DoorLockSensor

Bases: Device

HmIP-DLS

DoorLockSensorBaseChannel

Bases: FunctionalChannel

This represents the DOOR_LOCK_SENSOR_BASE_CHANNEL channel

DoorLockSensorChannel

Bases: FunctionalChannel

This respresents of the DoorLockSensorChannel

DoorModule

Bases: Device

Generic class for a door module

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

EnergySensorsInterface

Bases: Device

HmIP-ESI

ExternalBaseChannel

Bases: FunctionalChannel

this represents the EXTERNAL_BASE_CHANNEL function-channel for external devices

ExternalDevice

Bases: BaseDevice

Represents devices with archtetype EXTERNAL

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

FloorTerminalBlock10

Bases: FloorTerminalBlock6

HMIP-FAL24-C10 (Floor Heating Actuator – 10x channels, 24V)

FloorTerminalBlock12

Bases: Device

HMIP-FALMOT-C12 (Floor Heating Actuator – 12x channels, motorised)

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

set_minimum_floor_heating_valve_position_async 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

FloorTerminalBlock6

Bases: Device

HMIP-FAL230-C6 (Floor Heating Actuator - 6 channels, 230 V)

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

FullFlushBlind

Bases: FullFlushShutter, Blind

HMIP-FBL (Blind Actuator - flush-mount)

FullFlushContactInterface

Bases: Device

HMIP-FCI1 (Contact Interface flush-mount – 1 channel)

FullFlushContactInterface6

Bases: Device

HMIP-FCI6 (Contact Interface flush-mount – 6 channels)

FullFlushDimmer

Bases: Dimmer

HMIP-FDT Dimming Actuator flush-mount

FullFlushDoorController

Bases: Device

HmIP-FDC Full Flush Door Controller (door opener).

Provides an impulse-driven door opener output via DOOR_SWITCH_CHANNEL (role DOOR_OPENER_ACTUATOR). Two MULTI_MODE_LOCK_INPUT_CHANNEL inputs and a set of ACCESS_AUTHORIZATION_CHANNEL channels for keypad/code access are exposed via the standard functionalChannels collection.

FullFlushInputSwitch

Bases: Switch

HMIP-FSI16 (Switch Actuator with Push-button Input 230V, 16A) and HMIP-FSI6 (Switch Actuator with Push-button Input, compact)

FullFlushLockController

Bases: Device

HmIP-FLC Universal lock controller.

set_door_lock_active 

set_door_lock_active

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

FullFlushShutter

Bases: Shutter

HMIP-FROLL (Shutter Actuator - flush-mount) / HMIP-BROLL (Shutter Actuator - Brand-mount)

FullFlushWiegandInterface

Bases: Device

HmIP-FWI (Wiegand Interface)

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

GarageDoorModuleTormatic

Bases: DoorModule

HMIP-MOD-TM (Garage Door Module Tormatic)

GenericInputChannel

Bases: FunctionalChannel

this is the representative of the GENERIC_INPUT_CHANNEL channel

Group

Bases: HomeMaticIPObject

this class represents a group

HeatDemandChannel

Bases: FunctionalChannel

this is the representative of the HEAT_DEMAND_CHANNEL channel

HeatingSwitch2

Bases: Switch

HMIP-WHS2 (Switch Actuator for heating systems – 2x channels)

HeatingThermostat

Bases: OperationLockableDevice

HMIP-eTRV (Radiator Thermostat)

HeatingThermostatChannel

Bases: FunctionalChannel

this is the representative of the HEATING_THERMOSTAT_CHANNEL channel

HeatingThermostatCompact

Bases: SabotageDevice

HMIP-eTRV-C (Heating-thermostat compact without display)

HeatingThermostatEvo

Bases: OperationLockableDevice

HMIP-eTRV-E (Heating-thermostat new evo version)

HoermannDrivesModule

Bases: DoorModule

HMIP-MOD-HO (Garage Door Module for Hörmann)

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 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()

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

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

KeyRemoteControl4

Bases: PushButton

HMIP-KRC4 (Key Ring Remote Control - 4 buttons)

KeyRemoteControlAlarm

Bases: Device

HMIP-KRCA (Key Ring Remote Control - alarm)

KeyRemoteControlKeyMatic

Bases: PushButton

HmIP-KRC-K (Key Ring Remote Control - 4 buttons, for door lock)

LightSensor

Bases: Device

HMIP-SLO (Light Sensor outdoor)

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

MetaGroup

Bases: Group

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

MotionDetectionChannel

Bases: FunctionalChannel

this is the representative of the MOTION_DETECTION_CHANNEL channel

MotionDetectorIndoor

Bases: SabotageDevice

HMIP-SMI (Motion Detector with Brightness Sensor - indoor)

MotionDetectorOutdoor

Bases: Device

HMIP-SMO-A (Motion Detector with Brightness Sensor - outdoor)

MotionDetectorPushButton

Bases: MotionDetectorOutdoor

HMIP-SMI55 (Motion Detector with Brightness Sensor and Remote Control - 2-button)

MotionDetectorSwitchOutdoor

Bases: SabotageDevice

HmIP-SMO230 (Motion Detector with Brightness Sensor and Switch - outdoor)

MultiIOBox

Bases: Switch

HMIP-MIOB (Multi IO Box for floor heating & cooling)

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.

OpenCollector8Module

Bases: Switch

HMIP-MOD-OC8 ( Open Collector Module )

OpticalSignalChannel

Bases: FunctionalChannel

this class represents the OPTICAL_SIGNAL_CHANNEL

OpticalSignalGroupChannel

Bases: FunctionalChannel

this class represents the OPTICAL_SIGNAL_GROUP_CHANNEL

ParticulateMatterSensor

Bases: Device

HmIP-SFD (Fine Dust Sensor)

ParticulateMatterSensorChannel

Bases: FunctionalChannel

Representation of the PARTICULATE_MATTER_SENSOR_CHANNEL channel

PassageDetector

Bases: SabotageDevice

HMIP-SPDR (Passage Detector)

PassageDetectorChannel

Bases: FunctionalChannel

this is the representative of the PASSAGE_DETECTOR_CHANNEL channel

PlugableSwitch

Bases: Switch

HMIP-PS (Pluggable Switch), HMIP-PCBS (Switch Circuit Board - 1 channel)

PluggableDimmer

Bases: Dimmer

HMIP-PDT Pluggable Dimmer

PluggableMainsFailureSurveillance

Bases: Device

HMIP-PMFS (Plugable Power Supply Monitoring)

PresenceDetectionChannel

Bases: FunctionalChannel

this is the representative of the PRESENCE_DETECTION_CHANNEL channel

PresenceDetectorIndoor

Bases: SabotageDevice

HMIP-SPI (Presence Sensor - indoor)

PrintedCircuitBoardSwitch2

Bases: Switch

HMIP-PCBS2 (Switch Circuit Board - 2x channels)

PrintedCircuitBoardSwitchBattery

Bases: Switch

HMIP-PCBS-BAT (Printed Circuit Board Switch Battery)

PushButton

Bases: Device

HMIP-WRC2 (Wall-mount Remote Control - 2-button)

PushButton6

Bases: PushButton

HMIP-WRC6 (Wall-mount Remote Control - 6-button)

PushButton6LedSwitch

Bases: WiredPushButton

HmIP-WRC6-230 (Wall-mount Remote Control - 6-button, 230V, with LED)

PushButtonFlat

Bases: PushButton

HmIP-WRCC2 (Wall-mount Remote Control – flat)

RainDetectionChannel

Bases: FunctionalChannel

this is the representative of the TILT_VIBRATION_SENSOR_CHANNEL channel

RainSensor

Bases: Device

HMIP-SRD (Rain Sensor)

RemoteControl8

Bases: PushButton

HMIP-RC8 (Remote Control - 8 buttons)

RemoteControl8Module

Bases: RemoteControl8

HMIP-MOD-RC8 (Open Collector Module Sender - 8x)

RgbwDimmer

Bases: Device

HmIP-RGBW

RoomControlDevice

Bases: WallMountedThermostatPro

ALPHA-IP-RBG (Alpha IP Wall Thermostat Display)

RoomControlDeviceAnalog

Bases: Device

ALPHA-IP-RBGa (ALpha IP Wall Thermostat Display analog)

RotaryHandleChannel

Bases: ShutterContactChannel

this is the representative of the ROTARY_HANDLE_CHANNEL channel

RotaryHandleSensor

Bases: SabotageDevice

HMIP-SRH

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).

Rule

Bases: HomeMaticIPObject

this class represents the automation rule

set_label 

set_label

sets the label of the rule

set_label_async async 

set_label_async

sets the label of the rule

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"

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

Shutter

Bases: Device

Base class for shutter devices

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_level_async 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 

set_shutter_stop

stops the current shutter operation

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

set_shutter_stop_async async 

set_shutter_stop_async

stops the current shutter operation

Args: channelIndex(int): the channel to control 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

ShutterContact

Bases: SabotageDevice

HMIP-SWDO (Door / Window Contact - optical) / HMIP-SWDO-I (Door / Window Contact Invisible - optical)

ShutterContactChannel

Bases: FunctionalChannel

this is the representative of the SHUTTER_CONTACT_CHANNEL channel

ShutterContactMagnetic

Bases: Device

HMIP-SWDM / HMIP-SWDM-B2 (Door / Window Contact - magnetic )

ShutterContactOpticalPlus

Bases: ShutterContact

HmIP-SWDO-PL ( Window / Door Contact – optical, plus )

SimpleRule

Bases: Rule

This class represents a "Simple" automation rule

disable 

disable

disables the rule

disable_async async 

disable_async

disables the rule

enable 

enable

enables the rule

enable_async async 

enable_async

enables the rule

set_rule_enabled_state 

set_rule_enabled_state

enables/disables this rule

set_rule_enabled_state_async async 

set_rule_enabled_state_async

enables/disables this rule

SingleKeyChannel

Bases: FunctionalChannel

this is the representative of the SINGLE_KEY_CHANNEL channel

SmokeDetector

Bases: Device

HMIP-SWSD, HmIP-SWSD-2 (Smoke Alarm with Q label)

SmokeDetectorChannel

Bases: FunctionalChannel

this is the representative of the SMOKE_DETECTOR_CHANNEL channel

SoilMoistureSensorInterface

Bases: Device

ELV-SH-SMSI (Soil Moisture Sensor Interface)

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.

StatusBoard8

Bases: Switch

ELV-SH-SB8 (Status Board with 8 LEDs)

Switch

Bases: Device

Generic Switch class

SwitchChannel

Bases: FunctionalChannel

this is the representative of the SWITCH_CHANNEL channel

SwitchMeasuring

Bases: Switch

Generic class for Switch and Meter

SwitchMeasuringChannel

Bases: SwitchChannel

this is the representative of the SWITCH_MEASURING_CHANNEL channel

TemperatureDifferenceSensor2

Bases: Device

HmIP-STE2-PCB (Temperature Difference Sensors - 2x sensors)

TemperatureDifferenceSensor2Channel

Bases: FunctionalChannel

this is the representative of the TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL channel

TemperatureHumiditySensorDisplay

Bases: Device

HMIP-STHD (Temperature and Humidity Sensor with display - indoor)

TemperatureHumiditySensorOutdoor

Bases: Device

HMIP-STHO (Temperature and Humidity Sensor outdoor)

TemperatureHumiditySensorWithoutDisplay

Bases: Device

HMIP-STH (Temperature and Humidity Sensor without display - indoor)

TemperatureSensorChannel

Bases: FunctionalChannel

this is the representative of the TEMPERATURE_SENSOR_CHANNEL channel

TemperatureTiltVibrationSensor

Bases: TiltVibrationSensor

ELV-SH-TACO (Inclination and vibration sensor with temperature sensor).

The tilt channel is index 2, so the acceleration setters need channelIndex=2.

TiltVibrationSensor

Bases: Device

HMIP-STV (Inclination and vibration Sensor)

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.

WallMountedGarageDoorController

Bases: Device

HmIP-WGC Wall mounted Garage Door Controller

send_start_impulse 

send_start_impulse

Toggle Wall mounted Garage Door Controller.

send_start_impulse_async async 

send_start_impulse_async

Toggle Wall mounted Garage Door Controller.

WallMountedRemoteControlRotaryButton

Bases: PushButton

HmIP-WRCR (Wall-mount Remote Control - Rotary)

Exposes a SINGLE_KEY_CHANNEL for the push button and two ROTARY_WHEEL_CHANNEL instances, one per rotation direction (CLOCK_WISE / COUNTER_CLOCK_WISE).

WallMountedThermostatBasicHumidity

Bases: WallMountedThermostatPro

HMIP-WTH-B (Wall Thermostat – basic)

WallMountedThermostatPro

Bases: TemperatureHumiditySensorDisplay, OperationLockableDevice

HMIP-WTH, HMIP-WTH-2 (Wall Thermostat with Humidity Sensor) / HMIP-BWTH (Brand Wall Thermostat with Humidity Sensor)

WallMountedThermostatProChannel

Bases: FunctionalChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL channel

WallMountedThermostatWithCarbon

Bases: WallMountedThermostatPro

HmIP-WGTC (Glass Wall Thermostat with Carbon Dioxide Sensor)

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

WaterSensor

Bases: Device

HMIP-SWD ( Water Sensor )

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.

WeatherSensor

Bases: Device

HMIP-SWO-B

WeatherSensorChannel

Bases: FunctionalChannel

this is the representative of the WEATHER_SENSOR_CHANNEL channel

WeatherSensorPlus

Bases: Device

HMIP-SWO-PL

WeatherSensorPlusChannel

Bases: WeatherSensorChannel

this is the representative of the WEATHER_SENSOR_PLUS_CHANNEL channel

WeatherSensorPro

Bases: Device

HMIP-SWO-PR

WeatherSensorProChannel

Bases: WeatherSensorPlusChannel

this is the representative of the WEATHER_SENSOR_PRO_CHANNEL channel

WiredCarbonTemperatureHumiditySensorDisplay

Bases: Device

HMIP-STHD-C (Wired Carbon Dioxide, Temperature and Humidity Sensor with display)

WiredDimmer3

Bases: Dimmer

HMIPW-DRD3 (Homematic IP Wired Dimming Actuator – 3x channels)

WiredDinRailBlind4

Bases: Blind

HmIPW-DRBL4

WiredFloorTerminalBlock12

Bases: FloorTerminalBlock12

Implementation of HmIPW-FALMOT-C12

WiredInput32

Bases: FullFlushContactInterface

HMIPW-DRI32 (Homematic IP Wired Inbound module – 32x channels)

WiredInputSwitch6

Bases: Switch

HmIPW-FIO6

WiredMotionDetectorPushButton

Bases: MotionDetectorOutdoor

HmIPW-SMI55

WiredPushButton

Bases: PushButton

HmIPW-WRC6 and HmIPW-WRC2

set_dim_level 

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

set_dim_level_async 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 

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

set_optical_signal_async 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

WiredSwitch4

Bases: Switch

HMIPW-DRS4 (Homematic IP Wired Switch Actuator – 4x channels)

WiredSwitch8

Bases: Switch

HMIPW-DRS8 (Homematic IP Wired Switch Actuator – 8x channels)