Skip to content

homematicip.device

AccelerationSensor

Bases: Device

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

AlarmSirenIndoor

Bases: SabotageDevice

HMIP-ASIR (Alarm Siren)

AlarmSirenOutdoor

Bases: AlarmSirenIndoor

HMIP-ASIR-O (Alarm Siren Outdoor)

AutoNameEnum

Bases: str, Enum

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

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

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

ContactInterface

Bases: SabotageDevice

HMIP-SCI (Contact Interface Sensor)

DaliGateway

Bases: Device

HmIP-DRG-DALI Dali Gateway device.

Device

Bases: BaseDevice

this class represents a generic homematic ip device

Dimmer

Bases: Device

Base dimmer device class

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)

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

DoorLockSensor

Bases: Device

HmIP-DLS

DoorModule

Bases: Device

Generic class for a door module

EnergySensorsInterface

Bases: Device

HmIP-ESI

ExternalDevice

Bases: BaseDevice

Represents devices with archtetype EXTERNAL

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)

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

FullFlushInputSwitch

Bases: Switch

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

FullFlushShutter

Bases: Shutter

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

GarageDoorModuleTormatic

Bases: DoorModule

HMIP-MOD-TM (Garage Door Module Tormatic)

HeatingSwitch2

Bases: Switch

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

HeatingThermostat

Bases: OperationLockableDevice

HMIP-eTRV (Radiator Thermostat)

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)

KeyRemoteControl4

Bases: PushButton

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

KeyRemoteControlAlarm

Bases: Device

HMIP-KRCA (Key Ring Remote Control - alarm)

LightSensor

Bases: Device

HMIP-SLO (Light Sensor outdoor)

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)

MultiIOBox

Bases: Switch

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

OpenCollector8Module

Bases: Switch

HMIP-MOD-OC8 ( Open Collector Module )

PassageDetector

Bases: SabotageDevice

HMIP-SPDR (Passage Detector)

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)

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)

PushButtonFlat

Bases: PushButton

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

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)

RotaryHandleSensor

Bases: SabotageDevice

HMIP-SRH

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

ShutterContact

Bases: SabotageDevice

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

ShutterContactMagnetic

Bases: Device

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

ShutterContactOpticalPlus

Bases: ShutterContact

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

SmokeDetector

Bases: Device

HMIP-SWSD (Smoke Alarm with Q label)

Switch

Bases: Device

Generic Switch class

SwitchMeasuring

Bases: Switch

Generic class for Switch and Meter

TemperatureDifferenceSensor2

Bases: Device

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

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)

TiltVibrationSensor

Bases: Device

HMIP-STV (Inclination and vibration Sensor)

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.

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)

WaterSensor

Bases: Device

HMIP-SWD ( Water Sensor )

WeatherSensor

Bases: Device

HMIP-SWO-B

WeatherSensorPlus

Bases: Device

HMIP-SWO-PL

WeatherSensorPro

Bases: Device

HMIP-SWO-PR

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)