Introduction

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, 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.

License

The plugin is available as open source and licensed under the BSD (3-Clause) license.

Usage

Currently the compilation of the plugin is only supported for Raspbian Jessie distribution. Packages for Qt4 and Raspbian Wheezy are available but not described here.

Install deCONZ

1. Download deCONZ package

    wget http://www.dresden-elektronik.de/rpi/deconz/beta/deconz-2.04.86-qt5.deb
   

2. Install deCONZ package

    sudo dpkg -i deconz-2.04.86-qt5.deb
   

3. Install missing dependencies

    sudo apt install -f
   

Install deCONZ development package

The development package is only needed if you wan't to modify the plugin or try the latest commits from master.

1. Download deCONZ development package

    wget http://www.dresden-elektronik.de/rpi/deconz-dev/deconz-dev-2.04.86.deb
   

2. Install deCONZ development package

    sudo dpkg -i deconz-dev-2.04.86.deb
   

Get and compile the plugin

1. Checkout the repository

    git clone https://github.com/dresden-elektronik/deconz-rest-plugin.git
   

2. Checkout related version tag

    cd deconz-rest-plugin
    git checkout -b mybranch V2_04_86
   

3. Compile the plugin

    qmake && make -j2
   

Note On Raspberry Pi 1 use qmake && make

4. Replace original plugin

    sudo cp ../libde_rest_plugin.so /usr/share/deCONZ/plugins
   

Headless support

The beta version contains a systemd script, which allows deCONZ to run without a X11 server.

Note The service does not yet support deCONZ updates via WebApp, therefore these must be installed manually. A further systemd script will handle updates in future versions.

1. Enable the service at boot time

$ sudo systemctl enable deconz

2. Disable X11 deCONZ autostart script

The dresden elektronik Raspbian sd-card image contains a autostart script for X11 which should be removed.

$ rm -f /home/pi/.config/autostart/deCONZ.desktop

Software requirements

• Raspbian Jessie or 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.

Hardware requirements

• Raspberry Pi 1, 2 or 3
• RaspBee ZigBee Shield for Raspberry Pi
• ConBee USB dongle for Raspberry Pi and PC

3rd party libraries

The following libraries are used by the plugin:

• SQLite
• qt-json
• colorspace