Tables

Clusters

This table lists all Zigbee clusters that are supported by Zigate. Refer to the Zigbee Cluser Library specification for details.

Cluster ID Name Description
0x0000 Basic
(ZCL, p. 3-1)
Attributes for determining basic information about a device, setting user device information such as desc of location, and enabling a device.
0x0001 Power configuration
(ZCL, p. 3-1)
Attributes for determining more detailed information about a device’s power source(s), and for configuring under/over voltage alarms.
0x0002 Device temperature configuration
(ZCL, p. 3-1)
Attributes for determining information about a device’s internal temperature, and for configuring under/over temperature alarms.
0x0003 Identify
(ZCL, p. 3-1)
Attributes and commands for putting a device into Identification mode (e.g., flashing a light)
0x0004 Groups
(ZCL, p. 3-2)
Attributes and commands for allocating a device to one or more of a number of groups of devices, where each group is addressable by a group address.
0x0005 Scenes
(ZCL, p. 3-2)
Attributes and commands for setting up and recalling a number of scenes for a device. Each scene corresponds to a set of stored values of specified device attributes.
0x0006 On/Off
(ZCL, p. 3-2)
Attributes and commands for switching devices between ‘On’ and ‘Off’ states.
0x0007 On/Off switch configuration
(ZCL, p. 3-2)
Attributes and commands for configuring on/off switching devices.
0x0008 Level Control
(ZCL, p. 3-2)
Attributes and commands for controlling a characteristic of devices that can be set to a level between fully ‘On’ and fully ‘Off’.
0x0009 Alarms
(ZCL, p. 3-3)
Attributes and commands for sending alarm notifications and configuring alarm functionality.
0x000a Time
(ZCL, p. 3-3)
Attributes and commands that provide an interface to a real-time clock.
0x000f Binary Input (basic)
(ZCL, p. 3-4)
An interface for reading the value of a binary measurement and accessing various characteristics of that measurement.
0x0019 OTA An interface for setting the value of a binary output (typically to the environment) and accessing various characteristics of that value.
0x0020 Poll Control
(ZCL, p. 3-143)
0x0101 Door Lock
(ZCL, p. 7-1)
An interface to a generic way to secure a door.
0x0201 Thermostat
(ZCL, p. 6-1)
An interface for configuring and controlling the functionality of a thermostat.
0x0202 Fan control
(ZCL, p. 6-1)
An interface for controlling a fan in a heating / cooling system.
0x0300 Color control
(ZCL, p. 5-1)
Attributes and commands for controlling the color of a color-capable light.
0x0400 Illuminance measurement
(ZCL, p. 4-1)
Attributes and commands for configuring the measurement of illuminance, and reporting illuminance measurements
0x0402 Temperature measurement
(ZCL, p. 4-2)
Attributes and commands for configuring the meas- urement of temperature, and reporting temPressure Measurement
0x0405 Measurement: Humidity
(ZCL, p. 4-2)
Attributes and commands for configuring the meas- urement of pressure, and reporting pressure measurements.
0x0500 IAS Zone
(ZCL, p. 457)
0x0702 Metering
(ZCL, p. 10-1)
Commands and attributes for reporting metering data.
0x0b05 Diagnostics
(ZCL, p. 3-4)
Attributes and commands that provide an interface to diagnostics of the ZigBee stack.
0x1000 Touchlink commissioning
0xff01 Xiaomi proprietary
0xff02 Xiaomi proprietary

Enumerations

This table explains the meaning of the enumerations used in the ZDP. For more information refer to Spec., p. 214.

Enumeration Value Description
SUCCESS 0x0000 The requested operation or transmission was completed successfully.
INV_REQUESTTYPE 0x0080 The supplied request type was invalid.
DEVICE_NOT_FOUND 0x0081 The requested device did not exist on a device following a child descriptor request to a parent.
INVALID_EP 0x0082 The supplied endpoint was equal to 0x00 or 0xff.
NOT_ACTIVE 0x0083 The requested endpoint is not described by a simple descriptor.
NOT_SUPPORTED 0x0084 The requested optional feature is not supported on the target device.
TIMEOUT 0x0085 A timeout has occurred with the requested operation.
NO_MATCH 0x0086 The end device bind request was unsuccessful due to a failure to match any suitable clusters.
NO_ENTRY 0x0088 The unbind request was unsuccessful due to the coordinator or source device not having an entry in its binding table to unbind.
NO_DESCRIPTOR 0x0089 A child descriptor was not available following a discovery request to a parent.
INSUFFICIENT_SPACE 0x008a The device does not have storage space to support the requested operation.
NOT_PERMITTED 0x008b The device is not in the proper state to support the requested operation.
TABLE_FULL 0x008e The device does not have table space to support the operation.
NOT_AUTHORIZED 0x008d The permissions configuration table on the target indicates that the request is not authorized from this device.
DEVICE_BINDING_TABLE_FULL 0x008e The device does not have binding table space to support the operation.

Commands

Basic
Request Parameters
Request Version

0x0010

Response: Status, Version

Set Channel Mask

0x0021

Response: Status

Channel mask
uint32_t
Set Device Type

0x0022

Response: Status

Device type
uint8_t
Enumerations
0
Coordinator
1
Router
2
Legacy router
Start Network

0x0024

Response: Status, Network Joined

Network Address Request

Zigbee: NWK_addr_req, Spec., p. 101.
0x0040

Response: Status, Network Address Response

The NWK_addr_req is generated from a Local Device wishing to inquire as to the 16-bit address of the Remote Device based on its known IEEE address. The destination addressing on this command shall be unicast or broadcast to all devices for which macRxOnWhenIdle = TRUE.

IEEE Address
uint64_t
Request Type
uint8_t
Enumerations
0
Simple Device Response
1
Extended Device Response
0x02 - 0xff
Reserved
Request Type
uint8_t
IEEE Address Request

Zigbee: IEEE_addr_req, Spec., p. 103.
0x0041

Response: Status, IEEE Address Response

The IEEE_addr_req is generated from a Local Device wishing to inquire as to the 64-bit IEEE address of the Remote Device based on their known 16-bit address. The destination addressing on this command shall be unicast.

Short address
uint16_t
Request type
uint8_t
Enumerations
0
Single device response
1
Extended response
Start index
uint8_t
Node Descriptor request

Zigbee: Node_Desc_req, Spec., p. 105.
0x0042

Response: Status, Node Descriptor response

The Node_Desc_req command is generated from a local device wishing to inquire as to the node descriptor of a remote device. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. The local device shall generate the

Address
uint16_t
Node Descriptor request

Zigbee: Simple_Desc_req, Spec., p. 105.
0x0043

Response: Status, Simple Descriptor response

The Simple_Desc_req command is generated from a local device wishing to inquire as to the simple descriptor of a remote device on a specified endpoint. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. The local device shall generate the Simple_Desc_req command using.

Address
uint16_t
endpoint
uint8_t

Responses
Request Parameters
Status

0x8000

Status
uint8_t
Enumerations
0
Success
1
Incorrect parameters
2
Unhandled command
3
Command failed
4
Busy (node is carying out lenghty operation)
5
Stack already starteed (no new configuration accepted)
127 - 244
Zigbee error
Sequence number
uint8_t
Packet type
uint16_t
Additional info
string
Node Descriptor response

Zigbee: Node_Desc_rsp, Spec., p. 158.
0x8042

Sequence number
uint8_t
Status
uint8_t
Enumerations
0x00
SUCCESS
0x81
DEVICE_NOT_FOUND
0x80
INV_REQUESTTYPE
0x89
NO_DESCRIPTOR
NWKAddrOfInterest
uint16_t
Manufacturer code
uint16_t
Max RX size
uint16_t
Server mask bits
uint16_t
Bit Flag
0 Primary trust center
1 Back up trust center
2 Primary binding cache
3 Backup binding cache
4 Primary discovery cache
5 Backup discovery cache
6 Network manager
7 - 15 Reserved
Descriptor capability
uint8_t
MAC flags
uint8_t
Bit fields
uint16_t

Reference: to Spec., p. 82

Field name Length (bits)
Logical type 3
Complex descriptor available 1
User descriptor available 1
Reserved 3
APS flags 3
Frequency band 5