homematicip.base package

Submodules

homematicip.base.HomeMaticIPObject module

homematicip.base.base_connection module

exception homematicip.base.base_connection.HmipConnectionError

Bases: Exception

exception homematicip.base.base_connection.HmipServerCloseError

Bases: HmipConnectionError

exception homematicip.base.base_connection.HmipThrottlingError

Bases: HmipConnectionError

exception homematicip.base.base_connection.HmipWrongHttpStatusError(status_code=None)

Bases: HmipConnectionError

homematicip.base.constants module

homematicip.base.enums module

class homematicip.base.enums.AbsenceType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

NOT_ABSENT = 'NOT_ABSENT'

PARTY = 'PARTY'

PERIOD = 'PERIOD'

PERMANENT = 'PERMANENT'

VACATION = 'VACATION'

class homematicip.base.enums.AccelerationSensorMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ANY_MOTION = 'ANY_MOTION'

FLAT_DECT = 'FLAT_DECT'

class homematicip.base.enums.AccelerationSensorNeutralPosition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

HORIZONTAL = 'HORIZONTAL'

VERTICAL = 'VERTICAL'

class homematicip.base.enums.AccelerationSensorSensitivity(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

SENSOR_RANGE_16G = 'SENSOR_RANGE_16G'

SENSOR_RANGE_2G = 'SENSOR_RANGE_2G'

SENSOR_RANGE_2G_2PLUS_SENSE = 'SENSOR_RANGE_2G_2PLUS_SENSE'

SENSOR_RANGE_2G_PLUS_SENS = 'SENSOR_RANGE_2G_PLUS_SENS'

SENSOR_RANGE_4G = 'SENSOR_RANGE_4G'

SENSOR_RANGE_8G = 'SENSOR_RANGE_8G'

class homematicip.base.enums.AcousticAlarmSignal(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

DELAYED_EXTERNALLY_ARMED = 'DELAYED_EXTERNALLY_ARMED'

DELAYED_INTERNALLY_ARMED = 'DELAYED_INTERNALLY_ARMED'

DISABLE_ACOUSTIC_SIGNAL = 'DISABLE_ACOUSTIC_SIGNAL'

DISARMED = 'DISARMED'

ERROR = 'ERROR'

EVENT = 'EVENT'

EXTERNALLY_ARMED = 'EXTERNALLY_ARMED'

FREQUENCY_ALTERNATING_LOW_HIGH = 'FREQUENCY_ALTERNATING_LOW_HIGH'

FREQUENCY_ALTERNATING_LOW_MID_HIGH = 'FREQUENCY_ALTERNATING_LOW_MID_HIGH'

FREQUENCY_FALLING = 'FREQUENCY_FALLING'

FREQUENCY_HIGHON_LONGOFF = 'FREQUENCY_HIGHON_LONGOFF'

FREQUENCY_HIGHON_OFF = 'FREQUENCY_HIGHON_OFF'

FREQUENCY_LOWON_LONGOFF_HIGHON_LONGOFF = 'FREQUENCY_LOWON_LONGOFF_HIGHON_LONGOFF'

FREQUENCY_LOWON_OFF_HIGHON_OFF = 'FREQUENCY_LOWON_OFF_HIGHON_OFF'

FREQUENCY_RISING = 'FREQUENCY_RISING'

FREQUENCY_RISING_AND_FALLING = 'FREQUENCY_RISING_AND_FALLING'

INTERNALLY_ARMED = 'INTERNALLY_ARMED'

LOW_BATTERY = 'LOW_BATTERY'

class homematicip.base.enums.AcousticAlarmTiming(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ONCE_PER_MINUTE = 'ONCE_PER_MINUTE'

PERMANENT = 'PERMANENT'

SIX_MINUTES = 'SIX_MINUTES'

THREE_MINUTES = 'THREE_MINUTES'

class homematicip.base.enums.AlarmContactType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

PASSIVE_GLASS_BREAKAGE_DETECTOR = 'PASSIVE_GLASS_BREAKAGE_DETECTOR'

WINDOW_DOOR_CONTACT = 'WINDOW_DOOR_CONTACT'

class homematicip.base.enums.AlarmSignalType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

FULL_ALARM = 'FULL_ALARM'

NO_ALARM = 'NO_ALARM'

SILENT_ALARM = 'SILENT_ALARM'

class homematicip.base.enums.ApExchangeState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

DONE = 'DONE'

IN_PROGRESS = 'IN_PROGRESS'

NONE = 'NONE'

REJECTED = 'REJECTED'

REQUESTED = 'REQUESTED'

class homematicip.base.enums.AutoNameEnum(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

auto() will generate the name of the attribute as value

classmethod from_str(text: str, default=None)

this function will create the enum object based on its string value

Parameters:

• 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

class homematicip.base.enums.AutomationRuleType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

SIMPLE = 'SIMPLE'

class homematicip.base.enums.BinaryBehaviorType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

NORMALLY_CLOSE = 'NORMALLY_CLOSE'

NORMALLY_OPEN = 'NORMALLY_OPEN'

class homematicip.base.enums.CliActions(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

RESET_ENERGY_COUNTER = 'RESET_ENERGY_COUNTER'

SEND_DOOR_COMMAND = 'SEND_DOOR_COMMAND'

SET_DIM_LEVEL = 'SET_DIM_LEVEL'

SET_LOCK_STATE = 'SET_LOCK_STATE'

SET_SHUTTER_LEVEL = 'SET_SHUTTER_LEVEL'

SET_SHUTTER_STOP = 'SET_SHUTTER_STOP'

SET_SLATS_LEVEL = 'SET_SLATS_LEVEL'

SET_SWITCH_STATE = 'SET_SWITCH_STATE'

TOGGLE_GARAGE_DOOR = 'TOGGLE_GARAGE_DOOR'

class homematicip.base.enums.ClientType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

APP = 'APP'

C2C = 'C2C'

class homematicip.base.enums.ClimateControlDisplay(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ACTUAL = 'ACTUAL'

ACTUAL_HUMIDITY = 'ACTUAL_HUMIDITY'

SETPOINT = 'SETPOINT'

class homematicip.base.enums.ClimateControlMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

AUTOMATIC = 'AUTOMATIC'

ECO = 'ECO'

MANUAL = 'MANUAL'

class homematicip.base.enums.ConnectionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

EXTERNAL = 'EXTERNAL'

HMIP_LAN = 'HMIP_LAN'

HMIP_RF = 'HMIP_RF'

HMIP_WIRED = 'HMIP_WIRED'

HMIP_WLAN = 'HMIP_WLAN'

class homematicip.base.enums.ContactType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

NORMALLY_CLOSE = 'NORMALLY_CLOSE'

NORMALLY_OPEN = 'NORMALLY_OPEN'

class homematicip.base.enums.DeviceArchetype(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

EXTERNAL = 'EXTERNAL'

HMIP = 'HMIP'

class homematicip.base.enums.DeviceType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ACCELERATION_SENSOR = 'ACCELERATION_SENSOR'

ALARM_SIREN_INDOOR = 'ALARM_SIREN_INDOOR'

ALARM_SIREN_OUTDOOR = 'ALARM_SIREN_OUTDOOR'

BASE_DEVICE = 'BASE_DEVICE'

BLIND_MODULE = 'BLIND_MODULE'

BRAND_BLIND = 'BRAND_BLIND'

BRAND_DIMMER = 'BRAND_DIMMER'

BRAND_PUSH_BUTTON = 'BRAND_PUSH_BUTTON'

BRAND_SHUTTER = 'BRAND_SHUTTER'

BRAND_SWITCH_2 = 'BRAND_SWITCH_2'

BRAND_SWITCH_MEASURING = 'BRAND_SWITCH_MEASURING'

BRAND_SWITCH_NOTIFICATION_LIGHT = 'BRAND_SWITCH_NOTIFICATION_LIGHT'

BRAND_WALL_MOUNTED_THERMOSTAT = 'BRAND_WALL_MOUNTED_THERMOSTAT'

CARBON_DIOXIDE_SENSOR = 'CARBON_DIOXIDE_SENSOR'

DALI_GATEWAY = 'DALI_GATEWAY'

DEVICE = 'DEVICE'

DIN_RAIL_BLIND_4 = 'DIN_RAIL_BLIND_4'

DIN_RAIL_DIMMER_3 = 'DIN_RAIL_DIMMER_3'

DIN_RAIL_SWITCH = 'DIN_RAIL_SWITCH'

DIN_RAIL_SWITCH_4 = 'DIN_RAIL_SWITCH_4'

DOOR_BELL_BUTTON = 'DOOR_BELL_BUTTON'

DOOR_BELL_CONTACT_INTERFACE = 'DOOR_BELL_CONTACT_INTERFACE'

DOOR_LOCK_DRIVE = 'DOOR_LOCK_DRIVE'

DOOR_LOCK_SENSOR = 'DOOR_LOCK_SENSOR'

ENERGY_SENSORS_INTERFACE = 'ENERGY_SENSORS_INTERFACE'

EXTERNAL = 'EXTERNAL'

FLOOR_TERMINAL_BLOCK_10 = 'FLOOR_TERMINAL_BLOCK_10'

FLOOR_TERMINAL_BLOCK_12 = 'FLOOR_TERMINAL_BLOCK_12'

FLOOR_TERMINAL_BLOCK_6 = 'FLOOR_TERMINAL_BLOCK_6'

FULL_FLUSH_BLIND = 'FULL_FLUSH_BLIND'

FULL_FLUSH_CONTACT_INTERFACE = 'FULL_FLUSH_CONTACT_INTERFACE'

FULL_FLUSH_CONTACT_INTERFACE_6 = 'FULL_FLUSH_CONTACT_INTERFACE_6'

FULL_FLUSH_DIMMER = 'FULL_FLUSH_DIMMER'

FULL_FLUSH_INPUT_SWITCH = 'FULL_FLUSH_INPUT_SWITCH'

FULL_FLUSH_SHUTTER = 'FULL_FLUSH_SHUTTER'

FULL_FLUSH_SWITCH_MEASURING = 'FULL_FLUSH_SWITCH_MEASURING'

HEATING_SWITCH_2 = 'HEATING_SWITCH_2'

HEATING_THERMOSTAT = 'HEATING_THERMOSTAT'

HEATING_THERMOSTAT_COMPACT = 'HEATING_THERMOSTAT_COMPACT'

HEATING_THERMOSTAT_COMPACT_PLUS = 'HEATING_THERMOSTAT_COMPACT_PLUS'

HEATING_THERMOSTAT_EVO = 'HEATING_THERMOSTAT_EVO'

HOERMANN_DRIVES_MODULE = 'HOERMANN_DRIVES_MODULE'

HOME_CONTROL_ACCESS_POINT = 'HOME_CONTROL_ACCESS_POINT'

KEY_REMOTE_CONTROL_4 = 'KEY_REMOTE_CONTROL_4'

KEY_REMOTE_CONTROL_ALARM = 'KEY_REMOTE_CONTROL_ALARM'

LIGHT_SENSOR = 'LIGHT_SENSOR'

MOTION_DETECTOR_INDOOR = 'MOTION_DETECTOR_INDOOR'

MOTION_DETECTOR_OUTDOOR = 'MOTION_DETECTOR_OUTDOOR'

MOTION_DETECTOR_PUSH_BUTTON = 'MOTION_DETECTOR_PUSH_BUTTON'

MULTI_IO_BOX = 'MULTI_IO_BOX'

OPEN_COLLECTOR_8_MODULE = 'OPEN_COLLECTOR_8_MODULE'

PASSAGE_DETECTOR = 'PASSAGE_DETECTOR'

PLUGABLE_SWITCH = 'PLUGABLE_SWITCH'

PLUGABLE_SWITCH_MEASURING = 'PLUGABLE_SWITCH_MEASURING'

PLUGGABLE_DIMMER = 'PLUGGABLE_DIMMER'

PLUGGABLE_MAINS_FAILURE_SURVEILLANCE = 'PLUGGABLE_MAINS_FAILURE_SURVEILLANCE'

PRESENCE_DETECTOR_INDOOR = 'PRESENCE_DETECTOR_INDOOR'

PRINTED_CIRCUIT_BOARD_SWITCH_2 = 'PRINTED_CIRCUIT_BOARD_SWITCH_2'

PRINTED_CIRCUIT_BOARD_SWITCH_BATTERY = 'PRINTED_CIRCUIT_BOARD_SWITCH_BATTERY'

PUSH_BUTTON = 'PUSH_BUTTON'

PUSH_BUTTON_6 = 'PUSH_BUTTON_6'

PUSH_BUTTON_FLAT = 'PUSH_BUTTON_FLAT'

RAIN_SENSOR = 'RAIN_SENSOR'

REMOTE_CONTROL_8 = 'REMOTE_CONTROL_8'

REMOTE_CONTROL_8_MODULE = 'REMOTE_CONTROL_8_MODULE'

RGBW_DIMMER = 'RGBW_DIMMER'

ROOM_CONTROL_DEVICE = 'ROOM_CONTROL_DEVICE'

ROOM_CONTROL_DEVICE_ANALOG = 'ROOM_CONTROL_DEVICE_ANALOG'

ROTARY_HANDLE_SENSOR = 'ROTARY_HANDLE_SENSOR'

SHUTTER_CONTACT = 'SHUTTER_CONTACT'

SHUTTER_CONTACT_INTERFACE = 'SHUTTER_CONTACT_INTERFACE'

SHUTTER_CONTACT_INVISIBLE = 'SHUTTER_CONTACT_INVISIBLE'

SHUTTER_CONTACT_MAGNETIC = 'SHUTTER_CONTACT_MAGNETIC'

SHUTTER_CONTACT_OPTICAL_PLUS = 'SHUTTER_CONTACT_OPTICAL_PLUS'

SMOKE_DETECTOR = 'SMOKE_DETECTOR'

TEMPERATURE_HUMIDITY_SENSOR = 'TEMPERATURE_HUMIDITY_SENSOR'

TEMPERATURE_HUMIDITY_SENSOR_DISPLAY = 'TEMPERATURE_HUMIDITY_SENSOR_DISPLAY'

TEMPERATURE_HUMIDITY_SENSOR_OUTDOOR = 'TEMPERATURE_HUMIDITY_SENSOR_OUTDOOR'

TEMPERATURE_SENSOR_2_EXTERNAL_DELTA = 'TEMPERATURE_SENSOR_2_EXTERNAL_DELTA'

TILT_VIBRATION_SENSOR = 'TILT_VIBRATION_SENSOR'

TORMATIC_MODULE = 'TORMATIC_MODULE'

WALL_MOUNTED_GARAGE_DOOR_CONTROLLER = 'WALL_MOUNTED_GARAGE_DOOR_CONTROLLER'

WALL_MOUNTED_THERMOSTAT_BASIC_HUMIDITY = 'WALL_MOUNTED_THERMOSTAT_BASIC_HUMIDITY'

WALL_MOUNTED_THERMOSTAT_PRO = 'WALL_MOUNTED_THERMOSTAT_PRO'

WALL_MOUNTED_UNIVERSAL_ACTUATOR = 'WALL_MOUNTED_UNIVERSAL_ACTUATOR'

WATER_SENSOR = 'WATER_SENSOR'

WEATHER_SENSOR = 'WEATHER_SENSOR'

WEATHER_SENSOR_PLUS = 'WEATHER_SENSOR_PLUS'

WEATHER_SENSOR_PRO = 'WEATHER_SENSOR_PRO'

WIRED_BLIND_4 = 'WIRED_BLIND_4'

WIRED_DIMMER_3 = 'WIRED_DIMMER_3'

WIRED_DIN_RAIL_ACCESS_POINT = 'WIRED_DIN_RAIL_ACCESS_POINT'

WIRED_FLOOR_TERMINAL_BLOCK_12 = 'WIRED_FLOOR_TERMINAL_BLOCK_12'

WIRED_INPUT_32 = 'WIRED_INPUT_32'

WIRED_INPUT_SWITCH_6 = 'WIRED_INPUT_SWITCH_6'

WIRED_MOTION_DETECTOR_PUSH_BUTTON = 'WIRED_MOTION_DETECTOR_PUSH_BUTTON'

WIRED_PRESENCE_DETECTOR_INDOOR = 'WIRED_PRESENCE_DETECTOR_INDOOR'

WIRED_PUSH_BUTTON_2 = 'WIRED_PUSH_BUTTON_2'

WIRED_PUSH_BUTTON_6 = 'WIRED_PUSH_BUTTON_6'

WIRED_SWITCH_4 = 'WIRED_SWITCH_4'

WIRED_SWITCH_8 = 'WIRED_SWITCH_8'

WIRED_WALL_MOUNTED_THERMOSTAT = 'WIRED_WALL_MOUNTED_THERMOSTAT'

class homematicip.base.enums.DeviceUpdateState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

BACKGROUND_UPDATE_NOT_SUPPORTED = 'BACKGROUND_UPDATE_NOT_SUPPORTED'

TRANSFERING_UPDATE = 'TRANSFERING_UPDATE'

UPDATE_AUTHORIZED = 'UPDATE_AUTHORIZED'

UPDATE_AVAILABLE = 'UPDATE_AVAILABLE'

UP_TO_DATE = 'UP_TO_DATE'

class homematicip.base.enums.DeviceUpdateStrategy(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

AUTOMATICALLY_IF_POSSIBLE = 'AUTOMATICALLY_IF_POSSIBLE'

MANUALLY = 'MANUALLY'

class homematicip.base.enums.DoorCommand(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

CLOSE = 'CLOSE'

OPEN = 'OPEN'

PARTIAL_OPEN = 'PARTIAL_OPEN'

STOP = 'STOP'

class homematicip.base.enums.DoorState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

CLOSED = 'CLOSED'

OPEN = 'OPEN'

POSITION_UNKNOWN = 'POSITION_UNKNOWN'

VENTILATION_POSITION = 'VENTILATION_POSITION'

class homematicip.base.enums.DriveSpeed(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

CREEP_SPEED = 'CREEP_SPEED'

NOMINAL_SPEED = 'NOMINAL_SPEED'

OPTIONAL_SPEED = 'OPTIONAL_SPEED'

SLOW_SPEED = 'SLOW_SPEED'

class homematicip.base.enums.EcoDuration(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

FOUR = 'FOUR'

ONE = 'ONE'

PERMANENT = 'PERMANENT'

SIX = 'SIX'

TWO = 'TWO'

class homematicip.base.enums.EventType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

CLIENT_ADDED = 'CLIENT_ADDED'

CLIENT_CHANGED = 'CLIENT_CHANGED'

CLIENT_REMOVED = 'CLIENT_REMOVED'

DEVICE_ADDED = 'DEVICE_ADDED'

DEVICE_CHANGED = 'DEVICE_CHANGED'

DEVICE_CHANNEL_EVENT = 'DEVICE_CHANNEL_EVENT'

DEVICE_REMOVED = 'DEVICE_REMOVED'

GROUP_ADDED = 'GROUP_ADDED'

GROUP_CHANGED = 'GROUP_CHANGED'

GROUP_REMOVED = 'GROUP_REMOVED'

HOME_CHANGED = 'HOME_CHANGED'

SECURITY_JOURNAL_CHANGED = 'SECURITY_JOURNAL_CHANGED'

class homematicip.base.enums.FunctionalChannelType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ACCELERATION_SENSOR_CHANNEL = 'ACCELERATION_SENSOR_CHANNEL'

ACCESS_AUTHORIZATION_CHANNEL = 'ACCESS_AUTHORIZATION_CHANNEL'

ACCESS_CONTROLLER_CHANNEL = 'ACCESS_CONTROLLER_CHANNEL'

ACCESS_CONTROLLER_WIRED_CHANNEL = 'ACCESS_CONTROLLER_WIRED_CHANNEL'

ALARM_SIREN_CHANNEL = 'ALARM_SIREN_CHANNEL'

ANALOG_OUTPUT_CHANNEL = 'ANALOG_OUTPUT_CHANNEL'

ANALOG_ROOM_CONTROL_CHANNEL = 'ANALOG_ROOM_CONTROL_CHANNEL'

BLIND_CHANNEL = 'BLIND_CHANNEL'

CARBON_DIOXIDE_SENSOR_CHANNEL = 'CARBON_DIOXIDE_SENSOR_CHANNEL'

CHANGE_OVER_CHANNEL = 'CHANGE_OVER_CHANNEL'

CLIMATE_SENSOR_CHANNEL = 'CLIMATE_SENSOR_CHANNEL'

CONTACT_INTERFACE_CHANNEL = 'CONTACT_INTERFACE_CHANNEL'

DEHUMIDIFIER_DEMAND_CHANNEL = 'DEHUMIDIFIER_DEMAND_CHANNEL'

DEVICE_BASE = 'DEVICE_BASE'

DEVICE_BASE_FLOOR_HEATING = 'DEVICE_BASE_FLOOR_HEATING'

DEVICE_GLOBAL_PUMP_CONTROL = 'DEVICE_GLOBAL_PUMP_CONTROL'

DEVICE_INCORRECT_POSITIONED = 'DEVICE_INCORRECT_POSITIONED'

DEVICE_OPERATIONLOCK = 'DEVICE_OPERATIONLOCK'

DEVICE_OPERATIONLOCK_WITH_SABOTAGE = 'DEVICE_OPERATIONLOCK_WITH_SABOTAGE'

DEVICE_PERMANENT_FULL_RX = 'DEVICE_PERMANENT_FULL_RX'

DEVICE_RECHARGEABLE_WITH_SABOTAGE = 'DEVICE_RECHARGEABLE_WITH_SABOTAGE'

DEVICE_SABOTAGE = 'DEVICE_SABOTAGE'

DIMMER_CHANNEL = 'DIMMER_CHANNEL'

DOOR_CHANNEL = 'DOOR_CHANNEL'

DOOR_LOCK_CHANNEL = 'DOOR_LOCK_CHANNEL'

DOOR_LOCK_SENSOR_CHANNEL = 'DOOR_LOCK_SENSOR_CHANNEL'

ENERGY_SENSORS_INTERFACE_CHANNEL = 'ENERGY_SENSORS_INTERFACE_CHANNEL'

EXTERNAL_BASE_CHANNEL = 'EXTERNAL_BASE_CHANNEL'

EXTERNAL_UNIVERSAL_LIGHT_CHANNEL = 'EXTERNAL_UNIVERSAL_LIGHT_CHANNEL'

FLOOR_TERMINAL_BLOCK_CHANNEL = 'FLOOR_TERMINAL_BLOCK_CHANNEL'

FLOOR_TERMINAL_BLOCK_LOCAL_PUMP_CHANNEL = 'FLOOR_TERMINAL_BLOCK_LOCAL_PUMP_CHANNEL'

FLOOR_TERMINAL_BLOCK_MECHANIC_CHANNEL = 'FLOOR_TERMINAL_BLOCK_MECHANIC_CHANNEL'

FUNCTIONAL_CHANNEL = 'FUNCTIONAL_CHANNEL'

GENERIC_INPUT_CHANNEL = 'GENERIC_INPUT_CHANNEL'

HEATING_THERMOSTAT_CHANNEL = 'HEATING_THERMOSTAT_CHANNEL'

HEAT_DEMAND_CHANNEL = 'HEAT_DEMAND_CHANNEL'

IMPULSE_OUTPUT_CHANNEL = 'IMPULSE_OUTPUT_CHANNEL'

INTERNAL_SWITCH_CHANNEL = 'INTERNAL_SWITCH_CHANNEL'

LIGHT_SENSOR_CHANNEL = 'LIGHT_SENSOR_CHANNEL'

MAINS_FAILURE_CHANNEL = 'MAINS_FAILURE_CHANNEL'

MOTION_DETECTION_CHANNEL = 'MOTION_DETECTION_CHANNEL'

MULTI_MODE_INPUT_BLIND_CHANNEL = 'MULTI_MODE_INPUT_BLIND_CHANNEL'

MULTI_MODE_INPUT_CHANNEL = 'MULTI_MODE_INPUT_CHANNEL'

MULTI_MODE_INPUT_DIMMER_CHANNEL = 'MULTI_MODE_INPUT_DIMMER_CHANNEL'

MULTI_MODE_INPUT_SWITCH_CHANNEL = 'MULTI_MODE_INPUT_SWITCH_CHANNEL'

NOTIFICATION_LIGHT_CHANNEL = 'NOTIFICATION_LIGHT_CHANNEL'

OPTICAL_SIGNAL_CHANNEL = 'OPTICAL_SIGNAL_CHANNEL'

OPTICAL_SIGNAL_GROUP_CHANNEL = 'OPTICAL_SIGNAL_GROUP_CHANNEL'

PASSAGE_DETECTOR_CHANNEL = 'PASSAGE_DETECTOR_CHANNEL'

PRESENCE_DETECTION_CHANNEL = 'PRESENCE_DETECTION_CHANNEL'

RAIN_DETECTION_CHANNEL = 'RAIN_DETECTION_CHANNEL'

ROTARY_HANDLE_CHANNEL = 'ROTARY_HANDLE_CHANNEL'

SHADING_CHANNEL = 'SHADING_CHANNEL'

SHUTTER_CHANNEL = 'SHUTTER_CHANNEL'

SHUTTER_CONTACT_CHANNEL = 'SHUTTER_CONTACT_CHANNEL'

SINGLE_KEY_CHANNEL = 'SINGLE_KEY_CHANNEL'

SMOKE_DETECTOR_CHANNEL = 'SMOKE_DETECTOR_CHANNEL'

SWITCH_CHANNEL = 'SWITCH_CHANNEL'

SWITCH_MEASURING_CHANNEL = 'SWITCH_MEASURING_CHANNEL'

TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL = 'TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL'

TILT_VIBRATION_SENSOR_CHANNEL = 'TILT_VIBRATION_SENSOR_CHANNEL'

UNIVERSAL_ACTUATOR_CHANNEL = 'UNIVERSAL_ACTUATOR_CHANNEL'

UNIVERSAL_LIGHT_CHANNEL = 'UNIVERSAL_LIGHT_CHANNEL'

UNIVERSAL_LIGHT_GROUP_CHANNEL = 'UNIVERSAL_LIGHT_GROUP_CHANNEL'

WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL = 'WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL'

WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL = 'WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL'

WATER_SENSOR_CHANNEL = 'WATER_SENSOR_CHANNEL'

WEATHER_SENSOR_CHANNEL = 'WEATHER_SENSOR_CHANNEL'

WEATHER_SENSOR_PLUS_CHANNEL = 'WEATHER_SENSOR_PLUS_CHANNEL'

WEATHER_SENSOR_PRO_CHANNEL = 'WEATHER_SENSOR_PRO_CHANNEL'

class homematicip.base.enums.FunctionalHomeType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ACCESS_CONTROL = 'ACCESS_CONTROL'

ENERGY = 'ENERGY'

INDOOR_CLIMATE = 'INDOOR_CLIMATE'

LIGHT_AND_SHADOW = 'LIGHT_AND_SHADOW'

SECURITY_AND_ALARM = 'SECURITY_AND_ALARM'

WEATHER_AND_ENVIRONMENT = 'WEATHER_AND_ENVIRONMENT'

class homematicip.base.enums.GroupType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ACCESS_AUTHORIZATION_PROFILE = 'ACCESS_AUTHORIZATION_PROFILE'

ACCESS_CONTROL = 'ACCESS_CONTROL'

ALARM_SWITCHING = 'ALARM_SWITCHING'

ENERGY = 'ENERGY'

ENVIRONMENT = 'ENVIRONMENT'

EXTENDED_LINKED_GARAGE_DOOR = 'EXTENDED_LINKED_GARAGE_DOOR'

EXTENDED_LINKED_SHUTTER = 'EXTENDED_LINKED_SHUTTER'

EXTENDED_LINKED_SWITCHING = 'EXTENDED_LINKED_SWITCHING'

GROUP = 'GROUP'

HEATING = 'HEATING'

HEATING_CHANGEOVER = 'HEATING_CHANGEOVER'

HEATING_COOLING_DEMAND = 'HEATING_COOLING_DEMAND'

HEATING_COOLING_DEMAND_BOILER = 'HEATING_COOLING_DEMAND_BOILER'

HEATING_COOLING_DEMAND_PUMP = 'HEATING_COOLING_DEMAND_PUMP'

HEATING_DEHUMIDIFIER = 'HEATING_DEHUMIDIFIER'

HEATING_EXTERNAL_CLOCK = 'HEATING_EXTERNAL_CLOCK'

HEATING_FAILURE_ALERT_RULE_GROUP = 'HEATING_FAILURE_ALERT_RULE_GROUP'

HEATING_HUMIDITY_LIMITER = 'HEATING_HUMIDITY_LIMITER'

HEATING_TEMPERATURE_LIMITER = 'HEATING_TEMPERATURE_LIMITER'

HOT_WATER = 'HOT_WATER'

HUMIDITY_WARNING_RULE_GROUP = 'HUMIDITY_WARNING_RULE_GROUP'

INBOX = 'INBOX'

INDOOR_CLIMATE = 'INDOOR_CLIMATE'

LINKED_SWITCHING = 'LINKED_SWITCHING'

LOCK_OUT_PROTECTION_RULE = 'LOCK_OUT_PROTECTION_RULE'

OVER_HEAT_PROTECTION_RULE = 'OVER_HEAT_PROTECTION_RULE'

SECURITY = 'SECURITY'

SECURITY_BACKUP_ALARM_SWITCHING = 'SECURITY_BACKUP_ALARM_SWITCHING'

SECURITY_ZONE = 'SECURITY_ZONE'

SHUTTER_PROFILE = 'SHUTTER_PROFILE'

SHUTTER_WIND_PROTECTION_RULE = 'SHUTTER_WIND_PROTECTION_RULE'

SMOKE_ALARM_DETECTION_RULE = 'SMOKE_ALARM_DETECTION_RULE'

SWITCHING = 'SWITCHING'

SWITCHING_PROFILE = 'SWITCHING_PROFILE'

class homematicip.base.enums.GroupVisibility(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

INVISIBLE_CONTROL = 'INVISIBLE_CONTROL'

INVISIBLE_GROUP_AND_CONTROL = 'INVISIBLE_GROUP_AND_CONTROL'

VISIBLE = 'VISIBLE'

class homematicip.base.enums.HeatingFailureValidationType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

HEATING_FAILURE_ALARM = 'HEATING_FAILURE_ALARM'

HEATING_FAILURE_WARNING = 'HEATING_FAILURE_WARNING'

NO_HEATING_FAILURE = 'NO_HEATING_FAILURE'

class homematicip.base.enums.HeatingLoadType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

LOAD_BALANCING = 'LOAD_BALANCING'

LOAD_COLLECTION = 'LOAD_COLLECTION'

class homematicip.base.enums.HeatingValveType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

NORMALLY_CLOSE = 'NORMALLY_CLOSE'

NORMALLY_OPEN = 'NORMALLY_OPEN'

class homematicip.base.enums.HomeUpdateState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

PERFORMING_UPDATE = 'PERFORMING_UPDATE'

PERFORM_UPDATE_SENT = 'PERFORM_UPDATE_SENT'

UPDATE_AVAILABLE = 'UPDATE_AVAILABLE'

UP_TO_DATE = 'UP_TO_DATE'

class homematicip.base.enums.HumidityValidationType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

GREATER_LOWER_LESSER_UPPER_THRESHOLD = 'GREATER_LOWER_LESSER_UPPER_THRESHOLD'

GREATER_UPPER_THRESHOLD = 'GREATER_UPPER_THRESHOLD'

LESSER_LOWER_THRESHOLD = 'LESSER_LOWER_THRESHOLD'

class homematicip.base.enums.LiveUpdateState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

LIVE_UPDATE_NOT_SUPPORTED = 'LIVE_UPDATE_NOT_SUPPORTED'

UPDATE_AVAILABLE = 'UPDATE_AVAILABLE'

UPDATE_INCOMPLETE = 'UPDATE_INCOMPLETE'

UP_TO_DATE = 'UP_TO_DATE'

class homematicip.base.enums.LockState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

LOCKED = 'LOCKED'

NONE = 'NONE'

OPEN = 'OPEN'

UNLOCKED = 'UNLOCKED'

class homematicip.base.enums.MotionDetectionSendInterval(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

SECONDS_120 = 'SECONDS_120'

SECONDS_240 = 'SECONDS_240'

SECONDS_30 = 'SECONDS_30'

SECONDS_480 = 'SECONDS_480'

SECONDS_60 = 'SECONDS_60'

class homematicip.base.enums.MotorState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

CLOSING = 'CLOSING'

OPENING = 'OPENING'

STOPPED = 'STOPPED'

class homematicip.base.enums.MultiModeInputMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

BINARY_BEHAVIOR = 'BINARY_BEHAVIOR'

KEY_BEHAVIOR = 'KEY_BEHAVIOR'

SWITCH_BEHAVIOR = 'SWITCH_BEHAVIOR'

class homematicip.base.enums.NotificationSoundType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

SOUND_LONG = 'SOUND_LONG'

SOUND_NO_SOUND = 'SOUND_NO_SOUND'

SOUND_SHORT = 'SOUND_SHORT'

SOUND_SHORT_SHORT = 'SOUND_SHORT_SHORT'

class homematicip.base.enums.OpticalAlarmSignal(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

BLINKING_ALTERNATELY_REPEATING = 'BLINKING_ALTERNATELY_REPEATING'

BLINKING_BOTH_REPEATING = 'BLINKING_BOTH_REPEATING'

CONFIRMATION_SIGNAL_0 = 'CONFIRMATION_SIGNAL_0'

CONFIRMATION_SIGNAL_1 = 'CONFIRMATION_SIGNAL_1'

CONFIRMATION_SIGNAL_2 = 'CONFIRMATION_SIGNAL_2'

DISABLE_OPTICAL_SIGNAL = 'DISABLE_OPTICAL_SIGNAL'

DOUBLE_FLASHING_REPEATING = 'DOUBLE_FLASHING_REPEATING'

FLASHING_BOTH_REPEATING = 'FLASHING_BOTH_REPEATING'

class homematicip.base.enums.OpticalSignalBehaviour(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

BILLOW_MIDDLE = 'BILLOW_MIDDLE'

BLINKING_MIDDLE = 'BLINKING_MIDDLE'

FLASH_MIDDLE = 'FLASH_MIDDLE'

OFF = 'OFF'

ON = 'ON'

class homematicip.base.enums.PassageDirection(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

LEFT = 'LEFT'

RIGHT = 'RIGHT'

class homematicip.base.enums.ProfileMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

AUTOMATIC = 'AUTOMATIC'

MANUAL = 'MANUAL'

class homematicip.base.enums.RGBColorState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

BLACK = 'BLACK'

BLUE = 'BLUE'

GREEN = 'GREEN'

PURPLE = 'PURPLE'

RED = 'RED'

TURQUOISE = 'TURQUOISE'

WHITE = 'WHITE'

YELLOW = 'YELLOW'

class homematicip.base.enums.SecurityEventType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ACCESS_POINT_CONNECTED = 'ACCESS_POINT_CONNECTED'

ACCESS_POINT_DISCONNECTED = 'ACCESS_POINT_DISCONNECTED'

ACTIVATION_CHANGED = 'ACTIVATION_CHANGED'

EXTERNAL_TRIGGERED = 'EXTERNAL_TRIGGERED'

MAINS_FAILURE_EVENT = 'MAINS_FAILURE_EVENT'

MOISTURE_DETECTION_EVENT = 'MOISTURE_DETECTION_EVENT'

OFFLINE_ALARM = 'OFFLINE_ALARM'

OFFLINE_WATER_DETECTION_EVENT = 'OFFLINE_WATER_DETECTION_EVENT'

SABOTAGE = 'SABOTAGE'

SENSOR_EVENT = 'SENSOR_EVENT'

SILENCE_CHANGED = 'SILENCE_CHANGED'

SMOKE_ALARM = 'SMOKE_ALARM'

WATER_DETECTION_EVENT = 'WATER_DETECTION_EVENT'

class homematicip.base.enums.SecurityZoneActivationMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ACTIVATION_IF_ALL_IN_VALID_STATE = 'ACTIVATION_IF_ALL_IN_VALID_STATE'

ACTIVATION_WITH_DEVICE_IGNORELIST = 'ACTIVATION_WITH_DEVICE_IGNORELIST'

class homematicip.base.enums.ShadingPackagePosition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

BOTTOM = 'BOTTOM'

CENTER = 'CENTER'

LEFT = 'LEFT'

NOT_USED = 'NOT_USED'

RIGHT = 'RIGHT'

SPLIT = 'SPLIT'

TDBU = 'TDBU'

TOP = 'TOP'

class homematicip.base.enums.ShadingStateType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

MIXED = 'MIXED'

NOT_EXISTENT = 'NOT_EXISTENT'

NOT_POSSIBLE = 'NOT_POSSIBLE'

NOT_USED = 'NOT_USED'

POSITION_USED = 'POSITION_USED'

TILT_USED = 'TILT_USED'

class homematicip.base.enums.SmokeDetectorAlarmType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

IDLE_OFF = 'IDLE_OFF'

INTRUSION_ALARM = 'INTRUSION_ALARM'

PRIMARY_ALARM = 'PRIMARY_ALARM'

SECONDARY_ALARM = 'SECONDARY_ALARM'

class homematicip.base.enums.ValveState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

ADAPTION_DONE = 'ADAPTION_DONE'

ADAPTION_IN_PROGRESS = 'ADAPTION_IN_PROGRESS'

ADJUSTMENT_TOO_BIG = 'ADJUSTMENT_TOO_BIG'

ADJUSTMENT_TOO_SMALL = 'ADJUSTMENT_TOO_SMALL'

ERROR_POSITION = 'ERROR_POSITION'

RUN_TO_START = 'RUN_TO_START'

STATE_NOT_AVAILABLE = 'STATE_NOT_AVAILABLE'

TOO_TIGHT = 'TOO_TIGHT'

WAIT_FOR_ADAPTION = 'WAIT_FOR_ADAPTION'

class homematicip.base.enums.WaterAlarmTrigger(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

MOISTURE_DETECTION = 'MOISTURE_DETECTION'

NO_ALARM = 'NO_ALARM'

WATER_DETECTION = 'WATER_DETECTION'

WATER_MOISTURE_DETECTION = 'WATER_MOISTURE_DETECTION'

class homematicip.base.enums.WeatherCondition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

CLEAR = 'CLEAR'

CLOUDY = 'CLOUDY'

CLOUDY_WITH_RAIN = 'CLOUDY_WITH_RAIN'

CLOUDY_WITH_SNOW_RAIN = 'CLOUDY_WITH_SNOW_RAIN'

FOGGY = 'FOGGY'

HEAVILY_CLOUDY = 'HEAVILY_CLOUDY'

HEAVILY_CLOUDY_WITH_RAIN = 'HEAVILY_CLOUDY_WITH_RAIN'

HEAVILY_CLOUDY_WITH_RAIN_AND_THUNDER = 'HEAVILY_CLOUDY_WITH_RAIN_AND_THUNDER'

HEAVILY_CLOUDY_WITH_SNOW = 'HEAVILY_CLOUDY_WITH_SNOW'

HEAVILY_CLOUDY_WITH_SNOW_RAIN = 'HEAVILY_CLOUDY_WITH_SNOW_RAIN'

HEAVILY_CLOUDY_WITH_STRONG_RAIN = 'HEAVILY_CLOUDY_WITH_STRONG_RAIN'

HEAVILY_CLOUDY_WITH_THUNDER = 'HEAVILY_CLOUDY_WITH_THUNDER'

LIGHT_CLOUDY = 'LIGHT_CLOUDY'

STRONG_WIND = 'STRONG_WIND'

UNKNOWN = 'UNKNOWN'

class homematicip.base.enums.WeatherDayTime(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

DAY = 'DAY'

NIGHT = 'NIGHT'

TWILIGHT = 'TWILIGHT'

class homematicip.base.enums.WindValueType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

AVERAGE_VALUE = 'AVERAGE_VALUE'

CURRENT_VALUE = 'CURRENT_VALUE'

MAX_VALUE = 'MAX_VALUE'

MIN_VALUE = 'MIN_VALUE'

class homematicip.base.enums.WindowState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoNameEnum

CLOSED = 'CLOSED'

OPEN = 'OPEN'

TILTED = 'TILTED'

homematicip.base.functionalChannels module

class homematicip.base.functionalChannels.AccelerationSensorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the ACCELERATION_SENSOR_CHANNEL channel

accelerationSensorEventFilterPeriod

float:

accelerationSensorMode

AccelerationSensorMode:

accelerationSensorNeutralPosition

AccelerationSensorNeutralPosition:

accelerationSensorSensitivity

AccelerationSensorSensitivity:

accelerationSensorTriggerAngle

int:

accelerationSensorTriggered

bool:

async async_set_acceleration_sensor_event_filter_period(period: float)

async async_set_acceleration_sensor_mode(mode)

async async_set_acceleration_sensor_neutral_position(neutralPosition: AccelerationSensorNeutralPosition)

async async_set_acceleration_sensor_sensitivity(sensitivity: AccelerationSensorSensitivity)

async async_set_acceleration_sensor_trigger_angle(angle: int)

async async_set_notification_sound_type(soundType: NotificationSoundType, isHighToLow: bool)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

notificationSoundTypeHighToLow

NotificationSoundType:

notificationSoundTypeLowToHigh

NotificationSoundType:

set_acceleration_sensor_event_filter_period(period: float)

set_acceleration_sensor_mode(mode: AccelerationSensorMode)

set_acceleration_sensor_neutral_position(neutralPosition: AccelerationSensorNeutralPosition)

set_acceleration_sensor_sensitivity(sensitivity: AccelerationSensorSensitivity)

set_acceleration_sensor_trigger_angle(angle: int)

set_notification_sound_type(soundType: NotificationSoundType, isHighToLow: bool)

class homematicip.base.functionalChannels.AccessAuthorizationChannel(device, connection)

Bases: FunctionalChannel

this represents ACCESS_AUTHORIZATION_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.AccessControllerChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the ACCESS_CONTROLLER_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.AccessControllerWiredChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the ACCESS_CONTROLLER_WIRED_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.AlarmSirenChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the ALARM_SIREN_CHANNEL channel

class homematicip.base.functionalChannels.AnalogOutputChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the ANALOG_OUTPUT_CHANNEL channel

analogOutputLevel

the analog output level (Volt?)

Type:

float

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.AnalogRoomControlChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the ANALOG_ROOM_CONTROL_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.BlindChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the BLIND_CHANNEL channel

async async_set_shutter_level(level=0.0)

async async_set_shutter_stop()

async async_set_slats_level(slatsLevel=0.0, shutterLevel=None)

async async_stop()

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_shutter_level(level=0.0)

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

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

set_slats_level(slatsLevel=0.0, shutterLevel=None)

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

stop()

stops the current shutter operation

Returns:

the result of the _restCall

class homematicip.base.functionalChannels.CarbonDioxideSensorChannel(device, connection)

Bases: FunctionalChannel

Representation of the CarbonDioxideSensorChannel Channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.ChangeOverChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the CHANGE_OVER_CHANNEL channel

class homematicip.base.functionalChannels.ClimateSensorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the CLIMATE_SENSOR_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.ContactInterfaceChannel(device, connection)

Bases: ShutterContactChannel

this is the representative of the CONTACT_INTERFACE_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.DehumidifierDemandChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the DEHUMIDIFIER_DEMAND_CHANNEL channel

class homematicip.base.functionalChannels.DeviceBaseChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the DEVICE_BASE channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.DeviceBaseFloorHeatingChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the DEVICE_BASE_FLOOR_HEATING channel

async async_set_minimum_floor_heating_valve_position(minimumFloorHeatingValvePosition: float)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

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.base.functionalChannels.DeviceGlobalPumpControlChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the DEVICE_GLOBAL_PUMP_CONTROL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.DeviceIncorrectPositionedChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the DEVICE_INCORRECT_POSITIONED channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.DeviceOperationLockChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the DEVICE_OPERATIONLOCK channel

async async_set_operation_lock(operationLock=True)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_operation_lock(operationLock=True)

class homematicip.base.functionalChannels.DeviceOperationLockChannelWithSabotage(device, connection)

Bases: DeviceOperationLockChannel

this is the representation of the DeviceOperationLockChannelWithSabotage channel

class homematicip.base.functionalChannels.DevicePermanentFullRxChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the DEVICE_PERMANENT_FULL_RX channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.DeviceRechargeableWithSabotage(device, connection)

Bases: DeviceSabotageChannel

this is the representative of the DEVICE_RECHARGEABLE_WITH_SABOTAGE channel

badBatteryHealth

is the battery in a bad condition

Type:

bool

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.DeviceSabotageChannel(device, connection)

Bases: DeviceBaseChannel

this is the representative of the DEVICE_SABOTAGE channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.DimmerChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the DIMMER_CHANNEL channel

async async_set_dim_level(dimLevel=0.0)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_dim_level(dimLevel=0.0)

class homematicip.base.functionalChannels.DoorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the DoorChannel channel

async async_send_door_command(doorCommand=DoorCommand.STOP)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

send_door_command(doorCommand=DoorCommand.STOP)

class homematicip.base.functionalChannels.DoorLockChannel(device, connection)

Bases: FunctionalChannel

This respresents of the DoorLockChannel

async async_set_lock_state(doorLockState: LockState, pin='')

sets the door lock state

Parameters:

• 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

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_lock_state(doorLockState: LockState, pin='')

sets the door lock state

Parameters:

• 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

class homematicip.base.functionalChannels.DoorLockSensorChannel(device, connection)

Bases: FunctionalChannel

This respresents of the DoorLockSensorChannel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.EnergySensorInterfaceChannel(device, connection)

Bases: FunctionalChannel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.ExternalBaseChannel(device, connection)

Bases: FunctionalChannel

this represents the EXTERNAL_BASE_CHANNEL function-channel for external devices

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.ExternalUniversalLightChannel(device, connection)

Bases: FunctionalChannel

this represents the EXTERNAL_UNIVERSAL_LIGHT_CHANNEL function-channel for external devices

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.FloorTeminalBlockChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the FLOOR_TERMINAL_BLOCK_CHANNEL channel

class homematicip.base.functionalChannels.FloorTerminalBlockLocalPumpChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the FLOOR_TERMINAL_BLOCK_LOCAL_PUMP_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.FloorTerminalBlockMechanicChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the class FLOOR_TERMINAL_BLOCK_MECHANIC_CHANNEL(FunctionalChannel) channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

valveState

the current valve state

Type:

ValveState

class homematicip.base.functionalChannels.FunctionalChannel(device, connection)

Bases: HomeMaticIPObject

this is the base class for the functional channels

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.GenericInputChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the GENERIC_INPUT_CHANNEL channel

class homematicip.base.functionalChannels.HeatDemandChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the HEAT_DEMAND_CHANNEL channel

class homematicip.base.functionalChannels.HeatingThermostatChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the HEATING_THERMOSTAT_CHANNEL channel

automaticValveAdaptionNeeded

must the adaption re-run?

Type:

bool

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

setPointTemperature

the current temperature which should be reached in the room

Type:

float

temperatureOffset

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

Type:

float

valveActualTemperature

the current measured temperature at the valve

Type:

float

valvePosition

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

Type:

float

valveState

the current state of the valve

Type:

ValveState

class homematicip.base.functionalChannels.ImpulseOutputChannel(device, connection)

Bases: FunctionalChannel

this is the representation of the IMPULSE_OUTPUT_CHANNEL

async async_send_start_impulse()

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

send_start_impulse()

Toggle Wall mounted Garage Door Controller.

class homematicip.base.functionalChannels.InternalSwitchChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the INTERNAL_SWITCH_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.LightSensorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the LIGHT_SENSOR_CHANNEL channel

averageIllumination

the average illumination value

Type:

float

currentIllumination

the current illumination value

Type:

float

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

highestIllumination

the highest illumination value

Type:

float

lowestIllumination

the lowest illumination value

Type:

float

class homematicip.base.functionalChannels.MainsFailureChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the MAINS_FAILURE_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.MotionDetectionChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the MOTION_DETECTION_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.MultiModeInputBlindChannel(device, connection)

Bases: BlindChannel

this is the representative of the MULTI_MODE_INPUT_BLIND_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.MultiModeInputChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the MULTI_MODE_INPUT_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.MultiModeInputDimmerChannel(device, connection)

Bases: DimmerChannel

this is the representative of the MULTI_MODE_INPUT_DIMMER_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.MultiModeInputSwitchChannel(device, connection)

Bases: SwitchChannel

this is the representative of the MULTI_MODE_INPUT_SWITCH_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.NotificationLightChannel(device, connection)

Bases: DimmerChannel, SwitchChannel

this is the representative of the NOTIFICATION_LIGHT_CHANNEL channel

async async_set_optical_signal(opticalSignalBehaviour: OpticalSignalBehaviour, rgb: RGBColorState, dimLevel=1.01)

sets the signal type for the leds

Parameters:

• opticalSignalBehaviour (OpticalSignalBehaviour) – LED signal behaviour

• rgb (RGBColorState) – Color

• dimLevel (float) – usally 1.01. Use set_dim_level instead

Returns:

Result of the _restCall

async async_set_rgb_dim_level(rgb: RGBColorState, dimLevel: float)

async async_set_rgb_dim_level_with_time(rgb: 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

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

on

is the light turned on?

Type:

boolean

set_optical_signal(opticalSignalBehaviour: OpticalSignalBehaviour, rgb: RGBColorState, dimLevel=1.01)

set_rgb_dim_level(rgb: 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(rgb: RGBColorState, dimLevel: float, onTime: float, rampTime: float)

simpleRGBColorState

the color of the light

Type:

RGBColorState

class homematicip.base.functionalChannels.OpticalSignalChannel(device, connection)

Bases: FunctionalChannel

this class represents the OPTICAL_SIGNAL_CHANNEL

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.OpticalSignalGroupChannel(device, connection)

Bases: FunctionalChannel

this class represents the OPTICAL_SIGNAL_GROUP_CHANNEL

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.PassageDetectorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the PASSAGE_DETECTOR_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.PresenceDetectionChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the PRESENCE_DETECTION_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.RainDetectionChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the TILT_VIBRATION_SENSOR_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

rainSensorSensitivity

float:

raining

bool:

class homematicip.base.functionalChannels.RotaryHandleChannel(device, connection)

Bases: ShutterContactChannel

this is the representative of the ROTARY_HANDLE_CHANNEL channel

class homematicip.base.functionalChannels.ShadingChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the SHADING_CHANNEL channel

async async_set_primary_shading_level(primaryShadingLevel: float)

async async_set_secondary_shading_level(primaryShadingLevel: float, secondaryShadingLevel: float)

async async_set_shutter_stop()

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

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_primary_shading_level(primaryShadingLevel: float)

set_secondary_shading_level(primaryShadingLevel: float, secondaryShadingLevel: float)

set_shutter_stop()

class homematicip.base.functionalChannels.ShutterChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the SHUTTER_CHANNEL channel

async async_set_shutter_level(level=0.0)

sets the shutter level

Parameters:

level (float) – the new level of the shutter. 0.0 = open, 1.0 = closed

Returns:

the result of the _restCall

async async_set_shutter_stop()

stops the current shutter operation

Parameters:

channelIndex (int) – the channel to control

Returns:

the result of the _restCall

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_shutter_level(level=0.0)

set_shutter_stop()

class homematicip.base.functionalChannels.ShutterContactChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the SHUTTER_CONTACT_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.SingleKeyChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the SINGLE_KEY_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.SmokeDetectorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the SMOKE_DETECTOR_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.SwitchChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the SWITCH_CHANNEL channel

async async_set_switch_state(on=True)

async async_turn_off()

async async_turn_on()

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_switch_state(on=True)

turn_off()

turn_on()

class homematicip.base.functionalChannels.SwitchMeasuringChannel(device, connection)

Bases: SwitchChannel

this is the representative of the SWITCH_MEASURING_CHANNEL channel

async async_reset_energy_counter()

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

reset_energy_counter()

class homematicip.base.functionalChannels.TemperatureDifferenceSensor2Channel(device, connection)

Bases: FunctionalChannel

this is the representative of the TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

temperatureExternalDelta

float:

temperatureExternalOne

float:

temperatureExternalTwo

float:

class homematicip.base.functionalChannels.TiltVibrationSensorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the TILT_VIBRATION_SENSOR_CHANNEL channel

accelerationSensorEventFilterPeriod

float:

accelerationSensorMode

AccelerationSensorMode:

accelerationSensorSensitivity

AccelerationSensorSensitivity:

accelerationSensorTriggerAngle

int:

accelerationSensorTriggered

bool:

async async_set_acceleration_sensor_event_filter_period(period: float)

async async_set_acceleration_sensor_mode(mode: AccelerationSensorMode)

async async_set_acceleration_sensor_sensitivity(sensitivity: AccelerationSensorSensitivity)

async async_set_acceleration_sensor_trigger_angle(angle: int)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_acceleration_sensor_event_filter_period(period: float)

set_acceleration_sensor_mode(mode: AccelerationSensorMode)

set_acceleration_sensor_sensitivity(sensitivity: AccelerationSensorSensitivity)

set_acceleration_sensor_trigger_angle(angle: int)

class homematicip.base.functionalChannels.UniversalActuatorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the UniversalActuatorChannel UNIVERSAL_ACTUATOR_CHANNEL

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.UniversalLightChannel(device, connection)

Bases: FunctionalChannel

Represents Universal Light Channel.

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.UniversalLightChannelGroup(device, connection)

Bases: UniversalLightChannel

Universal-Light-Channel-Group.

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.WallMountedThermostatProChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL channel

async async_set_display(display: ClimateControlDisplay = ClimateControlDisplay.ACTUAL)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_display(display: ClimateControlDisplay = ClimateControlDisplay.ACTUAL)

class homematicip.base.functionalChannels.WallMountedThermostatWithoutDisplayChannel(device, connection)

Bases: ClimateSensorChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.WaterSensorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the WATER_SENSOR_CHANNEL channel

async async_set_acoustic_alarm_signal(acousticAlarmSignal: AcousticAlarmSignal)

async async_set_acoustic_alarm_timing(acousticAlarmTiming: AcousticAlarmTiming)

async async_set_acoustic_water_alarm_trigger(acousticWaterAlarmTrigger: WaterAlarmTrigger)

async async_set_inapp_water_alarm_trigger(inAppWaterAlarmTrigger: WaterAlarmTrigger)

async async_set_siren_water_alarm_trigger(sirenWaterAlarmTrigger: WaterAlarmTrigger)

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

set_acoustic_alarm_signal(acousticAlarmSignal: AcousticAlarmSignal)

set_acoustic_alarm_timing(acousticAlarmTiming: AcousticAlarmTiming)

set_acoustic_water_alarm_trigger(acousticWaterAlarmTrigger: WaterAlarmTrigger)

set_inapp_water_alarm_trigger(inAppWaterAlarmTrigger: WaterAlarmTrigger)

set_siren_water_alarm_trigger(sirenWaterAlarmTrigger: WaterAlarmTrigger)

class homematicip.base.functionalChannels.WeatherSensorChannel(device, connection)

Bases: FunctionalChannel

this is the representative of the WEATHER_SENSOR_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.WeatherSensorPlusChannel(device, connection)

Bases: WeatherSensorChannel

this is the representative of the WEATHER_SENSOR_PLUS_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

class homematicip.base.functionalChannels.WeatherSensorProChannel(device, connection)

Bases: WeatherSensorPlusChannel

this is the representative of the WEATHER_SENSOR_PRO_CHANNEL channel

from_json(js, groups: Iterable[Group])

this function will load the functional channel object from a json object and the given groups

Parameters:

• js (dict) – the json object

• groups (Iterable[Group]) – the groups for referencing

homematicip.base.helpers module

homematicip.base.helpers.anonymizeConfig(config, pattern, format, flags=re.IGNORECASE)

homematicip.base.helpers.bytes2str(b)

homematicip.base.helpers.detect_encoding(b)

homematicip.base.helpers.get_functional_channel(channel_type, js)

homematicip.base.helpers.get_functional_channels(channel_type, js)

homematicip.base.helpers.handle_config(json_state: str, anonymize: bool) → str

Module contents