Hue API Compatibility - dresden-elektronik/deconz-rest-plugin GitHub Wiki
These pages document the differences between the deCONZ REST API, v2_04_40 beta, and the Philips Hue API, v1.17.0. Ultimately, we would like Philips Hue applications (like my Homebridge plugin) to work unaltered with deCONZ.
| Section | Resource | Conclusion |
|---|---|---|
| Bridge Discovery | Major application changes needed. | |
| Lights | /lights |
Minor application changes needed. Handling of colours seems to be slightly different. |
| Groups | /groups |
Major application changes needed. Notably deCONZ doesn't return the details per group on a GET of /groups, so groups need to be polled individually. |
| Schedules | /schedules |
t.b.d. |
| Scenes | /scenes |
Major application changes needed, but not used by homebridge-hue. |
| Sensors | /sensors |
t.b.d.Minor application changes needed, as deCONZ reports a different sensor type (e.g. ZHASwitch vs ZLLSwitch for the Hue dimmer switch). |
| Rules | /rules |
t.b.d. |
| Configuration | /config |
t.b.d. |
| Info | Deprecated. | |
| Resourcelinks | /resourcelinks |
Missing from the deCONZ API, but not used by homebridge-hue. |
| Capabilities | /capabilities |
Missing from the deCONZ API, but not used by homebridge-hue. |
Notes
JSON formatting
Typically the deCONZ REST API returns the key/value pairs of an object in alphabetical order of the key, whereas the Hue API returns them in some pre-defined order. This is not an issue from an API perspective, as JSON doesn't assign any meaning to the order of the key/value pairs in a JSON object. Likewise, the formatting of JSON (whitespace, newlines) has no meaning.
For readability, the JSON examples used in this Wiki are formatted and sorted.