Giter VIP home page Giter VIP logo

homebridge-homematicip's Introduction

homebridge-homematicip

npm npm GitHub last commit GitHub build

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": "<your access point ID>",
    "auth_token": "<your API 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": "<your access point ID>",
    "pin": "<your PIN if set in the app>"
}

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 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-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 [1]
  • HmIP-MOD-OC8 Open collector module [1]
  • HmIP-WHS2 Switch actuator for heating systems – 2x channels [1]
  • HmIP-DRS8 Wired switch actuator – 8x channels [1]
  • HmIP-DRSI4 Switch actuator for DIN rail mount – 4x channels [1]
  • 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-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

[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

Help needed!

homebridge-homematicip's People

Contributors

aceg1k avatar dependabot[bot] avatar dmalch avatar gkminix avatar jhnvz avatar marcsowen avatar nsowen avatar ohueter avatar smhex avatar stefanschleich avatar svenlie avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.