The deCONZ REST plugin provides a REST-API to access Zigbee 3.0 (Z30), Zigbee Home Automation (ZHA) and Zigbee Light Link (ZLL) lights, switches and sensors from Xiaomi Aqara, IKEA TRÅDFRI, Philips Hue, innr, Samsung and many more vendors.
A list of supported Zigbee devices can be found on the Supported Devices page.
To learn more about the REST-API itself please visit the REST-API Documentation page.
The Phoscon App is browser based and supports lights, sensors and switches. For more information and screenshots check out:
- Raspbian Jessie, Stretch and Buster
- Ubuntu Xenial and Bionic (AMD64)
- Windows 7 and 10
You find the instructions for your platform and device on the Phoscon website:
Important: If you're updating from a previous version always make sure to create an backup in the Phoscon App and read the changelog first.
Install deCONZ development package (optional, Linux only)
Important: The deCONZ package already contains the REST-API plugin, the development package is only needed if you wan't to modify the plugin or try the latest commits from master branch.
sudo apt install deconz-dev
Get and compile the plugin
Checkout the repository
git clone https://github.com/dresden-elektronik/deconz-rest-plugin.git
Checkout the latest version
cd deconz-rest-plugin git checkout -b mybranch HEAD
Compile the plugin
qmake && make -j2
Note On Raspberry Pi 1 use
qmake && make
Replace original plugin
sudo cp ../libde_rest_plugin.so /usr/share/deCONZ/plugins
Precompiled deCONZ packages for manual installation
The deCONZ application packages are available for the following platforms and contain the main application and the pre-compiled REST-API plugin.
- Windows https://www.dresden-elektronik.de/deconz/win/
- Raspbian https://www.dresden-elektronik.de/deconz/raspbian/beta/
- Ubuntu 64-bit https://www.dresden-elektronik.de/deconz/ubuntu/beta/
Headless support for Linux
The deCONZ package contains a systemd script, which allows deCONZ to run without a X11 server.
- Enable the service at boot time
$ sudo systemctl enable deconz
- Disable deCONZ GUI autostart service
The dresden elektronik sd-card image and default installation method autostarts deCONZ GUI. The following commands disable the deCONZ GUI service:
$ sudo systemctl disable deconz-gui $ sudo systemctl stop deconz-gui
- Raspberry Pi 1, 2B, 3B, 3B+ or 4B
- RaspBee Zigbee Shield for Raspberry Pi
- ConBee USB-dongle for Raspberry Pi and PC
- ConBee II USB-dongle for Raspberry Pi and PC
3rd party libraries
The following libraries are used by the plugin:
The plugin is available as open source and licensed under the BSD (3-Clause) license.