Request Device Support - dresden-elektronik/deconz-rest-plugin GitHub Wiki

Introduction

This page provides guideline to get new devices integrated and supported in the deCONZ REST-API.

Check Supported Devices

The first step should be checking if the device is already supported or support is currently being worked on. Please refer to the list of DDF supported devices as well as the list of legacy supported devices. The latter is a Wiki page of this repository and provides information on already integrated devices and links to GitHub issues for respective device integration. Also, it is not a bad idea to take a peak at the currently open PRs.

If there's already an open issue for your device, please feel free to contribute as necessary. In case any issue got closed on missing feedback or information, we're more than happy to re-open as appropriate.

Create New Device Request

If the new device is not listed under the sources mentioned above or no GitHub issue exits, a new issue should be created with the information as described below. Please do take note that the form to create an issue already provides useful guidance on what is expected and how to obtain that information. Additionally, please refer to the below.

Required screenshots

  • Clusters of the node, by clicking the right node circle
  • Node Info Panel
  • Basic cluster's attributes as shown in the Cluster Info Panel, with the data returned by read. Please note that at least "Manufacturer Name" and "Model Identifier" must be populated with data (therefore, must not be empty), otherwise that information will not be usable. For battery powered devices, after pressing read it is required to wake-up the device by pressing a button or any other means of interaction. Info on how to read clusters
  • Further clusters (if available) including Simple Metering, Electrical Measurement, Power Configuration, Thermostat, etc. You can typically spare indentify, alarms, device temperature, on/off. Again, please ensure data has been read prior to taking any screenshots.

In the following, you find examples of appropriate screenshots:

Screenshot of the Basic cluster

Screenshot of nodes basic cluster

Screenshot of the Node Info Panel

Screenshot of nodes info panel

Note: To include a screenshot in a GitHub, issue just copy it to clipboard and paste it in the GitHub issue editor.

Debug Output (optional upon request)

Debug prints provide further more detailed data on send and received commands. To enable verbose logging, start deCONZ on the command line as follows:

$ deCONZ --dbg-info=2 --dbg-error=2 --dbg-aps=1