The deCONZ REST plugin provides a REST API to access ZigBee Home Automation (ZHA) and ZigBee Light Link (ZLL) lights, switches and sensors like the dresden elektronik Wireless Light Control system, Xiaomi Aqara, IKEA TRÅDFRI and Philips Hue.
As hardware the RaspBee ZigBee Shield for Raspberry Pi or a ConBee USB dongle is used to directly communicate with the ZigBee devices.
To learn more about the REST API itself please visit the REST API Documentation page.
The Phoscon App is the successor of the 2016 WebApp (Wireless Light Control), it's browser based and supports more sensors and switches. For more information and screenshots check out:
The deCONZ application is available for the following platforms and contains 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/
- Raspbian Jessie
- Raspbian Stretch
A uncomplete list of supported devices can be found here:
https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Supported-Devices
Important If you're updateing from a previous version always make sure to create an backup in the Phoscon App and read the changelog first.
https://github.com/dresden-elektronik/deconz-rest-plugin/releases
-
Download deCONZ package
wget http://www.dresden-elektronik.de/rpi/deconz/beta/deconz-2.05.57-qt5.deb -
Install deCONZ package
sudo dpkg -i deconz-2.05.57-qt5.deb
Important this step might print some errors that's ok and will be fixed in the next step.
-
Install missing dependencies
sudo apt update sudo apt install -f
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.
-
Download deCONZ development package
wget http://www.dresden-elektronik.de/rpi/deconz-dev/deconz-dev-2.05.57.deb -
Install deCONZ development package
sudo dpkg -i deconz-dev-2.05.57.deb -
Install missing dependencies
sudo apt update sudo apt install -f
-
Checkout the repository
git clone https://github.com/dresden-elektronik/deconz-rest-plugin.git -
Checkout related version tag
cd deconz-rest-plugin git checkout -b mybranch V2_05_57 -
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
The beta version 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
The dresden elektronik Raspbian sd-card image autostarts deCONZ GUI.
$ sudo systemctl disable deconz-gui
$ sudo systemctl stop deconz-guiOn older versions of deCONZ this can be done by removing the X11 Autostart file.
$ rm -f /home/pi/.config/autostart/deCONZ.desktop- Raspbian Jessie or Raspbian Stretch with Qt5
Important The serial port must be configured as follows to allow communication with the RaspBee.
$ sudo raspi-config
() Interfacting Options > Serial
* Would you like a login shell accessible over serial?
> No
* Would you like the serial port hardware to be enabled?
> Yes
After changing the settings reboot the Raspberry Pi.
- Raspberry Pi 1, 2 or 3
- RaspBee ZigBee Shield for Raspberry Pi
- ConBee USB dongle for Raspberry Pi and PC
The following libraries are used by the plugin:
The plugin is available as open source and licensed under the BSD (3-Clause) license.