msoftware/deconz-rest-plugin

REST API Plugin to control ZigBee lights like Philips Hue and dresden elektroniks wireless electronic ballasts

Introduction

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 like Xiaomi Aqara, IKEA TRÅDFRI and Philips Hue.

A list of supported Zigbee devices can be found on the Supported Devices page.

As hardware the RaspBee Zigbee Shield for Raspberry Pi, a ConBee or ConBee II USB-dongle is used to communicate with the Zigbee devices.

To learn more about the REST-API itself please visit the REST-API Documentation page.

Phoscon App

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:

• Phoscon App Documentation
• Phoscon App Description

Installation

Supported platforms

• Raspbian Jessie and Stretch
• Ubuntu Xenial and Bionic
• Windows 7 and 10

Install deCONZ

Select the your device and follow the instructions on the Phoscon website for your platform.

• RaspBee
• ConBee
• ConBee II

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.

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

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

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 HEAD
   

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
   

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 beta version contains a systemd script, which allows deCONZ to run without a X11 server.

1. Enable the service at boot time

$ sudo systemctl enable deconz

2. Disable deCONZ GUI autostart

The dresden elektronik Raspbian sd-card image autostarts deCONZ GUI.

$ sudo systemctl disable deconz-gui
$ sudo systemctl stop deconz-gui

Hardware requirements

• Raspberry Pi 1, 2B, 3B or 3B+
• 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:

• SQLite
• qt-json
• colorspace

License

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