ZCL Touchlink Commissioning cluster

Data Structures
struct	zb_zll_commissioning_scan_req_s
	Parsed Scan request payload representation. More...
struct	zb_zll_commissioning_ep_info_s
	Endpoint information for parsed Commissioning.ScanResponse representation. More...
struct	zb_zll_commissioning_scan_res_s
	Parsed Commissioning.ScanResponse structure. More...
struct	zb_zll_commissioning_device_information_req_s
	Parsed Commissioning.DeviceInformationRequest payload. More...
struct	zb_zll_commissioning_device_information_common_res_s
	Parsed permanent part of the Commissioning.DeviceInformationResponse payload. More...
struct	zb_zll_commissioning_device_information_ep_info_res_s
	Parsed device information record from the Commissioning.DeviceInformationResponse payload. More...
struct	zb_zll_commissioning_identify_req_s
	Parsed Commissioning.IdentifyRequest payload. More...
struct	zb_zll_commissioning_identify_req_param_s
	Identify request parameters. More...
struct	zb_zll_commissioning_reset_to_fn_s
	Parsed Commissioning.ResetToFactoryNewRequest payload. More...
struct	zb_zll_commissioning_network_start_req_s
	Parsed Commissioning.NetworkStartRequest payload. More...
struct	zb_zll_commissioning_network_start_res_s
	Parsed Commissioning.NetworkStartResponse payload. More...
struct	zb_zll_commissioning_network_join_router_req_s
	Parsed Commissioning.NetworkJoinRouterRequest payload. More...
struct	zb_zll_commissioning_network_join_router_res_s
	Parsed Commissioning.NetworkJoinRouterResponse payload. More...
struct	zb_zll_commissioning_network_join_end_device_req_s
	Parsed Commissioning.NetworkJoinEndDeviceRequest payload. More...
struct	zb_zll_commissioning_network_join_end_device_res_s
	Parsed Commissioning.NetworkJoinEndDeviceResponse payload. More...
struct	zb_zll_commissioning_network_update_req_s
	Parsed Commissioning.NetworkUpdateRequest payload. More...
struct	zb_zll_commissioning_get_group_ids_req_s
	Parsed Commissioning.GetGroupIdentifiersRequest payload. More...
struct	zb_zll_commissioning_get_group_ids_res_permanent_s
	Parsed Commissioning.GetGroupIdentifiersResponse payload. More...
struct	zb_zll_commissioning_group_info_record_s
	Group information record for Commissioning.GetGroupIdentifiersResponse command. More...
struct	zb_zll_commissioning_get_endpoint_list_req_s
	Parsed Commissioning.GetEndpointListRequest payload. More...
struct	zb_zll_commissioning_get_endpoint_list_res_s
	Parsed Commissioning.GetEndpointListResponse payload. More...
struct	zb_zll_commissioning_endpoint_info_record_s
	Endpoint information record for Commissioning.GetEndpointListResponse command. More...
struct	zb_zll_commissioning_endpoint_information_s
	Parsed Commissioning.EndpointInformation payload. More...

Macros
#define	ZB_ZCL_TOUCHLINK_COMMISSIONING_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0003u)
	Default value for Touchlink Commissioning cluster revision global attribute.
#define	ZB_ZCL_DECLARE_TOUCHLINK_COMMISSIONING_ATTR_LIST(attr_list)
	Declare attribute list for Touchlink Commissioning cluster (only cluster revision attribute) More...
#define	ZB_ZLL_PRIMARY_CHANNEL_MASK   ((1l << 11) | (1l << 15) | (1l << 20) | (1l << 25))
	First primary Touchlink channels mask.
#define	ZB_ZLL_MIN_ADDR_RANGE   100
	Configurable parameters: minimum address range that maybe assigned during commissioning.
#define	ZB_ZLL_DEFAULT_ADDR_RANGE   1000
	Configurable parameters: default address range that is assigned during commissioning.
#define	ZB_ZLL_MIN_GROUP_ID_RANGE   100
	Configurable parameters: minimum group id range that maybe assigned during commissioning.
#define	ZB_ZLL_DEFAULT_GROUP_ID_RANGE   1000
	Configurable parameters: default group id range that is assigned during commissioning.
#define	ZB_ZLL_APLC_INTRP_TRANSID_LIFETIME   ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(8000))
	aplcInterPANTransIdLifetime constant value. More...
#define	ZB_ZLL_APLC_SCAN_TIME_BASE_DURATION   ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(250))
	aplcScanTimeBaseDuration constant value. More...
#define	ZB_ZLL_APLC_RX_WINDOW_DURATION   (ZB_MILLISECONDS_TO_BEACON_INTERVAL(5000))
	aplcRxWindowDuration constant value. More...
#define	ZB_ZLL_APLC_MIN_STARTUP_DELAY_TIME   (ZB_MILLISECONDS_TO_BEACON_INTERVAL(2000))
	aplcMinStartupDelayTime constant value. More...
#define	ZB_ZLL_REPORT_ATTR_COUNT   0

Touchlink Commissioning cluster internals
Internal structures for Touchlink Commissioning cluster
enum	zb_zll_general_status_e { ZB_ZLL_GENERAL_STATUS_SUCCESS, ZB_ZLL_GENERAL_STATUS_FAILURE }
	Touchlink commissioning general status is used in different commissioning response command frames. More...
typedef enum zb_zll_general_status_e	zb_zll_general_status_t
	Touchlink commissioning general status is used in different commissioning response command frames.
zb_ret_t	zb_zll_send_packet (zb_bufid_t buffer, zb_uint8_t *data_ptr, zb_ieee_addr_t dst_addr_long, zb_callback_t callback)
	Finish packet and send it to the designated IEEE address. More...
zb_uint8_t *	zb_zll_get_nib_ext_pan_id (void)
	Get NIB Ext Pan ID.
zb_uint8_t	zb_zll_get_nib_update_id (void)
	Get NIB Update ID.
#define	ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr_long, callback)   zb_zll_send_packet(buffer, data_ptr, dst_addr_long, callback)
#define	ZB_ZLL_GET_NEW_RESPONSE_ID()   0x01
	Provides new response identifier.
#define	ZB_ZLL_GET_NEW_TRANS_ID()   0x01
	Provides new inter-PAN transaction identifier.

Touchlink Commissioning cluster commands
enum	zb_zll_commissioning_touchlink_cmd_e {   ZB_ZLL_CMD_COMMISSIONING_SCAN_REQ = 0x00, ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_REQ = 0x02, ZB_ZLL_CMD_COMMISSIONING_IDENTIFY_REQ = 0x06, ZB_ZLL_CMD_COMMISSIONING_RESET_TO_FACTORY_NEW_REQ = 0x07,   ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_REQ = 0x10, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_REQ = 0x12, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_REQ = 0x14, ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ = 0x16 }
	Touchlink commissioning cluster command identifiers. More...
enum	zb_zll_commissioning_utility_cmd_e { ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_REQUEST = 0x41, ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_REQUEST = 0x42 }
	Touchlink commissioning cluster utility command identifiers. More...
enum	zb_zll_commissioning_touchlink_cmd_resp_e {   ZB_ZLL_CMD_COMMISSIONING_SCAN_RES = 0x01, ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_RES = 0x03, ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_RES = 0x11, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_RES = 0x13,   ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_RES = 0x15 }
	Touchlink commissioning cluster response command identifiers. More...
enum	zb_zll_commissioning_utility_cmd_resp_e { ZB_ZLL_CMD_COMMISSIONING_ENDPOINT_INFORMATION = 0x40, ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_RESPONSE = 0x41, ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_RESPONSE = 0x42 }
	Touchlink commissioning cluster utility response command identifiers. More...
enum	zb_zll_info_e { ZB_ZLL_INFO_FACTORY_NEW = 0x01, ZB_ZLL_INFO_ADDR_ASSIGNMENT = 0x02, ZB_ZLL_INFO_TOUCHLINK_INITIATOR = 0x10, ZB_ZLL_INFO_TOUCHLINK_PRIOR = 0x20 }
	Touchlink information bit values. More...
typedef struct zb_zll_commissioning_scan_req_s	zb_zll_commissioning_scan_req_t
	Parsed Scan request payload representation. More...
typedef struct zb_zll_commissioning_ep_info_s	zb_zll_commissioning_ep_info_t
	Endpoint information for parsed Commissioning.ScanResponse representation.
typedef struct zb_zll_commissioning_scan_res_s	zb_zll_commissioning_scan_res_t
	Parsed Commissioning.ScanResponse structure. More...
typedef struct zb_zll_commissioning_device_information_req_s	zb_zll_commissioning_device_information_req_t
	Parsed Commissioning.DeviceInformationRequest payload. More...
typedef struct zb_zll_commissioning_device_information_common_res_s	zb_zll_commissioning_device_information_common_res_t
	Parsed permanent part of the Commissioning.DeviceInformationResponse payload. More...
typedef struct zb_zll_commissioning_device_information_ep_info_res_s	zb_zll_commissioning_device_information_ep_info_res_t
	Parsed device information record from the Commissioning.DeviceInformationResponse payload. More...
typedef struct zb_zll_commissioning_identify_req_s	zb_zll_commissioning_identify_req_t
	Parsed Commissioning.IdentifyRequest payload. More...
typedef struct zb_zll_commissioning_identify_req_param_s	zb_zll_commissioning_identify_req_param_t
	Identify request parameters.
typedef struct zb_zll_commissioning_reset_to_fn_s	zb_zll_commissioning_reset_to_fn_t
	Parsed Commissioning.ResetToFactoryNewRequest payload. More...
typedef struct zb_zll_commissioning_network_start_req_s	zb_zll_commissioning_network_start_req_t
	Parsed Commissioning.NetworkStartRequest payload. More...
typedef struct zb_zll_commissioning_network_start_res_s	zb_zll_commissioning_network_start_res_t
	Parsed Commissioning.NetworkStartResponse payload. More...
typedef struct zb_zll_commissioning_network_join_router_req_s	zb_zll_commissioning_network_join_router_req_t
	Parsed Commissioning.NetworkJoinRouterRequest payload. More...
typedef struct zb_zll_commissioning_network_join_router_res_s	zb_zll_commissioning_network_join_router_res_t
	Parsed Commissioning.NetworkJoinRouterResponse payload. More...
typedef struct zb_zll_commissioning_network_join_end_device_req_s	zb_zll_commissioning_network_join_end_device_req_t
	Parsed Commissioning.NetworkJoinEndDeviceRequest payload. More...
typedef struct zb_zll_commissioning_network_join_end_device_res_s	zb_zll_commissioning_network_join_end_device_res_t
	Parsed Commissioning.NetworkJoinEndDeviceResponse payload. More...
typedef struct zb_zll_commissioning_network_update_req_s	zb_zll_commissioning_network_update_req_t
	Parsed Commissioning.NetworkUpdateRequest payload. More...
typedef struct zb_zll_commissioning_get_group_ids_req_s	zb_zll_commissioning_get_group_ids_req_t
	Parsed Commissioning.GetGroupIdentifiersRequest payload. More...
typedef struct zb_zll_commissioning_get_group_ids_res_permanent_s	zb_zll_commissioning_get_group_ids_res_permanent_t
	Parsed Commissioning.GetGroupIdentifiersResponse payload. More...
typedef struct zb_zll_commissioning_group_info_record_s	zb_zll_commissioning_group_info_record_t
	Group information record for Commissioning.GetGroupIdentifiersResponse command. More...
typedef struct zb_zll_commissioning_get_endpoint_list_req_s	zb_zll_commissioning_get_endpoint_list_req_t
	Parsed Commissioning.GetEndpointListRequest payload. More...
typedef struct zb_zll_commissioning_get_endpoint_list_res_s	zb_zll_commissioning_get_endpoint_list_res_t
	Parsed Commissioning.GetEndpointListResponse payload. More...
typedef struct zb_zll_commissioning_endpoint_info_record_s	zb_zll_commissioning_endpoint_info_record_t
	Endpoint information record for Commissioning.GetEndpointListResponse command. More...
typedef struct zb_zll_commissioning_endpoint_information_s	zb_zll_commissioning_endpoint_information_t
	Parsed Commissioning.EndpointInformation payload. More...
zb_uint8_t	zb_zll_get_info_current_value (void)
	Get Touchlink Info current value.
void	zb_zll_commissioning_send_scan_req (zb_bufid_t buffer, zb_callback_t callback)
	Schedules Commissioning.ScanRequest sending. More...
zb_ret_t	zb_zll_identify (zb_uint8_t param)
	Sets up Identify request and schedules it for sending. Checks transaction state, identify period acceptability, fills in and schedules for sending command packet. More...
#define	ZB_ZLL_ZB_INFO_CURRENT_VALUE()   zb_zll_get_info_current_value()
#define	ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW(zll_info)   ((zll_info) & ZB_ZLL_INFO_FACTORY_NEW)
	Check is Touchlink device factory new.
#define	ZB_ZLL_IS_FACTORY_NEW()   (ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW(ZLL_DEVICE_INFO().zll_info))
	Check is current Touchlink device factory new.
#define	ZB_ZLL_SET_FACTORY_NEW()   (ZLL_DEVICE_INFO().zll_info |= ZB_ZLL_INFO_FACTORY_NEW)
	Set current Touchlink device is factory new.
#define	ZB_ZLL_CLEAR_FACTORY_NEW()   (ZLL_DEVICE_INFO().zll_info &= ~ZB_ZLL_INFO_FACTORY_NEW)
	Set current Touchlink device is not factory new.
#define	ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT(zll_info)   ((zll_info) & ZB_ZLL_INFO_ADDR_ASSIGNMENT)
	Check is Touchlink device capable of address assignment.
#define	ZB_ZLL_IS_ADDR_ASSIGNMENT()   (ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT(ZLL_DEVICE_INFO().zll_info))
	Check is current Touchlink device capable of address assignment.
#define	ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR(zll_info)   ((zll_info) & ZB_ZLL_INFO_TOUCHLINK_INITIATOR)
	Check is Touchlink device a link initiator.
#define	ZB_ZLL_IS_LINK_INITIATOR()   (ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR(ZLL_DEVICE_INFO().zll_info))
	Check is current Touchlink device a link initiator.
#define	ZB_ZLL_COMMISSIONING_SEND_SCAN_REQ(buffer, callback)   zb_zll_commissioning_send_scan_req(buffer, callback)
#define	ZB_ZLL_COMMISSIONING_GET_SCAN_REQ(data_ptr, buffer, status)
	Parses Commissioning.ScanRequest payload. More...
#define	ZB_ZLL_COMMISSIONING_SEND_SCAN_RES( buffer, seq_num, callback, status)
	Schedules Commissioning.ScanResponse sending. More...
#define	ZB_ZLL_COMMISSIONING_GET_SCAN_RES(data_ptr, buffer, status)
	Parses Commissioning.ScanResponse. More...
#define	ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_REQ( buffer, start_index, dst_addr, callback, status)
	Schedules sending Commissioning.DeviceInformationRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_REQ(data_ptr, buffer, status)
	Parses Commissioning.DeviceInformationRequest. More...
#define	ZB_ZLL_COMMISSIONING_DEVICE_INFO_MAX_RECORDS   0x05
	Maximum number of device information records in the response.
#define	ZB_ZLL_COMMISSIONING_INIT_DEVICE_INFO_RES( buffer, data_ptr, tsn, start_index, n_devs_reported)
	Starts filling in Commissioning.DeviceInformationResponse command. More...
#define	ZB_ZLL_COMMISSIONING_ADD_EP_INFO_DEVICE_INFO_RES( data_ptr, ep_id_, profile, device, version_, n_group_ids, sort_)
	Add next device information record into Commissioning.DeviceInformationResponse. More...
#define	ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_RES(buffer, data_ptr, dst_addr, callback, status)   (status) = ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr, callback)
	Schedules Commissioning.DeviceInformationResponse for sending. More...
#define	ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_RES(data_ptr, buffer, status)
	Parses Commissioning.DeviceInformationResponse permanent part. More...
#define	ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_DEVICE_INFO_RES(data_ptr, buffer, status)
#define	ZB_ZLL_COMMISSIONING_SEND_IDENTIFY_REQ( buffer, p_identify_duration, ieee_addr, callback, status)
	Schedules sending Commissioning.IdentifyRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ(data_ptr, buffer, status)
	Parses Commissioning.IdentifyRequest. More...
#define	ZB_ZLL_IDENTIFY_STOP   0
	"Exit identify mode" constant for Identify request.
#define	ZB_ZLL_IDENTIFY_DEFAULT_TIME   0xffff
	"Identify for default period" constant for Identify request.
#define	ZB_ZLL_COMMISSIONING_FILL_IDENTIFY_REQ(buffer, address, period, status)
	Fills in appropriate structures and starts identify request sending process. More...
#define	ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ_PARAM(data_ptr, buffer)
	Extract Identify request parameters from the buffer. More...
#define	ZB_ZLL_COMMISSIONING_SEND_RESET_TO_FN_REQ( buffer, dst_addr, callback, status)
	Schedules sending Commissioning.ResetToFactoryNewRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_RESET_TO_FN_REQ(data_ptr, buffer, status)
	Parses Commissioning.ResetToFactoryNewRequest. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_REQ( buffer, ext_pan_id_, key_index, encrypted_nwk_key, logical_channel, pan_id_, nwk_addr, grp_ids_begin, grp_ids_end, free_nwk_addrs_begin_, free_nwk_addrs_end_, free_group_ids_begin_, free_group_ids_end_, dst_addr, callback, status)
	Schedules sending Commissioning.NetworkStartRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_NETWORK_START_REQ(data_ptr, buffer, status)
	Parses Commissioning.NetworkStartRequest. More...
#define	ZB_ZLL_NETWORK_UPDATE_ID   ((zb_uint8_t)0)
	The only acceptable value for network update identifier field in the network start response. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_RES( buffer, seq_num, nwk_status, ext_pan_id_, pan_id_, channel_, dst_addr, callback, status_)
	Schedules Commissioning.NetworkStartResponse sending. More...
#define	ZB_ZLL_COMMISSIONING_GET_NETWORK_START_RES(data_ptr, buffer, op_status)
	Parses Commissioning.NetworkStartResponse. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_REQ( buffer, key_index, encrypted_nwk_key, nwk_addr, grp_ids_begin, grp_ids_end, free_nwk_addrs_begin_, free_nwk_addrs_end_, free_group_ids_begin_, free_group_ids_end_, dst_addr, callback, status)
	Schedules sending Commissioning.NetworkJoinRouterRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_REQ(data_ptr, buffer, status)
	Parses Commissioning.NetworkJoinRouterRequest. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_RES( buffer, nwk_status, tsn, dst_addr, callback, status)
	Schedules sending Commissioning.NetworkJoinRouterResponse command. More...
#define	ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_RES(data_ptr, buffer, op_status)
	Parses Commissioning.NetworkJoinRouterResponse. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_REQ( buffer, key_index, encrypted_nwk_key, logical_channel, nwk_addr, grp_ids_begin, grp_ids_end, free_nwk_addrs_begin_, free_nwk_addrs_end_, free_group_ids_begin_, free_group_ids_end_, dst_addr, callback, status)
	Schedules sending Commissioning.NetworkJoinEndDeviceRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_REQ(data_ptr, buffer, status)
	Parses Commissioning.NetworkJoinEndDeviceRequest. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_RES( buffer, nwk_status, tsn, dst_addr, callback, status)
	Schedules sending Commissioning.NetworkJoinEndDeviceResponse command. More...
#define	ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_RES(data_ptr, buffer, op_status)
	Parses Commissioning.NetworkJoinEndDeviceResponse. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL( buffer, nwk_addr, dst_addr, logical_channel, callback, status)
	Schedules sending Commissioning.NetworkUpdateRequest command. More...
#define	ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ( buffer, nwk_addr, dst_addr, callback, status)
	Schedules sending Commissioning.NetworkUpdateRequest command. (send command with current value of channel from pib cache) More...
#define	ZB_ZLL_COMMISSIONING_GET_NETWORK_UPDATE_REQ(data_ptr, buffer, status)
	Parses Commissioning.NetworkUpdateRequest. More...
#define	ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_REQ( buffer, start_index, dst_addr, dst_ep, ep, callback)
	Schedules sending Commissioning.GetGroupIdentifiersRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_REQ(data_ptr, buffer, status)
	Parses Commissioning.GetGroupIdentifiersRequest. More...
#define	ZB_ZLL_COMMISSIONING_GROUP_INFO_GROUP_TYPE_VALUE   0x00
	Group type value for group_type field of zb_zll_commissioning_group_info_record_s. More...
#define	ZB_ZLL_COMMISSIONING_INIT_GET_GROUP_ID_RES( buffer, data_ptr, total_, start_index, count_, tsn)
	Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload. More...
#define	ZB_ZLL_COMMISSIONING_ADD_GROUP_INFO_GET_GROUP_ID_RES(data_ptr, grp_id, grp_type)
#define	ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_RES(buffer, data_ptr, addr, dst_ep, ep, callback)
#define	ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_RES(data_ptr, buffer, status)
	Parses permanent part of Commissioning.GetGroupIdentifiersResponse. More...
#define	ZB_ZLL_COMMISSIONING_GET_NEXT_GROUP_INFO_GET_GROUP_ID_RES(data_ptr, buffer, status)
	Extracts next group information record from Commissioning.GetGroupIdentifiersResponse. More...
#define	ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_REQ( buffer, start_index, addr, dst_ep, ep, callback)
	Schedules sending Commissioning.GetEndpointListRequest command. More...
#define	ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_REQ(data_ptr, buffer, status)
	Parses Commissioning.GetEndpointListRequest. More...
#define	ZB_ZLL_COMMISSIONING_INIT_GET_EP_LIST_RES( buffer, total_, start_index, count_, tsn, data_ptr)
	Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload. More...
#define	ZB_ZLL_COMMISSIONING_ADD_EP_INFO_GET_EP_LIST_RES(data_ptr, addr, ep, profile, device, version_id)
#define	ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_RES(buffer, data_ptr, dst_addr, dst_ep, ep, callback)
#define	ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_RES(data_ptr, buffer, status)
	Parses permanent part of Commissioning.GetEndpointListResponse. More...
#define	ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_GET_EP_LIST_RES(data_ptr, buffer, status)
	Extracts next endpoint information record from Commissioning.GetEndpointListResponse. More...
#define	ZB_ZLL_COMMISSIONING_SEND_EP_INFO( buffer, endpoint_id, profile, device, version_, dst_addr, dst_ep, ep, callback)
	Schedules sending Commissioning.EndpointInformation command. More...
#define	ZB_ZLL_COMMISSIONING_GET_EP_INFO(data_ptr, buffer, status)
	Parses Commissioning.EndpointInformation. More...

Detailed Description

Touchlink Commissioning cluster

Macro Definition Documentation

ZB_ZCL_DECLARE_TOUCHLINK_COMMISSIONING_ATTR_LIST

#define ZB_ZCL_DECLARE_TOUCHLINK_COMMISSIONING_ATTR_LIST

(

attr_list

)

Value:

ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_TOUCHLINK_COMMISSIONING) \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Touchlink Commissioning cluster (only cluster revision attribute)

Parameters

attr_list

- attribute list name

ZB_ZLL_APLC_INTRP_TRANSID_LIFETIME

#define ZB_ZLL_APLC_INTRP_TRANSID_LIFETIME   ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(8000))

aplcInterPANTransIdLifetime constant value.

See also

ZCL spec, subclause 13.3.4.2.

ZB_ZLL_APLC_MIN_STARTUP_DELAY_TIME

#define ZB_ZLL_APLC_MIN_STARTUP_DELAY_TIME   (ZB_MILLISECONDS_TO_BEACON_INTERVAL(2000))

aplcMinStartupDelayTime constant value.

See also

ZCL spec, subclause 13.3.4.2.

ZB_ZLL_APLC_RX_WINDOW_DURATION

#define ZB_ZLL_APLC_RX_WINDOW_DURATION   (ZB_MILLISECONDS_TO_BEACON_INTERVAL(5000))

aplcRxWindowDuration constant value.

See also

ZCL spec, subclause 13.3.4.2.

ZB_ZLL_APLC_SCAN_TIME_BASE_DURATION

#define ZB_ZLL_APLC_SCAN_TIME_BASE_DURATION   ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(250))

aplcScanTimeBaseDuration constant value.

See also

ZCL spec, subclause 13.3.4.2.

ZB_ZLL_COMMISSIONING_ADD_EP_INFO_DEVICE_INFO_RES

#define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_DEVICE_INFO_RES	(		data_ptr,
			ep_id_,
			profile,
			device,
			version_,
			n_group_ids,
			sort_
	)

Value:

{                                                                           \
  zb_zll_commissioning_device_information_ep_info_res_t *req_data =         \
      (zb_zll_commissioning_device_information_ep_info_res_t*)data_ptr;     \
  ZB_IEEE_ADDR_COPY(req_data->ieee_addr, ZB_PIBCACHE_EXTENDED_ADDRESS());   \
  req_data->ep_id = (ep_id_);                                               \
  ZB_HTOLE16_VAL(&(req_data->profile_id), (profile));                       \
  ZB_HTOLE16_VAL(&(req_data->device_id), (device));                         \
  req_data->version = (version_);                                           \
  req_data->group_id_count = (n_group_ids);                                 \
  req_data->sort = (sort_);                                                 \
  data_ptr += sizeof(zb_zll_commissioning_device_information_ep_info_res_t);\
}

Add next device information record into Commissioning.DeviceInformationResponse.

Parameters

data_ptr	[IN] - pointer to contain address right after the added record's tail.
ep_id_	[IN] - endpoint identifier of the sub-device.
profile	[IN] - profile identifier of the sub-device.
device	[IN] - device identifier.
version_	[IN] of the device.
n_group_ids	[IN] - group identifier count.
sort_	[IN] - endpoint info sort flag.

Attention

According to ZCL spec, Device Information Response frame can contain not more than 5 device information records. Caller should check this condition.

ZB_ZLL_COMMISSIONING_ADD_EP_INFO_GET_EP_LIST_RES

#define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_GET_EP_LIST_RES	(		data_ptr,
			addr,
			ep,
			profile,
			device,
			version_id
	)

Value:

{                                                         \
  zb_zll_commissioning_endpoint_info_record_t *res_data =               \
    (zb_zll_commissioning_endpoint_info_record_t*)data_ptr;             \
  res_data = (zb_zll_commissioning_get_endpoint_list_res_t*)data_ptr;   \
  ZB_HTOLE16_VAL(&(res_data->addr_short), (addr));                      \
  res_data->endpoint = (ep);                                            \
  ZB_HTOLE16_VAL(&(res_data->profile_id), (profile));                   \
  ZB_HTOLE16_VAL(&(res_data->device_id), (device));                     \
  res_data->version = (version_id);                                     \
  (data_ptr) += sizeof(zb_zll_commissioning_endpoint_info_record_t);    \
}

ZB_ZLL_COMMISSIONING_ADD_GROUP_INFO_GET_GROUP_ID_RES

#define ZB_ZLL_COMMISSIONING_ADD_GROUP_INFO_GET_GROUP_ID_RES	(		data_ptr,
			grp_id,
			grp_type
	)

Value:

{                                                                                        \
  ZB_ZCL_PACKET_PUT_DATA16((data_ptr), (grp_id));                                        \
  ZB_ZCL_PACKET_PUT_DATA8((data_ptr), (grp_type));                                       \
}

ZB_ZLL_COMMISSIONING_FILL_IDENTIFY_REQ

#define ZB_ZLL_COMMISSIONING_FILL_IDENTIFY_REQ	(		buffer,
			address,
			period,
			status
	)

Value:

{                                                                               \
  zb_zll_commissioning_identify_req_param_t* request =                          \
      ZB_BUF_GET_PARAM((buffer), zb_zll_commissioning_identify_req_param_t);    \
  ZB_IEEE_ADDR_COPY(request->dst_addr, (address));                              \
  request->identify_time = (period);                                            \
  (status) = zb_zll_identify(ZB_REF_FROM_BUF((buffer)));                        \
}

Fills in appropriate structures and starts identify request sending process.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
address	[IN] - IEEE address of the target device.
period	[IN] - time to identify.
status	[OUT] - status of the operation.

ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_REQ

#define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                    \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_device_information_req_t)) \
  {                                                                                  \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                          \
  }                                                                                  \
  else                                                                               \
  {                                                                                  \
    zb_zll_commissioning_device_information_req_t *req_data =                        \
      (zb_zll_commissioning_device_information_req_t*)zb_buf_begin((buffer));        \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                          \
    ZB_LETOH32(&((data_ptr)->trans_id), &(req_data->trans_id));                      \
    (data_ptr)->start_idx = req_data->start_idx;                                     \
  }                                                                                  \
}

Parses Commissioning.DeviceInformationRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_device_information_req_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_RES

#define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_RES	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                             \
  if (zb_buf_len((buffer)) < sizeof(zb_zll_commissioning_device_information_common_res_t))    \
  {                                                                                           \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                                   \
  }                                                                                           \
  else                                                                                        \
  {                                                                                           \
    zb_zll_commissioning_device_information_common_res_t* src_ptr =                           \
      (zb_zll_commissioning_device_information_common_res_t*)zb_buf_begin((buffer));          \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                                   \
    ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id));                                \
    (data_ptr)->n_subdevs = src_ptr->n_subdevs;                                               \
    (data_ptr)->start_idx = src_ptr->start_idx;                                               \
    (data_ptr)->n_records = src_ptr->n_records;                                               \
    (void)zb_buf_cut_left((buffer), sizeof(zb_zll_commissioning_device_information_common_res_t)); \
  }                                                                                           \
}

Parses Commissioning.DeviceInformationResponse permanent part.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_device_information_common_res_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_EP_INFO

#define ZB_ZLL_COMMISSIONING_GET_EP_INFO	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                  \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_endpoint_information_t)) \
  {                                                                                \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                        \
  }                                                                                \
  else                                                                             \
  {                                                                                \
    zb_zll_commissioning_endpoint_information_t* src_ptr =                         \
      (zb_zll_commissioning_endpoint_information_t*)zb_buf_begin((buffer));        \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                        \
    ZB_IEEE_ADDR_COPY((data_ptr)->addr_long, src_ptr->addr_long);                  \
    ZB_LETOH16(&((data_ptr)->addr_short), &(src_ptr->addr_short));                 \
    (data_ptr)->endpoint = src_ptr->endpoint;                                      \
    ZB_LETOH16(&((data_ptr)->profile_id), &(src_ptr->profile_id));                 \
    ZB_LETOH16(&((data_ptr)->device_id), &(src_ptr->device_id));                   \
    (data_ptr)->version = src_ptr->version;                                        \
  }                                                                                \
}

Parses Commissioning.EndpointInformation.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_endpoint_information_s.
buffer	containing the packet (by pointer).
status	- status read parameters - see zb_zcl_parse_status_e

ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_REQ

#define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                   \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_get_endpoint_list_req_t)) \
  {                                                                                 \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                         \
  }                                                                                 \
  else                                                                              \
  {                                                                                 \
    zb_uint8_t* src_ptr = zb_buf_begin((buffer));                                   \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                         \
    ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->start_idx), (src_ptr));                   \
  }                                                                                 \
}

Parses Commissioning.GetEndpointListRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_get_endpoint_list_req_s.
status	- status read parameters - see zb_zcl_parse_status_e
buffer	containing the packet (by pointer).

ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_RES

#define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_RES	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                     \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_get_endpoint_list_res_t))   \
  {                                                                                   \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                           \
  }                                                                                   \
  else                                                                                \
  {                                                                                   \
    zb_zll_commissioning_get_endpoint_list_res_t* src_ptr =                           \
      (zb_zll_commissioning_get_endpoint_list_res_t*)zb_buf_begin((buffer));          \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                           \
    ZB_MEMCPY((data_ptr)), src_ptr, sizeof(zb_zll_commissioning_get_endpoint_list_res_t)); \
    (void)zb_buf_cut_left((buffer), sizeof(zb_zll_commissioning_get_endpoint_list_res_t)); \
  }                                                                                   \
}

Parses permanent part of Commissioning.GetEndpointListResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_get_endpoint_list_res_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_REQ

#define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                               \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_get_group_ids_req_t)) \
  {                                                                             \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                     \
  }                                                                             \
  else                                                                          \
  {                                                                             \
    zb_uint8_t* src_ptr = zb_buf_begin((buffer));                               \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                     \
    ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->start_idx), (src_ptr));               \
  }                                                                             \
}

Parses Commissioning.GetGroupIdentifiersRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_get_group_ids_req_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_RES

#define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_RES	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                           \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_get_group_ids_res_permanent_t))   \
  {                                                                                         \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                                 \
  }                                                                                         \
  else                                                                                      \
  {                                                                                         \
    zb_zll_commissioning_get_group_ids_res_permanent_t* src_ptr =                           \
      (zb_zll_commissioning_get_group_ids_res_permanent_t*)zb_buf_begin((buffer));          \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                                 \
    ZB_MEMCPY((data_ptr), src_ptr,sizeof(zb_zll_commissioning_get_group_ids_res_permanent_t)); \
    (void)zb_buf_cut_left((buffer), sizeof(zb_zll_commissioning_get_group_ids_res_permanent_t)); \
  }                                                                                         \
}

Parses permanent part of Commissioning.GetGroupIdentifiersResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_get_group_ids_res_permanent_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ

#define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                          \
  /* FIXED */                                                              \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_identify_req_t)) \
  {                                                                        \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                \
  }                                                                        \
  else                                                                     \
  {                                                                        \
    zb_zll_commissioning_identify_req_t* src_ptr =                         \
      (zb_zll_commissioning_identify_req_t*)zb_buf_begin((buffer));        \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                \
    ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id));             \
    ZB_LETOH16(&((data_ptr)->duration), &(src_ptr->duration));             \
  }                                                                        \
}

Parses Commissioning.IdentifyRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_identify_req_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ_PARAM

#define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ_PARAM	(		data_ptr,
			buffer
	)

Value:

{                                                                                    \
  zb_zll_commissioning_identify_req_param_t* tmp_ptr =                               \
      ZB_BUF_GET_PARAM((buffer), zb_zll_commissioning_identify_req_param_t);         \
  ZB_MEMCPY((data_ptr), tmp_ptr, sizeof(zb_zll_commissioning_identify_req_param_t)); \
}

Extract Identify request parameters from the buffer.

Parameters

data_ptr	[OUT] - pointer to a memory region to put request parameters to. Must be capable of storing value of type zb_zll_commissioning_identify_req_param_s.
buffer	[IN] - index zb_bufid_t of the buffer containing request parameters (as a tail parameter).

ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_REQ

#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                         \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_network_join_end_device_req_t)) \
  {                                                                                       \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                               \
  }                                                                                       \
  else                                                                                    \
  {                                                                                       \
    zb_zll_commissioning_network_join_end_device_req_t *src_ptr =                         \
        (zb_zll_commissioning_network_join_end_device_req_t*)zb_buf_begin((buffer));      \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                               \
    ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id));                            \
    ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id);                       \
    (data_ptr)->key_idx = src_ptr->key_idx;                                               \
    ZB_MEMCPY((data_ptr)->encr_nwk_key, src_ptr->encr_nwk_key, 16);                       \
    (data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id;                                         \
    (data_ptr)->channel  = src_ptr->channel;                                              \
    ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id));                                \
    ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr));                        \
    ZB_LETOH16(&((data_ptr)->group_ids_begin), &(src_ptr->group_ids_begin));              \
    ZB_LETOH16(&((data_ptr)->group_ids_end), &(src_ptr->group_ids_end));                  \
    ZB_LETOH16(&((data_ptr)->free_nwk_addrs_begin), &(src_ptr->free_nwk_addrs_begin));    \
    ZB_LETOH16(&((data_ptr)->free_nwk_addrs_end), &(src_ptr->free_nwk_addrs_end));        \
    ZB_LETOH16(&((data_ptr)->free_group_ids_begin), &(src_ptr->free_group_ids_begin));    \
    ZB_LETOH16(&((data_ptr)->free_group_ids_end), &(src_ptr->free_group_ids_end));        \
  }                                                                                       \
}

Parses Commissioning.NetworkJoinEndDeviceRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_network_join_end_device_req_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_RES

#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_RES	(		data_ptr,
			buffer,
			op_status
	)

Value:

{                                                                                         \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_network_join_end_device_res_t)) \
  {                                                                                       \
    (op_status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                            \
  }                                                                                       \
  else                                                                                    \
  {                                                                                       \
    zb_uint8_t* src_ptr = zb_buf_begin((buffer));                                         \
    (op_status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                            \
    ZB_ZCL_PACKET_GET_DATA32(&((data_ptr)->trans_id), (src_ptr));                         \
    ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->status), (src_ptr));                            \
  }                                                                                       \
}

Parses Commissioning.NetworkJoinEndDeviceResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_network_join_end_device_res_s.
buffer	containing the packet (by pointer).
op_status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_REQ

#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                     \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_network_join_router_req_t)) \
  {                                                                                   \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                           \
  }                                                                                   \
  else                                                                                \
  {                                                                                   \
    zb_zll_commissioning_network_join_router_req_t *src_ptr =                           \
        (zb_zll_commissioning_network_join_router_req_t*)zb_buf_begin((buffer));        \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                             \
    ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id));                          \
    ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id);                     \
    (data_ptr)->key_idx = src_ptr->key_idx;                                             \
    ZB_MEMCPY((data_ptr)->encr_nwk_key, src_ptr->encr_nwk_key, 16);                     \
    (data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id;                                       \
    (data_ptr)->channel  = src_ptr->channel;                                            \
    ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id));                              \
    ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr));                      \
    ZB_LETOH16(&((data_ptr)->group_ids_begin), &(src_ptr->group_ids_begin));            \
    ZB_LETOH16(&((data_ptr)->group_ids_end), &(src_ptr->group_ids_end));                \
    ZB_LETOH16(&((data_ptr)->free_nwk_addrs_begin), &(src_ptr->free_nwk_addrs_begin));  \
    ZB_LETOH16(&((data_ptr)->free_nwk_addrs_end), &(src_ptr->free_nwk_addrs_end));      \
    ZB_LETOH16(&((data_ptr)->free_group_ids_begin), &(src_ptr->free_group_ids_begin));  \
    ZB_LETOH16(&((data_ptr)->free_group_ids_end), &(src_ptr->free_group_ids_end));      \
  }                                                                                     \
}

Parses Commissioning.NetworkJoinRouterRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_network_join_router_req_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_RES

#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_RES	(		data_ptr,
			buffer,
			op_status
	)

Value:

{                                                                                     \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_network_join_router_res_t)) \
  {                                                                                   \
    (op_status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                        \
  }                                                                                   \
  else                                                                                \
  {                                                                                   \
    zb_uint8_t* src_ptr = zb_buf_begin((buffer));                                     \
    (op_status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                        \
    ZB_ZCL_PACKET_GET_DATA32(&((data_ptr)->trans_id), (src_ptr));                     \
    ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->status), (src_ptr));                        \
  }                                                                                   \
}

Parses Commissioning.NetworkJoinRouterResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_network_join_router_res_s.
buffer	containing the packet (by pointer).
op_status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NETWORK_START_REQ

#define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                       \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_network_start_req_t))         \
  {                                                                                     \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                             \
  }                                                                                     \
  else                                                                                  \
  {                                                                                     \
    zb_zll_commissioning_network_start_req_t *src_ptr =                                 \
        (zb_zll_commissioning_network_start_req_t*)zb_buf_begin((buffer));              \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                             \
    ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id));                          \
    ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id);                     \
    (data_ptr)->key_idx = src_ptr->key_idx;                                             \
    ZB_MEMCPY((data_ptr)->encr_nwk_key, src_ptr->encr_nwk_key, 16);                     \
    (data_ptr)->channel  = src_ptr->channel;                                            \
    ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id));                              \
    ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr));                      \
    ZB_LETOH16(&((data_ptr)->group_ids_begin), &(src_ptr->group_ids_begin));            \
    ZB_LETOH16(&((data_ptr)->group_ids_end), &(src_ptr->group_ids_end));                \
    ZB_LETOH16(&((data_ptr)->free_nwk_addrs_begin), &(src_ptr->free_nwk_addrs_begin));  \
    ZB_LETOH16(&((data_ptr)->free_nwk_addrs_end), &(src_ptr->free_nwk_addrs_end));      \
    ZB_LETOH16(&((data_ptr)->free_group_ids_begin), &(src_ptr->free_group_ids_begin));  \
    ZB_LETOH16(&((data_ptr)->free_group_ids_end), &(src_ptr->free_group_ids_end));      \
    ZB_IEEE_ADDR_COPY((data_ptr)->initiator_ieee, (src_ptr->initiator_ieee));           \
    ZB_LETOH16(&((data_ptr)->initiator_short), &(src_ptr->initiator_short));            \
  }                                                                                     \
}

Parses Commissioning.NetworkStartRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	[OUT] - pointer to a variable of type zb_zll_commissioning_network_start_req_s.
buffer	[IN] - index zb_bufid_t of the buffer containing the packet.
status	[OUT] - variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NETWORK_START_RES

#define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_RES	(		data_ptr,
			buffer,
			op_status
	)

Value:

{                                                                               \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_network_start_res_t)) \
  {                                                                             \
    (op_status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                  \
  }                                                                             \
  else                                                                          \
  {                                                                             \
    zb_zll_commissioning_network_start_res_t *src_ptr =                         \
        (zb_zll_commissioning_network_start_res_t*)zb_buf_begin((buffer));      \
    (op_status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                  \
    ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id));                  \
    (data_ptr)->status = src_ptr->status;                                       \
    ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id);             \
    (data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id;                               \
    (data_ptr)->channel = src_ptr->channel;                                     \
    ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id));                      \
  }                                                                             \
}

Parses Commissioning.NetworkStartResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	[OUT] - pointer to a variable of type zb_zll_commissioning_network_start_res_s that will contain parsed information.
buffer	[IN] - index zb_bufid_t of the buffer containing the packet.
op_status	[OUT] - variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NETWORK_UPDATE_REQ

#define ZB_ZLL_COMMISSIONING_GET_NETWORK_UPDATE_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_network_update_req_t)) \
  {                                                                              \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                      \
  }                                                                              \
  else                                                                           \
  {                                                                              \
    zb_zll_commissioning_network_update_req_t *src_ptr =                         \
        (zb_zll_commissioning_network_update_req_t*)zb_buf_begin((buffer));      \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                      \
    ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id));                   \
    ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id);              \
    (data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id;                                \
    (data_ptr)->channel  = src_ptr->channel;                                     \
    ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id));                       \
    ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr));               \
  }                                                                              \
}

Parses Commissioning.NetworkUpdateRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_network_update_req_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_DEVICE_INFO_RES

#define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_DEVICE_INFO_RES	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                              \
  if (zb_buf_len((buffer)) < sizeof(zb_zll_commissioning_device_information_ep_info_res_t))    \
  {                                                                                            \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                                    \
  }                                                                                            \
  else                                                                                         \
  {                                                                                            \
    zb_zll_commissioning_device_information_ep_info_res_t* src_ptr =                           \
      (zb_zll_commissioning_device_information_ep_info_res_t*)zb_buf_begin((buffer));          \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                                    \
    ZB_ZCL_PACKET_GET_DATA_IEEE((data_ptr)->ieee_addr, (src_ptr));                             \
    (data_ptr)->ep_id = src_ptr->ep_id;                                                        \
    ZB_LETOH16(&((data_ptr)->profile_id), &(src_ptr->profile_id));                             \
    ZB_LETOH16(&((data_ptr)->device_id), &(src_ptr->device_id));                               \
    (data_ptr)->version = src_ptr->version;                                                    \
    (data_ptr)->group_id_count = src_ptr->group_id_count;                                      \
    (data_ptr)->sort = src_ptr->sort;                                                          \
    (void)zb_buf_cut_left((buffer), sizeof(zb_zll_commissioning_device_information_ep_info_res_t)); \
  }                                                                                            \
}

Parses next device description record in Commissioning.DeviceInformationResponse payload.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_device_information_ep_info_res_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_GET_EP_LIST_RES

#define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_GET_EP_LIST_RES	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                       \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_endpoint_info_record_t))      \
  {                                                                                     \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                             \
  }                                                                                     \
  else                                                                                  \
  {                                                                                     \
    zb_zll_commissioning_endpoint_info_record_t* src_ptr =                              \
      (zb_zll_commissioning_endpoint_info_record_t*)zb_buf_begin((buffer));             \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                             \
    ZB_LETOH16(&((data_ptr)->addr_short), &(src_ptr->addr_short));                      \
    (data_ptr)->endpoint = src_ptr->endpoint;                                           \
    ZB_LETOH16(&((data_ptr)->profile_id), &(src_ptr->profile_id));                      \
    ZB_LETOH16(&((data_ptr)->device_id), &(src_ptr_device_id));                         \
    (data_ptr)->version = src_ptr->version;                                             \
    (void)zb_buf_cut_left((buffer), sizeof(zb_zll_commissioning_endpoint_info_record_t)); \
  }                                                                                     \
}

Extracts next endpoint information record from Commissioning.GetEndpointListResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_endpoint_info_record_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_NEXT_GROUP_INFO_GET_GROUP_ID_RES

#define ZB_ZLL_COMMISSIONING_GET_NEXT_GROUP_INFO_GET_GROUP_ID_RES	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                                           \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_group_info_record_t))             \
  {                                                                                         \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                                 \
  }                                                                                         \
  else                                                                                      \
  {                                                                                         \
    zb_uint8_t* src_ptr = zb_buf_begin((buffer));                                           \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                                 \
    ZB_ZCL_PACKET_GET_DATA16(&((data_ptr)->group_id), (src_ptr));                           \
    ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->group_type), (src_ptr));                          \
    (void)zb_buf_cut_left((buffer), sizeof(zb_zll_commissioning_group_info_record_t));      \
  }                                                                                         \
}

Extracts next group information record from Commissioning.GetGroupIdentifiersResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_group_info_record_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_RESET_TO_FN_REQ

#define ZB_ZLL_COMMISSIONING_GET_RESET_TO_FN_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                          \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_reset_to_fn_t))  \
  {                                                                        \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                                \
  }                                                                        \
  else                                                                     \
  {                                                                        \
    zb_uint8_t* src_ptr = zb_buf_begin((buffer));                          \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                                \
    ZB_ZCL_PACKET_GET_DATA32(&((data_ptr)->trans_id), (src_ptr));          \
  }                                                                        \
}

Parses Commissioning.ResetToFactoryNewRequest.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_reset_to_fn_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_SCAN_REQ

#define ZB_ZLL_COMMISSIONING_GET_SCAN_REQ	(		data_ptr,
			buffer,
			status
	)

Value:

{                                                                      \
  zb_uint8_t* src_ptr = zb_buf_begin((buffer));                        \
  if (zb_buf_len((buffer)) != sizeof(zb_zll_commissioning_scan_req_t)) \
  {                                                                    \
    (status) = ZB_ZCL_PARSE_STATUS_FAILURE;                            \
  }                                                                    \
  else                                                                 \
  {                                                                    \
    (status) = ZB_ZCL_PARSE_STATUS_SUCCESS;                            \
    ZB_LETOH32(&((data_ptr)->trans_id), src_ptr);                      \
    src_ptr += sizeof(zb_uint32_t);                                    \
    (data_ptr)->zb_info = *(src_ptr++);                                \
    (data_ptr)->zll_info = *(src_ptr);                                 \
  }                                                                    \
}

Parses Commissioning.ScanRequest payload.

Attention

Assumes that ZCL header was already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_scan_req_s.
buffer	with the Commissioning.ScanRequest payload.
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GET_SCAN_RES

#define ZB_ZLL_COMMISSIONING_GET_SCAN_RES	(		data_ptr,
			buffer,
			status
	)

Parses Commissioning.ScanResponse.

Attention

Assumes that ZCL header already cut.

Parameters

data_ptr	- pointer to a variable of type zb_zll_commissioning_scan_res_s.
buffer	containing the packet (by pointer).
status	- variable to put parse status to (see zb_zcl_parse_status_t).

ZB_ZLL_COMMISSIONING_GROUP_INFO_GROUP_TYPE_VALUE

#define ZB_ZLL_COMMISSIONING_GROUP_INFO_GROUP_TYPE_VALUE   0x00

Group type value for group_type field of zb_zll_commissioning_group_info_record_s.

See also

ZCL spec, subclause 13.3.2.2.7.4.

ZB_ZLL_COMMISSIONING_INIT_DEVICE_INFO_RES

#define ZB_ZLL_COMMISSIONING_INIT_DEVICE_INFO_RES	(		buffer,
			data_ptr,
			tsn,
			start_index,
			n_devs_reported
	)

Value:

{                                                                      \
  zb_zll_commissioning_device_information_common_res_t *req_data;      \
  data_ptr = ZB_ZCL_START_PACKET((buffer));                            \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL((data_ptr));     \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                     \
      (data_ptr),                                                      \
      (tsn),                                                           \
      ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_RES);                \
  req_data = (zb_zll_commissioning_device_information_common_res_t*)data_ptr;   \
  ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id));          \
  req_data->n_subdevs = ZCL_CTX().device_ctx->ep_count;                         \
  req_data->start_idx = (start_index);                                          \
  req_data->n_records = (n_devs_reported);                                      \
  data_ptr += sizeof(zb_zll_commissioning_device_information_common_res_t);     \
}

Starts filling in Commissioning.DeviceInformationResponse command.

Parameters

buffer	to put packet to (by pointer).
data_ptr	- pointer to contain address right after the response's permanent part's tail.
tsn	- ZCL transaction sequence number.
start_index	- index of the first reported device.
n_devs_reported	- number of reported devices.

ZB_ZLL_COMMISSIONING_INIT_GET_EP_LIST_RES

#define ZB_ZLL_COMMISSIONING_INIT_GET_EP_LIST_RES	(		buffer,
			total_,
			start_index,
			count_,
			tsn,
			data_ptr
	)

Value:

{                                                                  \
  zb_zll_commissioning_get_endpoint_list_res_t *res_data;          \
  (data_ptr) = ZB_ZCL_START_PACKET((buffer));                      \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL((data_ptr)); \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                 \
      (data_ptr),                                                  \
      (tsn),                                                       \
      ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_RESPONSE);        \
  res_data = (zb_zll_commissioning_get_endpoint_list_res_t*)(data_ptr); \
  res_data->total = (total_);                                           \
  res_data->start_idx = (start_index);                                  \
  res_data->count = (count_);                                           \
  (data_ptr) += sizeof(zb_zll_commissioning_get_endpoint_list_res_t);   \
}

Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload.

Parameters

buffer	to put packet to (by pointer).
total_	- all count endpoint list
start_index	- Index at which to start returning endpoint list.
count_	- count of endpoints in this payload.
tsn	[IN] - ZCL transaction sequence number.
data_ptr	- pointer to contain address right after the response's permanent part's tail.

ZB_ZLL_COMMISSIONING_INIT_GET_GROUP_ID_RES

#define ZB_ZLL_COMMISSIONING_INIT_GET_GROUP_ID_RES	(		buffer,
			data_ptr,
			total_,
			start_index,
			count_,
			tsn
	)

Value:

{                                                                \
  (data_ptr) = ZB_ZCL_START_PACKET((buffer));                    \
  zb_zll_commissioning_get_group_ids_res_permanent_t *req_data;  \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr); \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                               \
      data_ptr,                                                  \
      (tsn),                                                     \
      ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_RESPONSE);  \
  req_data = (zb_zll_commissioning_get_group_ids_res_permanent_t*)data_ptr; \
  req_data->total = (total_);                                    \
  req_data->start_idx = (start_index);                           \
  req_data->count = (count_);                                    \
  data_ptr += sizeof(zb_zll_commissioning_get_group_ids_res_permanent_t);   \
}

Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload.

Parameters

buffer	to put packet to (by pointer).
data_ptr	- pointer to contain address right after the response's permanent part's tail.
total_	- all count group identifiers
start_index	- Index at which to start returning group identifiers.
count_	- count of identifiers in this payload.
tsn	[IN] - ZCL transaction sequence number.

ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_REQ

#define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_REQ	(		buffer,
			start_index,
			dst_addr,
			callback,
			status
	)

Value:

{                                                                           \
  zb_zll_commissioning_device_information_req_t *req;                       \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));                     \
  ZB_ZCL_CONSTRUCT_GENERAL_COMMAND_RESP_FRAME_CONTROL_A(data_ptr,           \
        ZB_ZCL_FRAME_DIRECTION_TO_SRV,                                      \
        ZB_ZCL_NOT_MANUFACTURER_SPECIFIC);                                  \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                          \
      data_ptr,                                                             \
      ZB_ZCL_GET_SEQ_NUM(),                                                 \
      ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_REQ);                     \
  req = (zb_zll_commissioning_device_information_req_t*)data_ptr;           \
  ZB_HTOLE32(&(req->trans_id), &(ZLL_TRAN_CTX().transaction_id));           \
  req->start_idx= (start_index);                                            \
  data_ptr += sizeof(zb_zll_commissioning_device_information_req_t);        \
  status = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}

Schedules sending Commissioning.DeviceInformationRequest command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
start_index	[IN] - device index to start reporting with.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_RES

#define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_RES	(		buffer,
			data_ptr,
			dst_addr,
			callback,
			status
	)		(status) = ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr, callback)

Schedules Commissioning.DeviceInformationResponse for sending.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer containing payload.
data_ptr	[IN] - pointer to the payload's tail.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to call upon packet confirm.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_EP_INFO

#define ZB_ZLL_COMMISSIONING_SEND_EP_INFO	(		buffer,
			endpoint_id,
			profile,
			device,
			version_,
			dst_addr,
			dst_ep,
			ep,
			callback
	)

Value:

{                                                                        \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));                  \
  zb_zll_commissioning_endpoint_information_t *req_data;                 \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr);         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                       \
      data_ptr,                                                          \
      ZB_ZCL_GET_SEQ_NUM(),                                              \
      ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ);                      \
  req_data = (zb_zll_commissioning_endpoint_information_t*)(data_ptr);   \
  ZB_IEEE_ADDR_COPY(req_data->addr_long, ZB_PIBCACHE_EXTENDED_ADDRESS());\
  ZB_HTOLE16_VAL(&(req_data->addr_short), ZB_PIBCACHE_NETWORK_ADDRESS());\
  req_data->endpoint = (endpoint_id);                                    \
  ZB_HTOLE16_VAL(&(req_data->profile_id), (profile));                    \
  ZB_HTOLE16_VAL(&(req_data->device_id), (device));                      \
  req_data->version = (version_);                                        \
  (data_ptr) += sizeof(zb_zll_commissioning_endpoint_information_t);     \
  ZB_ZCL_FINISH_PACKET((buffer), (data_ptr))                             \
  ZB_ZCL_SEND_COMMAND_SHORT(                                             \
      (buffer),                                                          \
      dst_addr,                                                          \
      ZB_APS_ADDR_MODE_16_ENDP_PRESENT,                                  \
      dst_ep,                                                            \
      ep,                                                                \
      ZB_AF_ZLL_PROFILE_ID,                                              \
      ZB_ZCL_CLUSTER_ID_TOUCHLINK_COMMISSIONING,                         \
      callback);                                                         \
}

Schedules sending Commissioning.EndpointInformation command.

Parameters

buffer	to put packet to (by pointer).
endpoint_id	- endpoint identifier.
profile	- profile identifier.
device	- device identifier.
version_	- device version.
dst_addr	- IEEE device address to send packet to.
dst_ep	- endpoint of device to send packet to.
ep	- endpoint of target device.
callback	to schedule on packet send confirmation.

ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_REQ

#define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_REQ	(		buffer,
			start_index,
			addr,
			dst_ep,
			ep,
			callback
	)

Value:

{                                                                \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));          \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr); \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                               \
      data_ptr,                                                  \
      ZB_ZCL_GET_SEQ_NUM(),                                      \
      ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_REQUEST);       \
  ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (start_index));              \
  ZB_ZCL_FINISH_PACKET((buffer), data_ptr)                       \
  ZB_ZCL_SEND_COMMAND_SHORT(                                     \
      (buffer),                                                  \
      addr,                                                      \
      ZB_APS_ADDR_MODE_16_ENDP_PRESENT,                          \
      dst_ep,                                                    \
      ep,                                                        \
      ZB_AF_ZLL_PROFILE_ID,                                      \
      ZB_ZCL_CLUSTER_ID_TOUCHLINK_COMMISSIONING,                 \
      callback);                                                 \
}

Schedules sending Commissioning.GetEndpointListRequest command.

Parameters

buffer	to put packet to (by pointer).
start_index	- Index at which to start returning group identifiers.
addr	- IEEE device address to send packet to.
dst_ep	- endpoint of device to send packet to.
ep	- endpoint of target device.
callback	to schedule on packet send confirmation.

ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_RES

#define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_RES	(		buffer,
			data_ptr,
			dst_addr,
			dst_ep,
			ep,
			callback
	)

Value:

{                                                  \
  ZB_ZCL_FINISH_PACKET((buffer), (data_ptr))       \
  ZB_ZCL_SEND_COMMAND_SHORT(                       \
      (buffer),                                    \
      dst_addr,                                    \
      ZB_APS_ADDR_MODE_16_ENDP_PRESENT,            \
      dst_ep,                                      \
      ep,                                          \
    ZB_AF_ZLL_PROFILE_ID,                        \
    ZB_ZCL_CLUSTER_ID_TOUCHLINK_COMMISSIONING,   \
    callback);                                   \
}

ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_REQ

#define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_REQ	(		buffer,
			start_index,
			dst_addr,
			dst_ep,
			ep,
			callback
	)

Value:

{                                                                \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));          \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr); \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                               \
      data_ptr,                                                  \
      ZB_ZCL_GET_SEQ_NUM(),                                      \
      ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ);              \
  ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (start_index));              \
  ZB_ZCL_FINISH_PACKET((buffer), data_ptr)                       \
  ZB_ZCL_SEND_COMMAND_SHORT(                                     \
      (buffer),                                                  \
      dst_addr,                                                  \
      ZB_APS_ADDR_MODE_16_ENDP_PRESENT,                          \
      dst_ep,                                                    \
      ep,                                                        \
      ZB_AF_ZLL_PROFILE_ID,                                      \
      ZB_ZCL_CLUSTER_ID_TOUCHLINK_COMMISSIONING,                 \
      callback);                                                 \
}

Schedules sending Commissioning.GetGroupIdentifiersRequest command.

Parameters

buffer	to put packet to (by pointer).
start_index	- Rindex at which to start returning group identifiers.
dst_addr	- IEEE device address to send packet to.
dst_ep	- endpoint of device to send packet to.
ep	- endpoint of target device.
callback	to schedule on packet send confirmation.

ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_RES

#define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_RES	(		buffer,
			data_ptr,
			addr,
			dst_ep,
			ep,
			callback
	)

Value:

{                                                   \
  ZB_ZCL_FINISH_PACKET((buffer), (data_ptr))        \
  ZB_ZCL_SEND_COMMAND_SHORT(                        \
      (buffer),                                     \
      addr,                                         \
      ZB_APS_ADDR_MODE_16_ENDP_PRESENT,             \
      dst_ep,                                       \
      ep,                                           \
      ZB_AF_ZLL_PROFILE_ID,                         \
      ZB_ZCL_CLUSTER_ID_TOUCHLINK_COMMISSIONING,    \
      callback);                                    \
}

ZB_ZLL_COMMISSIONING_SEND_IDENTIFY_REQ

#define ZB_ZLL_COMMISSIONING_SEND_IDENTIFY_REQ	(		buffer,
			p_identify_duration,
			ieee_addr,
			callback,
			status
	)

Value:

{                                                                            \
  zb_zll_commissioning_identify_req_t *req_data;                             \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));                      \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL_O(data_ptr, ZB_ZCL_DISABLE_DEFAULT_RESPONSE); \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                           \
      data_ptr,                                                              \
      ZB_ZCL_GET_SEQ_NUM(),                                                  \
      ZB_ZLL_CMD_COMMISSIONING_IDENTIFY_REQ);                                \
  req_data = (zb_zll_commissioning_identify_req_t*)data_ptr;                 \
  ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id));       \
  ZB_HTOLE16(&(req_data->duration), (p_identify_duration));                  \
  data_ptr += sizeof(zb_zll_commissioning_identify_req_t);                   \
  (status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (ieee_addr), (callback)); \
}

Schedules sending Commissioning.IdentifyRequest command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
p_identify_duration	[IN] - period to identify.
ieee_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_REQ

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_REQ	(		buffer,
			key_index,
			encrypted_nwk_key,
			logical_channel,
			nwk_addr,
			grp_ids_begin,
			grp_ids_end,
			free_nwk_addrs_begin_,
			free_nwk_addrs_end_,
			free_group_ids_begin_,
			free_group_ids_end_,
			dst_addr,
			callback,
			status
	)

Value:

{                                                                           \
  zb_zll_commissioning_network_join_end_device_req_t *req_data;             \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET(buffer);                       \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr);            \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                          \
      data_ptr,                                                             \
      ZB_ZCL_GET_SEQ_NUM(),                                                 \
      ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_REQ);                \
  req_data = (zb_zll_commissioning_network_join_end_device_req_t*)data_ptr; \
  ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id));      \
  ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, zb_zll_get_nib_ext_pan_id());     \
  req_data->key_idx = (key_index);                                            \
  ZB_MEMCPY(req_data->encr_nwk_key, (encrypted_nwk_key), 16);                 \
  req_data->nwk_upd_id = zb_zll_get_nib_update_id();                          \
  req_data->channel = (logical_channel);                                      \
  ZB_HTOLE16_VAL(&(req_data->pan_id), ZB_PIBCACHE_PAN_ID());                  \
  ZB_HTOLE16_VAL(&(req_data->short_addr), (nwk_addr));                        \
  ZB_HTOLE16_VAL(&(req_data->group_ids_begin), (grp_ids_begin));              \
  ZB_HTOLE16_VAL(&(req_data->group_ids_end), (grp_ids_end));                  \
  ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_begin), (free_nwk_addrs_begin_)); \
  ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_end), (free_nwk_addrs_end_));     \
  ZB_HTOLE16_VAL(&(req_data->free_group_ids_begin), (free_group_ids_begin_)); \
  ZB_HTOLE16_VAL(&(req_data->free_group_ids_end), (free_group_ids_end_));     \
  data_ptr += sizeof(zb_zll_commissioning_network_join_end_device_req_t);     \
  (status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback));   \
}

Schedules sending Commissioning.NetworkJoinEndDeviceRequest command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
key_index	[IN] - index of the field to be used in the encrypted network key field.
encrypted_nwk_key	[IN] - encrypted network key.
logical_channel	[IN] - Touchlink channel to be used for the new network.
nwk_addr	[IN] - short network address for the recipient.
grp_ids_begin	[IN] - group identifiers begin field.
grp_ids_end	[IN] - group identifiers end field.
free_nwk_addrs_begin_	[IN] - free network addresses begin field.
free_nwk_addrs_end_	[IN] - free network addresses end field.
free_group_ids_begin_	[IN] - free group identifiers begin field.
free_group_ids_end_	[IN] - free group identifiers end field.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_RES

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_RES	(		buffer,
			nwk_status,
			tsn,
			dst_addr,
			callback,
			status
	)

Value:

{                                                                           \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));                     \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr);            \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                          \
      data_ptr,                                                             \
      (tsn),                                                                \
      ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_RES);                \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(data_ptr, ZLL_TRAN_CTX().transaction_id);    \
  ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (nwk_status));                          \
  (status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}

Schedules sending Commissioning.NetworkJoinEndDeviceResponse command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
nwk_status	[IN] - network join end device result.
tsn	[IN] - ZCL transaction sequence number.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_REQ

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_REQ	(		buffer,
			key_index,
			encrypted_nwk_key,
			nwk_addr,
			grp_ids_begin,
			grp_ids_end,
			free_nwk_addrs_begin_,
			free_nwk_addrs_end_,
			free_group_ids_begin_,
			free_group_ids_end_,
			dst_addr,
			callback,
			status
	)

Value:

{                                                                             \
  zb_zll_commissioning_network_join_router_req_t* req_data;                   \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET(buffer);                         \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RESP_FRAME_CONTROL_A(data_ptr,            \
      ZB_ZCL_FRAME_DIRECTION_TO_SRV, ZB_ZCL_NOT_MANUFACTURER_SPECIFIC);       \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                            \
      data_ptr,                                                               \
      ZB_ZCL_GET_SEQ_NUM(),                                                   \
      ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_REQ);                      \
  req_data = (zb_zll_commissioning_network_join_router_req_t*)data_ptr;       \
  ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id));        \
  ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, zb_zll_get_nib_ext_pan_id());       \
  req_data->key_idx = (key_index);                                            \
  ZB_MEMCPY(req_data->encr_nwk_key, (encrypted_nwk_key), 16);                 \
  req_data->nwk_upd_id = zb_zll_get_nib_update_id();                          \
  req_data->channel = (ZLL_DEVICE_INFO().nwk_channel) ?                       \
    ZLL_DEVICE_INFO().nwk_channel : ZB_PIBCACHE_CURRENT_CHANNEL();      \
  ZB_HTOLE16_VAL(&(req_data->pan_id), ZB_PIBCACHE_PAN_ID());                  \
  ZB_HTOLE16_VAL(&(req_data->short_addr), (nwk_addr));                        \
  ZB_HTOLE16_VAL(&(req_data->group_ids_begin), (grp_ids_begin));              \
  ZB_HTOLE16_VAL(&(req_data->group_ids_end), (grp_ids_end));                  \
  ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_begin), (free_nwk_addrs_begin_)); \
  ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_end), (free_nwk_addrs_end_));     \
  ZB_HTOLE16_VAL(&(req_data->free_group_ids_begin), (free_group_ids_begin_)); \
  ZB_HTOLE16_VAL(&(req_data->free_group_ids_end), (free_group_ids_end_));     \
  data_ptr += sizeof(zb_zll_commissioning_network_join_router_req_t);         \
  (status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback));  \
}

Schedules sending Commissioning.NetworkJoinRouterRequest command.

Parameters

buffer	to put packet to (by pointer).
key_index	[IN] - index of the field to be used in the encrypted network key field.
encrypted_nwk_key	[IN] - encrypted network key.
nwk_addr	[IN] - short network address for the recipient.
grp_ids_begin	[IN] - group identifiers begin field.
grp_ids_end	[IN] - group identifiers end field.
free_nwk_addrs_begin_	[IN] - free network addresses begin field.
free_nwk_addrs_end_	[IN] - free network addresses end field.
free_group_ids_begin_	[IN] - free group identifiers begin field.
free_group_ids_end_	[IN] - free group identifiers end field.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_RES

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_RES	(		buffer,
			nwk_status,
			tsn,
			dst_addr,
			callback,
			status
	)

Value:

{                                                                           \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET(buffer);                       \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr);            \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                          \
      data_ptr,                                                             \
      (tsn),                                                                \
      ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_RES);                    \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(data_ptr, ZLL_TRAN_CTX().transaction_id);    \
  ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (nwk_status));                          \
  (status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}

Schedules sending Commissioning.NetworkJoinRouterResponse command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
nwk_status	[IN] - network join router operation status.
tsn	[IN] - ZCL transaction sequence number.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_REQ

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_REQ	(		buffer,
			ext_pan_id_,
			key_index,
			encrypted_nwk_key,
			logical_channel,
			pan_id_,
			nwk_addr,
			grp_ids_begin,
			grp_ids_end,
			free_nwk_addrs_begin_,
			free_nwk_addrs_end_,
			free_group_ids_begin_,
			free_group_ids_end_,
			dst_addr,
			callback,
			status
	)

Schedules sending Commissioning.NetworkStartRequest command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
ext_pan_id_	[IN] - extended Pan ID of the new network.
key_index	[IN] - index of the field to be used in the encrypted network key field.
encrypted_nwk_key	[IN] - encrypted network key.
logical_channel	[IN] - Touchlink channel to be used for the new network.
pan_id_	[IN] - new network Pan ID.
nwk_addr	[IN] - short network address for the recipient.
grp_ids_begin	[IN] - group identifiers begin field.
grp_ids_end	[IN] - group identifiers end field.
free_nwk_addrs_begin_	[IN] - free network addresses begin field.
free_nwk_addrs_end_	[IN] - free network addresses end field.
free_group_ids_begin_	[IN] - free group identifiers begin field.
free_group_ids_end_	[IN] - free group identifiers end field.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_RES

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_RES	(		buffer,
			seq_num,
			nwk_status,
			ext_pan_id_,
			pan_id_,
			channel_,
			dst_addr,
			callback,
			status_
	)

Value:

{                                                                                          \
  zb_zll_commissioning_network_start_res_t *req_data;                                      \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));                                    \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(data_ptr);                           \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, (seq_num),                                     \
            ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_RES);                                   \
  req_data = (zb_zll_commissioning_network_start_res_t*)data_ptr;                          \
  ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id));                     \
  req_data->status = (nwk_status);                                                         \
  ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, (ext_pan_id_));                                  \
  req_data->nwk_upd_id = ZB_ZLL_NETWORK_UPDATE_ID;                                         \
  req_data->channel = (channel_);                                                          \
  ZB_HTOLE16_VAL(&(req_data->pan_id), (pan_id_));                                          \
  data_ptr += sizeof(zb_zll_commissioning_network_start_res_t);                            \
  (status_) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback));              \
}

Schedules Commissioning.NetworkStartResponse sending.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer containing payload.
seq_num	[IN] - ZCL transaction sequence number.
nwk_status	[IN] - network start request result.
ext_pan_id_	[IN] - extended Pan ID of the network to be started.
pan_id_	[IN] - Pan ID of the network to be started.
channel_	[IN] - channel number network will be started on.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status_	[OUT] - packet send schedule status.

ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ	(		buffer,
			nwk_addr,
			dst_addr,
			callback,
			status
	)

Value:

{                                                                           \
  ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL(                \
      buffer,                                                               \
      nwk_addr,                                                             \
      dst_addr,                                                             \
      ZB_PIBCACHE_CURRENT_CHANNEL(),                                        \
      callback,                                                             \
      status);                                                              \
}

Schedules sending Commissioning.NetworkUpdateRequest command. (send command with current value of channel from pib cache)

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
nwk_addr	[IN] - network address assigned to the target.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL

#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL	(		buffer,
			nwk_addr,
			dst_addr,
			logical_channel,
			callback,
			status
	)

Value:

{                                                                               \
  zb_zll_commissioning_network_update_req_t *req_data;                          \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));                         \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL_O(data_ptr, ZB_ZCL_DISABLE_DEFAULT_RESPONSE); \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                              \
      data_ptr,                                                                 \
      ZB_ZCL_GET_SEQ_NUM(),                                                     \
      ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ);                             \
  req_data = (zb_zll_commissioning_network_update_req_t*)data_ptr;              \
  ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id));          \
  ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, zb_zll_get_nib_ext_pan_id());         \
  req_data->nwk_upd_id = zb_zll_get_nib_update_id();                            \
  req_data->channel = (logical_channel);                                        \
  ZB_HTOLE16_VAL(&(req_data->pan_id), ZB_PIBCACHE_PAN_ID());                    \
  ZB_HTOLE16_VAL(&(req_data->short_addr), (nwk_addr));                          \
  data_ptr += sizeof(zb_zll_commissioning_network_update_req_t);                \
  (status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback));    \
}

Schedules sending Commissioning.NetworkUpdateRequest command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
nwk_addr	[IN] - network address assigned to the target.
dst_addr	[IN] - IEEE device address to send packet to.
logical_channel	[IN] - channel number.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_RESET_TO_FN_REQ

#define ZB_ZLL_COMMISSIONING_SEND_RESET_TO_FN_REQ	(		buffer,
			dst_addr,
			callback,
			status
	)

Value:

{                                                                           \
  zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer));                     \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL_O(data_ptr, ZB_ZCL_ENABLE_DEFAULT_RESPONSE);       \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(                                          \
      data_ptr,                                                             \
      ZB_ZCL_GET_SEQ_NUM(),                                                 \
      ZB_ZLL_CMD_COMMISSIONING_RESET_TO_FACTORY_NEW_REQ);                   \
  ZB_ZCL_PACKET_PUT_DATA32_VAL(data_ptr, ZLL_TRAN_CTX().transaction_id);    \
  (status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback));       \
}

Schedules sending Commissioning.ResetToFactoryNewRequest command.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
dst_addr	[IN] - IEEE device address to send packet to.
callback	[IN] - callback to schedule on packet send confirmation.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_COMMISSIONING_SEND_SCAN_RES

#define ZB_ZLL_COMMISSIONING_SEND_SCAN_RES	(		buffer,
			seq_num,
			callback,
			status
	)

Schedules Commissioning.ScanResponse sending.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer to put packet to.
seq_num	[IN] - ZCL sequence number.
callback	[IN] - callback to call upon packet confirm.
status	[OUT] - packet send schedule status (see zb_ret_t).

ZB_ZLL_NETWORK_UPDATE_ID

#define ZB_ZLL_NETWORK_UPDATE_ID   ((zb_uint8_t)0)

The only acceptable value for network update identifier field in the network start response.

See also

ZCL spec, subclause 13.3.2.2.3.4.

ZB_ZLL_REPORT_ATTR_COUNT

#define ZB_ZLL_REPORT_ATTR_COUNT   0

No attributes for reporting in Touchlink profile.

Typedef Documentation

zb_zll_commissioning_device_information_common_res_t

typedef struct zb_zll_commissioning_device_information_common_res_s zb_zll_commissioning_device_information_common_res_t

Parsed permanent part of the Commissioning.DeviceInformationResponse payload.

See also

ZCL spec, subclause 13.3.2.2.2.

zb_zll_commissioning_device_information_ep_info_res_t

typedef struct zb_zll_commissioning_device_information_ep_info_res_s zb_zll_commissioning_device_information_ep_info_res_t

Parsed device information record from the Commissioning.DeviceInformationResponse payload.

See also

ZCL spec, subclause 13.3.2.2.2.

zb_zll_commissioning_device_information_req_t

typedef struct zb_zll_commissioning_device_information_req_s zb_zll_commissioning_device_information_req_t

Parsed Commissioning.DeviceInformationRequest payload.

See also

ZCL spec, subclause 13.3.2.1.2.

zb_zll_commissioning_endpoint_info_record_t

typedef struct zb_zll_commissioning_endpoint_info_record_s zb_zll_commissioning_endpoint_info_record_t

Endpoint information record for Commissioning.GetEndpointListResponse command.

See also

ZCL spec, subclause 13.3.2.2.8.

zb_zll_commissioning_endpoint_information_t

typedef struct zb_zll_commissioning_endpoint_information_s zb_zll_commissioning_endpoint_information_t

Parsed Commissioning.EndpointInformation payload.

See also

ZCL spec, subclause 13.3.2.2.6.

zb_zll_commissioning_get_endpoint_list_req_t

typedef struct zb_zll_commissioning_get_endpoint_list_req_s zb_zll_commissioning_get_endpoint_list_req_t

Parsed Commissioning.GetEndpointListRequest payload.

See also

ZCL spec, subclause 13.3.2.1.10.

zb_zll_commissioning_get_endpoint_list_res_t

typedef struct zb_zll_commissioning_get_endpoint_list_res_s zb_zll_commissioning_get_endpoint_list_res_t

Parsed Commissioning.GetEndpointListResponse payload.

See also

ZCL spec, subclause 13.3.2.2.8.

zb_zll_commissioning_get_group_ids_req_t

typedef struct zb_zll_commissioning_get_group_ids_req_s zb_zll_commissioning_get_group_ids_req_t

Parsed Commissioning.GetGroupIdentifiersRequest payload.

See also

ZCL spec, subclause 13.3.2.1.9.

zb_zll_commissioning_get_group_ids_res_permanent_t

typedef struct zb_zll_commissioning_get_group_ids_res_permanent_s zb_zll_commissioning_get_group_ids_res_permanent_t

Parsed Commissioning.GetGroupIdentifiersResponse payload.

See also

ZCL spec, subclause 13.3.2.2.7.

zb_zll_commissioning_group_info_record_t

typedef struct zb_zll_commissioning_group_info_record_s zb_zll_commissioning_group_info_record_t

Group information record for Commissioning.GetGroupIdentifiersResponse command.

See also

ZCL spec, subclause 13.3.2.2.7.4.

zb_zll_commissioning_identify_req_t

typedef struct zb_zll_commissioning_identify_req_s zb_zll_commissioning_identify_req_t

Parsed Commissioning.IdentifyRequest payload.

See also

ZCL spec, subclause 13.3.2.1.3.

zb_zll_commissioning_network_join_end_device_req_t

typedef struct zb_zll_commissioning_network_join_end_device_req_s zb_zll_commissioning_network_join_end_device_req_t

Parsed Commissioning.NetworkJoinEndDeviceRequest payload.

See also

ZCL spec, subclause 13.3.2.1.7.

zb_zll_commissioning_network_join_end_device_res_t

typedef struct zb_zll_commissioning_network_join_end_device_res_s zb_zll_commissioning_network_join_end_device_res_t

Parsed Commissioning.NetworkJoinEndDeviceResponse payload.

See also

ZLL spec, subclause 13.3.2.2.5.

zb_zll_commissioning_network_join_router_req_t

typedef struct zb_zll_commissioning_network_join_router_req_s zb_zll_commissioning_network_join_router_req_t

Parsed Commissioning.NetworkJoinRouterRequest payload.

See also

ZCL spec, subclause 13.3.2.1.6.

zb_zll_commissioning_network_join_router_res_t

typedef struct zb_zll_commissioning_network_join_router_res_s zb_zll_commissioning_network_join_router_res_t

Parsed Commissioning.NetworkJoinRouterResponse payload.

See also

ZLL spec, subclause 13.3.2.2.4.

zb_zll_commissioning_network_start_req_t

typedef struct zb_zll_commissioning_network_start_req_s zb_zll_commissioning_network_start_req_t

Parsed Commissioning.NetworkStartRequest payload.

See also

ZCL spec, subclause 13.3.2.1.5.

zb_zll_commissioning_network_start_res_t

typedef struct zb_zll_commissioning_network_start_res_s zb_zll_commissioning_network_start_res_t

Parsed Commissioning.NetworkStartResponse payload.

See also

ZLL spec, subclause 13.3.2.2.3.

zb_zll_commissioning_network_update_req_t

typedef struct zb_zll_commissioning_network_update_req_s zb_zll_commissioning_network_update_req_t

Parsed Commissioning.NetworkUpdateRequest payload.

See also

ZCL spec, subclause 13.3.2.2.5.

zb_zll_commissioning_reset_to_fn_t

typedef struct zb_zll_commissioning_reset_to_fn_s zb_zll_commissioning_reset_to_fn_t

Parsed Commissioning.ResetToFactoryNewRequest payload.

See also

ZCL spec, subclause 13.3.2.1.4.

zb_zll_commissioning_scan_req_t

typedef struct zb_zll_commissioning_scan_req_s zb_zll_commissioning_scan_req_t

Parsed Scan request payload representation.

See also

ZCL spec, subclause 13.3.2.1.1.

zb_zll_commissioning_scan_res_t

typedef struct zb_zll_commissioning_scan_res_s zb_zll_commissioning_scan_res_t

Parsed Commissioning.ScanResponse structure.

See also

ZCL spec, subclause 13.3.2.2.1.

Enumeration Type Documentation

zb_zll_commissioning_touchlink_cmd_e

enum zb_zll_commissioning_touchlink_cmd_e

Touchlink commissioning cluster command identifiers.

See also

ZCL spec, subclauses 13.3.2.1

zb_zll_commissioning_touchlink_cmd_resp_e

enum zb_zll_commissioning_touchlink_cmd_resp_e

Touchlink commissioning cluster response command identifiers.

See also

ZCL spec, subclause 13.3.2.2

zb_zll_commissioning_utility_cmd_e

enum zb_zll_commissioning_utility_cmd_e

Touchlink commissioning cluster utility command identifiers.

See also

ZCL spec, subclauses 13.3.2.1

zb_zll_commissioning_utility_cmd_resp_e

enum zb_zll_commissioning_utility_cmd_resp_e

Touchlink commissioning cluster utility response command identifiers.

See also

ZCL spec, subclause 13.3.2.2

zb_zll_general_status_e

enum zb_zll_general_status_e

Touchlink commissioning general status is used in different commissioning response command frames.

Enumerator
ZB_ZLL_GENERAL_STATUS_SUCCESS	Status: OK.
ZB_ZLL_GENERAL_STATUS_FAILURE	Status: Error.

zb_zll_info_e

enum zb_zll_info_e

Touchlink information bit values.

See also

ZCL spec, subclause 13.3.2.1.1.3.

Function Documentation

zb_zll_commissioning_send_scan_req()

void zb_zll_commissioning_send_scan_req	(	zb_bufid_t	buffer,
		zb_callback_t	callback
	)

Schedules Commissioning.ScanRequest sending.

Parameters

buffer	to use for packet creation.
callback	to call upon packet confirmation.

zb_zll_identify()

zb_ret_t zb_zll_identify

(

zb_uint8_t

param

)

Sets up Identify request and schedules it for sending. Checks transaction state, identify period acceptability, fills in and schedules for sending command packet.

Parameters

param

[IN] - reference to the packet buffer containing zb_zll_commissioning_identify_req_param_s structure as parameter.

Returns

• RET_OK in case of success. In this case application will be notified on further status (packet received, timed out, etc.) via zboss_signal_handler().
• RET_INVALID_STATE if identify time period doesn't correspond to the transaction state. I.e. either identify request was already sent, and identify period is non-zero, or request was not sent, and identify period is zero zus instructing the target to exit identify state.
• packet schedule error otherwise.

zb_zll_send_packet()

zb_ret_t zb_zll_send_packet	(	zb_bufid_t	buffer,
		zb_uint8_t *	data_ptr,
		zb_ieee_addr_t	dst_addr_long,
		zb_callback_t	callback
	)

Finish packet and send it to the designated IEEE address.

Parameters

buffer	[IN] - index zb_bufid_t of the buffer containing packet.
data_ptr	[IN] - pointer to the packet tail.
dst_addr_long	[IN] - destination device's IEEE address.
callback	[IN] - callback to call upon send packet confirmation.

Returns

packet send schedule status (see zb_ret_t).