Welcome to Homematic IP Rest API’s documentation!
This documentation is for a Python 3 wrapper for the homematicIP REST API (Access Point Based) Since there is no official documentation about this API everything was done via reverse engineering. Use at your own risk.
Getting started
API Documentation
- API Introduction
- homematicip
- homematicip package
- Subpackages
- Submodules
- homematicip.EventHook module
- homematicip.HomeMaticIPObject module
- homematicip.access_point_update_state module
- homematicip.auth module
- homematicip.class_maps module
- homematicip.client module
- homematicip.connection module
- homematicip.device module
AccelerationSensorAlarmSirenIndoorAlarmSirenOutdoorBaseDeviceBlindBlindModuleBrandBlindBrandDimmerBrandPushButtonBrandSwitch2BrandSwitchMeasuringBrandSwitchNotificationLightCarbonDioxideSensorContactInterfaceDaliGatewayDeviceDimmerDinRailBlind4DinRailDimmer3DinRailSwitchDinRailSwitch4DoorBellButtonDoorBellContactInterfaceDoorLockDriveDoorLockSensorDoorModuleEnergySensorsInterfaceExternalDeviceFloorTerminalBlock10FloorTerminalBlock12FloorTerminalBlock6FullFlushBlindFullFlushContactInterfaceFullFlushContactInterface6FullFlushDimmerFullFlushInputSwitchFullFlushShutterFullFlushSwitchMeasuringGarageDoorModuleTormaticHeatingSwitch2HeatingThermostatHeatingThermostatCompactHeatingThermostatEvoHoermannDrivesModuleHomeControlAccessPointKeyRemoteControl4KeyRemoteControlAlarmLightSensorMotionDetectorIndoorMotionDetectorOutdoorMotionDetectorPushButtonMultiIOBoxOpenCollector8ModuleOperationLockableDevicePassageDetectorPlugableSwitchPlugableSwitchMeasuringPluggableDimmerPluggableMainsFailureSurveillancePresenceDetectorIndoorPrintedCircuitBoardSwitch2PrintedCircuitBoardSwitchBatteryPushButtonPushButton6PushButtonFlatRainSensorRemoteControl8RemoteControl8ModuleRgbwDimmerRoomControlDeviceRoomControlDeviceAnalogRotaryHandleSensorSabotageDeviceShutterShutterContactShutterContactMagneticShutterContactOpticalPlusSmokeDetectorSwitchSwitchMeasuringTemperatureDifferenceSensor2TemperatureHumiditySensorDisplayTemperatureHumiditySensorOutdoorTemperatureHumiditySensorWithoutDisplayTiltVibrationSensorWallMountedGarageDoorControllerWallMountedThermostatBasicHumidityWallMountedThermostatProWaterSensorWeatherSensorWeatherSensorPlusWeatherSensorProWiredDimmer3WiredDinRailAccessPointWiredDinRailBlind4WiredFloorTerminalBlock12WiredInput32WiredInputSwitch6WiredMotionDetectorPushButtonWiredPushButtonWiredSwitch4WiredSwitch8
- homematicip.functionalHomes module
- homematicip.group module
AccessAuthorizationProfileGroupAccessControlGroupAlarmSwitchingGroupEnergyGroupEnvironmentGroupExtendedLinkedGarageDoorGroupExtendedLinkedShutterGroupExtendedLinkedSwitchingGroupGroupHeatingChangeoverGroupHeatingCoolingDemandBoilerGroupHeatingCoolingDemandGroupHeatingCoolingDemandPumpGroupHeatingCoolingPeriodHeatingCoolingProfileHeatingCoolingProfileDayHeatingDehumidifierGroupHeatingExternalClockGroupHeatingFailureAlertRuleGroupHeatingGroupHeatingHumidyLimiterGroupHeatingTemperatureLimiterGroupHotWaterGroupHumidityWarningRuleGroupInboxGroupIndoorClimateGroupLinkedSwitchingGroupLockOutProtectionRuleMetaGroupOverHeatProtectionRuleSecurityGroupSecurityZoneGroupShutterProfileShutterWindProtectionRuleSmokeAlarmDetectionRuleSwitchGroupBaseSwitchingGroupSwitchingProfileGroupTimeProfileTimeProfilePeriod
- homematicip.home module
- homematicip.location module
- homematicip.oauth_otk module
- homematicip.rule module
- homematicip.securityEvent module
AccessPointConnectedEventAccessPointDisconnectedEventActivationChangedEventExternalTriggeredEventMainsFailureEventMoistureDetectionEventOfflineAlarmEventOfflineWaterDetectionEventSabotageEventSecurityEventSecurityZoneEventSensorEventSilenceChangedEventSmokeAlarmEventWaterDetectionEvent
- homematicip.weather module
- Module contents
- homematicip package