homematicip.aio package

Submodules

homematicip.aio.auth module

class homematicip.aio.auth.AsyncAuth(loop, websession=None)[source]

Bases: homematicip.auth.Auth

this class represents the ‘Async Auth’ of the homematic ip

confirmAuthToken(authToken)[source]
connectionRequest(devicename='homematicip-async')[source]
init(access_point_id, lookup=True, lookup_url=None)[source]
isRequestAcknowledged()[source]
requestAuthToken()[source]
class homematicip.aio.auth.AsyncAuthConnection(loop, session=None)[source]

Bases: homematicip.aio.connection.AsyncConnection

homematicip.aio.class_maps module

homematicip.aio.connection module

class homematicip.aio.connection.AsyncConnection(loop, session=None)[source]

Bases: homematicip.base.base_connection.BaseConnection

Handles async http and websocket traffic.

api_call(path, body=None, full_url=False)[source]

Make the actual call to the HMIP server.

Throws HmipWrongHttpStatusError or HmipConnectionError if connection has failed or response is not correct.

close_websocket_connection(source_is_reading_loop=False)[source]
connect_timeout = 20
full_url(partial_url)[source]
init(accesspoint_id, lookup=True, lookup_url='https://lookup.homematic.com:48335/getHost', **kwargs)[source]
ping_loop = 60
ping_timeout = 3
ws_connect(*, on_message, on_error)[source]
ws_connected

Websocket is connected.

homematicip.aio.device module

class homematicip.aio.device.AsyncAccelerationSensor(connection)[source]

Bases: homematicip.device.AccelerationSensor, homematicip.aio.device.AsyncDevice

HMIP-SAM

set_acceleration_sensor_event_filter_period(period: float, channelIndex=1)[source]
set_acceleration_sensor_mode(mode: homematicip.base.enums.AccelerationSensorMode, channelIndex=1)[source]
set_acceleration_sensor_neutral_position(neutralPosition: homematicip.base.enums.AccelerationSensorNeutralPosition, channelIndex=1)[source]
set_acceleration_sensor_sensitivity(sensitivity: homematicip.base.enums.AccelerationSensorSensitivity, channelIndex=1)[source]
set_acceleration_sensor_trigger_angle(angle: int, channelIndex=1)[source]
set_notification_sound_type(soundType: homematicip.base.enums.NotificationSoundType, isHighToLow: bool, channelIndex=1)[source]
class homematicip.aio.device.AsyncAlarmSirenIndoor(connection)[source]

Bases: homematicip.device.AlarmSirenIndoor, homematicip.aio.device.AsyncSabotageDevice

HMIP-ASIR (Alarm Siren)

class homematicip.aio.device.AsyncAlarmSirenOutdoor(connection)[source]

Bases: homematicip.device.AlarmSirenOutdoor, homematicip.aio.device.AsyncAlarmSirenIndoor

HMIP-ASIR-O (Alarm Siren Outdoor)

class homematicip.aio.device.AsyncBlind(connection)[source]

Bases: homematicip.device.Blind, homematicip.aio.device.AsyncShutter

Base class for async blind devices

set_slats_level(slatsLevel=0.0, shutterLevel=None, channelIndex=1)[source]

sets the slats and shutter level

Parameters:
  • 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
class homematicip.aio.device.AsyncBlindModule(connection)[source]

Bases: homematicip.device.BlindModule, homematicip.aio.device.AsyncDevice

HMIP-HDM1 (Hunter Douglas & erfal window blinds)

set_primary_shading_level(primaryShadingLevel: float)[source]
set_secondary_shading_level(primaryShadingLevel: float, secondaryShadingLevel: float)[source]
stop()[source]

stops the current operation :returns: the result of the _restCall

class homematicip.aio.device.AsyncBrandBlind(connection)[source]

Bases: homematicip.device.BrandBlind, homematicip.aio.device.AsyncFullFlushBlind

HMIP-BBL (Blind Actuator for brand switches)

class homematicip.aio.device.AsyncBrandDimmer(connection)[source]

Bases: homematicip.aio.device.AsyncDimmer

HMIP-BDT Brand Dimmer

class homematicip.aio.device.AsyncBrandPushButton(connection)[source]

Bases: homematicip.device.BrandPushButton, homematicip.aio.device.AsyncPushButton

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

class homematicip.aio.device.AsyncBrandSwitchMeasuring(connection)[source]

Bases: homematicip.device.BrandSwitchMeasuring, homematicip.aio.device.AsyncSwitchMeasuring

HMIP-BSM (Brand Switch and Meter)

class homematicip.aio.device.AsyncBrandSwitchNotificationLight(connection)[source]

Bases: homematicip.device.BrandSwitchNotificationLight, homematicip.aio.device.AsyncSwitch

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

set_rgb_dim_level(channelIndex: int, rgb: homematicip.base.enums.RGBColorState, dimLevel: float)[source]

sets the color and dimlevel of the lamp

Parameters:
  • 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(channelIndex: int, rgb: homematicip.base.enums.RGBColorState, dimLevel: float, onTime: float, rampTime: float)[source]

sets the color and dimlevel of the lamp

Parameters:
  • 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
class homematicip.aio.device.AsyncContactInterface(connection)[source]

Bases: homematicip.device.ContactInterface, homematicip.aio.device.AsyncSabotageDevice

HMIP-SCI (Contact Interface Sensor)

class homematicip.aio.device.AsyncDevice(connection)[source]

Bases: homematicip.device.Device

Async implementation of a genereric homematic ip device

authorizeUpdate()[source]
delete()[source]
is_update_applicable()[source]
set_label(label)[source]
set_router_module_enabled(enabled=True)[source]
class homematicip.aio.device.AsyncDimmer(connection)[source]

Bases: homematicip.device.Dimmer, homematicip.aio.device.AsyncDevice

Base dimmer device class

set_dim_level(dimLevel=0.0, channelIndex=1)[source]
class homematicip.aio.device.AsyncDinRailBlind4(connection)[source]

Bases: homematicip.device.DinRailBlind4, homematicip.aio.device.AsyncBlind

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

class homematicip.aio.device.AsyncDinRailSwitch(connection)[source]

Bases: homematicip.device.DinRailSwitch, homematicip.aio.device.AsyncFullFlushInputSwitch

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

class homematicip.aio.device.AsyncDinRailSwitch4(connection)[source]

Bases: homematicip.device.DinRailSwitch4, homematicip.aio.device.AsyncSwitch

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

class homematicip.aio.device.AsyncDoorModule(connection)[source]

Bases: homematicip.device.DoorModule, homematicip.aio.device.AsyncDevice

Generic Door Module class

send_door_command(doorCommand=<DoorCommand.STOP: 'STOP'>)[source]
class homematicip.aio.device.AsyncFloorTerminalBlock10(connection)[source]

Bases: homematicip.device.FloorTerminalBlock10, homematicip.aio.device.AsyncFloorTerminalBlock6

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

class homematicip.aio.device.AsyncFloorTerminalBlock12(connection)[source]

Bases: homematicip.device.FloorTerminalBlock12, homematicip.aio.device.AsyncDevice

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

set_minimum_floor_heating_valve_position(minimumFloorHeatingValvePosition: float)[source]

sets the minimum floot heating valve position

Parameters:minimumFloorHeatingValvePosition (float) – the minimum valve position. must be between 0.0 and 1.0
Returns:the result of the _restCall
class homematicip.aio.device.AsyncFloorTerminalBlock6(connection)[source]

Bases: homematicip.device.FloorTerminalBlock6, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncFullFlushBlind(connection)[source]

Bases: homematicip.device.FullFlushBlind, homematicip.aio.device.AsyncBlind

HMIP-FBL (Blind Actuator - flush-mount)

class homematicip.aio.device.AsyncFullFlushContactInterface(connection)[source]

Bases: homematicip.device.FullFlushContactInterface, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncFullFlushContactInterface6(connection)[source]

Bases: homematicip.device.FullFlushContactInterface6, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncFullFlushDimmer(connection)[source]

Bases: homematicip.aio.device.AsyncDimmer

HMIP-FDT Dimming Actuator flush-mount

class homematicip.aio.device.AsyncFullFlushInputSwitch(connection)[source]

Bases: homematicip.device.FullFlushInputSwitch, homematicip.aio.device.AsyncSwitch

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

class homematicip.aio.device.AsyncFullFlushShutter(connection)[source]

Bases: homematicip.device.FullFlushShutter, homematicip.aio.device.AsyncShutter

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

class homematicip.aio.device.AsyncFullFlushSwitchMeasuring(connection)[source]

Bases: homematicip.device.FullFlushSwitchMeasuring, homematicip.aio.device.AsyncSwitchMeasuring

HMIP-FSM (Full flush Switch and Meter)

class homematicip.aio.device.AsyncGarageDoorModuleTormatic(connection)[source]

Bases: homematicip.device.GarageDoorModuleTormatic, homematicip.aio.device.AsyncDoorModule

HMIP-MOD-TM (Garage Door Module Tormatic)

class homematicip.aio.device.AsyncHeatingSwitch2(connection)[source]

Bases: homematicip.device.HeatingSwitch2, homematicip.aio.device.AsyncSwitch

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

class homematicip.aio.device.AsyncHeatingThermostat(connection)[source]

Bases: homematicip.device.HeatingThermostat, homematicip.aio.device.AsyncOperationLockableDevice

HMIP-eTRV (Radiator Thermostat)

class homematicip.aio.device.AsyncHeatingThermostatCompact(connection)[source]

Bases: homematicip.device.HeatingThermostatCompact, homematicip.aio.device.AsyncSabotageDevice

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

class homematicip.aio.device.AsyncHeatingThermostatEvo(connection)[source]

Bases: homematicip.device.HeatingThermostatEvo, homematicip.aio.device.AsyncSabotageDevice

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

class homematicip.aio.device.AsyncHoermannDrivesModule(connection)[source]

Bases: homematicip.device.HoermannDrivesModule, homematicip.aio.device.AsyncDoorModule

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

class homematicip.aio.device.AsyncHomeControlAccessPoint(connection)[source]

Bases: homematicip.device.HomeControlAccessPoint, homematicip.aio.device.AsyncDevice

HMIP-HAP

class homematicip.aio.device.AsyncKeyRemoteControl4(connection)[source]

Bases: homematicip.device.KeyRemoteControl4, homematicip.aio.device.AsyncPushButton

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

class homematicip.aio.device.AsyncKeyRemoteControlAlarm(connection)[source]

Bases: homematicip.device.KeyRemoteControlAlarm, homematicip.aio.device.AsyncDevice

HMIP-KRCA (Key Ring Remote Control - alarm)

class homematicip.aio.device.AsyncLightSensor(connection)[source]

Bases: homematicip.device.LightSensor, homematicip.aio.device.AsyncDevice

Async implementation of HMIP-SLO (Light Sensor outdoor)

class homematicip.aio.device.AsyncMotionDetectorIndoor(connection)[source]

Bases: homematicip.device.MotionDetectorIndoor, homematicip.aio.device.AsyncSabotageDevice

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

class homematicip.aio.device.AsyncMotionDetectorOutdoor(connection)[source]

Bases: homematicip.device.MotionDetectorOutdoor, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncMotionDetectorPushButton(connection)[source]

Bases: homematicip.device.MotionDetectorPushButton, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncMultiIOBox(connection)[source]

Bases: homematicip.device.MultiIOBox, homematicip.aio.device.AsyncSwitch

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

class homematicip.aio.device.AsyncOpenCollector8Module(connection)[source]

Bases: homematicip.device.OpenCollector8Module, homematicip.aio.device.AsyncSwitch

Async implementation of HMIP-MOD-OC8 ( Open Collector Module )

class homematicip.aio.device.AsyncOperationLockableDevice(connection)[source]

Bases: homematicip.device.OperationLockableDevice, homematicip.aio.device.AsyncDevice

set_operation_lock(operationLock=True)[source]
class homematicip.aio.device.AsyncPassageDetector(connection)[source]

Bases: homematicip.device.PassageDetector, homematicip.aio.device.AsyncSabotageDevice

HMIP-SPDR (Passage Detector)

class homematicip.aio.device.AsyncPlugableSwitch(connection)[source]

Bases: homematicip.device.PlugableSwitch, homematicip.aio.device.AsyncSwitch

Async implementation of HMIP-PS (Pluggable Switch)

class homematicip.aio.device.AsyncPlugableSwitchMeasuring(connection)[source]

Bases: homematicip.device.PlugableSwitchMeasuring, homematicip.aio.device.AsyncSwitchMeasuring

HMIP-PSM (Pluggable Switch and Meter)

class homematicip.aio.device.AsyncPluggableDimmer(connection)[source]

Bases: homematicip.aio.device.AsyncDimmer

HMIP-PDT Pluggable Dimmer

class homematicip.aio.device.AsyncPluggableMainsFailureSurveillance(connection)[source]

Bases: homematicip.device.PluggableMainsFailureSurveillance, homematicip.aio.device.AsyncDevice

[HMIP-PMFS] (Plugable Power Supply Monitoring)

class homematicip.aio.device.AsyncPresenceDetectorIndoor(connection)[source]

Bases: homematicip.device.PresenceDetectorIndoor, homematicip.aio.device.AsyncSabotageDevice

HMIP-SPI (Presence Sensor - indoor)

class homematicip.aio.device.AsyncPrintedCircuitBoardSwitch2(connection)[source]

Bases: homematicip.device.PrintedCircuitBoardSwitch2, homematicip.aio.device.AsyncSwitch

Async implementation of HMIP-PCBS2 (Switch Circuit Board - 2x channels)

class homematicip.aio.device.AsyncPrintedCircuitBoardSwitchBattery(connection)[source]

Bases: homematicip.device.PrintedCircuitBoardSwitchBattery, homematicip.aio.device.AsyncSwitch

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

class homematicip.aio.device.AsyncPushButton(connection)[source]

Bases: homematicip.device.PushButton, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncPushButton6(connection)[source]

Bases: homematicip.device.PushButton6, homematicip.aio.device.AsyncPushButton

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

class homematicip.aio.device.AsyncPushButtonFlat(connection)[source]

Bases: homematicip.device.PushButtonFlat, homematicip.aio.device.AsyncPushButton

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

class homematicip.aio.device.AsyncRainSensor(connection)[source]

Bases: homematicip.device.RainSensor, homematicip.aio.device.AsyncDevice

HMIP-SRD (Rain Sensor)

class homematicip.aio.device.AsyncRemoteControl8(connection)[source]

Bases: homematicip.device.RemoteControl8, homematicip.aio.device.AsyncPushButton

HMIP-RC8 (Remote Control - 8 buttons)

class homematicip.aio.device.AsyncRemoteControl8Module(connection)[source]

Bases: homematicip.device.RemoteControl8Module, homematicip.aio.device.AsyncRemoteControl8

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

class homematicip.aio.device.AsyncRoomControlDevice(connection)[source]

Bases: homematicip.device.RoomControlDevice, homematicip.aio.device.AsyncWallMountedThermostatPro

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

class homematicip.aio.device.AsyncRoomControlDeviceAnalog(connection)[source]

Bases: homematicip.aio.device.AsyncDevice

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

from_json(js)[source]

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse
class homematicip.aio.device.AsyncRotaryHandleSensor(connection)[source]

Bases: homematicip.device.RotaryHandleSensor, homematicip.aio.device.AsyncSabotageDevice

HMIP-SRH

class homematicip.aio.device.AsyncSabotageDevice(connection)[source]

Bases: homematicip.device.SabotageDevice, homematicip.aio.device.AsyncDevice

Async implementation sabotage signaling devices

class homematicip.aio.device.AsyncShutter(connection)[source]

Bases: homematicip.device.Shutter, homematicip.aio.device.AsyncDevice

Base class for async shutter devices

set_shutter_level(level=0.0, channelIndex=1)[source]

sets the shutter level

Parameters:
  • 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(channelIndex=1)[source]

stops the current shutter operation

Parameters:channelIndex (int) – the channel to control
Returns:the result of the _restCall
class homematicip.aio.device.AsyncShutterContact(connection)[source]

Bases: homematicip.device.ShutterContact, homematicip.aio.device.AsyncSabotageDevice

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

class homematicip.aio.device.AsyncShutterContactMagnetic(connection)[source]

Bases: homematicip.device.ShutterContactMagnetic, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncShutterContactOpticalPlus(connection)[source]

Bases: homematicip.device.ShutterContactOpticalPlus, homematicip.aio.device.AsyncShutterContact

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

class homematicip.aio.device.AsyncSmokeDetector(connection)[source]

Bases: homematicip.device.SmokeDetector, homematicip.aio.device.AsyncDevice

HMIP-SWSD (Smoke Alarm with Q label)

class homematicip.aio.device.AsyncSwitch(connection)[source]

Bases: homematicip.device.Switch, homematicip.aio.device.AsyncDevice

Generic async switch

set_switch_state(on=True, channelIndex=1)[source]
turn_off(channelIndex=1)[source]
turn_on(channelIndex=1)[source]
class homematicip.aio.device.AsyncSwitchMeasuring(connection)[source]

Bases: homematicip.device.SwitchMeasuring, homematicip.aio.device.AsyncSwitch

Generic async switch measuring

reset_energy_counter()[source]
class homematicip.aio.device.AsyncTemperaturDifferenceSensor2(connection)[source]

Bases: homematicip.device.TemperaturDifferenceSensor2, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncTemperatureHumiditySensorDisplay(connection)[source]

Bases: homematicip.device.TemperatureHumiditySensorDisplay, homematicip.aio.device.AsyncDevice

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

set_display(display: homematicip.base.enums.ClimateControlDisplay = <ClimateControlDisplay.ACTUAL: 'ACTUAL'>)[source]
class homematicip.aio.device.AsyncTemperatureHumiditySensorOutdoor(connection)[source]

Bases: homematicip.device.TemperatureHumiditySensorOutdoor, homematicip.aio.device.AsyncDevice

HMIP-STHO (Temperature and Humidity Sensor outdoor)

class homematicip.aio.device.AsyncTemperatureHumiditySensorWithoutDisplay(connection)[source]

Bases: homematicip.device.TemperatureHumiditySensorWithoutDisplay, homematicip.aio.device.AsyncDevice

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

class homematicip.aio.device.AsyncTiltVibrationSensor(connection)[source]

Bases: homematicip.device.TiltVibrationSensor, homematicip.aio.device.AsyncDevice

HMIP-STV (Inclination and vibration Sensor)

set_acceleration_sensor_event_filter_period(period: float, channelIndex=1)[source]
set_acceleration_sensor_mode(mode: homematicip.base.enums.AccelerationSensorMode, channelIndex=1)[source]
set_acceleration_sensor_sensitivity(sensitivity: homematicip.base.enums.AccelerationSensorSensitivity, channelIndex=1)[source]
set_acceleration_sensor_trigger_angle(angle: int, channelIndex=1)[source]
class homematicip.aio.device.AsyncWallMountedThermostatBasicHumidity(connection)[source]

Bases: homematicip.aio.device.AsyncWallMountedThermostatPro

HMIP-WTH-B (Wall Thermostat – basic)

class homematicip.aio.device.AsyncWallMountedThermostatPro(connection)[source]

Bases: homematicip.device.WallMountedThermostatPro, homematicip.aio.device.AsyncTemperatureHumiditySensorDisplay, homematicip.aio.device.AsyncOperationLockableDevice

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

class homematicip.aio.device.AsyncWaterSensor(connection)[source]

Bases: homematicip.device.WaterSensor, homematicip.aio.device.AsyncDevice

HMIP-SWD

set_acoustic_alarm_signal(acousticAlarmSignal: homematicip.base.enums.AcousticAlarmSignal)[source]
set_acoustic_alarm_timing(acousticAlarmTiming: homematicip.base.enums.AcousticAlarmTiming)[source]
set_acoustic_water_alarm_trigger(acousticWaterAlarmTrigger: homematicip.base.enums.WaterAlarmTrigger)[source]
set_inapp_water_alarm_trigger(inAppWaterAlarmTrigger: homematicip.base.enums.WaterAlarmTrigger)[source]
set_siren_water_alarm_trigger(sirenWaterAlarmTrigger: homematicip.base.enums.WaterAlarmTrigger)[source]
class homematicip.aio.device.AsyncWeatherSensor(connection)[source]

Bases: homematicip.device.WeatherSensor, homematicip.aio.device.AsyncDevice

HMIP-SWO-B

class homematicip.aio.device.AsyncWeatherSensorPlus(connection)[source]

Bases: homematicip.device.WeatherSensorPlus, homematicip.aio.device.AsyncDevice

HMIP-SWO-PL

class homematicip.aio.device.AsyncWeatherSensorPro(connection)[source]

Bases: homematicip.device.WeatherSensorPro, homematicip.aio.device.AsyncDevice

HMIP-SWO-PR

class homematicip.aio.device.AsyncWiredDimmer3(connection)[source]

Bases: homematicip.device.WiredDimmer3, homematicip.aio.device.AsyncDimmer

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

class homematicip.aio.device.AsyncWiredInput32(connection)[source]

Bases: homematicip.device.WiredInput32, homematicip.aio.device.AsyncFullFlushContactInterface

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

class homematicip.aio.device.AsyncWiredSwitch8(connection)[source]

Bases: homematicip.device.WiredSwitch8, homematicip.aio.device.AsyncSwitch

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

homematicip.aio.group module

class homematicip.aio.group.AsyncAlarmSwitchingGroup(connection)[source]

Bases: homematicip.group.AlarmSwitchingGroup, homematicip.aio.group.AsyncGroup

set_on_time(onTimeSeconds)[source]
set_signal_acoustic(signalAcoustic=<AcousticAlarmSignal.FREQUENCY_FALLING: 'FREQUENCY_FALLING'>)[source]
set_signal_optical(signalOptical=<OpticalAlarmSignal.BLINKING_ALTERNATELY_REPEATING: 'BLINKING_ALTERNATELY_REPEATING'>)[source]
test_signal_acoustic(signalAcoustic=<AcousticAlarmSignal.FREQUENCY_FALLING: 'FREQUENCY_FALLING'>)[source]
test_signal_optical(signalOptical=<OpticalAlarmSignal.BLINKING_ALTERNATELY_REPEATING: 'BLINKING_ALTERNATELY_REPEATING'>)[source]
class homematicip.aio.group.AsyncEnvironmentGroup(connection)[source]

Bases: homematicip.group.EnvironmentGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncExtendedLinkedShutterGroup(connection)[source]

Bases: homematicip.group.ExtendedLinkedShutterGroup, homematicip.aio.group.AsyncGroup

set_shutter_level(level)[source]
set_shutter_stop()[source]
set_slats_level(slatsLevel=0.0, shutterLevel=None)[source]
class homematicip.aio.group.AsyncExtendedLinkedSwitchingGroup(connection)[source]

Bases: homematicip.group.ExtendedLinkedSwitchingGroup, homematicip.aio.group.AsyncSwitchGroupBase

set_on_time(onTimeSeconds)[source]
class homematicip.aio.group.AsyncGroup(connection)[source]

Bases: homematicip.group.Group

delete()[source]
set_label(label)[source]
class homematicip.aio.group.AsyncHeatingChangeoverGroup(connection)[source]

Bases: homematicip.group.HeatingChangeoverGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingCoolingDemandBoilerGroup(connection)[source]

Bases: homematicip.group.HeatingCoolingDemandBoilerGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingCoolingDemandGroup(connection)[source]

Bases: homematicip.group.HeatingCoolingDemandGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingCoolingDemandPumpGroup(connection)[source]

Bases: homematicip.group.HeatingCoolingDemandPumpGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingDehumidifierGroup(connection)[source]

Bases: homematicip.group.HeatingDehumidifierGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingExternalClockGroup(connection)[source]

Bases: homematicip.group.HeatingExternalClockGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingFailureAlertRuleGroup(connection)[source]

Bases: homematicip.group.HeatingFailureAlertRuleGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingGroup(connection)[source]

Bases: homematicip.group.HeatingGroup, homematicip.aio.group.AsyncGroup

set_active_profile(index)[source]
set_boost(enable=True)[source]
set_boost_duration(duration: int)[source]
set_control_mode(mode=<ClimateControlMode.AUTOMATIC: 'AUTOMATIC'>)[source]
set_point_temperature(temperature)[source]
class homematicip.aio.group.AsyncHeatingHumidyLimiterGroup(connection)[source]

Bases: homematicip.group.HeatingHumidyLimiterGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHeatingTemperatureLimiterGroup(connection)[source]

Bases: homematicip.group.HeatingTemperatureLimiterGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncHotWaterGroup(connection)[source]

Bases: homematicip.group.HotWaterGroup, homematicip.aio.group.AsyncGroup

set_profile_mode(profileMode: homematicip.base.enums.ProfileMode)[source]
class homematicip.aio.group.AsyncHumidityWarningRuleGroup(connection)[source]

Bases: homematicip.group.HumidityWarningRuleGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncInboxGroup(connection)[source]

Bases: homematicip.group.InboxGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncLinkedSwitchingGroup(connection)[source]

Bases: homematicip.group.LinkedSwitchingGroup, homematicip.aio.group.AsyncGroup

set_light_group_switches(devices)[source]
class homematicip.aio.group.AsyncLockOutProtectionRule(connection)[source]

Bases: homematicip.group.LockOutProtectionRule, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncMetaGroup(connection)[source]

Bases: homematicip.group.MetaGroup, homematicip.aio.group.AsyncGroup

a meta group is a “Room” inside the homematic configuration

class homematicip.aio.group.AsyncOverHeatProtectionRule(connection)[source]

Bases: homematicip.group.OverHeatProtectionRule, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncSecurityGroup(connection)[source]

Bases: homematicip.group.SecurityGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncSecurityZoneGroup(connection)[source]

Bases: homematicip.group.SecurityZoneGroup, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncShutterProfile(connection)[source]

Bases: homematicip.group.ShutterProfile, homematicip.aio.group.AsyncGroup

set_profile_mode(profileMode: homematicip.base.enums.ProfileMode)[source]
set_shutter_level(level)[source]
set_shutter_stop()[source]
set_slats_level(slatsLevel, shutterlevel)[source]
class homematicip.aio.group.AsyncShutterWindProtectionRule(connection)[source]

Bases: homematicip.group.ShutterWindProtectionRule, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncSmokeAlarmDetectionRule(connection)[source]

Bases: homematicip.group.SmokeAlarmDetectionRule, homematicip.aio.group.AsyncGroup

class homematicip.aio.group.AsyncSwitchGroupBase(connection)[source]

Bases: homematicip.group.SwitchGroupBase, homematicip.aio.group.AsyncGroup

set_switch_state(on=True)[source]
turn_off()[source]
turn_on()[source]
class homematicip.aio.group.AsyncSwitchingGroup(connection)[source]

Bases: homematicip.group.SwitchingGroup, homematicip.aio.group.AsyncSwitchGroupBase

set_shutter_level(level)[source]
set_shutter_stop()[source]
set_slats_level(slatsLevel, shutterlevel)[source]
class homematicip.aio.group.AsyncSwitchingProfileGroup(connection)[source]

Bases: homematicip.group.SwitchingProfileGroup, homematicip.aio.group.AsyncGroup

create(label)[source]
set_group_channels()[source]
set_profile_mode(devices, automatic=True)[source]

homematicip.aio.home module

class homematicip.aio.home.AsyncHome(loop, websession=None)[source]

Bases: homematicip.home.Home

this class represents the ‘Async Home’ of the homematic ip

activate_absence_permanent()[source]

activates the absence forever

activate_absence_with_duration(duration)[source]

activates the absence mode for a given time

Parameters:duration (int) – the absence duration in minutes
activate_absence_with_period(endtime)[source]

activates the absence mode until the given time

Parameters:endtime (datetime) – the time when the absence should automatically be disabled
activate_vacation(endtime, temperature)[source]

activates the vatation mode until the given time

Parameters:
  • endtime (datetime) – the time when the vatation mode should automatically be disabled
  • temperature (float) – the settemperature during the vacation mode
deactivate_absence()[source]

deactivates the absence mode immediately

deactivate_vacation()[source]

deactivates the vacation mode immediately

delete_group(group)[source]

deletes the given group from the cloud

Parameters:group (Group) – the group to delete
disable_events()[source]
download_configuration()[source]

downloads the current configuration from the cloud

Returns
the downloaded configuration or an errorCode
enable_events() → _asyncio.Task[source]

Connects to the websocket. Returns a listening task.

get_OAuth_OTK()[source]
get_current_state(clearConfig: bool = False)[source]

downloads the current configuration and parses it into self

Parameters:
  • clearConfig (bool) – if set to true, this function will remove all old objects
  • self.devices, self.client, .. to have a fresh config instead of reparsing them (from) –
get_security_journal()[source]
init(access_point_id, lookup=True)[source]
set_intrusion_alert_through_smoke_detectors(activate=True)[source]

activate or deactivate if smoke detectors should “ring” during an alarm

Parameters:activate (bool) – True will let the smoke detectors “ring” during an alarm
set_location(city, latitude, longitude)[source]
set_pin(newPin, oldPin=None)[source]

sets a new pin for the home

Parameters:
  • newPin (str) – the new pin
  • oldPin (str) – optional, if there is currently a pin active it must be given here. Otherwise it will not be possible to set the new pin
Returns:

the result of the call
set_powermeter_unit_price(price)[source]
set_security_zones_activation(internal=True, external=True)[source]

this function will set the alarm system to armed or disable it

Parameters:
  • internal (bool) – activates/deactivates the internal zone
  • external (bool) – activates/deactivates the external zone

Examples

arming while being at home

>>> home.set_security_zones_activation(False,True)

arming without being at home

>>> home.set_security_zones_activation(True,True)

disarming the alarm system

>>> home.set_security_zones_activation(False,False)
set_timezone(timezone)[source]

sets the timezone for the AP. e.g. “Europe/Berlin” :param timezone: the new timezone :type timezone: str

set_zone_activation_delay(delay)[source]
set_zones_device_assignment(internal_devices, external_devices)[source]

sets the devices for the security zones :param internal_devices: the devices which should be used for the internal zone :type internal_devices: List[Device] :param external_devices: the devices which should be used for the external(hull) zone :type external_devices: List[Device]

Returns:the result of _restCall

homematicip.aio.securityEvent module

class homematicip.aio.securityEvent.AsyncAccessPointConnectedEvent(connection)[source]

Bases: homematicip.securityEvent.AccessPointConnectedEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncAccessPointDisconnectedEvent(connection)[source]

Bases: homematicip.securityEvent.AccessPointDisconnectedEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncActivationChangedEvent(connection)[source]

Bases: homematicip.securityEvent.ActivationChangedEvent, homematicip.aio.securityEvent.AsyncSecurityZoneEvent

class homematicip.aio.securityEvent.AsyncExternalTriggeredEvent(connection)[source]

Bases: homematicip.securityEvent.ExternalTriggeredEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncMainsFailureEvent(connection)[source]

Bases: homematicip.securityEvent.MainsFailureEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncMoistureDetectionEvent(connection)[source]

Bases: homematicip.securityEvent.MoistureDetectionEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncOfflineAlarmEvent(connection)[source]

Bases: homematicip.securityEvent.OfflineAlarmEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncOfflineWaterDetectionEvent(connection)[source]

Bases: homematicip.securityEvent.OfflineWaterDetectionEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncSabotageEvent(connection)[source]

Bases: homematicip.securityEvent.SabotageEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncSecurityEvent(connection)[source]

Bases: homematicip.securityEvent.SecurityEvent

this class represents a security event

class homematicip.aio.securityEvent.AsyncSecurityZoneEvent(connection)[source]

Bases: homematicip.securityEvent.SecurityZoneEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

This class will be used by other events which are just adding “securityZoneValues”

class homematicip.aio.securityEvent.AsyncSensorEvent(connection)[source]

Bases: homematicip.securityEvent.SensorEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncSilenceChangedEvent(connection)[source]

Bases: homematicip.securityEvent.SilenceChangedEvent, homematicip.aio.securityEvent.AsyncSecurityZoneEvent

class homematicip.aio.securityEvent.AsyncSmokeAlarmEvent(connection)[source]

Bases: homematicip.securityEvent.SmokeAlarmEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

class homematicip.aio.securityEvent.AsyncWaterDetectionEvent(connection)[source]

Bases: homematicip.securityEvent.WaterDetectionEvent, homematicip.aio.securityEvent.AsyncSecurityEvent

Module contents