homematicip 0.10.2

An API for the homematicip cloud

homematicip-rest-api

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.

Installation

Just run pip3 install -U homematicip to get the package

Usage

first run hmip_generate_auth_token.py (from the command line) to get an auth token for your access point. it will generate a “config.ini” in your current directory. The scripts will look for a config.ini in 3 different locations depending on your OS. Copy the file to one of these locations so that it will be accessable for the scripts.

• General

  • current working directory

• Windows

  • %APPDATA%\homematicip-rest-api

  • %PROGRAMDATA%\homematicip-rest-api

• Linux

  • ~/.homematicip-rest-api/

  • /etc/homematicip-rest-api/

• MAC OS

  • ~/Library/Preferences/homematicip-rest-api/

  • /Library/Application Support/homematicip-rest-api/

Examples

• hmip_cli.py for list devices,groups,securityJournal; set label, turn switches on/off

• Sample Projects are under https://github.com/coreGreenberet/homematicip-samples

Implemented Stuff

• [X] generate authentication token

• [X] Read current state of the Environment

• [X] Weather

• [X] Location

• [X] Basic Informations( apversion, pinAssigned, timeZone, … )

• [X] Devices (partly)

• [X] Client

• [X] Groups

Devices:

• [X] HMIP-ASIR (Alarm Siren)

• [X] HMIP-BROLL (Shutter Actuator - brand-mount)

• [X] HMIP-BSM (Brand Switch and Meter)

• [X] HMIP-BWTH (Brand Wall Mounted Thermostat Pro)

• [X] HMIP-eTRV, HMIP-eTRV2 (Heating-thermostat)

• [X] HMIP-FAL230-C6 (Floor Terminal Block)

• [X] HMIP-FDT (Dimming Actuator flush-mount)

• [X] HMIP-FROLL (Shutter Actuator - flush-mount)

• [X] HMIP-KRCA (Key Ring Remote Control & alarm)

• [X] HmIP-MOD-OC8 ( Open Collector Module )

• [X] HMIP-RC8 (Remote Control - 8 buttons)

• [X] HMIP-PCBS-BAT (Printed Curcuit Board Switch Battery)

• [X] HMIP-PDT (Pluggable Dimmer)

• [X] HMIP-PS (Plugable Switch)

• [X] HMIP-PSM (Plugable Switch Measuring)

• [X] HMIP-SMI (Motion Detector with Brightness Sensor - indoor)

• [X] HMIP-SMI55 (Motion Detector with Brightness Sensor and Remote Control - 2-button)

• [X] HmIP-SMO-A (Motion Detector with Brightness Sensor - outdoor)

• [X] HMIP-SPI (Precence Sensor - indoor)

• [X] HMIP-SRH (Rotary Handle Sensor)

• [X] HMIP-STH (Temperature and Humidity Sensor without display - indoor)

• [X] HMIP-STHD (Temperature and Humidity Sensor with display - indoor)

• [X] HMIP-STHO (Temperature and Humidity Sensor outdoor)

• [X] HMIP-SWD (Water Sensor)

• [X] HMIP-SWDO (Shutter Contact)

• [X] HMIP-SWDO-I (Shutter Contact Invisible)

• [X] HMIP-SWDM (Door / Window Contact - magnetic )

• [X] HMIP-SWDM-B2 (Door / Window Contact - magnetic )

• [X] HMIP-SWO-B (Weather Sensor)

• [X] HMIP-SWO-PR (Weather Sensor – pro)

• [X] HMIP-SWSD (Smoke Detector)

• [X] HMIP-WRC2 (Wall-mount Remote Control - 2-button)

• [X] HMIP-WRC6 (Wall-mount Remote Control - 6-button)

• [X] HMIP-WTH, HMIP-WTH-2 (Wall Mounted Thermostat Pro)

Events

It’s also possible to use push notifications based on a websocket connection

##initialize the api
#...
#get the home object
home = homematicip.Home()
#add a function to handle new events
home.onEvent += printEvents
#enable the event connection -> this will also start the websocket connection to the homeMaticIP Cloud
home.enable_events()


#example function to display incoming events
def printEvents(eventList):
    for event in eventList:
        print "EventType: {} Data: {}".format(event["eventType"], event["data"])

#if needed you can close the websocket connection with
home.disable_events()