homebridge-zigbee-nt

ZigBee Platform plugin for HomeBridge

Description

This Homebridge plugin exposes ZigBee devices connected to TI's CC253X wireless SoC to Apple's HomeKit. It uses zigbee-herdsman and zigbee-herdsman-converters under the hood, so technically all supported devices mapped in zigbee-herdsman-converters should be supported. To enable a new device you must implement a new HomeKit Device class and regirster it.

This project has been heavily inspired by homebridge-zigbee plugin by Anton Petrov.

Supported devices

See wiki page

Build from sources

To build and run the plugin from sources, you need to install yarn first.

Clone the repo:

git clone git@github.com:madchicken/homebridge-zigbee-nt.git

Once you get it, run yarn command:

cd homebridge-zigbee-nt
yarn && yarn build

You should end up with a new dist/ folder containing the compiled version of the plugin.

WEB UI

From version 1.0.8 you can see which device is paired through the WEB UI exposed on port 9000. To change the default port, set httpPort: YOUR_PORT_NUMBER in the configuration. To completely disable http UI, set disableHttpServer: true in the configuration.

License

Licensed under Apache 2.0

Contribute

Any PR is welcome to this project, so please, fork and open one if you can!

If otherwise, you simply enjoyed using this plugin, and you want to contribute in some way, you can always donate something!

Changelog

All notable changes to this project will be documented in this file. This project uses Semantic Versioning.

2.0.0 (2021-1-19)

Version 2.0.0

Changes

• Complete refactoring: better code structure to improve reuse of existing code. Updating of devices is now centralized.
• NEW: ability to manually configure devices from plugin configuration. See wiki for more details. Supported devices types for manual config are
  • contact sensors
  • light bulbs, switches and dimmers
  • motion sensors
  • leak sensors (water, gas or smoke sensors)
  • vibration sensors
  • humidity sensors
  • temperature sensors
  • outlets
• NEW: permit join status can now be turned on at startup using enablePermitJoin boolean config value
• NEW: auto backup of zigbee database on startup (to reduce lost of paired devices when changing antenna configuration)
• NEW: support for adapter type in configuration through adapter value (supported values are zstack, deconz and zigate)
• FIX: pan id is now correctly passed down to antenna configuration #79 (thanks to HalloTschuess)
• Improved UI with more device information
• NEW: support for Aquara Opple 4 buttons switch #76 (thanks to tr1ng0)
• NEW: support for Nanoleaf Ivy bulb #80 (thanks to andi-farr)
• FIX: improved pairing process to avoid possible errors
• Upgraded all dependencies (herdsman and herdsman-converters in particular)
• NEW: support for Xiaomi natural gas leak sensor

NOTE: you might need to pair again all your devices because of a change in the herdsman lib to the pan ID of your antenna

2.0.1 (2021-1-23)

Version 2.0.1

Changes

• Fix a bug with device state update #74
• Do not read humidity/temperature (rely on device report) #69
• Add devices to internal database
• Fix problem with accessories names: do not exceed 64 characters #92

2.0.2 (2021-1-28)

Version 2.0.2

Changes

• Add 2 and 6 buttons support for Aquara Opple button #94 #98
• Fix bug where switches were randomly turning on and off (driving people crazy by turning on bulbs in the middle of the night)
• Add support for BTicino Dimmer #82
• Add support for LIDL motion sensor #99
• Restore ping for router devices on mount process
• UI improvements
• Add support for TuYa plug #85
• Add support for Xiaomi MiJia Honeywell smoke detector #85
• Add support for Tuya Thermostatic Radiator Valve #104

2.0.3 (2021-1-29)

Version 2.0.3

Changes

• Restore long press for IKEA ON/OFF button

2.0.5 (2021-2-04)

Version 2.0.5

Changes

• Let manufacturer name be an array to map multiple devices all at once (#111)
• Add Tuya Thermostat model TS0601 with manufacturer _TZE200_2dpplnsn

2.1.0 (2021-2-28)

Version 2.1.0

Changes

• New auto discovery for devices: with the new system of device mapping, many ZigBee accessories will just work. Supported type (ATM) are
  • lights
  • switches (only on/off switches, not multi buttons)
  • locks Coming soon devices
  • thermostats
  • complex switches
  • fan
• Update of devices is now done in background: all the GET request to the plugin will return immediately the last read value
• Ability to set friendly names for your devices: just add them through the homebridge plugin setting window.
• Many other small improvements and fixes

2.1.1 (2021-3-01)

Version 2.1.1

Changes

• Fix a problem were options passed during message decoding could be null
• Added first test for zigbee client
• Review eslint configuration and settings

2.1.2 (2021-3-03)

Version 2.1.2

Changes

• More robust checks during startup
• More logs when starting WEB UI (#131)

2.1.3 (2021-3-04)

Version 2.1.3

Changes

• Device _TZE200_2dpplnsn TS0601 is not compatible with herdsman lib, removing from supported accessories
• Add support for _TZE200_ywdxldoj.TS0601 thermostat (same as _TZE200_ckud7u2l.TS0601)
• Add a try/catch during accessory initialisation to avoid plugin problems at startup
• Updated dependencies

2.2.0 (2021-3-21)

Version 2.2.0

Changes

• Multi switch auto discovery support
• Fix errors provided by default values
• Fix multi service support on a single device
• Updated dependencies

2.2.1 (2021-3-22)

Version 2.2.1

Changes

• Fix errors in thermostat values reporting #140
• Fix error in WEB UI #134
• Updated dependencies

2.2.2 (2021-3-25)

Version 2.2.2

Changes

• Fix state for devices #141
• Add Fakegato (Elgato) support #39
• Add support for Tuya smart dimmer #119
• Updated dependencies

2.2.3 (2021-3-29)

Version 2.2.3

Changes

• Fix state for devices (again) #141
• Fix issues with Moes/Tuya TS0601 thermostat issues #140

2.2.4 (2021-3-30)

Version 2.2.4

Changes

• Fix issues with Moes/Tuya TS0601 thermostat issues #140
• Updated dependencies

2.2.5 (2021-6-28)

Version 2.2.5

Changes

• Fix adapter initialization issue
• Fix double event coming from buttons
• Fix color issue with HUE bulbs (and all color bulbs)
• OTA update support in UI (beta)

2.5.1 (2021-8-09)

Version 2.5.1

Changes

• Improved OTA UI
• Fix color handling for light bulbs supporting it
• Fix dependencies
• Upgrade evergreen UI components library
• Fix vulnerabilities

2.5.2 (2021-9-07)

Version 2.5.2

Changes

• Fix bugs on configuration
• Add support for ikea repeater (beta)
• Fix buttons problem
• Always pass custom config to zigbee client, so you can use per device specific configuration
• Many other small fixes

2.5.3 (2021-9-12)

Version 2.5.3

Changes

• Update Herdsman libraries
• Fix dependency vulnerabilities

2.5.4 (2021-9-22)

Version 2.5.4

Changes

• Add support for low battery level for battery service
• Downgrade serial port dependency because of this issue https://github.com/Koenkk/zigbee2mqtt/issues/8282

2.6.2 (2024-8-31)

Version 2.6.2

Changes

• Add support for ezsp protocol and Ikea TRETAKT plug (@jdhuntington)