Skip to content
REST API Plugin to control ZigBee lights like Philips Hue and dresden elektroniks wireless electronic ballasts
C++ Shell Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Change wontfix label to stale Nov 23, 2018
img Add device integration images (2) Sep 21, 2018
linux/deCONZ Changed user pi to a generic mainuser variable Aug 14, 2019
.gitignore Ignore .qmake.stash, created under RaspBian Stretch. Oct 8, 2017
LICENSE.txt Fix license file to BSD Clause-3 license Jul 28, 2017
README.md README.md: Update with new reference to new install instructions on p… Apr 22, 2019
authorisation.cpp Fix Hue Essentials supports full api mode Jan 9, 2019
bindings.cpp Fix compile error due typo Aug 18, 2019
bindings.h Attribute reporting for _Instantaneous Demand_. Mar 16, 2018
change_channel.cpp Support restoring previous Zigbee configurations Feb 10, 2019
colorspace.cpp Fix various app crashed related to resource system May 18, 2017
colorspace.h Added Rgb2xy function to colorspace class Feb 22, 2017
connectivity.cpp Initial commit of all V2_03 files Mar 19, 2016
connectivity.h Initial commit of all V2_03 files Mar 19, 2016
database.cpp save homebridge update version in db and show in rest api Jul 9, 2019
daylight.cpp Support Daylight sensor with additional state.status Mar 10, 2018
daylight.h Support Daylight sensor with additional state.status Mar 10, 2018
de_otau.cpp Add config/powerup feature for lights (wip, not working) Mar 27, 2018
de_web.pro Reenable GCC unexpected __attribute__ warning Jul 25, 2019
de_web_plugin.cpp Add gesture GESTURE_ROTATE_CLOCKWISE* for Xiaomi Cube Aug 22, 2019
de_web_plugin.h Fix backup save/restore issues Jan 1, 2019
de_web_plugin_private.h save homebridge update version in db and show in rest api Jul 9, 2019
de_web_widget.cpp Add debug checks for dialog destructor Jan 4, 2019
de_web_widget.h Cleanup REST API plugin widget and display install code Sep 10, 2017
de_web_widget.ui Cleanup REST API plugin widget and display install code Sep 10, 2017
description_in.xml Echo requires Philips manufacturer in description.xml Nov 2, 2018
device_setup.cpp Reverted attribute changes committed by mistake Jul 29, 2019
discovery.cpp Ensure no-update state on non arm, todo enable for Ubuntu Jan 2, 2019
event.cpp Support id() method for RGroup resources used in rules Oct 22, 2017
event.h Refactor rules handling based on events (experimental) Sep 2, 2017
event_queue.cpp Refactor rules handling based on events (experimental) Sep 2, 2017
firmware_update.cpp Comment unused 'autoUpdate' variable until R21 bootlader refactor Aug 18, 2019
gateway.cpp Fix some clang warnings and code cosmetic Jan 3, 2019
gateway.h Cascade On/Off for IKEA Trådfri remote Jan 4, 2018
gateway_scanner.cpp Refactor gateway scanner, use UPnP and /api/config results Nov 20, 2017
gateway_scanner.h Refactor gateway scanner, use UPnP and /api/config results Nov 20, 2017
general.xml Added Develco specific attr to basic cluster Jul 16, 2019
group.cpp Improve maintenance of device membership groups (1) Nov 21, 2018
group.h Don't use RestNodeBase Mar 27, 2019
group_info.cpp Improve scene handling, use unicast add scene commands instead of sto… Sep 18, 2016
group_info.h Improve scene handling, use unicast add scene commands instead of sto… Sep 18, 2016
gw_uuid.cpp Initial commit of all V2_03 files Mar 19, 2016
ias_zone.cpp Fix IAS processing for multi resource sensors May 12, 2019
ikea-ota-download.py Add IKEA OTA download script Aug 11, 2017
json.cpp Allow null values in JSON response Mar 10, 2018
json.h add plugin content and update LICENSE Jul 23, 2013
light_node.cpp Update light_node.cpp Jul 9, 2019
light_node.h Refactor light color code (1) Jan 16, 2019
permitJoin.cpp Don't skip periodically permit join during ota Apr 22, 2019
poll_manager.cpp Update poll_manager.cpp Jul 9, 2019
poll_manager.h Fix poll timer non-stop idle loop, and gettings stuck Feb 4, 2019
reset_device.cpp Fix some clang warnings and code cosmetic Jan 3, 2019
resource.cpp Resource: provide assign operator=() to prevent g++ deprecated warning Aug 18, 2019
resource.h Resource: provide assign operator=() to prevent g++ deprecated warning Aug 18, 2019
resourcelinks.cpp Add /resourcelinks REST API Jul 18, 2017
resourcelinks.h Add /resourcelinks REST API Jul 18, 2017
rest_capabilities.cpp Fix build of capabilities code on newer Qt versions May 19, 2019
rest_configuration.cpp save homebridge update version in db and show in rest api Jul 9, 2019
rest_devices.cpp Forward Zigbee 3.0 Install Codes to core (wip) Jun 24, 2019
rest_devices.h Add stubs for PUT /api/<apikey>/devices/<uniqueid>/installcode Jun 10, 2019
rest_gateways.cpp Bring back guards for api endpoints Dec 12, 2018
rest_groups.cpp Add an actual group address for "group 0" instead of special-casing i… Jun 10, 2019
rest_info.cpp Implement the rest of the capabilities api May 19, 2019
rest_lights.cpp Add Develco to supported devices list, issue #1534. Jun 22, 2019
rest_node_base.cpp RestNodeBase remove unused m_available Oct 25, 2018
rest_node_base.h Don't use RestNodeBase Mar 27, 2019
rest_resourcelinks.cpp Several small fixes: Jun 10, 2019
rest_rules.cpp Several small fixes: Jun 10, 2019
rest_scenes.cpp Extend strict api mode to: normal, strict, amazon echo, philips hue app Dec 16, 2018
rest_schedules.cpp Several small fixes: Jun 10, 2019
rest_sensors.cpp Add a public attribute to ResourceItems so they can be hidden in the … Jun 13, 2019
rest_touchlink.cpp Extend strict api mode to: normal, strict, amazon echo, philips hue app Dec 16, 2018
rest_userparameter.cpp Refactor api handling: Nov 27, 2018
rule.cpp Webhooks: Support HTTP GET and more verbose debug prints May 8, 2019
rule.h Support weekday in rule condition with operator 'in' and 'not in' Jan 19, 2019
scene.cpp Fix in the store scene API (2) Aug 29, 2017
scene.h Fix in the store scene API (2) Aug 29, 2017
sensor.cpp Xiaomi round button (WXKG01LM) support hold (1001) and long release (… Jan 15, 2019
sensor.h Add rotate gesture constants Jul 25, 2019
thermostat.cpp Update thermostat.cpp Mar 8, 2019
time.cpp Fix build for older Qt version (3) Dec 9, 2018
upnp.cpp urn:schemas bugfix, use same socket for outgoing messages, and refactor Nov 2, 2018
websocket_server.cpp websocket_server.cpp: fix clang warnings, lower debug level Aug 22, 2018
websocket_server.h Investigate in stucked websocket buffer transmission (wip) Jun 11, 2018
window_covering.cpp Fix read multiple attributes from Window Covering Cluster Jan 14, 2019
zcl_tasks.cpp addTaskSetColorTemperature() handle ctmin/ctmax clipping Jun 13, 2019

README.md

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:

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.

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

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

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
  1. 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:

License

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

You can’t perform that action at this time.