All Projects → coreGreenberet → Homematicip Rest Api

coreGreenberet / Homematicip Rest Api

Licence: gpl-3.0
A python wrapper for the homematicIP REST API (Access Point Based)

Programming Languages

python
139335 projects - #7 most used programming language
python3
1442 projects

Projects that are alternatives of or similar to Homematicip Rest Api

Domonit
A Deadly Simple Docker Monitoring Wrapper For Docker API
Stars: ✭ 67 (-50.37%)
Mutual labels:  python-wrapper, cloud
Opencensus Erlang
A stats collection and distributed tracing framework
Stars: ✭ 131 (-2.96%)
Mutual labels:  cloud
Backup Manager
Database backup manager for dumping to and restoring databases from S3, Dropbox, FTP, SFTP, and Rackspace Cloud
Stars: ✭ 1,589 (+1077.04%)
Mutual labels:  cloud
Paas Profiles
Making Platform as a Service offerings comparable - Ecosystem profiles for portability matching.
Stars: ✭ 127 (-5.93%)
Mutual labels:  cloud
Watsonwebserver
Watson is the fastest, easiest way to build scalable RESTful web servers and services in C#.
Stars: ✭ 125 (-7.41%)
Mutual labels:  cloud
Keylime
A CNCF Project to Bootstrap & Maintain Trust on the Edge / Cloud and IoT
Stars: ✭ 128 (-5.19%)
Mutual labels:  cloud
Training
Container, Monitoring & Logging, Cloud & DevOps Tutorials and Labs
Stars: ✭ 121 (-10.37%)
Mutual labels:  cloud
Cloudinary ios
Cloudinary iOS SDK
Stars: ✭ 133 (-1.48%)
Mutual labels:  cloud
Stackset Controller
Opinionated StackSet resource for managing application life cycle and traffic switching in Kubernetes
Stars: ✭ 130 (-3.7%)
Mutual labels:  cloud
K8s
Kubernetes Helm Charts for the ORY ecosystem.
Stars: ✭ 127 (-5.93%)
Mutual labels:  cloud
Py Solc
Python wrapper around the solc Solidity compiler.
Stars: ✭ 126 (-6.67%)
Mutual labels:  python-wrapper
Hydra
OpenID Certified™ OpenID Connect and OAuth Provider written in Go - cloud native, security-first, open source API security for your infrastructure. SDKs for any language. Compatible with MITREid.
Stars: ✭ 11,884 (+8702.96%)
Mutual labels:  cloud
Couchdb Documentation
Apache CouchDB Documentation
Stars: ✭ 128 (-5.19%)
Mutual labels:  cloud
Core
Cloud Robotics Core: Kubernetes, Federation, App Management
Stars: ✭ 125 (-7.41%)
Mutual labels:  cloud
Kubicorn
kubicorn is a free and open source project that solves the Kubernetes infrastructure problem and gives users a rich golang library to work with infrastructure.
Stars: ✭ 1,671 (+1137.78%)
Mutual labels:  cloud
Awsprocesscreds
Process credential providers for AWS SDKs and Tools
Stars: ✭ 123 (-8.89%)
Mutual labels:  cloud
Opencensus Csharp
Distributed tracing and stats collecting framework
Stars: ✭ 126 (-6.67%)
Mutual labels:  cloud
Facepunch.steamworks
Another fucking c# Steamworks implementation
Stars: ✭ 1,945 (+1340.74%)
Mutual labels:  cloud
Aws Cli
Universal Command Line Interface for Amazon Web Services
Stars: ✭ 11,804 (+8643.7%)
Mutual labels:  cloud
Gpu monitor
Monitor your GPUs whether they are on a single computer or in a cluster
Stars: ✭ 133 (-1.48%)
Mutual labels:  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.

Any help from the community thru e.g. Pull Request would be highly appreciated.

|discord| |CircleCI| |Docs| |PyPi| |python-version| |codecov| |requirements| |Average time to resolve an issue| |commits-since-latest-release| |donate-paypal| |commit-activity|

Documentation

Documentation can be found under https://homematicip-rest-api.readthedocs.io

Installation

Just run pip install -U homematicip to get the package

"Nightly" Builds

each push on the master branch will trigger a build. That way you can test the latest version of the library with your systems. Just run pip install -U homematicip --pre 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 accessible 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

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

Homematic IP Devices:

  • [X] ALPHA-IP-RBG (Alpha IP Wall Thermostat Display)
  • [X] ALPHA-IP-RBGa (ALpha IP Wall Thermostat Display analog)
  • [X] HMIP-ASIR (Alarm Siren - indoor)
  • [X] HMIP-ASIR-B1 (Alarm Siren - indoor) Silvercrest Edition
  • [X] HMIP-ASIR-2 (Alarm Siren2 - indoor) New Version
  • [X] HMIP-ASIR-O (Alarm Siren - outdoor)
  • [X] HMIP-BBL (Blind Actuator for brand switches)
  • [X] HMIP-BDT (Dimming Actuator for brand switches)
  • [X] HMIP-BRC2 (Remote Control for brand switches – 2x channels)
  • [X] HMIP-BROLL (Shutter Actuator - brand-mount)
  • [X] HMIP-BSL (Switch Actuator for brand switches – with signal lamp)
  • [X] HMIP-BSM (Brand Switch and Meter Actuator)
  • [X] HMIP-BWTH (Wall Thermostat Display with switching output – for brand switches, 230V)
  • [ ] HMIP-BWTH24 (Wall Thermostat Display with switching output – for brand switches, 24V)
  • [ ] HMIP-DBB (Doorbell Push-Button)
  • [X] HMIP-DRBLI4 (Blind Actuator for DIN rail mount – 4 channels)
  • [X] HMIP-DRSI1 (Switch Actuator for DIN rail mount – 1x channel)
  • [ ] HMIP-DRDI3 (Dimming Actuator Inbound 230V – 3x channels, 200W per channel) electrical DIN rail
  • [X] HMIP-DRSI4 (Switch Actuator for DIN rail mount – 4x channels)
  • [ ] HMIP-DSD-PCB (Door Signal Dector PCB)
  • [X] HMIP-eTRV (Heating-Thermostat with Display)
  • [X] HMIP-eTRV2 (Heating-Thermostat with Display) New Version
  • [ ] HMIP-eTRV-2-UK (UK Version not tested, but it should work)
  • [X] HMIP-eTRV-B (Heating-Thermostat basic with Display)
  • [ ] HMIP-eTRV-B-UK (UK Version not tested, but it should work)
  • [X] HMIP-eTRV-B1 (Heating-Thermostat basic with Display) Silvercrest Edition
  • [X] HMIP-eTRV-C (Heating-thermostat compact without display)
  • [X] HMIP-FAL230-C6 (Floor Heating Actuator – 6x channels, 230V)
  • [X] HMIP-FAL230-C10 (Floor Heating Actuator – 10x channels, 230V)
  • [X] HMIP-FAL24-C6 (Floor Heating Actuator – 6x channels, 24V)
  • [X] HMIP-FAL24-C10 (Floor Heating Actuator – 10x channels, 24V)
  • [X] HMIP-FALMOT-C12 (Floor Heating Actuator – 12x channels, motorised)
  • [X] HMIP-FBL (Blind Actuator - flush-mount)
  • [X] HMIP-FCI1 (Contact Interface flush-mount – 1x channel)
  • [X] HMIP-FCI6 (Contact Interface flush-mount – 6x channels)
  • [X] HMIP-FDT (Dimming Actuator - flush-mount)
  • [X] HMIP-FROLL (Shutter Actuator - flush-mount)
  • [X] HMIP-FSM (Switch Actuator and Meter 5A – flush-mount)
  • [X] HMIP-FSM16 (Switch Actuator and Meter 16A – flush-mount)
  • [X] HMIP-FSI16 (Switch Actuator with Push-button Input 230V, 16A)
  • [X] HMIP-HAP (Cloud Access Point)
  • [X] HMIP-HAP-B1 (Cloud Access Point) Silvercrest Edition
  • [X] HMIP-HDM1 (Hunter Douglas & erfal window blinds)
  • [ ] HMIP-K-DRBLI4 (Blinds Actuator – 4x channels, 230V, 2,2A / 500W per channel) electrical DIN rail
  • [ ] HMIP-K-DRSI1 (Actuator Inbound 230V – 1x channel) electrical DIN rail
  • [ ] HMIP-K-DRDI3 (Dimming Actuator Inbound 230V – 3x channels, 200W per channel) electrical DIN rail
  • [ ] HMIP-K-DRSI4 (Swich Actuator – 4x channels, 16A per channel) electrical DIN rail
  • [X] HMIP-KRCA (Key Ring Remote Control & Alarm)
  • [X] HMIP-KRC4 (Key Ring Remote Control - 4x buttons)
  • [ ] HMIP-MIO16-PCB (Multi Analog/Digitial Interface - Switch Circuit Board)
  • [X] HMIP-MIOB (Multi IO Box for floor heating & cooling)
  • [X] HMIP-MOD-HO (Garage Door Module for Hörmann)
  • [X] HMIP-MOD-OC8 (Open Collector Module Receiver - 8x)
  • [X] HMIP-MOD-RC8 (Open Collector Module Sender - 8x)
  • [X] HMIP-MOD-TM (Garage Door Module for Novoferm and Tormatic door operators)
  • [ ] HMIP-MP3P (Combination Signalling Device MP3)
  • [X] HMIP-PCBS (Switch Circuit Board - 1x channel)
  • [X] HMIP-PCBS2 (Switch Circuit Board - 2x channels)
  • [X] HMIP-PCBS-BAT (Switch Circuit Board with Battery - 1x channel)
  • [X] HMIP-PDT (Plugable Dimmer)
  • [ ] HMIP-PDT-UK (UK Version not tested, but it should work)
  • [X] HMIP-PMFS (Plugable Power Supply Monitoring)
  • [X] HMIP-PS (Plugable Switch)
  • [X] HMIP-PSM (Plugable Switch Measuring, Type F - Standard for Homematic)
  • [ ] HMIP-PSM-CH (Type J not tested, but it should work)
  • [ ] HMIP-PSM-IT (Type L not tested, but it should work)
  • [ ] HMIP-PSM-PE (Type E not tested, but it should work)
  • [ ] HMIP-PSM-UK (Type G not tested, but it should work)
  • [X] HMIP-RC8 (Remote Control - 8x buttons)
  • [ ] HMIP-RCB1 (Remote Control - 1x button)
  • [X] HMIP-SAM (Acceleration Sensor)
  • [X] HMIP-SCI (Contact Interface Sensor)
  • [ ] HMIP-SCTH230 (CO2, Temperature and Humidity Sensor 230V)
  • [ ] HMIP-SFD (Fine Dust Sensor)
  • [X] HMIP-SLO (Light Sensor - outdoor)
  • [X] HMIP-SMI (Motion Detector with Brightness Sensor - indoor)
  • [X] HMIP-SMI55 (Motion Detector with Brightness Sensor and Remote Control - 2x buttons)
  • [X] HMIP-SMO (Motion Detector with Brightness Sensor - outdoor)
  • [X] HMIP-SMO-A (Motion Detector with Brightness Sensor - outdoor, anthracite)
  • [X] HMIP-SPDR (Passage Sensor with Direction Recognition)
  • [X] HMIP-SPI (Presence Sensor - indoor)
  • [X] HMIP-SRH (Window Rotary Handle Sensor)
  • [X] HMIP-SRD (Rain 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-STHO-A (Temperature and Humidity Sensor – outdoor, anthracite)
  • [X] HMIP-STV (Inclination and vibration Sensor)
  • [X] HMIP-SWD (Water Sensor)
  • [X] HMIP-SWDM (Door / Window Contact - magnetic)
  • [X] HMIP-SWDM-B2 (Door / Window Contact - magnetic) Silvercrest Edition
  • [X] HMIP-SWDO (Shutter Contact)
  • [X] HMIP-SWDO-I (Shutter Contact Invisible)
  • [X] HMIP-SWDO-PL (Shutter Contact Plus)
  • [X] HMIP-SWO-B (Weather Sensor - Basic)
  • [X] HMIP-SWO-PL (Weather Sensor – Plus)
  • [X] HMIP-SWO-PR (Weather Sensor – Pro)
  • [X] HMIP-SWSD (Smoke Detector)
  • [ ] HMIP-USBSM (USB Switching Measurement Actuator)
  • [ ] HMIP-WGC (Garage Door Button)
  • [X] HMIP-WHS2 (Switch Actuator for heating systems – 2x channels)
  • [ ] HMIP-WLAN-HAP (WLAN Access Point)
  • [X] HMIP-WRC2 (Wall-mount Remote Control - 2x buttons)
  • [X] HMIP-WRC6 (Wall-mount Remote Control - 6x buttons)
  • [X] HMIP-WRCC2 (Wall-mount Remote Control – flat)
  • [ ] HMIP-WRCD (Wall-mount Remote Control - E-Paper-Status display)
  • [ ] HMIP-WRCR (Wall-mount Remote Control - Rotary)
  • [ ] HMIP-WT (Wall Mounted Thermostat without adjusting wheel) #probably only prototype for WTH-B and was not released
  • [X] HMIP-WTH (Wall Mounted Thermostat Pro with Display)
  • [X] HMIP-WTH-2 (Wall Mounted Thermostat Pro with Display) New Version
  • [X] HMIP-WTH-B (Wall Mounted Thermostat basic without adjusting wheel)

Homematic IP Wired Devices (no radio signal):

  • [X] HMIPW-DRAP (Homematic IP Wired Access Point)
  • [ ] HMIPW-BRC2 (Homematic IP Wired Remote Control for brand switches – 2x channels)
  • [ ] HMIPW-DRBL4 (Homematic IP Wired Blinds Actuator – 4x channels)
  • [X] HMIPW-DRD3 (Homematic IP Wired Dimming Actuator – 3x channels)
  • [ ] HMIPW-DRS4 (Homematic IP Wired Switch Actuator – 4x channels)
  • [ ] HMIPW-DRI16 (Homematic IP Wired Inbound module – 16x channels)
  • [X] HMIPW-DRI32 (Homematic IP Wired Inbound module – 32x channels)
  • [X] HMIPW-DRS8 (Homematic IP Wired Switch Actuator – 8x channels)
  • [ ] HMIPW-FAL24-C6 (Homematic IP Wired Floor Heating Actuator – 6x channels, 24V)
  • [ ] HMIPW-FAL24-C10 (Homematic IP Wired Floor Heating Actuator – 10x channels, 24V)
  • [ ] HMIPW-FAL230-C6 (Homematic IP Wired Floor Heating Actuator – 6x channels, 230V)
  • [ ] HMIPW-FAL230-C10 (Homematic IP Wired Floor Heating Actuator – 10x channels, 230V)
  • [ ] HMIPW-FALMOT-C12 (Homematic IP Wired Floor Heating Actuator – 12x channels, motorised)
  • [ ] HMIPW-FIO6 (Homematic IP Wired IO Module flush-mount – 6x channels)
  • [ ] HMIPW-SMI55 (Homematic IP Wired Motion Detector with Brightness Sensor and Remote Control - 2x buttons)
  • [ ] HMIPW-SPI (Homematic IP Wired Presence Sensor - indoor)
  • [ ] HMIPW-STH (Homematic IP Wired Temperature and Humidity Sensor without display - indoor)
  • [ ] HMIPW-STHD (Homematic IP Wired Temperature and Humidity Sensor with display - indoor)
  • [ ] HMIPW-WRC2 (Homematic IP Wired Wall-mount Remote Control - 2x channels)
  • [ ] HMIPW-WTH (Homematic IP Wired Wall Mounted Thermostat Pro with Display)

Events

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

.. code:: python

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

.. |CircleCI| image:: https://circleci.com/gh/coreGreenberet/homematicip-rest-api.svg?style=shield :target: https://circleci.com/gh/coreGreenberet/homematicip-rest-api .. |PyPi| image:: https://badge.fury.io/py/homematicip.svg :target: https://badge.fury.io/py/homematicip .. |codecov| image:: https://codecov.io/gh/coreGreenberet/homematicip-rest-api/branch/master/graph/badge.svg :target: https://codecov.io/gh/coreGreenberet/homematicip-rest-api .. |Average time to resolve an issue| image:: http://isitmaintained.com/badge/resolution/coreGreenberet/homematicip-rest-api.svg :target: http://isitmaintained.com/project/coreGreenberet/homematicip-rest-api .. |commits-since-latest-release| image:: https://img.shields.io/github/commits-since/coreGreenberet/homematicip-rest-api/latest.svg .. |donate-paypal| image:: https://img.shields.io/badge/Donate-PayPal-green.svg :target: https://paypal.me/coreGreenberet .. |discord| image:: https://img.shields.io/discord/537253254074073088.svg?logo=discord&style=plastic :target: https://discord.gg/mZG2myJ .. |Docs| image:: https://readthedocs.org/projects/homematicip-rest-api/badge/?version=latest :target: https://homematicip-rest-api.readthedocs.io .. |requirements| image:: https://requires.io/github/coreGreenberet/homematicip-rest-api/requirements.svg?branch=master :target: https://requires.io/github/coreGreenberet/homematicip-rest-api/requirements/?branch=master .. |commit-activity| image:: https://img.shields.io/github/commit-activity/y/coreGreenberet/homematicip-rest-api.svg .. |python-version| image:: https://img.shields.io/pypi/pyversions/homematicip?style=plastic

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].