Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcsowen/homebridge-homematicip

Homematic IP plugin for homebridge
https://github.com/marcsowen/homebridge-homematicip

Last synced: about 1 month ago
JSON representation

Homematic IP plugin for homebridge

Awesome Lists containing this project

README 

        
# homebridge-homematicip



[![npm](https://img.shields.io/npm/v/homebridge-homematicip.svg?style=plastic)](https://www.npmjs.com/package/homebridge-homematicip)

[![npm](https://img.shields.io/npm/dt/homebridge-homematicip.svg?style=plastic)](https://www.npmjs.com/package/homebridge-homematicip)

[![GitHub last commit](https://img.shields.io/github/last-commit/marcsowen/homebridge-homematicip.svg?style=plastic)](https://github.com/marcsowen/homebridge-homematicip)

![GitHub build](https://img.shields.io/github/actions/workflow/status/marcsowen/homebridge-homematicip/main.yml?style=plastic)



## Homematic IP platform plugin for homebridge



Uses the unofficial HTTP API and WebSockets for continuous channel updates.



Add one (or more) Homematic IP Access Points to config.json. There are two configuration

options that you can set:



```

{

    "platform": "HomematicIP",

    "name": "HomematicIP",

    "access_point": "",

    "auth_token": ""

}

```



The Access Point ID is printed on the back of your Homematic IP Access Point (HmIP-HAP) and is

labeled as "SGTIN", e.g. 3014-xxxx-xxxx-xxxx-xxxx-xxxx.



### Pairing



```

{

    "platform": "HomematicIP",

    "name": "HomematicIP",

    "access_point": "",

    "pin": ""

}

```



If you do not have an auth_token or don't know it, leave it empty. Be sure to add the "pin" property if it is set in the app.

After startup, watch the logs and wait for "Press blue, glowing link button of HmIP Access Point now!". Then press the

button and note the "auth_token" that is being generated, add it to your config.json, remove the pin and restart.



### Additional config



See [Wiki](https://github.com/marcsowen/homebridge-homematicip/wiki) for details.



## Currently supported devices



- HmIP-HAP Access point

- HmIP-eTRV Radiator thermostat

- HmIP-eTRV-2 Radiator thermostat

- HmIP-eTRV-B Radiator thermostat - basic

- HmIP-eTRV-C Heating thermostat - compact without display

- HmIP-eTRV-CL Heating thermostat - compact plus with display

- HmIP-eTRV-E Radiator thermostat - Evo

- HmIP-FROLL Shutter actuator - flush-mount

- HmIP-BROLL Shutter actuator - brand-mount

- HmIP-FBL Blind actuator - flush-mount

- HmIP-BBL Blind actuator - brand-mount

- HmIP-WTH Wall thermostat

- HmIP-WTH-2 Wall thermostat with humidity sensor

- HmIP-BWTH Brand wall thermostat with humidity sensor

- HmIP-WTH-B Wall thermostat – basic

- ALPHA-IP-RBG Alpha IP wall thermostat display

- HmIP-STH Temperature and humidity sensor without display - indoor

- HmIP-STHD Temperature and humidity sensor with display - indoor

- HmIP-SWDO Door / window contact - optical

- HmIP-SWDO-I Door / window contact - optical, invisible

- HmIP-SWDO-PL Door / window contact – optical, plus

- HmIP-SWDM / HMIP-SWDM-B2 Door / window Contact - magnetic

- HmIP-SCI Contact interface sensor

- HmIP-SRH Rotary handle switch

- HmIP-SWSD Smoke detector

- HmIP-PS Pluggable switch

- HmIP-PCBS Switch circuit board - 1 channel

- HmIP-PCBS-BAT Printed circuit board switch battery

- HmIP-PCBS2 Switch circuit board - 2x channels

- HmIP-MOD-OC8 Open collector module

- HmIP-WHS2 Switch actuator for heating systems – 2x channels

- HmIPW-DRS8 Wired switch actuator – 8x channels

- HmIPW-DRS4 Wired switch actuator – 4x channels

- HmIP-BS2 Brand switch - 2x channels

- HmIP-DRSI4 Switch actuator for DIN rail mount – 4x channels

- HmIP-PSM Pluggable switch and meter

- HmIP-BSM Brand switch and meter

- HmIP-FSM, HmIP-FSM16 Full flush switch and meter

- HmIP-FSI16 full flush switch (16A)

- HmIP-MOD-TM Garage door module - Tormatic

- HmIP-MOD-HO Garage door module - Hörmann

- HmIP-WGC Wall mounted garage door controller

- HmIP-SWD Water sensor

- HmIP-SLO Light sensor outdoor

- HmIP-SMI Motion detector with brightness sensor - indoor

- HmIP-SMO-A Motion detector with brightness sensor - outdoor

- HmIP-SMI55 Motion detector with brightness sensor and remote control - 2-button

- HmIP-SPI Presence sensor - indoor

- HmIP-PDT Pluggable dimmer

- HmIP-BDT Brand dimmer

- HmIP-FDT Dimming actuator flush-mount

- HmIPW-DRD3 Wired dimming actuator – 3x channels [1]

- HmIP-DRDI3 DIN rail dimming actuator (multichannel)

- HmIP-DLD Door lock drive [2]

- HmIP-DLS Door lock sensor

- HmIP-BSL Notification light switch

- HmIP-SWO-B Smart weather sensor - basic

- HmIP-SWO-PL Smart weather sensor - plus

- HmIP-SWO-PR Smart weather sensor - pro

- HMIP-WRC2 Homematic IP button - 2 channels

- HMIP-WRC6 Homematic IP button - 6 channels

- HMIP-BRC2 Homematic IP brand button - 2 channels

- HMIP-WRCC2 Homematic IP flat button - 2 channels



[1] Currently, only first channel is supported.


[2] Please make sure homebridge-homematicip is added to the list of access control clients in HmIP app settings.



## TODOs



- Implement more devices

- Implement META-Group (Homematic IP rooms) to HomeKit room-Mapping

- Implement custom characteristics (Actuator) for Radiator Thermostats (e.g. to be used in Eve App)



## Many thanks to our contributors



- @coreGreenberet for reverse-engineering and implementation of the first HomematicIP-API client using Python

  (https://github.com/coreGreenberet/homematicip-rest-api)

- @dmalch for adding fakegato-history support (https://github.com/simont77/fakegato-history)

- @smhex for HmIP-DLS, HmIP-BSL and HmIP-DRDI3 support

- @ohueter for thermostat/climate sensor config option

- @aceg1k for improvements in thermostat heating/cooling state handling and API call handling

- @gkminix for HmIP-FSI16 support



## Help needed!