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

Download deCONZ package

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

Install deCONZ package
```
 sudo dpkg -i deconz-2.04.86-qt5.deb
```
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.

Download deCONZ development package

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

Install deCONZ development package
```
 sudo dpkg -i deconz-dev-2.04.86.deb
```

Get and compile the plugin

Checkout the repository

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

Checkout related version tag

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

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

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.

Enable the service at boot time

$ sudo systemctl enable deconz

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:

Name		Name	Last commit message	Last commit date
Latest commit History 1,023 Commits
.gitignore		.gitignore
LICENSE.txt		LICENSE.txt
README.md		README.md
atmel_wsndemo_sensor.cpp		atmel_wsndemo_sensor.cpp
authentification.cpp		authentification.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
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
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
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_configuration.cpp		rest_configuration.cpp
rest_gateways.cpp		rest_gateways.cpp
rest_groups.cpp		rest_groups.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_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
sqlite3.c		sqlite3.c
sqlite3.h		sqlite3.h
upnp.cpp		upnp.cpp
websocket_server.cpp		websocket_server.cpp
websocket_server.h		websocket_server.h
zcl_tasks.cpp		zcl_tasks.cpp

License

iOSExpertise/deconz-rest-plugin

Folders and files

Latest commit

History