homematicip.device¶
Bases: SabotageDevice
HMIP-ASIR (Alarm Siren)
Bases: StrEnum
auto() will generate the name of the attribute as value
classmethod
¶
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
Bases: HomeMaticIPObject
Base device class. This is the foundation for homematicip and external (hue) devices
Bases: Shutter
Base class for blind devices
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
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
Bases: Switch
ELV-SH-BS2 (ELV Smart Home ARR-Bausatz Schaltaktor für Markenschalter – 2-fach powered by Homematic IP)
Bases: Switch
HMIP-BSL (Switch Actuator for brand switches – with signal lamp)
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
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
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
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
Bases: Device
HmIP-MP3P (Combination Signalling Device)
A device that can play MP3 sounds and show optical signals for various alarm and notification conditions.
Bases: SabotageDevice
HMIP-SCI (Contact Interface Sensor)
Bases: BaseDevice
this class represents a generic homematic ip device
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).
Bases: Dimmer
HMIP-DRDI3 (Dimming Actuator Inbound 230V – 3x channels, 200W per channel) electrical DIN rail
Bases: OperationLockableDevice
HmIP-DLD
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
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
Bases: Device
HMIP-FALMOT-C12 (Floor Heating Actuator – 12x channels, motorised)
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
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
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.
Bases: Switch
HMIP-FSI16 (Switch Actuator with Push-button Input 230V, 16A) and HMIP-FSI6 (Switch Actuator with Push-button Input, compact)
Bases: Shutter
HMIP-FROLL (Shutter Actuator - flush-mount) / HMIP-BROLL (Shutter Actuator - Brand-mount)
Bases: OperationLockableDevice
HMIP-eTRV (Radiator Thermostat)
Bases: SabotageDevice
HMIP-eTRV-C (Heating-thermostat compact without display)
Bases: OperationLockableDevice
HMIP-eTRV-E (Heating-thermostat new evo version)
Bases: SabotageDevice
HMIP-SMI (Motion Detector with Brightness Sensor - indoor)
Bases: MotionDetectorOutdoor
HMIP-SMI55 (Motion Detector with Brightness Sensor and Remote Control - 2-button)
Bases: SabotageDevice
HmIP-SMO230 (Motion Detector with Brightness Sensor and Switch - outdoor)
Bases: SabotageDevice
HMIP-SPDR (Passage Detector)
Bases: SabotageDevice
HMIP-SPI (Presence Sensor - indoor)
Bases: SabotageDevice
HMIP-SRH
Bases: Device
Base class for shutter devices
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
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
stops the current shutter operation
Args: channelIndex(int): the channel to control Returns: the result of the _restCall
async
¶
stops the current shutter operation
Args: channelIndex(int): the channel to control Returns: the result of the _restCall
Bases: SabotageDevice
HMIP-SWDO (Door / Window Contact - optical) / HMIP-SWDO-I (Door / Window Contact Invisible - optical)
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.
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).
Bases: TemperatureHumiditySensorDisplay, OperationLockableDevice
HMIP-WTH, HMIP-WTH-2 (Wall Thermostat with Humidity Sensor) / HMIP-BWTH (Brand Wall Thermostat with Humidity Sensor)
Bases: PushButton
HmIPW-WRC6 and HmIPW-WRC2
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
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
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
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