homematicip package

Subpackages

• homematicip.aio package
  • Submodules
  • homematicip.aio.auth module
  • homematicip.aio.class_maps module
  • homematicip.aio.connection module
  • homematicip.aio.device module
  • homematicip.aio.group module
  • homematicip.aio.home module
  • homematicip.aio.securityEvent module
  • Module contents
• homematicip.base package
  • Submodules
  • homematicip.base.base_connection module
  • homematicip.base.constants module
  • homematicip.base.enums module
  • homematicip.base.functionalChannels module
  • homematicip.base.helpers module
  • Module contents

Submodules

homematicip.EventHook module

class homematicip.EventHook.EventHook

Bases: object

fire(*args, **keywargs)

homematicip.HomeMaticIPObject module

homematicip.auth module

class homematicip.auth.Auth(home: homematicip.home.Home)

Bases: object

confirmAuthToken(authToken)

connectionRequest(access_point, devicename='homematicip-python') → requests.models.Response

isRequestAcknowledged()

requestAuthToken()

homematicip.class_maps module

homematicip.connection module

class homematicip.connection.Connection

Bases: homematicip.base.base_connection.BaseConnection

init(accesspoint_id, lookup=True, lookup_url='https://lookup.homematic.com:48335/getHost', **kwargs)

homematicip.device module

class homematicip.device.AccelerationSensor(connection)

Bases: homematicip.device.Device

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

accelerationSensorEventFilterPeriod = None

type: float

accelerationSensorMode = None

type: AccelerationSensorMode

accelerationSensorNeutralPosition = None

type: AccelerationSensorNeutralPosition

accelerationSensorSensitivity = None

type: AccelerationSensorSensitivity

accelerationSensorTriggerAngle = None

type: int

accelerationSensorTriggered = None

type: bool

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

notificationSoundTypeHighToLow = None

type: NotificationSoundType

notificationSoundTypeLowToHigh = None

type: NotificationSoundType

set_acceleration_sensor_event_filter_period(period: float, channelIndex=1)

set_acceleration_sensor_mode(mode: homematicip.base.enums.AccelerationSensorMode, channelIndex=1)

set_acceleration_sensor_neutral_position(neutralPosition: homematicip.base.enums.AccelerationSensorNeutralPosition, channelIndex=1)

set_acceleration_sensor_sensitivity(sensitivity: homematicip.base.enums.AccelerationSensorSensitivity, channelIndex=1)

set_acceleration_sensor_trigger_angle(angle: int, channelIndex=1)

set_notification_sound_type(soundType: homematicip.base.enums.NotificationSoundType, isHighToLow: bool, channelIndex=1)

class homematicip.device.AlarmSirenIndoor(connection)

Bases: homematicip.device.SabotageDevice

HMIP-ASIR (Alarm Siren)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.AlarmSirenOutdoor(connection)

Bases: homematicip.device.AlarmSirenIndoor

HMIP-ASIR-O (Alarm Siren Outdoor)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.Blind(connection)

Bases: homematicip.device.Shutter

Base class for blind devices

set_slats_level(slatsLevel=0.0, shutterLevel=None, channelIndex=1)

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.device.BlindModule(connection)

Bases: homematicip.device.Device

HMIP-HDM1 (Hunter Douglas & erfal window blinds)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_primary_shading_level(primaryShadingLevel: float)

set_secondary_shading_level(primaryShadingLevel: float, secondaryShadingLevel: float)

stop()

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

class homematicip.device.BrandBlind(connection)

Bases: homematicip.device.FullFlushBlind

HMIP-BBL (Blind Actuator for brand switches)

class homematicip.device.BrandDimmer(connection)

Bases: homematicip.device.Dimmer

HMIP-BDT Brand Dimmer

class homematicip.device.BrandPushButton(connection)

Bases: homematicip.device.PushButton

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

class homematicip.device.BrandSwitchMeasuring(connection)

Bases: homematicip.device.SwitchMeasuring

HMIP-BSM (Brand Switch and Meter)

class homematicip.device.BrandSwitchNotificationLight(connection)

Bases: homematicip.device.Switch

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

bottomLightChannelIndex = None

the channel number for the bottom light

Type:int

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

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)

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

topLightChannelIndex = None

the channel number for the top light

Type:int

class homematicip.device.ContactInterface(connection)

Bases: homematicip.device.SabotageDevice

HMIP-SCI (Contact Interface Sensor)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.Device(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

this class represents a generic homematic ip device

authorizeUpdate()

delete()

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

is_update_applicable()

load_functionalChannels(groups: Iterable[homematicip.group.Group])

this function will load the functionalChannels into the device

set_label(label)

set_router_module_enabled(enabled=True)

class homematicip.device.Dimmer(connection)

Bases: homematicip.device.Device

Base dimmer device class

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_dim_level(dimLevel=0.0, channelIndex=1)

class homematicip.device.DinRailBlind4(connection)

Bases: homematicip.device.Blind

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

class homematicip.device.DinRailDimmer3(connection)

Bases: homematicip.device.Dimmer

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.DinRailSwitch(connection)

Bases: homematicip.device.FullFlushInputSwitch

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

class homematicip.device.DinRailSwitch4(connection)

Bases: homematicip.device.Switch

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

class homematicip.device.DoorModule(connection)

Bases: homematicip.device.Device

Generic class for a door module

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

send_door_command(doorCommand=<DoorCommand.STOP: 'STOP'>)

class homematicip.device.FloorTerminalBlock10(connection)

Bases: homematicip.device.FloorTerminalBlock6

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

class homematicip.device.FloorTerminalBlock12(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_minimum_floor_heating_valve_position(minimumFloorHeatingValvePosition: float)

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.device.FloorTerminalBlock6(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.FullFlushBlind(connection)

Bases: homematicip.device.FullFlushShutter, homematicip.device.Blind

HMIP-FBL (Blind Actuator - flush-mount)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.FullFlushContactInterface(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.FullFlushContactInterface6(connection)

Bases: homematicip.device.Device

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

class homematicip.device.FullFlushDimmer(connection)

Bases: homematicip.device.Dimmer

HMIP-FDT Dimming Actuator flush-mount

class homematicip.device.FullFlushInputSwitch(connection)

Bases: homematicip.device.Switch

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.FullFlushShutter(connection)

Bases: homematicip.device.Shutter

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.FullFlushSwitchMeasuring(connection)

Bases: homematicip.device.SwitchMeasuring

HMIP-FSM, HMIP-FSM16 (Full flush Switch and Meter)

class homematicip.device.GarageDoorModuleTormatic(connection)

Bases: homematicip.device.DoorModule

HMIP-MOD-TM (Garage Door Module Tormatic)

class homematicip.device.HeatingSwitch2(connection)

Bases: homematicip.device.Switch

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

class homematicip.device.HeatingThermostat(connection)

Bases: homematicip.device.OperationLockableDevice

HMIP-eTRV (Radiator Thermostat)

automaticValveAdaptionNeeded = None

must the adaption re-run?

Type:bool

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

setPointTemperature = None

the current temperature which should be reached in the room

Type:float

temperatureOffset = None

the offset temperature for the thermostat (+/- 3.5)

Type:float

valveActualTemperature = None

the current measured temperature at the valve

Type:float

valvePosition = None

the current position of the valve 0.0 = closed, 1.0 max opened

Type:float

valveState = None

the current state of the valve

Type:ValveState

class homematicip.device.HeatingThermostatCompact(connection)

Bases: homematicip.device.SabotageDevice

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

automaticValveAdaptionNeeded = None

must the adaption re-run?

Type:bool

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

setPointTemperature = None

the current temperature which should be reached in the room

Type:float

temperatureOffset = None

the offset temperature for the thermostat (+/- 3.5)

Type:float

valveActualTemperature = None

the current measured temperature at the valve

Type:float

valvePosition = None

the current position of the valve 0.0 = closed, 1.0 max opened

Type:float

valveState = None

the current state of the valve

Type:ValveState

class homematicip.device.HeatingThermostatEvo(connection)

Bases: homematicip.device.OperationLockableDevice

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

automaticValveAdaptionNeeded = None

must the adaption re-run?

Type:bool

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

setPointTemperature = None

the current temperature which should be reached in the room

Type:float

temperatureOffset = None

the offset temperature for the thermostat (+/- 3.5)

Type:float

valveActualTemperature = None

the current measured temperature at the valve

Type:float

valvePosition = None

the current position of the valve 0.0 = closed, 1.0 max opened

Type:float

valveState = None

the current state of the valve

Type:ValveState

class homematicip.device.HoermannDrivesModule(connection)

Bases: homematicip.device.DoorModule

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

class homematicip.device.HomeControlAccessPoint(connection)

Bases: homematicip.device.Device

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.KeyRemoteControl4(connection)

Bases: homematicip.device.PushButton

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

class homematicip.device.KeyRemoteControlAlarm(connection)

Bases: homematicip.device.Device

HMIP-KRCA (Key Ring Remote Control - alarm)

class homematicip.device.LightSensor(connection)

Bases: homematicip.device.Device

HMIP-SLO (Light Sensor outdoor)

averageIllumination = None

the average illumination value

Type:float

currentIllumination = None

the current illumination value

Type:float

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

highestIllumination = None

the highest illumination value

Type:float

lowestIllumination = None

the lowest illumination value

Type:float

class homematicip.device.MotionDetectorIndoor(connection)

Bases: homematicip.device.SabotageDevice

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.MotionDetectorOutdoor(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.MotionDetectorPushButton(connection)

Bases: homematicip.device.MotionDetectorOutdoor

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.MultiIOBox(connection)

Bases: homematicip.device.Switch

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.OpenCollector8Module(connection)

Bases: homematicip.device.Switch

HMIP-MOD-OC8 ( Open Collector Module )

class homematicip.device.OperationLockableDevice(connection)

Bases: homematicip.device.Device

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_operation_lock(operationLock=True)

class homematicip.device.PassageDetector(connection)

Bases: homematicip.device.SabotageDevice

HMIP-SPDR (Passage Detector)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.PlugableSwitch(connection)

Bases: homematicip.device.Switch

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

class homematicip.device.PlugableSwitchMeasuring(connection)

Bases: homematicip.device.SwitchMeasuring

HMIP-PSM (Pluggable Switch and Meter)

class homematicip.device.PluggableDimmer(connection)

Bases: homematicip.device.Dimmer

HMIP-PDT Pluggable Dimmer

class homematicip.device.PluggableMainsFailureSurveillance(connection)

Bases: homematicip.device.Device

HMIP-PMFS (Plugable Power Supply Monitoring)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.PresenceDetectorIndoor(connection)

Bases: homematicip.device.SabotageDevice

HMIP-SPI (Presence Sensor - indoor)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.PrintedCircuitBoardSwitch2(connection)

Bases: homematicip.device.Switch

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

class homematicip.device.PrintedCircuitBoardSwitchBattery(connection)

Bases: homematicip.device.Switch

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

class homematicip.device.PushButton(connection)

Bases: homematicip.device.Device

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

class homematicip.device.PushButton6(connection)

Bases: homematicip.device.PushButton

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

class homematicip.device.PushButtonFlat(connection)

Bases: homematicip.device.PushButton

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

class homematicip.device.RainSensor(connection)

Bases: homematicip.device.Device

HMIP-SRD (Rain Sensor)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

rainSensorSensitivity = None

type: float

raining = None

type: bool

class homematicip.device.RemoteControl8(connection)

Bases: homematicip.device.PushButton

HMIP-RC8 (Remote Control - 8 buttons)

class homematicip.device.RemoteControl8Module(connection)

Bases: homematicip.device.RemoteControl8

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

class homematicip.device.RoomControlDevice(connection)

Bases: homematicip.device.WallMountedThermostatPro

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

class homematicip.device.RoomControlDeviceAnalog(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.RotaryHandleSensor(connection)

Bases: homematicip.device.SabotageDevice

HMIP-SRH

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.SabotageDevice(connection)

Bases: homematicip.device.Device

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.Shutter(connection)

Bases: homematicip.device.Device

Base class for shutter devices

set_shutter_level(level=0.0, channelIndex=1)

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)

stops the current shutter operation

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

class homematicip.device.ShutterContact(connection)

Bases: homematicip.device.SabotageDevice

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.ShutterContactMagnetic(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.ShutterContactOpticalPlus(connection)

Bases: homematicip.device.ShutterContact

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

class homematicip.device.SmokeDetector(connection)

Bases: homematicip.device.Device

HMIP-SWSD (Smoke Alarm with Q label)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.Switch(connection)

Bases: homematicip.device.Device

Generic Switch class

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_switch_state(on=True, channelIndex=1)

turn_off(channelIndex=1)

turn_on(channelIndex=1)

class homematicip.device.SwitchMeasuring(connection)

Bases: homematicip.device.Switch

Generic class for Switch and Meter

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

reset_energy_counter()

class homematicip.device.TemperaturDifferenceSensor2(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

temperatureExternalDelta = None

type: float

temperatureExternalOne = None

type: float

temperatureExternalTwo = None

type: float

class homematicip.device.TemperatureHumiditySensorDisplay(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_display(display: homematicip.base.enums.ClimateControlDisplay = <ClimateControlDisplay.ACTUAL: 'ACTUAL'>)

class homematicip.device.TemperatureHumiditySensorOutdoor(connection)

Bases: homematicip.device.Device

HMIP-STHO (Temperature and Humidity Sensor outdoor)

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.TemperatureHumiditySensorWithoutDisplay(connection)

Bases: homematicip.device.Device

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.TiltVibrationSensor(connection)

Bases: homematicip.device.Device

HMIP-STV (Inclination and vibration Sensor)

accelerationSensorEventFilterPeriod = None

type: float

accelerationSensorMode = None

type: AccelerationSensorMode

accelerationSensorSensitivity = None

type: AccelerationSensorSensitivity

accelerationSensorTriggerAngle = None

type: int

accelerationSensorTriggered = None

type: bool

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_acceleration_sensor_event_filter_period(period: float, channelIndex=1)

set_acceleration_sensor_mode(mode: homematicip.base.enums.AccelerationSensorMode, channelIndex=1)

set_acceleration_sensor_sensitivity(sensitivity: homematicip.base.enums.AccelerationSensorSensitivity, channelIndex=1)

set_acceleration_sensor_trigger_angle(angle: int, channelIndex=1)

class homematicip.device.WallMountedThermostatBasicHumidity(connection)

Bases: homematicip.device.WallMountedThermostatPro

HMIP-WTH-B (Wall Thermostat – basic)

class homematicip.device.WallMountedThermostatPro(connection)

Bases: homematicip.device.TemperatureHumiditySensorDisplay, homematicip.device.OperationLockableDevice

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.WaterSensor(connection)

Bases: homematicip.device.Device

HMIP-SWD ( Water Sensor )

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_acoustic_alarm_signal(acousticAlarmSignal: homematicip.base.enums.AcousticAlarmSignal)

set_acoustic_alarm_timing(acousticAlarmTiming: homematicip.base.enums.AcousticAlarmTiming)

set_acoustic_water_alarm_trigger(acousticWaterAlarmTrigger: homematicip.base.enums.WaterAlarmTrigger)

set_inapp_water_alarm_trigger(inAppWaterAlarmTrigger: homematicip.base.enums.WaterAlarmTrigger)

set_siren_water_alarm_trigger(sirenWaterAlarmTrigger: homematicip.base.enums.WaterAlarmTrigger)

class homematicip.device.WeatherSensor(connection)

Bases: homematicip.device.Device

HMIP-SWO-B

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.WeatherSensorPlus(connection)

Bases: homematicip.device.Device

HMIP-SWO-PL

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.WeatherSensorPro(connection)

Bases: homematicip.device.Device

HMIP-SWO-PR

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.device.WiredDimmer3(connection)

Bases: homematicip.device.Dimmer

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

class homematicip.device.WiredInput32(connection)

Bases: homematicip.device.FullFlushContactInterface

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

class homematicip.device.WiredSwitch8(connection)

Bases: homematicip.device.Switch

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

homematicip.functionalHomes module

class homematicip.functionalHomes.AccessControlHome(connection)

Bases: homematicip.functionalHomes.FunctionalHome

from_json(js, groups: List[homematicip.group.Group])

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.functionalHomes.FunctionalHome(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

assignGroups(gids, groups: List[homematicip.group.Group])

from_json(js, groups: List[homematicip.group.Group])

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.functionalHomes.IndoorClimateHome(connection)

Bases: homematicip.functionalHomes.FunctionalHome

from_json(js, groups: List[homematicip.group.Group])

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.functionalHomes.LightAndShadowHome(connection)

Bases: homematicip.functionalHomes.FunctionalHome

from_json(js, groups: List[homematicip.group.Group])

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.functionalHomes.SecurityAndAlarmHome(connection)

Bases: homematicip.functionalHomes.FunctionalHome

from_json(js, groups: List[homematicip.group.Group])

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.functionalHomes.WeatherAndEnvironmentHome(connection)

Bases: homematicip.functionalHomes.FunctionalHome

homematicip.group module

class homematicip.group.AlarmSwitchingGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_on_time(onTimeSeconds)

set_signal_acoustic(signalAcoustic=<AcousticAlarmSignal.FREQUENCY_FALLING: 'FREQUENCY_FALLING'>)

set_signal_optical(signalOptical=<OpticalAlarmSignal.BLINKING_ALTERNATELY_REPEATING: 'BLINKING_ALTERNATELY_REPEATING'>)

test_signal_acoustic(signalAcoustic=<AcousticAlarmSignal.FREQUENCY_FALLING: 'FREQUENCY_FALLING'>)

test_signal_optical(signalOptical=<OpticalAlarmSignal.BLINKING_ALTERNATELY_REPEATING: 'BLINKING_ALTERNATELY_REPEATING'>)

class homematicip.group.EnvironmentGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.ExtendedLinkedShutterGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_shutter_level(level)

set_shutter_stop()

set_slats_level(slatsLevel=0.0, shutterLevel=None)

class homematicip.group.ExtendedLinkedSwitchingGroup(connection)

Bases: homematicip.group.SwitchGroupBase

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_on_time(onTimeSeconds)

class homematicip.group.Group(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

this class represents a group

delete()

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_label(label)

class homematicip.group.HeatingChangeoverGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.HeatingCoolingDemandBoilerGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.HeatingCoolingDemandGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.HeatingCoolingDemandPumpGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.HeatingCoolingPeriod(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.HeatingCoolingProfile(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

get_details()

update_profile()

class homematicip.group.HeatingCoolingProfileDay(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.HeatingDehumidifierGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.HeatingExternalClockGroup(connection)

Bases: homematicip.group.Group

class homematicip.group.HeatingFailureAlertRuleGroup(connection)

Bases: homematicip.group.Group

checkInterval = None

how often the system will check for an error

Type:int

enabled = None

is this rule active

Type:bool

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

heatingFailureValidationResult = None

the heating failure value

Type:HeatingFailureValidationType

lastExecutionTimestamp = None

last time of execution

Type:datetime

validationTimeout = None

time in ms for the validation period. default 24Hours

Type:int

class homematicip.group.HeatingGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_active_profile(index)

set_boost(enable=True)

set_boost_duration(duration: int)

set_control_mode(mode=<ClimateControlMode.AUTOMATIC: 'AUTOMATIC'>)

set_point_temperature(temperature)

class homematicip.group.HeatingHumidyLimiterGroup(connection)

Bases: homematicip.group.Group

class homematicip.group.HeatingTemperatureLimiterGroup(connection)

Bases: homematicip.group.Group

class homematicip.group.HotWaterGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_profile_mode(profileMode: homematicip.base.enums.ProfileMode)

class homematicip.group.HumidityWarningRuleGroup(connection)

Bases: homematicip.group.Group

enabled = None

is this rule active

Type:bool

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

humidityLowerThreshold = None

the lower humidity threshold

Type:int

humidityUpperThreshold = None

the upper humidity threshold

Type:int

humidityValidationResult = None

the current humidity result

Type:HumidityValidationType

lastExecutionTimestamp = None

last time of execution

Type:datetime

lastStatusUpdate = None

last time the humidity got updated

Type:datetime

outdoorClimateSensor = None

the climate sensor which get used as an outside reference. None if OpenWeatherMap will be used

Type:Device

triggered = None

is it currently triggered?

Type:bool

ventilationRecommended = None

should the windows be opened?

Type:bool

class homematicip.group.InboxGroup(connection)

Bases: homematicip.group.Group

class homematicip.group.LinkedSwitchingGroup(connection)

Bases: homematicip.group.Group

set_light_group_switches(devices)

class homematicip.group.LockOutProtectionRule(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.MetaGroup(connection)

Bases: homematicip.group.Group

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

from_json(js, devices, groups)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.OverHeatProtectionRule(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.SecurityGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.SecurityZoneGroup(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.ShutterProfile(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_profile_mode(profileMode: homematicip.base.enums.ProfileMode)

set_shutter_level(level)

set_shutter_stop()

set_slats_level(slatsLevel, shutterlevel)

class homematicip.group.ShutterWindProtectionRule(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.SmokeAlarmDetectionRule(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.group.SwitchGroupBase(connection)

Bases: homematicip.group.Group

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_switch_state(on=True)

turn_off()

turn_on()

class homematicip.group.SwitchingGroup(connection)

Bases: homematicip.group.SwitchGroupBase

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_shutter_level(level)

set_shutter_stop()

set_slats_level(slatsLevel, shutterlevel)

class homematicip.group.SwitchingProfileGroup(connection)

Bases: homematicip.group.Group

create(label)

from_json(js, devices)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_group_channels()

set_profile_mode(devices, automatic=True)

class homematicip.group.TimeProfile(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

get_details()

class homematicip.group.TimeProfilePeriod(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

homematicip.home module

class homematicip.home.AccessPointUpdateState(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.home.Client(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

A client is an app which has access to the access point. e.g. smartphone, 3th party apps, google home, conrad connect

c2cServiceIdentifier = None

the c2c service name

Type:str

clientType = None

the type of this client

Type:ClientType

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

homeId = None

the home where the client belongs to

Type:str

id = None

the unique id of the client

Type:str

label = None

a human understandable name of the client

Type:str

class homematicip.home.Home(connection=None)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

this class represents the ‘Home’ of the homematic ip

accessPointUpdateStates = None

a map of all access points and their updateStates

Type:Map

activate_absence_permanent()

activates the absence forever

activate_absence_with_duration(duration: int)

activates the absence mode for a given time

Parameters:duration (int) – the absence duration in minutes

activate_absence_with_period(endtime: datetime.datetime)

activates the absence mode until the given time

Parameters:endtime (datetime) – the time when the absence should automatically be disabled

activate_vacation(endtime: datetime.datetime, temperature: float)

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

clients = None

a collection of all clients in home

Type:List[Client]

currentAPVersion = None

the current version of the access point

Type:str

deactivate_absence()

deactivates the absence mode immediately

deactivate_vacation()

deactivates the vacation mode immediately

delete_group(group: homematicip.group.Group)

deletes the given group from the cloud

Parameters:group (Group) – the group to delete

devices = None

a collection of all devices in home

Type:List[Device]

disable_events()

download_configuration() → str

downloads the current configuration from the cloud

Returns

the downloaded configuration or an errorCode

enable_events(enable_trace=False, ping_interval=20)

fire_create_event(*args, **kwargs)

Trigger the method tied to _on_create

from_json(js_home)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

functionalHomes = None

a collection of all functionalHomes in the home

get_OAuth_OTK()

get_current_state(clearConfig: bool = False)

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_functionalHome(functionalHomeType: type) → homematicip.functionalHomes.FunctionalHome

gets the specified functionalHome

Parameters:functionalHome (type) – the type of the functionalHome which should be returned Returns:the FunctionalHome or None if it couldn’t be found

get_security_journal()

get_security_zones_activation() -> (<class 'bool'>, <class 'bool'>)

returns the value of the security zones if they are armed or not

Returns

internal

True if the internal zone is armed

external

True if the external zone is armed

groups = None

a collection of all groups in the home

Type:List[Group]

id = None

the SGTIN of the access point

Type:str

init(access_point_id, lookup=True)

location = None

the location of the AP

Type:Location

on_create(handler)

Adds an event handler to the create method. Fires when a device is created.

pinAssigned = None

determines if a pin is set on this access point

Type:bool

remove_callback(handler)

Remove event handler.

rules = None

a collection of all rules in the home

Type:List[Rule]

search_client_by_id(clientID) → homematicip.home.Client

searches a client by given id

Parameters:clientID (str) – the client to search for

Returns

the client object or None if it couldn’t find a client

search_device_by_id(deviceID) → homematicip.device.Device

searches a device by given id

Parameters:deviceID (str) – the device to search for

Returns

the Device object or None if it couldn’t find a device

search_group_by_id(groupID) → homematicip.group.Group

searches a group by given id

Parameters:groupID (str) – groupID the group to search for

Returns

the group object or None if it couldn’t find a group

search_rule_by_id(ruleID) → homematicip.rule.Rule

searches a rule by given id

Parameters:ruleID (str) – the rule to search for

Returns

the rule object or None if it couldn’t find a rule

set_auth_token(auth_token)

set_intrusion_alert_through_smoke_detectors(activate: bool = True)

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)

set_pin(newPin: str, oldPin: str = None) → dict

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)

set_security_zones_activation(internal=True, external=True)

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: str)

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

set_zone_activation_delay(delay)

set_zones_device_assignment(internal_devices, external_devices) → dict

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

start_inclusion(deviceId)

start inclusion mode for specific device :param deviceId: sgtin of device

update_home(json_state, clearConfig: bool = False)

parse a given json configuration into self. This will update the whole home including devices, clients and groups.

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

update_home_only(js_home, clearConfig: bool = False)

parse a given home json configuration into self. This will update only the home without updating devices, clients and groups.

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

weather = None

the current weather

Type:Weather

websocket_reconnect_on_error = None

switch to enable/disable automatic reconnection of the websocket (default=True)

Type:bool

class homematicip.home.Location(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

This class represents the possible location

city = None

the name of the city

Type:str

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

latitude = None

the latitude of the location

Type:float

longitude = None

the longitue of the location

Type:float

class homematicip.home.OAuthOTK(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.home.Weather(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

this class represents the weather of the home location

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

humidity = None

the current humidity

Type:float

maxTemperature = None

the maximum temperature of the day

Type:float

minTemperature = None

the minimum temperature of the day

Type:float

temperature = None

the current temperature

Type:float

vaporAmount = None

the current vapor

Type:float

weatherCondition = None

the current weather

Type:WeatherCondition

weatherDayTime = None

the current datime

Type:datetime

windDirection = None

the current wind direction in 360° where 0° is north

Type:int

windSpeed = None

the current windspeed

Type:float

homematicip.rule module

class homematicip.rule.Rule(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

this class represents the automation rule

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

set_label(label)

sets the label of the rule

class homematicip.rule.SimpleRule(connection)

Bases: homematicip.rule.Rule

This class represents a “Simple” automation rule

disable()

disables the rule

enable()

enables the rule

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

get_simple_rule()

set_rule_enabled_state(enabled)

enables/disables this rule

homematicip.securityEvent module

class homematicip.securityEvent.AccessPointConnectedEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.AccessPointDisconnectedEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.ActivationChangedEvent(connection)

Bases: homematicip.securityEvent.SecurityZoneEvent

class homematicip.securityEvent.ExternalTriggeredEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.MainsFailureEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.MoistureDetectionEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.OfflineAlarmEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.OfflineWaterDetectionEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.SabotageEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.SecurityEvent(connection)

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

this class represents a security event

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.securityEvent.SecurityZoneEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

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

from_json(js)

this method will parse the homematicip object from a json object

Parameters:js – the json object to parse

class homematicip.securityEvent.SensorEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.SilenceChangedEvent(connection)

Bases: homematicip.securityEvent.SecurityZoneEvent

class homematicip.securityEvent.SmokeAlarmEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

class homematicip.securityEvent.WaterDetectionEvent(connection)

Bases: homematicip.securityEvent.SecurityEvent

Module contents

class homematicip.HmipConfig(auth_token, access_point, log_level, log_file, raw_config)

Bases: tuple

access_point

Alias for field number 1

auth_token

Alias for field number 0

log_file

Alias for field number 3

log_level

Alias for field number 2

raw_config

Alias for field number 4

homematicip.find_and_load_config_file() → homematicip.HmipConfig

homematicip.get_config_file_locations() → []

homematicip.load_config_file(config_file: str) → homematicip.HmipConfig

Loads the config ini file. :raises a FileNotFoundError when the config file does not exist.