Logo
Developing with ZBOSS for Zigbee
Modules | Macros | Typedefs
ZCL commands shared by all clusters
Zigbee stack API » ZCL API

Modules

 Default response command sending and parsing.
 
 Read attributes request and response sending and parsing.
 
 Write attributes command sending and parsing.
 
 Discover attributes request and response sending and parsing.
 
 Configure reporting command sending and parsing
 
 Report attribute command parsing
 
 Read reporting configuration command sending and parsing
 

Macros

#define ZB_ZCL_BROADCAST_ENDPOINT   0xFFU
 ZCL broadcast endpoint. More...
 
#define ZB_ZCL_BROADCAST_ENDPOINT_CMD_RESP_JITTER   (ZB_MILLISECONDS_TO_BEACON_INTERVAL(100))
 Minimum time delay between responses to ZCL command sent to broadcast endpoint. More...
 

Typedefs

typedef zb_uint8_t zb_zcl_cmd_t
 Type for ZCL common command IDs. More...
 

ZCL common command IDs

See also
ZCL spec, clause 2.4
Note
These values do not contain commands not unused in ZB HA profile
#define ZB_ZCL_CMD_READ_ATTRIB   0x00U
 
#define ZB_ZCL_CMD_READ_ATTRIB_RESP   0x01U
 
#define ZB_ZCL_CMD_WRITE_ATTRIB   0x02U
 
#define ZB_ZCL_CMD_WRITE_ATTRIB_UNDIV   0x03U
 
#define ZB_ZCL_CMD_WRITE_ATTRIB_RESP   0x04U
 
#define ZB_ZCL_CMD_WRITE_ATTRIB_NO_RESP   0x05U
 
#define ZB_ZCL_CMD_CONFIG_REPORT   0x06U
 
#define ZB_ZCL_CMD_CONFIG_REPORT_RESP   0x07U
 
#define ZB_ZCL_CMD_READ_REPORT_CFG   0x08U
 
#define ZB_ZCL_CMD_READ_REPORT_CFG_RESP   0x09U
 
#define ZB_ZCL_CMD_REPORT_ATTRIB   0x0aU
 
#define ZB_ZCL_CMD_DEFAULT_RESP   0x0bU
 
#define ZB_ZCL_CMD_DISC_ATTRIB   0x0cU
 
#define ZB_ZCL_CMD_DISC_ATTRIB_RESP   0x0dU
 
#define ZB_ZCL_CMD_READ_ATTRIB_STRUCT   0x0eU
 
#define ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT   0x0fU
 
#define ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT_RESP   0x10U
 
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED   0x11U
 
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED_RES   0x12U
 
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED   0x13U
 
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED_RES   0x14U
 
#define ZB_ZCL_CMD_DISCOVER_ATTR_EXT   0x15U
 
#define ZB_ZCL_CMD_DISCOVER_ATTR_EXT_RES   0x16U
 

Detailed Description

This section describes data structures representing command payloads shared by all clusters, and APIs for sending these commands and parsing their payloads.

Macro Definition Documentation

§ ZB_ZCL_BROADCAST_ENDPOINT

#define ZB_ZCL_BROADCAST_ENDPOINT   0xFFU

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

ZCL broadcast endpoint.

§ ZB_ZCL_BROADCAST_ENDPOINT_CMD_RESP_JITTER

#define ZB_ZCL_BROADCAST_ENDPOINT_CMD_RESP_JITTER   (ZB_MILLISECONDS_TO_BEACON_INTERVAL(100))

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Minimum time delay between responses to ZCL command sent to broadcast endpoint.

§ ZB_ZCL_CMD_CONFIG_REPORT

#define ZB_ZCL_CMD_CONFIG_REPORT   0x06U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Configure reporting command

§ ZB_ZCL_CMD_CONFIG_REPORT_RESP

#define ZB_ZCL_CMD_CONFIG_REPORT_RESP   0x07U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Configure reporting response command

§ ZB_ZCL_CMD_DEFAULT_RESP

#define ZB_ZCL_CMD_DEFAULT_RESP   0x0bU

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Default response command

§ ZB_ZCL_CMD_DISC_ATTRIB

#define ZB_ZCL_CMD_DISC_ATTRIB   0x0cU

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover attributes command

§ ZB_ZCL_CMD_DISC_ATTRIB_RESP

#define ZB_ZCL_CMD_DISC_ATTRIB_RESP   0x0dU

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover attributes response command

§ ZB_ZCL_CMD_DISCOVER_ATTR_EXT

#define ZB_ZCL_CMD_DISCOVER_ATTR_EXT   0x15U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover attributes extended command

§ ZB_ZCL_CMD_DISCOVER_ATTR_EXT_RES

#define ZB_ZCL_CMD_DISCOVER_ATTR_EXT_RES   0x16U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover attributes extended response command

§ ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED

#define ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED   0x13U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover Commands Generated command

§ ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED_RES

#define ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED_RES   0x14U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover Commands Generated response command

§ ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED

#define ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED   0x11U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover Commands Received command

§ ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED_RES

#define ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED_RES   0x12U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Discover Commands Received response command

§ ZB_ZCL_CMD_READ_ATTRIB

#define ZB_ZCL_CMD_READ_ATTRIB   0x00U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Read attributes command

§ ZB_ZCL_CMD_READ_ATTRIB_RESP

#define ZB_ZCL_CMD_READ_ATTRIB_RESP   0x01U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Read attributes response command

§ ZB_ZCL_CMD_READ_ATTRIB_STRUCT

#define ZB_ZCL_CMD_READ_ATTRIB_STRUCT   0x0eU

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Read attributes structured

§ ZB_ZCL_CMD_READ_REPORT_CFG

#define ZB_ZCL_CMD_READ_REPORT_CFG   0x08U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Read reporting config command

§ ZB_ZCL_CMD_READ_REPORT_CFG_RESP

#define ZB_ZCL_CMD_READ_REPORT_CFG_RESP   0x09U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Read reporting config response command

§ ZB_ZCL_CMD_REPORT_ATTRIB

#define ZB_ZCL_CMD_REPORT_ATTRIB   0x0aU

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Report attribute command

§ ZB_ZCL_CMD_WRITE_ATTRIB

#define ZB_ZCL_CMD_WRITE_ATTRIB   0x02U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Write attributes foundation command

§ ZB_ZCL_CMD_WRITE_ATTRIB_NO_RESP

#define ZB_ZCL_CMD_WRITE_ATTRIB_NO_RESP   0x05U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Write attributes no response command

§ ZB_ZCL_CMD_WRITE_ATTRIB_RESP

#define ZB_ZCL_CMD_WRITE_ATTRIB_RESP   0x04U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Write attributes response command

§ ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT

#define ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT   0x0fU

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Write attributes structured

§ ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT_RESP

#define ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT_RESP   0x10U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Write attributes structured response

§ ZB_ZCL_CMD_WRITE_ATTRIB_UNDIV

#define ZB_ZCL_CMD_WRITE_ATTRIB_UNDIV   0x03U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Write attributes undivided command

Typedef Documentation

§ zb_zcl_cmd_t

typedef zb_uint8_t zb_zcl_cmd_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_commands.h>

Type for ZCL common command IDs.

Deprecated:
holds one of zcl_cmd. Kept only for backward compatibility as zcl_cmd were declared previously as enum. Can be removed in future releases.
Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA. http://www.dsr-zboss.com http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.