homematicip.base package

Submodules

homematicip.base.base_connection module

class homematicip.base.base_connection.BaseConnection

Bases: object

Base connection class.

Threaded and Async connection class must inherit from this.

auth_token

clientCharacteristics

clientauth_token

init(accesspoint_id, lookup=True, **kwargs)

set_auth_token(auth_token)

set_token_and_characteristics(accesspoint_id)

urlREST

urlWebSocket

exception homematicip.base.base_connection.HmipConnectionError

Bases: Exception

exception homematicip.base.base_connection.HmipServerCloseError

Bases: homematicip.base.base_connection.HmipConnectionError

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

Bases: homematicip.base.base_connection.HmipConnectionError

homematicip.base.constants module

homematicip.base.enums module

class homematicip.base.enums.AbsenceType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

NOT_ABSENT = 'NOT_ABSENT'

PARTY = 'PARTY'

PERIOD = 'PERIOD'

PERMANENT = 'PERMANENT'

VACATION = 'VACATION'

class homematicip.base.enums.AccelerationSensorMode(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

ANY_MOTION = 'ANY_MOTION'

FLAT_DECT = 'FLAT_DECT'

class homematicip.base.enums.AccelerationSensorNeutralPosition(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

HORIZONTAL = 'HORIZONTAL'

VERTICAL = 'VERTICAL'

class homematicip.base.enums.AccelerationSensorSensitivity(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

ONCE_PER_MINUTE = 'ONCE_PER_MINUTE'

PERMANENT = 'PERMANENT'

SIX_MINUTES = 'SIX_MINUTES'

THREE_MINUTES = 'THREE_MINUTES'

class homematicip.base.enums.AlarmContactType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

PASSIVE_GLASS_BREAKAGE_DETECTOR = 'PASSIVE_GLASS_BREAKAGE_DETECTOR'

WINDOW_DOOR_CONTACT = 'WINDOW_DOOR_CONTACT'

class homematicip.base.enums.AlarmSignalType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

FULL_ALARM = 'FULL_ALARM'

NO_ALARM = 'NO_ALARM'

SILENT_ALARM = 'SILENT_ALARM'

class homematicip.base.enums.ApExchangeState(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

DONE = 'DONE'

IN_PROGRESS = 'IN_PROGRESS'

NONE = 'NONE'

REJECTED = 'REJECTED'

REQUESTED = 'REQUESTED'

class homematicip.base.enums.AutoNameEnum(*args, **kwds)

Bases: str, aenum.Enum

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

from_str = <bound method AutoNameEnum.from_str of <aenum 'AutoNameEnum'>>

class homematicip.base.enums.AutomationRuleType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

SIMPLE = 'SIMPLE'

class homematicip.base.enums.BinaryBehaviorType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

NORMALLY_CLOSE = 'NORMALLY_CLOSE'

NORMALLY_OPEN = 'NORMALLY_OPEN'

class homematicip.base.enums.ClientType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

APP = 'APP'

C2C = 'C2C'

class homematicip.base.enums.ClimateControlDisplay(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

ACTUAL = 'ACTUAL'

ACTUAL_HUMIDITY = 'ACTUAL_HUMIDITY'

SETPOINT = 'SETPOINT'

class homematicip.base.enums.ClimateControlMode(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

AUTOMATIC = 'AUTOMATIC'

ECO = 'ECO'

MANUAL = 'MANUAL'

class homematicip.base.enums.ConnectionType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

HMIP_LAN = 'HMIP_LAN'

HMIP_RF = 'HMIP_RF'

HMIP_WIRED = 'HMIP_WIRED'

HMIP_WLAN = 'HMIP_WLAN'

class homematicip.base.enums.ContactType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

NORMALLY_CLOSE = 'NORMALLY_CLOSE'

NORMALLY_OPEN = 'NORMALLY_OPEN'

class homematicip.base.enums.DeviceType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

ACCELERATION_SENSOR = 'ACCELERATION_SENSOR'

ALARM_SIREN_INDOOR = 'ALARM_SIREN_INDOOR'

ALARM_SIREN_OUTDOOR = 'ALARM_SIREN_OUTDOOR'

BLIND_MODULE = 'BLIND_MODULE'

BRAND_BLIND = 'BRAND_BLIND'

BRAND_DIMMER = 'BRAND_DIMMER'

BRAND_PUSH_BUTTON = 'BRAND_PUSH_BUTTON'

BRAND_SHUTTER = 'BRAND_SHUTTER'

BRAND_SWITCH_MEASURING = 'BRAND_SWITCH_MEASURING'

BRAND_SWITCH_NOTIFICATION_LIGHT = 'BRAND_SWITCH_NOTIFICATION_LIGHT'

BRAND_WALL_MOUNTED_THERMOSTAT = 'BRAND_WALL_MOUNTED_THERMOSTAT'

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'

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_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'

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_THERMOSTAT_BASIC_HUMIDITY = 'WALL_MOUNTED_THERMOSTAT_BASIC_HUMIDITY'

WALL_MOUNTED_THERMOSTAT_PRO = 'WALL_MOUNTED_THERMOSTAT_PRO'

WATER_SENSOR = 'WATER_SENSOR'

WEATHER_SENSOR = 'WEATHER_SENSOR'

WEATHER_SENSOR_PLUS = 'WEATHER_SENSOR_PLUS'

WEATHER_SENSOR_PRO = 'WEATHER_SENSOR_PRO'

WIRED_DIMMER_3 = 'WIRED_DIMMER_3'

WIRED_INPUT_32 = 'WIRED_INPUT_32'

WIRED_SWITCH_8 = 'WIRED_SWITCH_8'

class homematicip.base.enums.DeviceUpdateState(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

AUTOMATICALLY_IF_POSSIBLE = 'AUTOMATICALLY_IF_POSSIBLE'

MANUALLY = 'MANUALLY'

class homematicip.base.enums.DoorCommand(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

CLOSE = 'CLOSE'

OPEN = 'OPEN'

PARTIAL_OPEN = 'PARTIAL_OPEN'

STOP = 'STOP'

class homematicip.base.enums.DoorState(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

CLOSED = 'CLOSED'

OPEN = 'OPEN'

POSITION_UNKNOWN = 'POSITION_UNKNOWN'

VENTILATION_POSITION = 'VENTILATION_POSITION'

class homematicip.base.enums.DriveSpeed(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

CREEP_SPEED = 'CREEP_SPEED'

NOMINAL_SPEED = 'NOMINAL_SPEED'

OPTIONAL_SPEED = 'OPTIONAL_SPEED'

SLOW_SPEED = 'SLOW_SPEED'

class homematicip.base.enums.EcoDuration(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

FOUR = 'FOUR'

ONE = 'ONE'

PERMANENT = 'PERMANENT'

SIX = 'SIX'

TWO = 'TWO'

class homematicip.base.enums.EventType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

CLIENT_ADDED = 'CLIENT_ADDED'

CLIENT_CHANGED = 'CLIENT_CHANGED'

CLIENT_REMOVED = 'CLIENT_REMOVED'

DEVICE_ADDED = 'DEVICE_ADDED'

DEVICE_CHANGED = 'DEVICE_CHANGED'

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

ACCELERATION_SENSOR_CHANNEL = 'ACCELERATION_SENSOR_CHANNEL'

ACCESS_CONTROLLER_CHANNEL = 'ACCESS_CONTROLLER_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'

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_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'

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'

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'

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'

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

ACCESS_CONTROL = 'ACCESS_CONTROL'

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

ALARM_SWITCHING = 'ALARM_SWITCHING'

ENVIRONMENT = 'ENVIRONMENT'

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'

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

INVISIBLE_CONTROL = 'INVISIBLE_CONTROL'

INVISIBLE_GROUP_AND_CONTROL = 'INVISIBLE_GROUP_AND_CONTROL'

VISIBLE = 'VISIBLE'

class homematicip.base.enums.HeatingFailureValidationType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

HEATING_FAILURE_ALARM = 'HEATING_FAILURE_ALARM'

HEATING_FAILURE_WARNING = 'HEATING_FAILURE_WARNING'

NO_HEATING_FAILURE = 'NO_HEATING_FAILURE'

class homematicip.base.enums.HeatingLoadType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

LOAD_BALANCING = 'LOAD_BALANCING'

LOAD_COLLECTION = 'LOAD_COLLECTION'

class homematicip.base.enums.HeatingValveType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

NORMALLY_CLOSE = 'NORMALLY_CLOSE'

NORMALLY_OPEN = 'NORMALLY_OPEN'

class homematicip.base.enums.HomeUpdateState(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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.MotionDetectionSendInterval(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

SECONDS_120 = 'SECONDS_120'

SECONDS_240 = 'SECONDS_240'

SECONDS_30 = 'SECONDS_30'

SECONDS_480 = 'SECONDS_480'

SECONDS_60 = 'SECONDS_60'

class homematicip.base.enums.MultiModeInputMode(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

BINARY_BEHAVIOR = 'BINARY_BEHAVIOR'

KEY_BEHAVIOR = 'KEY_BEHAVIOR'

SWITCH_BEHAVIOR = 'SWITCH_BEHAVIOR'

class homematicip.base.enums.NotificationSoundType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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.PassageDirection(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

LEFT = 'LEFT'

RIGHT = 'RIGHT'

class homematicip.base.enums.ProfileMode(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

AUTOMATIC = 'AUTOMATIC'

MANUAL = 'MANUAL'

class homematicip.base.enums.RGBColorState(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

BLACK = 'BLACK'

BLUE = 'BLUE'

GREEN = 'GREEN'

PURPLE = 'PURPLE'

RED = 'RED'

TURQUOISE = 'TURQUOISE'

WHITE = 'WHITE'

YELLOW = 'YELLOW'

class homematicip.base.enums.SecurityEventType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

BOTTOM = 'BOTTOM'

CENTER = 'CENTER'

LEFT = 'LEFT'

NOT_USED = 'NOT_USED'

RIGHT = 'RIGHT'

SPLIT = 'SPLIT'

TDBU = 'TDBU'

TOP = 'TOP'

class homematicip.base.enums.ShadingStateType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

IDLE_OFF = 'IDLE_OFF'

INTRUSION_ALARM = 'INTRUSION_ALARM'

PRIMARY_ALARM = 'PRIMARY_ALARM'

SECONDARY_ALARM = 'SECONDARY_ALARM'

class homematicip.base.enums.ValveState(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

MOISTURE_DETECTION = 'MOISTURE_DETECTION'

NO_ALARM = 'NO_ALARM'

WATER_DETECTION = 'WATER_DETECTION'

WATER_MOISTURE_DETECTION = 'WATER_MOISTURE_DETECTION'

class homematicip.base.enums.WeatherCondition(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

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(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

DAY = 'DAY'

NIGHT = 'NIGHT'

TWILIGHT = 'TWILIGHT'

class homematicip.base.enums.WindValueType(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

AVERAGE_VALUE = 'AVERAGE_VALUE'

CURRENT_VALUE = 'CURRENT_VALUE'

MAX_VALUE = 'MAX_VALUE'

MIN_VALUE = 'MIN_VALUE'

class homematicip.base.enums.WindowState(*args, **kwds)

Bases: homematicip.base.enums.AutoNameEnum

An enumeration.

CLOSED = 'CLOSED'

OPEN = 'OPEN'

TILTED = 'TILTED'

homematicip.base.functionalChannels module

class homematicip.base.functionalChannels.AccelerationSensorChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the ACCELERATION_SENSOR_CHANNEL 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, groups: Iterable[homematicip.group.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 = None

type: NotificationSoundType

notificationSoundTypeLowToHigh = None

type: NotificationSoundType

class homematicip.base.functionalChannels.AccessControllerChannel

Bases: homematicip.base.functionalChannels.DeviceBaseChannel

this is the representative of the ACCESS_CONTROLLER_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the ALARM_SIREN_CHANNEL channel

class homematicip.base.functionalChannels.AnalogOutputChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the ANALOG_OUTPUT_CHANNEL channel

analogOutputLevel = None

the analog output level (Volt?)

Type:float

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the ANALOG_ROOM_CONTROL_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.ShutterChannel

this is the representative of the BLIND_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the CHANGE_OVER_CHANNEL channel

class homematicip.base.functionalChannels.ClimateSensorChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the CLIMATE_SENSOR_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.ShutterContactChannel

this is the representative of the CONTACT_INTERFACE_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the DEHUMIDIFIER_DEMAND_CHANNEL channel

class homematicip.base.functionalChannels.DeviceBaseChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the DEVICE_BASE channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.DeviceBaseChannel

this is the representative of the DEVICE_BASE_FLOOR_HEATING channel

from_json(js, groups: Iterable[homematicip.group.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.DeviceGlobalPumpControlChannel

Bases: homematicip.base.functionalChannels.DeviceBaseChannel

this is the representative of the DEVICE_GLOBAL_PUMP_CONTROL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.DeviceBaseChannel

this is the representative of the DEVICE_INCORRECT_POSITIONED channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.DeviceBaseChannel

this is the representative of the DEVICE_OPERATIONLOCK channel

from_json(js, groups: Iterable[homematicip.group.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.DevicePermanentFullRxChannel

Bases: homematicip.base.functionalChannels.DeviceBaseChannel

this is the representative of the DEVICE_PERMANENT_FULL_RX channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.DeviceSabotageChannel

this is the representative of the DEVICE_RECHARGEABLE_WITH_SABOTAGE channel

badBatteryHealth = None

is the battery in a bad condition

Type:bool

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.DeviceBaseChannel

this is the representative of the DEVICE_SABOTAGE channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the DIMMER_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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.DoorChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the DoorChannel channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the FLOOR_TERMINAL_BLOCK_CHANNEL channel

class homematicip.base.functionalChannels.FloorTerminalBlockLocalPumpChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the FLOOR_TERMINAL_BLOCK_LOCAL_PUMP_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

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

from_json(js, groups: Iterable[homematicip.group.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 = None

the current valve state

Type:ValveState

class homematicip.base.functionalChannels.FunctionalChannel

Bases: homematicip.base.HomeMaticIPObject.HomeMaticIPObject

this is the base class for the functional channels

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the GENERIC_INPUT_CHANNEL channel

class homematicip.base.functionalChannels.HeatDemandChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the HEAT_DEMAND_CHANNEL channel

class homematicip.base.functionalChannels.HeatingThermostatChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the HEATING_THERMOSTAT_CHANNEL channel

automaticValveAdaptionNeeded = None

must the adaption re-run?

Type:bool

from_json(js, groups: Iterable[homematicip.group.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 = 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.base.functionalChannels.InternalSwitchChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the INTERNAL_SWITCH_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the LIGHT_SENSOR_CHANNEL channel

averageIllumination = None

the average illumination value

Type:float

currentIllumination = None

the current illumination value

Type:float

from_json(js, groups: Iterable[homematicip.group.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 = None

the highest illumination value

Type:float

lowestIllumination = None

the lowest illumination value

Type:float

class homematicip.base.functionalChannels.MainsFailureChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the MAINS_FAILURE_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the MOTION_DETECTION_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.BlindChannel

this is the representative of the MULTI_MODE_INPUT_BLIND_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the MULTI_MODE_INPUT_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the MULTI_MODE_INPUT_DIMMER_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the MULTI_MODE_INPUT_SWITCH_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.DimmerChannel

this is the representative of the NOTIFICATION_LIGHT_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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 = None

is the light turned on?

Type:boolean

simpleRGBColorState = None

the color of the light

Type:RGBColorState

class homematicip.base.functionalChannels.PassageDetectorChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the PASSAGE_DETECTOR_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the PRESENCE_DETECTION_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the TILT_VIBRATION_SENSOR_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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 = None

type: float

raining = None

type: bool

class homematicip.base.functionalChannels.RotaryHandleChannel

Bases: homematicip.base.functionalChannels.ShutterContactChannel

this is the representative of the ROTARY_HANDLE_CHANNEL channel

class homematicip.base.functionalChannels.ShadingChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the SHADING_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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.ShutterChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the SHUTTER_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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.ShutterContactChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the SHUTTER_CONTACT_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the SINGLE_KEY_CHANNEL channel

class homematicip.base.functionalChannels.SmokeDetectorChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the SMOKE_DETECTOR_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the SWITCH_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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.SwitchMeasuringChannel

Bases: homematicip.base.functionalChannels.SwitchChannel

this is the representative of the SWITCH_MEASURING_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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.TemperaturDifferenceSensor2Channel(connection)

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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 = None

type: float

temperatureExternalOne = None

type: float

temperatureExternalTwo = None

type: float

class homematicip.base.functionalChannels.TiltVibrationSensorChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the TILT_VIBRATION_SENSOR_CHANNEL channel

accelerationSensorEventFilterPeriod = None

type: float

accelerationSensorMode = None

type: AccelerationSensorMode

accelerationSensorSensitivity = None

type: AccelerationSensorSensitivity

accelerationSensorTriggerAngle = None

type: int

accelerationSensorTriggered = None

type: bool

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.WallMountedThermostatWithoutDisplayChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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.WallMountedThermostatWithoutDisplayChannel

Bases: homematicip.base.functionalChannels.ClimateSensorChannel

this is the representative of the WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the WATER_SENSOR_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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.WeatherSensorChannel

Bases: homematicip.base.functionalChannels.FunctionalChannel

this is the representative of the WEATHER_SENSOR_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.WeatherSensorChannel

this is the representative of the WEATHER_SENSOR_PLUS_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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

Bases: homematicip.base.functionalChannels.WeatherSensorPlusChannel

this is the representative of the WEATHER_SENSOR_PRO_CHANNEL channel

from_json(js, groups: Iterable[homematicip.group.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=<RegexFlag.IGNORECASE: 2>)

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