Skip to content

modsfabio/deconz-rest-plugin

This branch is 1 commit ahead of, 34 commits behind dresden-elektronik/deconz-rest-plugin:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2b8f2c0 · Feb 2, 2025
Jun 1, 2024
Apr 22, 2024
Jun 2, 2024
Apr 19, 2021
Aug 11, 2024
Feb 2, 2025
Nov 23, 2021
Apr 3, 2023
Apr 16, 2021
Jun 25, 2023
Oct 29, 2022
Sep 3, 2024
Jun 8, 2024
Dec 18, 2023
Dec 27, 2023
Jun 25, 2023
Jul 24, 2023
Nov 26, 2024
Apr 13, 2023
Jul 28, 2017
Aug 26, 2024
Sep 7, 2023
Nov 21, 2021
Oct 6, 2021
Aug 9, 2021
Aug 1, 2021
Aug 1, 2021
Aug 9, 2021
Aug 9, 2021
Aug 1, 2023
Aug 2, 2021
Jun 13, 2021
Jul 27, 2023
Dec 12, 2023
May 6, 2021
Jun 13, 2021
Aug 9, 2024
Oct 18, 2020
Jul 24, 2023
May 27, 2021
May 27, 2021
May 26, 2024
Mar 17, 2023
Jun 13, 2023
Sep 6, 2021
May 18, 2017
Feb 22, 2017
Oct 9, 2024
May 14, 2024
Sep 5, 2019
Sep 5, 2019
Aug 12, 2024
Jan 29, 2025
Aug 1, 2023
Sep 24, 2024
Aug 3, 2023
Aug 25, 2020
Aug 25, 2020
Nov 2, 2018
Oct 9, 2024
Feb 26, 2024
Aug 9, 2024
Nov 9, 2022
Oct 6, 2023
Apr 15, 2022
May 14, 2024
May 14, 2024
Oct 9, 2024
Sep 6, 2021
Nov 26, 2024
May 27, 2024
Nov 9, 2022
Mar 29, 2021
Dec 14, 2020
Aug 9, 2024
Sep 5, 2022
Sep 5, 2022
Sep 19, 2022
Aug 25, 2022
May 5, 2022
Jul 31, 2023
Jun 1, 2021
Sep 14, 2023
Mar 21, 2024
Dec 24, 2017
Feb 9, 2020
Nov 20, 2017
Nov 8, 2024
Jun 2, 2024
Aug 10, 2021
Mar 31, 2023
Jul 17, 2021
Sep 18, 2016
Sep 18, 2016
Mar 19, 2016
Oct 7, 2024
Aug 27, 2021
Aug 27, 2021
Jan 28, 2022
Nov 21, 2021
Nov 30, 2021
May 4, 2020
Apr 22, 2024
Apr 22, 2024
Sep 24, 2024
Aug 20, 2021
Aug 5, 2023
Jun 13, 2023
Apr 21, 2022
Dec 10, 2020
Feb 5, 2024
Feb 4, 2019
Aug 9, 2024
Feb 1, 2023
May 27, 2021
Mar 31, 2023
May 27, 2021
Aug 3, 2023
Nov 8, 2024
Nov 8, 2024
Jul 18, 2017
Jul 18, 2017
Dec 1, 2021
Aug 27, 2021
Apr 22, 2024
May 27, 2024
May 19, 2019
Nov 26, 2024
Jun 14, 2024
May 14, 2024
Jun 10, 2024
May 14, 2024
Oct 16, 2021
May 6, 2024
May 19, 2019
Nov 8, 2024
May 24, 2021
May 24, 2021
Feb 9, 2020
Mar 19, 2024
Dec 16, 2018
Mar 21, 2024
Jan 29, 2025
Aug 3, 2023
Nov 27, 2018
Mar 19, 2024
Mar 19, 2024
Aug 29, 2017
Jan 12, 2020
Mar 21, 2024
Dec 18, 2023
Mar 19, 2024
Apr 14, 2023
Feb 20, 2024
Nov 9, 2022
Aug 9, 2024
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Apr 26, 2022
Mar 31, 2023
Nov 26, 2021
Jul 10, 2023
Sep 25, 2021
Jun 11, 2018
Aug 3, 2023
Mar 19, 2024
May 22, 2022
Sep 24, 2024
Mar 19, 2024

Repository files navigation

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 / ConBee III 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 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:

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.

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.

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.

  1. Enable the service at boot time
$ sudo systemctl enable deconz
  1. 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
  • ConBee III 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.

About

deCONZ REST-API plugin to control ZigBee devices

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 50.9%
  • C 48.2%
  • Other 0.9%