https://github.com/WebThingsIO/zigbee-adapter

Zigbee adapter add-on for WebThings Gateway
https://github.com/WebThingsIO/zigbee-adapter

Last synced: about 2 months ago
JSON representation

Zigbee adapter add-on for WebThings Gateway

• Host: GitHub
• URL: https://github.com/WebThingsIO/zigbee-adapter
• Owner: WebThingsIO
• License: mpl-2.0
• Created: 2018-01-17T19:33:45.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-09T18:05:31.000Z (3 months ago)
• Last Synced: 2024-06-10T01:27:05.645Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.47 MB
• Stars: 46
• Watchers: 14
• Forks: 30
• Open Issues: 82
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Zigbee Adapter

Zigbee device adapter for WebThings Gateway.

## Compatibility

This adapter is compatible with the following USB dongles:

* Digi XStick2 (XU-Z11)

* RaspBee module plugged into a Raspberry Pi

  * RaspBee module needs to be connected with UART PL011, not the mini UART, and

    be accesssible on /dev/ttyAMA0.

  * In `/boot/config.txt` add `dtoverlay=pi3-miniuart-bt` in section `[all]`

  * In `/boot/cmdline.txt` remove `console=tty1` to disable console on tty1

  * The `allowAMASerial` flag must be enabled via _Settings -> Add-ons -> Zigbee -> Configure_.

  * Notes on the UART config: [UART Configuration - Raspberry Pi Documentation](https://www.raspberrypi.org/documentation/configuration/uart.md)

* ConBee Zigbee USB stick

* ConBee II Zigbee USB stick

* TI CC253x-based dongles

  * These must be flashed with the firmware in the `firmware` directory of

    this repository, following [these instructions](https://www.zigbee2mqtt.io/information/flashing_the_cc2531.html),

    or using [Raspberry Pi](https://lemariva.com/blog/2019/07/zigbee-flashing-cc2531-using-raspberry-pi-without-cc-debugger)

  * Last time [ITEAD](https://www.itead.cc/cc2531-usb-dongle.html) sells them

    preprogrammed with some ZNP firmware - probably working with this plugin.

Additionally, the adapter can talk to one or more [Zigbee2MQTT](https://www.zigbee2mqtt.io/) instances over MQTT.

The supported dongles are listed [here](https://www.zigbee2mqtt.io/information/supported_adapters.html).

To see if your devices are supported, look [here](https://www.zigbee2mqtt.io/information/supported_devices.html).

To use it, just add another Zigbee2MQTT entry in the config of the adapter and update the host field with the hostname or IP of your MQTT broker.

If you don't have an existing Zigbee2MQTT installation, you can follow this [guide](https://www.zigbee2mqtt.io/getting_started/running_zigbee2mqtt.html) to set one up.