|
|
|
|
|
The application layer of the Bosch IoT Gateway ZigBee Stack implementation uses the latest available version of the ZCL Metadata, which currently complies with ZigBee Library Specification R7.
ZigBee Cluster Library Support
Supported General Commands
Command Name |
Command ID |
Direction |
Used By |
|---|---|---|---|
Configure Reporting |
0x0006 |
Server/Client |
com.prosyst.mbs.services.zigbee.da.items.Reporting#OPERATION_CONFIGURE_REPORTING |
Read Reporting Configuration |
0x0008 |
Server/Client |
com.prosyst.mbs.services.zigbee.da.items.Reporting#OPERATION_READ_REPORTING |
Other General Command are supported as well, but their functionality is not exported as a dedicated item. E.g. Read/Write/Report attributes commands are used to get/set/event item properties.
Supported Clusters
Cluster Name |
Cluster ID |
Client/Server |
Bundle |
|---|---|---|---|
Basic |
0x0000 |
Server |
com.prosyst.mbs.zigbee.zcl.app.controller |
Identify |
0x0003 |
Server |
com.prosyst.mbs.zigbee.zcl.app.controller |
Time |
0x000a |
Server |
com.prosyst.mbs.zigbee.zcl.app.controller |
OTA Upgrade |
0x0019 |
Server |
com.prosyst.mbs.zigbee.zcl.app.controller |
Basic |
0x0000 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Power Configuration |
0x0001 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Identify |
0x0003 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
On/Off |
0x0006 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
On/Off Switch Configuration |
0x0007 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Level Control |
0x0008 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Alarms |
0x0009 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Time |
0x000a |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Poll Control |
0x0020 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Door Lock |
0x0101 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Window Covering |
0x0102 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Thermostat |
0x0201 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Fan Control |
0x0202 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Thermostat User Interface Configuration |
0x0204 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Color Control |
0x0300 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Illuminance Measurement |
0x0400 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Temperature Measurement |
0x0402 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Pressure Measurement |
0x0403 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Flow Measurement |
0x0404 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Relative Humidity Measurement |
0x0405 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Occupancy Sensing |
0x0406 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
IAS Zone |
0x0500 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
IAS Warning |
0x0502 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Metering |
0x0702 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Electrical Measurement |
0x0b04 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Diagnostics |
0x0b05 |
Client |
com.prosyst.mbs.zigbee.da.items.provider |
Basic Cluster (Server)
ZCL Attributes
Attribute Name |
Attribute ID |
Default Value |
Access |
Min |
Max |
Persistent |
|---|---|---|---|---|---|---|
ZCL Version |
0x0000 |
1 |
Read Only |
N/A |
N/A |
Yes |
Manufacturer Name |
0x0004 |
Bosch.IO |
Read Only |
N/A |
N/A |
Yes |
Model Identifier |
0x0005 |
Bosch ZigBee Stack |
Read Only |
N/A |
N/A |
Yes |
Power Source |
0x0007 |
1 |
Read Only |
N/A |
N/A |
Yes |
Identify Cluster (Server)
ZCL Attributes
Attribute Name |
Attribute ID |
Default Value |
Access |
Min |
Max |
Persistent |
|---|---|---|---|---|---|---|
Identify Time |
0x0000 |
1 |
Read Write |
0x0000 |
0xffff |
No |
ZCL Commands
Command Name |
Command ID |
Direction |
|---|---|---|
Identify |
0x0000 |
Client -> Server |
Identify Query |
0x0001 |
Client -> Server |
Time Cluster (Server)
Attribute Name |
Attribute ID |
Default Value |
Access |
Min |
Max |
Persistent |
|---|---|---|---|---|---|---|
Time* |
0x0000 |
N/A |
Read Write |
0x00000000 |
0xfffffffe |
N/A |
Time Status* |
0x0001 |
0b1001 |
Read Write |
N/A |
N/A |
N/A |
Time and Time Status attributes are not writable for Master Clock.
OTA Upgrade Cluster (Server)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Current File Version |
0x0002 |
Read Only |
Optional |
com.prosyst.mbs.services.da.Device#getAttributes(), firmware.version |
ZCL Commands
Command Name |
Command ID |
Direction |
|---|---|---|
Image Notify |
0x0000 |
Server -> Client |
Query Next Image Request |
0x0001 |
Client -> Server |
Query Next Image Response |
0x0002 |
Server -> Client |
Image Block Request |
0x0003 |
Client -> Server |
Image Page Request |
0x0004 |
Client -> Server |
Image Block Response |
0x0005 |
Server -> Client |
Upgrade End Request |
0x0006 |
Client -> Server |
Upgrade End Response |
0x0007 |
Server -> Client |
Basic Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Application Version |
0x0001 |
Read Only |
Optional |
com.prosyst.mbs.services.da.Device#getAttributes(), firmware.version |
HW Version |
0x0003 |
Read Only |
Optional |
com.prosyst.mbs.services.da.Device#getAttributes(), hardware.version |
Manufacturer Name |
0x0004 |
Read Only |
Optional |
com.prosyst.mbs.services.da.Device#getAttributes(), hardware.vendor |
Model Identifier |
0x0005 |
Read Only |
Optional |
com.prosyst.mbs.services.da.Device#getAttributes(), model |
Power Source |
0x0007 |
Read Only |
Optional |
com.prosyst.mbs.services.da.Device#getAttributes(), primary.power.source |
Power configuration Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Battery Voltage |
0x0020 |
Read Only |
Optional* |
com.prosyst.mbs.services.da.items.Detector, detector.detects=battery-low |
Battery Source 1 Percentage Remaining |
0x0021 |
Read Only |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Dimensionless>, da.sensor.medium=battery, da.sensor.type=level |
Battery Alarm Mask |
0x0035 |
Read Only |
Optional* |
com.prosyst.mbs.services.da.items.Detector, detector.detects=battery-low |
Battery Voltage Min Threshold |
0x0036 |
Read Only |
Optional* |
com.prosyst.mbs.services.da.items.Detector, detector.detects=battery-low |
Battery Source 1 Alarm State |
0x003e |
Read Only |
Optional* |
com.prosyst.mbs.services.da.items.Detector, detector.detects=battery-low |
At least one of the following is mandatory: Battery Voltage with Battery Voltage Min Threshold or Battery Alarm Mask or Battery Source 1 Alarm State.
Identify Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Identify Time |
0x0000 |
Read Only |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.Identifier#PROPERTY_REMAINING_TIME |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Off |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.Switch#OPERATION_OFF |
On |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.Switch#OPERATION_ON |
On/Off Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
OnOff |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Switch#PROPERTY_ON com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Off |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.Switch#OPERATION_OFF |
On |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.Switch#OPERATION_ON |
On/Off Switch Configuration Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Switch Type |
0x0000 |
Read Only |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.OnOffSwitchConfiguration#PROPERTY_SWITCH_TYPE |
Switch Actions |
0x0010 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.OnOffSwitchConfiguration#PROPERTY_SWITCH_ACTION |
Level Control Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Current Level |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.TransitionActuator<Dimensionless> |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Stop |
0x0003 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.TransitionActuator<Dimensionless> com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Move to Level (with On/Off) |
0x0004 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.TransitionActuator<Dimensionless> com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Alarms Cluster (Client)
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Alarm |
0x0000 |
Server -> Client |
Mandatory |
com.prosyst.mbs.services.da.items.Detector, detector.detects=battery-low com.prosyst.mbs.services.zigbee.da.items.ZigBeeAlarms#PROPERTY_ALARM |
Reset Alarm |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeeAlarms#OPERATION_RESET_ALARM |
Reset all alarms |
0x0001 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeeAlarms#OPERATION_RESET_ALL_ALARMS |
Time Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Time |
0x0000 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.TimeControl#PROPERTY_TIME |
Time Status |
0x0001 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.TimeControl#PROPERTY_STATUS |
Poll Control Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Check-in Interval |
0x0000 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_WAKE_UP_INTERVAL |
Long Poll Interval |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_LONG_POLL_INTERVAL |
Short Poll Interval |
0x0002 |
Read |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_SHORT_POLL_INTERVAL |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Check-in |
0x0000 |
Server -> Client |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_AWAKE |
Check-in Response |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_AWAKE |
Fast Poll Stop |
0x0001 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_SHORT_POLL_INTERVAL |
Set Long Poll Interval |
0x0002 |
Client -> Server |
Optional |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_LONG_POLL_INTERVAL |
Set Short Poll Interval |
0x0003 |
Client -> Server |
Optional |
com.prosyst.mbs.services.zigbee.da.items.ZigBeePowerSave#PROPERTY_SHORT_POLL_INTERVAL |
Door Lock Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Lock State |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ha.Lock#PROPERTY_STATE |
Lock Type |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ha.Lock, zigbee.lock.type |
Door State |
0x0003 |
Read Report |
Optional |
com.prosyst.mbs.services.zigbee.da.items.ha.Door#PROPERTY_STATE |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Lock Door |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ha.Lock#OPERATION_LOCK |
Unlock Door |
0x0001 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ha.Lock#OPERATION_UNLOCK |
Toggle |
0x0002 |
Client -> Server |
Optional |
com.prosyst.mbs.services.zigbee.da.items.ha.Lock#OPERATION_TOGGLE |
Window Covering (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Window Covering Type |
0x0000 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Opener, da.operates, da.characteristic |
Current Position Lift |
0x0003 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Length>#PROPERTY_VALUE |
Current Position Tilt |
0x0004 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Actuator<PlaneAngle>#PROPERTY_VALUE |
Current Position Lift Percentage |
0x0008 |
Read Report |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Dimensionless>#PROPERTY_VALUE |
Current Position Tilt Percentage |
0x0009 |
Read Report |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Dimensionless>#PROPERTY_VALUE |
Installed Open Limit Lift |
0x0010 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Length>#PROPERTY_RANGE |
Installed Closed Limit Lift |
0x0011 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Length>#PROPERTY_RANGE |
Installed Open Limit Tilt |
0x0012 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Actuator<PlaneAngle>#PROPERTY_RANGE |
Installed Closed Limit Tilt |
0x0013 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Actuator<PlaneAngle>#PROPERTY_RANGE |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Up/Open |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.Opener#OPERATION_OPEN |
Down/Close |
0x0001 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.Opener#OPERATION_CLOSE |
Stop |
0x0002 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.Opener#OPERATION_STOP |
Go To Lift Value |
0x0004 |
Client -> Server |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Length> |
Go to Lift Percentage |
0x0005 |
Client -> Server |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Dimensionless> |
Go To Tilt Value |
0x0007 |
Client -> Server |
Optional |
com.prosyst.mbs.services.da.items.Actuator<PlaneAngle> |
Go to Tilt Percentage |
0x0008 |
Client -> Server |
Optional |
com.prosyst.mbs.services.da.items.Actuator<Dimensionless> |
Thermostat Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Local Temperature |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Temperature> |
Abs Min Heat Setpoint Limit |
0x0003 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Abs Max Heat Setpoint Limit |
0x0004 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Abs Min Cool Setpoint Limit |
0x0005 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Abs Max Cool Setpoint Limit |
0x0006 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Occupied Cooling Setpoint |
0x0011 |
Read Write Report |
Mandatory* |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_VALUE |
Occupied Heating Setpoint |
0x0012 |
Read Write Report |
Mandatory* |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_VALUE |
Min Heat Setpoint Limit |
0x0015 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Max Heat Setpoint Limit |
0x0016 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Min Cool Setpoint Limit |
0x0017 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Max Cool Setpoint Limit |
0x0018 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Temperature>#PROPERTY_RANGE |
Control Sequence Of Operation |
0x001b |
Read Write Report |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ha.Thermostat#PROPERTY_CONTROL_MODE |
System Mode |
0x001c |
Read Write Report |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ha.Thermostat#PROPERTY_SYSTEM_MODE |
Thermostat Running Mode |
0x001e |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.ha.Thermostat#PROPERTY_RUNNING_MODE |
Thermostat Running State |
0x0029 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.ha.Thermostat#PROPERTY_RUNNING_STATE |
At least one of these attributes is mandatory.
Fan Control Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Fan Mode |
0x0000 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.FanControl#PROPERTY_MODE |
Fan Mode Sequence |
0x0001 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.FanControl#PROPERTY_MODE_SEQUENCE |
Thermostat User Interface Configuration Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Temperature Display Mode |
0x0000 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ThermostatUIConfiguration#PROPERTY_DISPLAY_MODE |
Keypad Lockout |
0x0001 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ThermostatUIConfiguration#PROPERTY_KEYPAD_LOCKOUT |
Color Control Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Current Hue |
0x0000 |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Current Saturation |
0x0001 |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Current X |
0x0003 |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Current Y |
0x0004 |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Color Temperature Mireds |
0x0007 |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Color Mode |
0x0008 |
Read |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.ll.ColorMode#PROPERTY_MODE |
Enhanced Current Hue |
0x4000 |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Color Capabilities |
0x400a |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Color Temp Physical Min Mireds |
0x400b |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Dimensionless>#PROPERTY_RANGE |
Color Temp Physical Max Mireds |
0x400c |
Read |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Dimensionless>#PROPERTY_RANGE |
Depending on Color Capabilities attribute.
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Move to Hue and Saturation |
0x0006 |
Client -> Server |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Move to Color |
0x0007 |
Client -> Server |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Move to Color Temperature |
0x000a |
Client -> Server |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Dimensionless> |
Enhanced Move to Hue and Saturation |
0x0040 |
Client -> Server |
Mandatory* |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Stop Move Step |
0x0047 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.da.items.TransitionActuator<Color> |
Depending on Color Capabilities attribute.
Illuminance Measurement Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Measured Value |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Illuminance>#PROPERTY_VALUE |
Min Measured Value |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Illuminance>#PROPERTY_RANGE |
Max Measured Value |
0x0002 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Illuminance>#PROPERTY_RANGE |
Temperature Measurement Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Measured Value |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Temperature>#PROPERTY_VALUE |
Min Measured Value |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Temperature>#PROPERTY_RANGE |
Max Measured Value |
0x0002 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Temperature>#PROPERTY_RANGE |
Pressure Measurement Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Measured Value |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Pressure>#PROPERTY_VALUE |
Min Measured Value |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Pressure>#PROPERTY_RANGE |
Max Measured Value |
0x0002 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Pressure>#PROPERTY_RANGE |
Flow Measurement Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Measured Value |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<VolumetricFlowRate>#PROPERTY_VALUE |
Min Measured Value |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<VolumetricFlowRate>#PROPERTY_RANGE |
Max Measured Value |
0x0002 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<VolumetricFlowRate>#PROPERTY_RANGE |
Relative Humidity Measurement Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Measured Value |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Dimensionless>#PROPERTY_VALUE |
Min Measured Value |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Dimensionless>#PROPERTY_RANGE |
Max Measured Value |
0x0002 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor<Dimensionless>#PROPERTY_RANGE |
Occupancy Sensing Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Occupancy |
0x0000 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Detector, da.detector.detects=motion |
PIR Occupied To Unoccupied Delay |
0x0010 |
Read Write |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Time>#PROPERTY_VALUE |
PIR Unoccupied To Occupied Delay |
0x0011 |
Read Write |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Time>#PROPERTY_VALUE |
PIR Unoccupied To Occupied Threshold |
0x0012 |
Read Write |
Optional |
com.prosyst.mbs.services.da.items.Setpoint<Dimensionless>#PROPERTY_VALUE |
IAS Zone Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Zone State |
0x0000 |
Read |
Mandatory |
Internal usage, part of IAS Zone Enroll process. |
Zone Type |
0x0001 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Detector, da.detector.detects |
Zone Status |
0x0002 |
Read Report |
Mandatory |
com.prosyst.mbs.services.da.items.Detector, da.detector.detects |
IAS_CIE_Address |
0x0010 |
Read Write |
Mandatory |
Internal usage, part of IAS Zone Enroll process. |
Number Of Zone Sensitivity Levels Supported |
0x0012 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.IASZoneConfiguration#PROPERTY_NUMBER_OF_ZONE_SENSITIVITY_LEVELS |
Current Zone Sensitivity Level |
0x0013 |
Read Write |
Optional |
com.prosyst.mbs.services.zigbee.da.items.IASZoneConfiguration#PROPERTY_CURRENT_ZONE_SENSITIVITY_LEVEL |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Zone Enroll Response |
0x0000 |
Client -> Server |
Mandatory |
Internal usage, part of IAS Zone Enroll process. |
Initiate Normal Operation Mode |
0x0001 |
Client -> Server |
Optional |
com.prosyst.mbs.services.zigbee.da.items.IASZoneConfiguration#OPERATION_INITIATE_NORMAL_OPERATION_MODE |
Initiate Test Mode |
0x0002 |
Client -> Server |
Optional |
com.prosyst.mbs.services.zigbee.da.items.IASZoneConfiguration#OPERATION_INITIATE_TEST_MODE |
Zone Status Change Notification |
0x0000 |
Server -> Client |
Mandatory |
com.prosyst.mbs.services.da.items.Detector, da.detector.detects |
Zone Enroll Request |
0x0000 |
Server -> Client |
Mandatory |
Internal usage, part of IAS Zone Enroll process. |
IAS Warning Cluster
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Max Duration |
0x0000 |
Read Write |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.IASWarning#PROPERTY_MAX_SOUND_DURATION |
ZCL Commands
Command Name |
Command ID |
Direction |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Start Warning |
0x0000 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.IASWarning#OPERATION_START_WARNING |
Squawk |
0x0001 |
Client -> Server |
Mandatory |
com.prosyst.mbs.services.zigbee.da.items.IASWarning#OPERATION_SQUAWK |
Metering Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Current Tier 1 Summation Delivered |
0x0000 |
Read Report |
Optional |
com.prosyst.mbs.services.da.items.Sensor#PROPERTY_VALUE |
Current Tier 1 Summation Received |
0x0001 |
Read Report |
Optional |
com.prosyst.mbs.services.da.items.Sensor#PROPERTY_VALUE |
Unit of Measure |
0x0300 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor |
Multiplier |
0x0301 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Sensor |
Divisor |
0x0302 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Sensor |
Metering Device Type |
0x0306 |
Read |
Mandatory |
com.prosyst.mbs.services.da.items.Sensor, da.sensor.medium |
Instantaneous Demand |
0x0400 |
Read Report |
Optional |
com.prosyst.mbs.services.da.items.Sensor#PROPERTY_VALUE |
Electrical Measurement Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Total Active Power |
0x0304 |
Read Report |
Optional |
com.prosyst.mbs.services.da.items.Sensor<Power>#PROPERTY_VALUE |
Power Multiplier |
0x0402 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Sensor<Power> |
Power Divisor |
0x0403 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Sensor<Power> |
Active Power |
0x050b |
Read Report |
Optional |
com.prosyst.mbs.services.da.items.Sensor<Power>#PROPERTY_VALUE |
AC Power Multiplier |
0x0604 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Sensor<Power> |
AC Power Divisor |
0x0605 |
Read |
Optional |
com.prosyst.mbs.services.da.items.Sensor<Power> |
Diagnostics Cluster (Client)
ZCL Attributes
Attribute Name |
Attribute ID |
Access |
Mandatory/Optional |
Used By |
|---|---|---|---|---|
Number Of Resets |
0x0000 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Persistent Memory Writes |
0x0001 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Mac Rx Bcast |
0x0100 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Mac Tx Bcast |
0x0101 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Mac Rx Ucast |
0x0102 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Mac Tx Ucast |
0x0103 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Mac Tx Ucast Retry |
0x0104 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Mac Tx Ucast Fail |
0x0105 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Rx Bcast |
0x0106 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Tx Bcast |
0x0107 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Rx Ucast |
0x0108 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Tx Ucast Success |
0x0109 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Tx Ucast Retry |
0x010a |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Tx Ucast Fail |
0x010b |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Route Disc Initiated |
0x010c |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Neighbor Added |
0x010d |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Neighbor Removed |
0x010e |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Neighbor Stale |
0x010f |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Join Indication |
0x0110 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Child Moved |
0x0111 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
NWK FC Failure |
0x0112 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS FC Failure |
0x0113 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Unauthorized Key |
0x0114 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
NWK Decrypt Failures |
0x0115 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
APS Decrypt Failures |
0x0116 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Packet Buffer Allocate Failures |
0x0117 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Relayed Ucast |
0x0118 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Phy to MAC queue limit reached |
0x0119 |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Packet Validate drop count |
0x011a |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Average MAC Retry Per APS Message Sent |
0x011b |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Last Message LQI |
0x011c |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |
Last Message RSSI |
0x011d |
Read |
Optional |
com.prosyst.mbs.services.zigbee.da.items.Diagnostics |