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

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

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

Phoscon App

The Phoscon App is browser based and supports lights, sensors and switches. For more information and screenshots check out:

Phoscon App Documentation

Installation

Supported platforms

Raspbian Jessie, Stretch and Buster
Ubuntu Xenial and Bionic (AMD64)
Windows 7 and 10

Install deCONZ

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.

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

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 http://deconz.dresden-elektronik.de/win/
Raspbian http://deconz.dresden-elektronik.de/raspbian/beta/
Ubuntu 64-bit http://deconz.dresden-elektronik.de/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

Hardware requirements

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:

License

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

Name		Name	Last commit message	Last commit date
Latest commit History 2,467 Commits
.github		.github
img		img
linux/deCONZ		linux/deCONZ
.gitignore		.gitignore
LICENSE.txt		LICENSE.txt
README.md		README.md
authorisation.cpp		authorisation.cpp
bindings.cpp		bindings.cpp
bindings.h		bindings.h
change_channel.cpp		change_channel.cpp
colorspace.cpp		colorspace.cpp
colorspace.h		colorspace.h
connectivity.cpp		connectivity.cpp
connectivity.h		connectivity.h
database.cpp		database.cpp
daylight.cpp		daylight.cpp
daylight.h		daylight.h
de_otau.cpp		de_otau.cpp
de_web.pro		de_web.pro
de_web_plugin.cpp		de_web_plugin.cpp
de_web_plugin.h		de_web_plugin.h
de_web_plugin_private.h		de_web_plugin_private.h
de_web_widget.cpp		de_web_widget.cpp
de_web_widget.h		de_web_widget.h
de_web_widget.ui		de_web_widget.ui
description_in.xml		description_in.xml
device_setup.cpp		device_setup.cpp
discovery.cpp		discovery.cpp
event.cpp		event.cpp
event.h		event.h
event_queue.cpp		event_queue.cpp
firmware_update.cpp		firmware_update.cpp
gateway.cpp		gateway.cpp
gateway.h		gateway.h
gateway_scanner.cpp		gateway_scanner.cpp
gateway_scanner.h		gateway_scanner.h
general.xml		general.xml
group.cpp		group.cpp
group.h		group.h
group_info.cpp		group_info.cpp
group_info.h		group_info.h
gw_uuid.cpp		gw_uuid.cpp
ias_zone.cpp		ias_zone.cpp
ikea-ota-download.py		ikea-ota-download.py
json.cpp		json.cpp
json.h		json.h
light_node.cpp		light_node.cpp
light_node.h		light_node.h
permitJoin.cpp		permitJoin.cpp
poll_manager.cpp		poll_manager.cpp
poll_manager.h		poll_manager.h
reset_device.cpp		reset_device.cpp
resource.cpp		resource.cpp
resource.h		resource.h
resourcelinks.cpp		resourcelinks.cpp
resourcelinks.h		resourcelinks.h
rest_capabilities.cpp		rest_capabilities.cpp
rest_configuration.cpp		rest_configuration.cpp
rest_devices.cpp		rest_devices.cpp
rest_devices.h		rest_devices.h
rest_gateways.cpp		rest_gateways.cpp
rest_groups.cpp		rest_groups.cpp
rest_info.cpp		rest_info.cpp
rest_lights.cpp		rest_lights.cpp
rest_node_base.cpp		rest_node_base.cpp
rest_node_base.h		rest_node_base.h
rest_resourcelinks.cpp		rest_resourcelinks.cpp
rest_rules.cpp		rest_rules.cpp
rest_scenes.cpp		rest_scenes.cpp
rest_schedules.cpp		rest_schedules.cpp
rest_sensors.cpp		rest_sensors.cpp
rest_touchlink.cpp		rest_touchlink.cpp
rest_userparameter.cpp		rest_userparameter.cpp
rule.cpp		rule.cpp
rule.h		rule.h
scene.cpp		scene.cpp
scene.h		scene.h
sensor.cpp		sensor.cpp
sensor.h		sensor.h
thermostat.cpp		thermostat.cpp
time.cpp		time.cpp
upnp.cpp		upnp.cpp
websocket_server.cpp		websocket_server.cpp
websocket_server.h		websocket_server.h
window_covering.cpp		window_covering.cpp
zcl_tasks.cpp		zcl_tasks.cpp

License

Pencl/deconz-rest-plugin

Folders and files

Latest commit

History