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.

To communicate with Zigbee devices the RaspBee / RaspBee II Zigbee shield for Raspberry Pi, or a ConBee / ConBee II USB dongle is required.

API Documentation

For community based support with deCONZ or Phoscon, please visit the deCONZ Discord server.

Phoscon App

The Phoscon App is a browser based web application and supports lights, sensors and switches. For more information and screenshots visit the Phoscon App Documentation.

Release Schedule

deCONZ beta releases are scheduled roughly once per week. After 2–3 betas a stable version is released and a new beta cycle begins. The stable release is usually published between 1st — 15th of the month.

Current Beta: v2.18.2-beta
Current Stable: v2.18.2

Next Beta: v2.19.0-beta Expected in October. Next Stable: v2.19.x Expected in October.

Installation

Supported platforms

Raspbian ~~Jessie~~, ~~Stretch~~, Buster and Bullseye
Ubuntu ~~Xenial~~, Bionic, Focal Fossa and Jammy
Windows 7, 10, 11

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 and Debian 64-bit http://deconz.dresden-elektronik.de/ubuntu/beta/

To manually install a Linux .deb package enter these commands:

sudo dpkg -i <package name>.deb
sudo apt-get install -f

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
RaspBee II 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 6,698 Commits
.github		.github
crypto		crypto
device		device
device_js		device_js
devices		devices
img		img
linux/deCONZ		linux/deCONZ
resource		resource
tests		tests
ui		ui
utils		utils
zcl		zcl
zdp		zdp
.gitignore		.gitignore
CMakeLists.txt		CMakeLists.txt
LICENSE.txt		LICENSE.txt
README.md		README.md
air_quality.cpp		air_quality.cpp
air_quality.h		air_quality.h
alarm_system.cpp		alarm_system.cpp
alarm_system.h		alarm_system.h
alarm_system_device_table.cpp		alarm_system_device_table.cpp
alarm_system_device_table.h		alarm_system_device_table.h
alarm_system_event_handler.cpp		alarm_system_event_handler.cpp
alarm_system_event_handler.h		alarm_system_event_handler.h
appliances.cpp		appliances.cpp
aps_controller_wrapper.cpp		aps_controller_wrapper.cpp
aps_controller_wrapper.h		aps_controller_wrapper.h
authorisation.cpp		authorisation.cpp
backup.cpp		backup.cpp
backup.h		backup.h
basic.cpp		basic.cpp
bindings.cpp		bindings.cpp
bindings.h		bindings.h
button_maps.cpp		button_maps.cpp
button_maps.h		button_maps.h
button_maps.json		button_maps.json
button_maps.schema.json		button_maps.schema.json
change_channel.cpp		change_channel.cpp
cloc_device.sh		cloc_device.sh
colorspace.cpp		colorspace.cpp
colorspace.h		colorspace.h
connectivity.cpp		connectivity.cpp
connectivity.h		connectivity.h
database.cpp		database.cpp
database.h		database.h
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.cpp		device.cpp
device.h		device.h
device_access_fn.cpp		device_access_fn.cpp
device_access_fn.h		device_access_fn.h
device_compat.cpp		device_compat.cpp
device_compat.h		device_compat.h
device_ddf_init.cpp		device_ddf_init.cpp
device_ddf_init.h		device_ddf_init.h
device_descriptions.cpp		device_descriptions.cpp
device_descriptions.h		device_descriptions.h
device_setup.cpp		device_setup.cpp
device_tick.cpp		device_tick.cpp
device_tick.h		device_tick.h
diagnostics.cpp		diagnostics.cpp
discovery.cpp		discovery.cpp
electrical_measurement.cpp		electrical_measurement.cpp
event.cpp		event.cpp
event.h		event.h
event_emitter.cpp		event_emitter.cpp
event_emitter.h		event_emitter.h
event_queue.cpp		event_queue.cpp
fan_control.cpp		fan_control.cpp
fan_control.h		fan_control.h
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
green_power.cpp		green_power.cpp
green_power.h		green_power.h
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_ace.cpp		ias_ace.cpp
ias_ace.h		ias_ace.h
ias_zone.cpp		ias_zone.cpp
ias_zone.h		ias_zone.h
identify.cpp		identify.cpp
ikea-ota-download.py		ikea-ota-download.py
json.cpp		json.cpp

License

Thomas-Vos/deconz-rest-plugin

Folders and files

Latest commit

History