Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

deCONZ REST-API plugin to control ZigBee devices
https://github.com/dresden-elektronik/deconz-rest-plugin

conbee home-automation raspbee raspberry-pi zha zigbee zll

Last synced: about 1 month ago
JSON representation

deCONZ REST-API plugin to control ZigBee devices

Host: GitHub
URL: https://github.com/dresden-elektronik/deconz-rest-plugin
Owner: dresden-elektronik
License: bsd-3-clause
Created: 2013-07-19T11:41:54.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2024-09-24T13:22:24.000Z (about 2 months ago)
Last Synced: 2024-09-28T10:04:20.178Z (about 1 month ago)
Topics: conbee, home-automation, raspbee, raspberry-pi, zha, zigbee, zll
Language: C++
Homepage:
Size: 24 MB
Stars: 1,895
Watchers: 107
Forks: 498
Open Issues: 157
Metadata Files:
- Readme: README.md
- Changelog: change_channel.cpp
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        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](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Supported-Devices) page.

To communicate with Zigbee devices the [RaspBee](https://phoscon.de/raspbee?ref=gh) / [RaspBee II](https://phoscon.de/raspbee2?ref=gh) Zigbee shield for Raspberry Pi, or a [ConBee](https://phoscon.de/conbee?ref=gh) / [ConBee II](https://phoscon.de/conbee2?ref=gh) / [ConBee III](https://phoscon.de/conbee3?ref=gh) USB dongle is required.

### API Documentation

* [REST-API Documentation](http://dresden-elektronik.github.io/deconz-rest-doc/)

* [deCONZ C++ Plugin API Documentation](https://phoscon.de/deconz-cpp).

* [DDF and C++ Device API Documentation](https://dresden-elektronik.github.io/deconz-dev-doc)

For community based support with deCONZ or Phoscon, please visit the [deCONZ Discord server](https://discord.gg/QFhTxqN). 

### 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](https://phoscon.de/app/doc?ref=gh).

### Release Schedule

deCONZ beta releases are scheduled roughly once per week. After 1–3 betas a stable version is released and a new beta cycle begins.

Current Beta: **v2.28.1-beta**  

Current Stable: **v2.28.1**

Next Beta: **v2.29.0-beta** Expected in September.

Next Stable: **v2.29.x** Expected in September.

Installation

============

##### Supported platforms

* Raspbian ~~Jessie~~, ~~Stretch~~, Buster, Bullseye and Bookworm

* 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:

* [RaspBee](https://phoscon.de/raspbee/install?ref=gh)

* [RaspBee II](https://phoscon.de/raspbee2/install?ref=gh)

* [ConBee](https://phoscon.de/conbee/install?ref=gh)

* [ConBee II](https://phoscon.de/conbee2/install?ref=gh)

* [ConBee III](https://phoscon.de/conbee3/install?ref=gh)

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

### Compiling the plugin

The build instructions are described in [BUILDING.md](BUILDING.md).

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/

* ARM64 systems http://deconz.dresden-elektronik.de/debian/beta/

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

    sudo dpkg -i .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.

1. Enable the service at boot time

```bash

$ sudo systemctl enable deconz

```

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

```bash

$ sudo systemctl disable deconz-gui

$ sudo systemctl stop deconz-gui

```

Hardware requirements

---------------------

* Raspberry Pi 1, 2B, 3B, 3B+ or 4B

* [RaspBee](https://phoscon.de/raspbee?ref=gh) Zigbee shield for Raspberry Pi

* [RaspBee II](https://phoscon.de/raspbee2?ref=gh) Zigbee shield for Raspberry Pi

* [ConBee](https://phoscon.de/conbee?ref=gh) USB dongle for Raspberry Pi and PC

* [ConBee II](https://phoscon.de/conbee2?ref=gh) USB dongle for Raspberry Pi and PC

* [ConBee III](https://phoscon.de/conbee3?ref=gh) USB dongle for Raspberry Pi and PC

3rd party libraries

-------------------

The following libraries are used by the plugin:

* [ArduinoJSON](https://arduinojson.org)

* [SQLite](http://www.sqlite.org)

* [qt-json](https://github.com/lawand/droper/tree/master/qt-json)

* [colorspace](http://www.getreuer.info/home/colorspace)

License

=======

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