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