Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-homematicip-svenlie

SvenLie33Apache-2.00.5.4-rc1

Homematic IP plugin for homebridge

homebridge-plugin, homekit, homematic, homematicip, hmip

readme

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.

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-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) (*)
  • HmIP-DRS8 (Homematic IP Wired Switch Actuator – 8x channels) (*)
  • HmIP-DRSI4 (Homematic IP 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-MOD-TM (Garage Door Module Tormatic)
  • HmIP-MOD-HO (Garage Door Module for 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 (Homematic IP Wired Dimming Actuator – 3x channels) (*)

(*) Currently, only first channel is supported.

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)
  • Implement custom EVE logging (https://github.com/simont77/fakegato-history)

Many thanks to coreGreenberet

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

Help needed!

changelog

0.5.1 (2021-07-29)

Bugfix

  • General: Version bumps for dependencies. Solves an issue with node-fetch for newer installations.

0.5.0 (2021-05-15)

Improvements

  • HmIP-STH/STHD: Device is now a thermostat instead of a simple climate sensor. The target temperature is usually extracted from the device channel. In case of the HmIP-STH the target temperature is determined from the heating group since the device channel doesn't provide this kind of information.
  • General: Log messages contain a unit symbol where applicable.
  • General: Removed now long-running Hclean-up code for obsolete services and characteristics

0.4.3 (2021-03-23)

Bugfix

  • Dimmer: Fixed turning dimmer on with Siri.

0.4.2 (2021-03-23)

Bugfix

  • Dimmer: Fixed "flashing" of dimmer while changing dim level.

0.4.1 (2021-03-21)

New devices

  • Dimmer: Added dimmer devices: HmIP-PDT, HmIP-BDT, HmIP-FDT, HmIPW-DRD3

0.4.0 (2021-03-19)

New devices

  • MotionDetector: Added motion detector style devices: HmIP-SMI, HmIP-SMO-A, HmIP-SMI55
  • PresenceDetector: Added presence detector: HmIP-SPI

0.3.7 (2021-03-13)

Bugfix

  • General: Fixed tampered state mapping.

0.3.6 (2021-03-13)

Improvements

  • ContactSensor: Added sabotage state (tampered state) for contact sensors which support it.

Bugfix

  • General: Fixed low battery display for all devices with sabotage channel.

0.3.5 (2021-03-13)

Improvements

  • SmokeDetector: Removed obsolete tampered characteristic.

0.3.4 (2021-03-13)

Bugfix

  • General: Prevent warning messages about missing characteristics.

0.3.3 (2021-03-13)

Improvements

  • General: Removed obsolete battery services and characteristics.

0.3.2 (2021-03-13)

Improvements

  • ContactSensor: Removed obsolete current door state characteristic.

0.3.1 (2021-03-13)

Improvements

  • ContactSensor: Removed additional "window" service which prevents display of two window sensors when there is only one.
  • RotaryHandleSensor: Use window service for the rotary handle sensor exclusively. Removed contact service for this device.

0.3.0 (2021-02-28)

New devices

  • SecuritySystem: Added security system including internal and external alarm zones. This is definitely beta, so please don't trust the alarm to go off inside HomeKit. Also check the HomematicIP app to be sure the right alarm setting is applied.

Improvements

  • ContactSensor: Added "window" service to contact sensor. The window service supports "tilted" windows by displaying a current position of 50%.
  • General: Only add battery service if device actually has a battery.
  • General: Removed now optional characteristics "battery level" and "charging state" which are not supported by HomematicIP anyway.

0.2.5 (2021-02-12)

Improvements

  • Shutter/Blind: Improved target position behavior even further. Now target always follows the current position. The spinning progress indicator was actually spinning because current and target position were not the same.

0.2.4 (2021-02-12)

Improvements

  • General: Removed all push button type devices. I haven't figured out a way to get push events from the HmIP-Cloud. My guess is it is not possible. Now those devices not shown as unsupported devices in the Home App.

0.2.3 (2021-02-12)

New devices

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

Improvements

  • HmIP-eTRV: Fixed update of valve position. Show valve position changes in logs.
  • HmIP-eTRV: Valve position > 0 indicates current cooling/heating state: HEAT. Valve position = 0 indicates current heating cooling/heating state: OFF.
  • HmIP-eTRV: Added logs for setting ignored values (target cooling/heating mode, display units).
  • HmIP-eTRV: Target cooling/heating mode is now ignored. Will be used for future mapping of custom states.
  • HmIP-eTRV: Show changes of valve state in logs.

Bugfix

  • Shutter/Blind: Fixed spinning progress indicator in Home app.
  • HmIP-eTRV-C: HmIP-eTRV-C was listed but not actually supported.

0.2.2 (2021-02-11)

New devices

  • HmIP-SLO: Light Sensor outdoor

Improvements

  • General: Added API call rate limiter to prevent 60 minutes IP blocks by eq-3 when using fast firing GUI elements like the shutter slider in EVE app.
  • SwitchMeasuring: Show power and energy with less decimal places.
  • Shutter/Blind: Show shutter and slats level without decimal places.
  • General: Minor code cleanup.

0.2.1 (2021-02-07)

Improvements

  • WallMountedThermostat: Added info log when changing target heating/cooling state or display unit. These changes are ignored.

Bug Fixes

  • General: Fixed dependency problem preventing plugin to start.

0.2.0 (2021-02-04)

Improvements

  • Switch: Split switch device into switch and measuring switch device to expose more features.
  • SwitchMeasuring: Added EVE characteristics ElectricPower and ElectricalEnergy for measuring switches. Those values can be viewed e.g. by using the EVE App on iOS.
  • General: Code clean-up. Removed dozens of unused home references.
  • General: Removed unused weather device.
  • WallMountedThermostat: Target heating mode is now AUTO by default. Current heating mode depends on cooling state of heating group.

0.1.5 (2021-02-02)

Improvements

  • GarageDoor: Introduced assumed target position. Enhanced state logic.

Bug Fixes

  • Blind: Set correct (current) shutter level when setting slats level. This should prevent the shutter from going all the way up when changing slats level.

0.1.4 (2021-02-01)

Improvements

  • GarageDoor: Removed explicit target door position which is not known anyway. This might improve display of animation in Home App.

0.1.3 (2021-02-01)

New devices

  • HmIP-FBL: Blind Actuator - flush-mount
  • HmIP-BBL: Blind Actuator - brand-mount

0.1.2 (2021-01-29)

Improvements

  • General: Automatically remove unsupported devices from cache

0.1.1 (2021-01-28)

Improvements

  • GarageDoor: Further optimized target door state by updating it asynchronously.

Bug Fixes

  • WaterSensor: Hopefully fixed "This callback function has already been called by someone else; it can only be called one time." bug. Removed humidity detector for now.
  • ClimateSensor: Fixed a bug where outside temperatures below zero won't be accepted by HomeKit.

0.1.0 (2021-01-28)

New devices

  • HmIP-SWD (Water sensor). The sensor exposes two services: Moisture detector and water level detector.

Improvements

  • GarageDoor: Display light state as ON/OFF instead of true/false
  • HomeControllerAccessPoint: Removed the device completely. It was not useful anyway and confused people why there was still light burning in the house.
  • SmokeDetector: Smoke alarm is only triggered when the device itself is detecting smoke. In this way the alarm displayed on your device is showing the sensor where the smoke actually was detected, not all the smoke sensors in the house.

Bug Fixes

  • GarageDoor: Fixes target door state update when OPEN/CLOSE was triggered by external app
  • SmokeDetector: Removed erroneous tampered state detection when instead it was really a burglar alarm.