Mandatory and Optional Items for Lights Resources - dresden-elektronik/deconz-rest-plugin GitHub Wiki

This page provides an overview of the mandatory and optional items for the various lights resource types:

Abbrviation	Type
OF	On/Off Light
Dim	Dimmable Light
CT	Colour Temperature Light
C	Color Light
EC	Enhanced Color Light

Note that Color Dimmable Light should be mapped to Colour Temperature Light, Color Light, or Enhanced Color Light, depending on the colour capabilities of the light.

Capabilities Item

Item	Zigbee	OF	Dim	CT	C	EC	Notes
alert/trigger_effect	0x0001	o	o	o	o	o	Light supports Trigger Effect command.This will cause additional values, like breathe, to be displayed under capabilities/alerts.
bri/min_dim_level	0x0008/0x0003*	-	o	o	o	o	Hue lights.
bri/move_with_onoff	0x0008	o	o	o	o	o	Move to Level (with On/Off) turns light on and off.This will turn the light on smoothly.
color/capabilities	0x0300/0x400A	-	-	M	M	M	Use static to correct where needed.
color/ct/computes_xy	0x0300	-	-	-	-	o	Light updates Current X and Current Y when changing colour temperature.
color/ct/max	0x0300/0x400A	-	-	M	-	M	Use static to correct where needed.
color/ct/min	0x0300/0x400B	-	-	M	-	M	Use static to correct where needed.
color/effects	0x0300	-	-	o	o	o	Include when light supports dynamic effects.The actual values are defined in the C++ code.
color/gamut_type	0x0300/0x0032	-	-	-	o	o	Hue lights.
color/gradient/max_segments	0xFC03/0x0036*	-	-	-	-	o	Gradient lights.Use static to correct where needed.
color/gradient/pixel_count	0xFC03/0x0030*	-	-	-	-	o	Gradient lights.Use static to correct where needed.
color/gradient/pixel_length	0xFC03/0x0031*	-	-	-	-	o	Gradient lights.Use static to correct where needed.
color/gradient/styles	0xFC03/0x0013*	-	-	-	-	o	Gradient lights.Use static to correct where needed.
color/xy/blue/x	0x0300/0x003A0x0300/0x0019	-	-	-	M	M	Use static to correct where needed.
color/xy/blue/y	0x0300/0x003B0x0300/0x001A	-	-	-	M	M	Use static to correct where needed.
color/xy/green/x	0x0300/0x00360x0300/0x0015	-	-	-	M	M	Use static to correct where needed.
color/xy/green/y	0x0300/0x00370x0300/0x0016	-	-	-	M	M	Use static to correct where needed.
color/xy/red/x	0x0300/0x00320x0300/0x0011	-	-	-	M	M	Use static to correct where needed.
color/xy/red/y	0x0300/0x00330x0300/0x0012	-	-	-	M	M	Use static to correct where needed.
groups/not_supported	0x0004	o	o	o	o	o	Light does not support Groups.
on/off_with_effect	0x0006	o	o	o	o	o	Light supports Off with Effect.
transition_block	0x00080x0300	-	-	o	o	o	Light does not honour other command during transition.IKEA firmware bug.

Config Items

Item	Zigbee	OF	Dim	CT	C	EC	Notes
bri/execute_if_off	0x0008/0x000F	-	o	o	o	o
bri/max	0x0301/0x00110xFCC0/0x0516*	-	o	o	o	o
bri/min	0x0301/0x00100xFCC0/0x0515*	-	o	o	o	o
bri/on_level	0x0008/0x0011	-	o	o	o	o
bri/onoff_transitiontime	0x0008/0x0010	-	o	o	o	o
bri/startup	0x0008/0x4000	-	o	o	o	o
color/ct/startup	0x0300/0x4010	-	-	o	-	o
color/execute_if_off	0x0300/0x000F	-	-	o	o	o
color/gradient/reversed	0xFC03/0x0033	-	-	-	-	o	Gradient lights.
color/xy/startup/x	0x0300/0x0003*	-	-	o	-	o	Hue lights.
color/xy/startup/y	0x0300/0x0004*	-	-	o	-	o	Hue lights.
on/startup	0x0006/0x40030xFFC0/0x0517*	o	o	o	o	o

State Items

Item	Zigbee	OF	Dim	CT	C	EC	Notes
alert	0x0001	M	M	M	M	M
on	0x0006/0x0000	M	M	M	M	M
reachable	-	M	M	M	M	M
bri	0x0008/0x0000	-	M	M	M	M
colormode	0x0300/0x40010x0300/0x0008	-	-	M	M	M	Use static to correct where needed (Color Temperature Light).Additional logic needed for gradient lights and dynamic effects.
ct	0x0300/0x0007	-	-	M	-	M
x	0x0300/0x0003	-	-	-	o	o	Mandatory when color capabilities include xy.
y	0x0300/0x0004	-	-	-	o	o	Mandatory when color capabilities include xy.
effect	0x0300/0x4002	-	-	o	o	o	Mandatory when color capabilities include effect or when light supports dynamic effects.
gradient	-	-	-	-	-	o	Gradient lights.
hue	0x0300/0x40000x0300/0x0000	-	-	-	o	o	Mandatory when color capabilities include hs.
sat	0x0300/0x0001	-	-	-	o	o	Mandatory when color capabilities include hs.

Top-Level Items

Item	Zigbee	OF	Dim	CT	C	EC	Notes
id	-	M	M	M	M	M
lastannounced	-	M	M	M	M	M
lastseen	-	M	M	M	M	M
manufacturername	0x0000/0x0004	M	M	M	M	M	Use static to correct where needed (e.g. Tuya).
modelid	0x0000/0x0005	M	M	M	M	M	Use static to correct where needed (e.g. Tuya).
name	-	M	M	M	M	M
productid	0x0000/0x0040*	o	o	o	o	o	Hue lights.
productname	0x0000	o	o	o	o	o	Read through Hue Capabilities command.Use static to correct where needed.
swconfigid	0x0000/0x0041*	o	o	o	o	o	Hue lights.
swversion	0x0000/0x40000x0000/0x0006	M	M	M	M	M
type	-	M	M	M	M	M
uniqueid	-	M	M	M	M	M