Supported Devices

Manuel Pietschmann edited this page Dec 7, 2018 · 81 revisions

This page provides an overview of devices which are supported by the deCONZ REST API. If you would like support for another ZigBee device, please see Request Device Support.

Note Some devices listed here are only visible in the REST-API but not shown in the Phoscon App yet.

Sections

Resources

The deCONZ REST API plugin knows two sorts of resources for ZigBee devices:

  • /lights resources to control a device function from the gateway. These "input/output" resources have read/write state attributes and no config attributes;
  • /sensors resources for device functions that control other devices (directly or through the gateway), or provide input to the gateway. These "input-only" resources have read-only state attributes and read/write config attributes.

Because of this setup, all device functions (clusters in ZigBee speak) that are controlled by the gateway are exposed as /lights resources: lights, smart plugs and wired switches (used to smartify traditional devices), vents, window covering devices, warning devices (sirens), door locks (once they'll be supported), etc. Device clusters that only provide input to the gateway are exposed as /sensors resources: sensors, wireless switches (used to control smart devices).

The API might expose multiple resources for a single device: a /lights resource per supported ZigBee endpoint, combining the On/Off, Level Control, and Color Control clusters, and a /sensors resource per supported ZigBee cluster per endpoint. The uniqueid attribute of the resource is made up of the device's mac address, the ZigBee endpoint, and, for /sensors resources, the cluster id.

This might be confusing at first, especially for some wired switches that are used a) to let the gateway control traditional devices, as well as b) to control smart devices (directly or through the gateway). For a), a /lights resource is provided; for b) a /sensors resource.

Sensors

Measured Values Legend

Sensors are supported through one or more /sensors resources. The column Measured Values lists for each sensor which attributes the REST API supports on which resource type.

Attribute Unit Resource Type
A state.alarm bool ZHAAlarm
b config.battery % (any battery-powered sensor)
C state.carbonmonoxide bool ZHACarbonMonoxide
d state.dark bool ZHAPresence
F state.fire bool ZHAFire
H state.humidity 0.01% ZHAHumidity
L state.lightlevel
state.lux
state.dark
state.daylight

lux
bool
bool
ZHALightLevel
l state.lowbattery bool (any IAS Zone sensor)
M state.presence bool ZHAPresence
O state.open bool ZHAOpenClose
P state.pressure hPa ZHAPressure
T state.temperature 0.01˚C ZHATemperature
t config.temperature 0.01˚C (any Xiaomi sensor)
p state.tampered bool (any IAS Zone sensor)
W state.water bool ZHAWater
V state.vibration bool ZHAVibration

Supported Sensors

Vendor Name Measured Values Issues
Climax IR-9ZBS motion sensor Mb
Climax LMHT-1ZBS light sensor L, T, H, M
Climax LM-1ZBS light sensor L
Climax DC-15ZBS door/window sensor C B
Heiman HS1MS motion sensor Mblp
Heiman HS1DS door/window sensor Cblp
Heiman HS1HT temperature/humidity sensor Tb, Hb
Heiman HS1CA carbon monoxide sensor Cblp
Heiman HS1CG combustible gas sensor Fblp
Heiman HS1WL water leakage sensor Wblp
Heiman HS1SA smoke sensor Fblp
Heiman Siren 1 Ablp
IKEA TRÅDFRI motion sensor Md
Keen Home Vent 2 Tb, Pb
Philips Hue motion sensor Mb, Lb, Tb
Trust ZPIR-8000 Mbl
Visonic MCT-340 E motion/temperature sensor MT 978
Xiaomi Aqara motion sensor Mbt, Lbt
Xiaomi Aqara weather sensor Tb, Hb, Pb
Xiaomi Aqara door/window sensor Obt
Xiaomi Aqara vibration sensor Vbt 748
Xiaomi Mi motion sensor Mbt
Xiaomi Mi door/window sensor Obt
Xiaomi Mi temperature/humidity sensor Tb, Hb
Xiaomi Mi water leakage sensor Wbt

1  The Heiman Siren is exposed as a light for controlling the siren, and as a ZHAAlarm sensor.
2  The Keen Home Vent is exposed as a light for controlling the level, and as a ZHATemperature and a ZHAPressure sensor.

Unsupported Sensors

The following sensors are proposed for integration, for details please refer to the related GitHub issues.

Vendor Name Issues
NYCE Ceiling Motion Sensor (NCZ-3043) 548
OSRAM Smart+ Motion Sensor (Motion-Sensor-A) 881
Samsung Water Leak Sensor 946

Wireless Switches

Events Legend

Switches are supported as one or more /sensors resources of type ZHASwitch (or ZGPSwitch for ZigBee Green Power switches). For most switches, the value of state.buttonevent indicates how the switch was operated (x indicates the button):

Value Action
0 x000 Initial Press
1 x001 Hold
2 x002 Release (after press)
3 x003 Release (after hold)
4 x004 Double press
5 x005 Triple press
6 x006 Quadruple press
7 x007 Shake
8 x008 Drop

Supported Wireless Switches

Vendor Name Events Issues
Busch-Jaeger Control element, 1 gang
Busch-Jaeger Control element, 2 gang
Busch-Jaeger Control element, 4 gang
Busch-Jaeger Transmitter 1-channel
Busch-Jaeger Transmitter 2-channel
Busch-Jaeger Transmitter 4-channel
dresden elektronik Scene Switch 123, 123, 123, 123
dresden elektronik Lighting Switch 123, 123, 2, 2, 2, 2
GIRA Hand-held transmitter
Off, On, 1, 2, 3, 4, 5, 6

123, 123, 2, 2, 2, 2, 2
GIRA Wall transmitter 3-gang
Off, On, 1, 2, 3, 4

123, 123, 2, 2, 2, 2
IKEA TRÅDFRI remote control
On/Off, Up, Down, Left, Right

12, 123, 123, 123, 123
IKEA TRÅDFRI dimmer 2, 2, 2, 2
JUNG Hand-held transmitter
JUNG Transmitter module 4-gang
Philips Hue Dimmer Switch
On, Up, Down, Off

0123, 0123, 0123, 0123
Philips Hue Tap custom 1
ubisys Control Unit C1 123, 123, 123, 123
ubisys Dimmer D1 123, 123
Trust ZYCT-202
On, Up, Down, Off
2, 13, 13, 2
Xiaomi Aqara smart cube custom 1 138
Xiaomi Mi round smart wireless switch WXKG01LM
Xiaomi Aqara smart wireless switch WXKG11LM 2016
Xiaomi Aqara smart wireless switch WXKG11LM 2018 917
Xiaomi Aqara smart wireless switch WXKG12LM
Xiaomi Aqara wall switch (single rocker) WXKG03LM 2016
Xiaomi Aqara wall switch (single rocker) WXKG03LM 2018 811 915
Xiaomi Aqara wall switch (double rocker) WXKG02LM 2016
Xiaomi Aqara wall switch (double rocker) WXKG02LM 2018 811
Xiaomi Aqara wall switch (single rocker) QBKG11LM
Xiaomi Aqara wall switch (double rocker) QBKG12LM
Xiaomi Mi wireless switch 02456
Xiaomi Mi smart home cube custom 1 138

1  These switches use custom values for state.buttonevent please refer to the related GitHub issue pages for more information.

Unsupported Switches

The following switches are proposed for integration, for details please refer to the related GitHub issues.

Vendor Name Issues
IKEA Trådfri on/off switch 853 779
Innr Remote Control (RC 110) 635
OSRAM 4x Button Remote Control

Smart Plugs / In-Wall Switches / Power Meters

Measured Values Legend

Plugs and in-wall switches/dimmers are exposed as light for On/Off and for dimming control. Smart metering is supported by one or two additional sensor resources:

Attribute Unit Resource Type
C state.consumption Wh ZHAConsumption
p state.power W ZHAConsumption
P state.power W ZHAPower
v state.voltage V ZHAPower
c state.current mA ZHAPower

Supported Smart Plugs / In-Wall Switches / Power Meters

Vendor Name Measured Values Issues
Bitron 902010/25 Cp
Bitron 902010/26
Climax PSM-29ZBS Cp
Heiman SmartPlug Cp, Pva
innr SP 120 C, Pva
IKEA Trådfri Smart Plug 779
OSRAM 1 Lightify Plug P
OSRAM 1 Smart+ Plug P
ubisys Control Unit C4 Cp, Pva
ubisys 2 Dimmer D1 Cp, Pva
ubisys Switch S2 Cp, Pva
Xiaomi Smart Plug C, P
Xiaomi 3 Wall Switch C, P

1  The OSRAM plugs report 40W when switched on and 0W when switched off, regardless of the attached load.
2  I'm seeing funny values from my ubisys dimmer - under investigation with ubisys support.
3  Work in progress, currently works for model lumi.ctrl_ln2.

Unsupported Smart Plugs / In-Wall Switches / Power Meters

The following smart plugs and switches are proposed for integration, for details please refer to the related GitHub issues.

Vendor Name Issues
Orvibo In-wall switch (R11W2Z) 794
Centralite 3-Series Smart Outlet (3200, also Samsung) 432 819
Salus Smart Plug (SP600) 812
Smartenit Metering Dual-Load 30A Controller (ZBMLC30) 792
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.