5.2.6.3.9. ZCL Commissioning Cluster

This section provides the commissioning clusters implementations in ZCL of ESP Zigbee Core.

5.2.6.3.9.1. Touchlink Commissioning

5.2.6.3.9.1.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/touchlink_commissioning_desc.h

5.2.6.3.9.1.2. Functions

ezb_err_t ezb_zcl_touchlink_commissioning_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an touchlink_commissioning cluster descriptor.

Parameters:

• cluster_desc -- [in] The touchlink_commissioning cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_touchlink_commissioning_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an touchlink_commissioning cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the touchlink_commissioning cluster configuration structure. Use ezb_zcl_touchlink_commissioning_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_touchlink_commissioning_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_touchlink_commissioning_cluster_client_init(uint8_t ep_id)

Initialize the TouchlinkCommissioning cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_touchlink_commissioning_cluster_server_init(uint8_t ep_id)

Initialize the TouchlinkCommissioning cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.9.1.3. Structures

struct ezb_zcl_touchlink_commissioning_cluster_config_s

Cluster configuration for the TouchlinkCommissioning cluster.

Public Members

int _unused

Unused.

5.2.6.3.9.1.4. Macros

EZB_ZCL_TOUCHLINK_COMMISSIONING_CLUSTER_REVISION

Cluster Revision of the touchlink_commissioning cluster implementation.

EZB_ZCL_CLUSTER_ID_TOUCHLINK_COMMISSIONING_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_TOUCHLINK_COMMISSIONING_SERVER_ROLE_INIT

5.2.6.3.9.1.5. Type Definitions

typedef struct ezb_zcl_touchlink_commissioning_cluster_config_s ezb_zcl_touchlink_commissioning_cluster_config_t

Cluster configuration for the TouchlinkCommissioning cluster.

5.2.6.3.9.1.6. Enumerations

enum ezb_zcl_touchlink_commissioning_server_cmd_id_t

Received Command identifiers for the TouchlinkCommissioning cluster.

Values:

enumerator EZB_ZCL_CMD_TOUCHLINK_COMMISSIONING_GET_GROUP_IDENTIFIERS_REQUEST_ID

GetGroupIdentifiersRequest command.

enumerator EZB_ZCL_CMD_TOUCHLINK_COMMISSIONING_GET_ENDPOINT_LIST_REQUEST_ID

GetEndpointListRequest command.

enum ezb_zcl_touchlink_commissioning_client_cmd_id_t

Received Command identifiers for the TouchlinkCommissioning cluster.

Values:

enumerator EZB_ZCL_CMD_TOUCHLINK_COMMISSIONING_ENDPOINT_INFORMATION_ID

EndpointInformation command.

enumerator EZB_ZCL_CMD_TOUCHLINK_COMMISSIONING_GET_GROUP_IDENTIFIERS_RESPONSE_ID

GetGroupIdentifiersResponse command.

enumerator EZB_ZCL_CMD_TOUCHLINK_COMMISSIONING_GET_ENDPOINT_LIST_RESPONSE_ID

GetEndpointListResponse command.

5.2.6.3.9.1.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/touchlink_commissioning.h

5.2.6.3.9.1.8. Functions

ezb_err_t ezb_zcl_touchlink_get_group_ids_cmd_req(const ezb_zcl_touchlink_get_group_ids_cmd_req_t *cmd_req)

Send ZCL Touchlink Commissioning GetGroupIdentifiers command request.

Parameters:

cmd_req -- Pointer to the GetGroupIdentifiers command request structure, ezb_zcl_touchlink_get_group_ids_cmd_req_s.

Returns:

Error code.

ezb_err_t ezb_zcl_touchlink_get_ep_list_cmd_req(const ezb_zcl_touchlink_get_ep_list_cmd_req_t *cmd_req)

Send ZCL Touchlink Commissioning GetEndpointList command request.

Parameters:

cmd_req -- Pointer to the GetEndpointList command request structure, ezb_zcl_touchlink_get_ep_list_cmd_req_s.

Returns:

Error code.

ezb_err_t ezb_zcl_touchlink_ep_info_cmd_req(const ezb_zcl_touchlink_ep_info_cmd_req_t *cmd_req)

Send ZCL Touchlink Commissioning EndpointInformation command request.

Parameters:

cmd_req -- Pointer to the EndpointInformation command request structure, ezb_zcl_touchlink_ep_info_cmd_req_s.

Returns:

Error code.

5.2.6.3.9.1.9. Structures

struct ezb_zcl_touchlink_get_group_ids_cmd_req_s

Structure for the ZCL Touchlink Commissioning GetGroupIdentifiers command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t start_index

Starting index for retrieving group identifiers.

struct ezb_zcl_touchlink_get_ep_list_cmd_req_s

Structure for the ZCL Touchlink Commissioning GetEndpointList command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t start_index

Starting index for retrieving endpoint list.

struct ezb_zcl_touchlink_ep_info_cmd_req_s

Structure for the ZCL Touchlink Commissioning EndpointInformation command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_extaddr_t ieee_addr

IEEE address of the device.

uint16_t nwk_addr

Network address of the device.

uint8_t ep_id

Endpoint identifier.

uint16_t profile_id

Application profile identifier.

uint16_t device_id

Device identifier.

uint8_t device_version

Device version number.

struct ezb_zcl_touchlink_ep_info_s

Structure containing endpoint information for Touchlink Commissioning.

Public Members

ezb_extaddr_t ieee_addr

Extended IEEE address (64-bit).

uint16_t nwk_addr

Network address (16-bit).

uint8_t ep_id

Endpoint identifier.

uint16_t profile_id

Application profile identifier.

uint16_t device_id

Device identifier.

uint8_t version

Device version number.

struct ezb_zcl_touchlink_get_group_ids_rsp_s

Structure for the ZCL Touchlink Commissioning GetGroupIdentifiers response.

Public Members

uint8_t total

Total number of group identifiers available.

uint8_t start_index

Starting index of the returned group identifiers.

uint8_t count

Number of group identifiers in this response.

uint16_t *group_ids

Pointer to array of group identifiers.

struct ezb_zcl_touchlink_ep_info_record_s

Structure for a single endpoint information record.

Public Members

uint16_t nwk_addr

Network address of the device.

uint8_t ep_id

Endpoint identifier.

uint16_t profile_id

Application profile identifier.

uint16_t device_id

Device identifier.

uint8_t version

Device version number.

struct ezb_zcl_touchlink_get_ep_list_rsp_s

Structure for the ZCL Touchlink Commissioning GetEndpointList response.

Public Members

uint8_t total

Total number of endpoints available.

uint8_t start_index

Starting index of the returned endpoints.

uint8_t count

Number of endpoint records in this response.

ezb_zcl_touchlink_ep_info_record_t *records

Pointer to array of endpoint information records.

struct ezb_zcl_touchlink_ep_info_message_s

Message for the ZCL Touchlink Commissioning EndpointInformation message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_touchlink_ep_info_t *ep_info

Pointer to endpoint information.

struct ezb_zcl_touchlink_ep_info_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_touchlink_ep_info_message_s out

Output: result to send back.

struct ezb_zcl_touchlink_get_group_ids_rsp_message_s

Message for the ZCL Touchlink Commissioning GetGroupIdentifiers response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_touchlink_get_group_ids_rsp_t *rsp

Pointer to group identifiers response.

struct ezb_zcl_touchlink_get_group_ids_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_touchlink_get_group_ids_rsp_message_s out

Output: result to send back.

struct ezb_zcl_touchlink_get_ep_list_rsp_message_s

Message for the ZCL Touchlink Commissioning GetEndpointList response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_touchlink_get_ep_list_rsp_t *rsp

Pointer to endpoint list response.

struct ezb_zcl_touchlink_get_ep_list_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_touchlink_get_ep_list_rsp_message_s out

Output: result to send back.

5.2.6.3.9.1.10. Type Definitions

typedef struct ezb_zcl_touchlink_get_group_ids_cmd_req_s ezb_zcl_touchlink_get_group_ids_cmd_req_t

Structure for the ZCL Touchlink Commissioning GetGroupIdentifiers command request.

typedef struct ezb_zcl_touchlink_get_ep_list_cmd_req_s ezb_zcl_touchlink_get_ep_list_cmd_req_t

Structure for the ZCL Touchlink Commissioning GetEndpointList command request.

typedef struct ezb_zcl_touchlink_ep_info_cmd_req_s ezb_zcl_touchlink_ep_info_cmd_req_t

Structure for the ZCL Touchlink Commissioning EndpointInformation command request.

typedef struct ezb_zcl_touchlink_ep_info_s ezb_zcl_touchlink_ep_info_t

Structure containing endpoint information for Touchlink Commissioning.

typedef struct ezb_zcl_touchlink_get_group_ids_rsp_s ezb_zcl_touchlink_get_group_ids_rsp_t

Structure for the ZCL Touchlink Commissioning GetGroupIdentifiers response.

typedef struct ezb_zcl_touchlink_ep_info_record_s ezb_zcl_touchlink_ep_info_record_t

Structure for a single endpoint information record.

typedef struct ezb_zcl_touchlink_get_ep_list_rsp_s ezb_zcl_touchlink_get_ep_list_rsp_t

Structure for the ZCL Touchlink Commissioning GetEndpointList response.

typedef struct ezb_zcl_touchlink_ep_info_message_s ezb_zcl_touchlink_ep_info_message_t

Message for the ZCL Touchlink Commissioning EndpointInformation message.

typedef struct ezb_zcl_touchlink_get_group_ids_rsp_message_s ezb_zcl_touchlink_get_group_ids_rsp_message_t

Message for the ZCL Touchlink Commissioning GetGroupIdentifiers response message.

typedef struct ezb_zcl_touchlink_get_ep_list_rsp_message_s ezb_zcl_touchlink_get_ep_list_rsp_message_t

Message for the ZCL Touchlink Commissioning GetEndpointList response message.