Logo
Developing with ZBOSS for Zigbee
Data Structures | Macros | Typedefs | Enumerations
MDU Pairing cluster commands
Zigbee stack API » SE API » SE clusters » SE MDU Pairing cluster

Data Structures

struct  zb_zcl_mdu_pairing_request_s
 Pairing Request command payload. More...
 
struct  zb_zcl_mdu_pairing_response_s
 Pairing Response command payload. More...
 

Macros

#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_GENERATED_CMD_LIST   ZB_ZCL_MDU_PAIRING_SRV_CMD_PAIRING_RESPONSE
 
#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_GENERATED_CMD_LIST   ZB_ZCL_MDU_PAIRING_CLI_CMD_PAIRING_REQUEST
 
#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_MDU_PAIRING_SEND_PAIRING_REQUEST( _param, _addr, _dst_addr_mode, _dst_ep, _ep, _prfl_id, _def_resp, _cb, _lpi_version, _eui64)
 Send PairingRequest command. More...
 
#define ZB_ZCL_MDU_PAIRING_GET_PAIRING_REQUEST(_data_ptr, _buffer, _status)
 Macro for parsing payload of PairingRequest command. More...
 

Typedefs

typedef struct zb_zcl_mdu_pairing_request_s zb_zcl_mdu_pairing_request_t
 Pairing Request command payload. More...
 
typedef struct zb_zcl_mdu_pairing_response_s zb_zcl_mdu_pairing_response_t
 Pairing Response command payload. More...
 

Enumerations

enum  zb_zcl_mdu_pairing_cmd_client_e { ZB_ZCL_MDU_PAIRING_CLI_CMD_PAIRING_REQUEST = 0x00 }
 MDU Pairing cluster client commands. More...
 
enum  zb_zcl_mdu_pairing_cmd_server_e { ZB_ZCL_MDU_PAIRING_SRV_CMD_PAIRING_RESPONSE = 0x00 }
 MDU Pairing cluster server commands. More...
 

Detailed Description

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_GENERATED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_GENERATED_CMD_LIST   ZB_ZCL_MDU_PAIRING_CLI_CMD_PAIRING_REQUEST

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

§ ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_RECEIVED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_GENERATED_CMD_LIST

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

§ ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_GENERATED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_GENERATED_CMD_LIST   ZB_ZCL_MDU_PAIRING_SRV_CMD_PAIRING_RESPONSE

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

§ ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_RECEIVED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING_SERVER_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_MDU_PAIRING_CLIENT_ROLE_GENERATED_CMD_LIST

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

§ ZB_ZCL_MDU_PAIRING_GET_PAIRING_REQUEST

#define ZB_ZCL_MDU_PAIRING_GET_PAIRING_REQUEST (   _data_ptr,
  _buffer,
  _status 
)

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

Value:
{ \
zb_uint8_t *src_ptr = (zb_uint8_t*)zb_buf_begin((_buffer)); \
\
if (zb_buf_len((_buffer)) < sizeof(zb_zcl_mdu_pairing_request_t)) \
{ \
(_status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
(_status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
ZB_HTOLE32(&(_data_ptr)->lpi_version, src_ptr); \
ZB_HTOLE64(&(_data_ptr)->eui64, src_ptr+4); \
} \
}
zb_zcl_mdu_pairing_request_s
Pairing Request command payload.
Definition: zb_zcl_mdu_pairing.h:96
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:339
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:338
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:354
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:147
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:372

Macro for parsing payload of PairingRequest command.

Parameters
_data_ptr- pointer to zb_zcl_mdu_pairing_request_t structure
_buffer- pointer to buffer where Pairing Request command's payload is stored.
_status- status of payload parsing
Example
zb_bufid_t buf;
zb_zcl_mdu_pairing_request_t req;
zb_uint8_t status;
ZB_ZCL_MDU_PAIRING_GET_PAIRING_REQUEST(req, buf, status);
if (status == ZB_ZCL_PARSE_STATUS_SUCCESS)
{
(void)req.eui64; // use it
(void)req.lpi_version; // use it
}

§ ZB_ZCL_MDU_PAIRING_SEND_PAIRING_REQUEST

#define ZB_ZCL_MDU_PAIRING_SEND_PAIRING_REQUEST (   _param,
  _addr,
  _dst_addr_mode,
  _dst_ep,
  _ep,
  _prfl_id,
  _def_resp,
  _cb,
  _lpi_version,
  _eui64 
)

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

Value:
{ \
zb_bufid_t buffer = ZB_BUF_FROM_REF(_param); \
zb_uint8_t* __ptr = zb_zcl_start_command_header(buffer, \
ZB_ZCL_CONSTRUCT_FRAME_CONTROL(ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC, \
ZB_ZCL_NOT_MANUFACTURER_SPECIFIC, \
ZB_ZCL_FRAME_DIRECTION_TO_SRV, (_def_resp)), \
0, /* No manuf_code */ \
ZB_ZCL_MDU_PAIRING_CLI_CMD_PAIRING_REQUEST, NULL); \
ZB_ZCL_PACKET_PUT_DATA32(__ptr, (_lpi_version)); \
ZB_ZCL_PACKET_PUT_DATA64(__ptr, (_eui64)); \
ZB_ZCL_FINISH_PACKET((buffer), __ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
(_buffer), (_addr), (_dst_addr_mode), (_dst_ep), (_ep), (_prfl_id), \
ZB_ZCL_CLUSTER_ID_MDU_PAIRING, (_cb)); \
}
zb_zcl_start_command_header
void * zb_zcl_start_command_header(zb_bufid_t zbbuf, zb_uint8_t frame_ctl, zb_uint16_t manuf_code, zb_uint8_t cmd_id, zb_uint8_t *tsn)
Construct ZCL command header in the buffer.
ZB_ZCL_CLUSTER_ID_MDU_PAIRING
#define ZB_ZCL_CLUSTER_ID_MDU_PAIRING
Definition: zb_zcl_common.h:280
ZB_ZCL_FRAME_DIRECTION_TO_SRV
#define ZB_ZCL_FRAME_DIRECTION_TO_SRV
Definition: zb_zcl_common.h:1064
ZB_ZCL_MDU_PAIRING_CLI_CMD_PAIRING_REQUEST
Definition: zb_zcl_mdu_pairing.h:66
ZB_ZCL_NOT_MANUFACTURER_SPECIFIC
#define ZB_ZCL_NOT_MANUFACTURER_SPECIFIC
Definition: zb_zcl_common.h:1017
ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC
#define ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC
Definition: zb_zcl_common.h:998

Send PairingRequest command.

Parameters
_param- Reference to buffer.
_addr- Address of the device to send command to.
_dst_addr_mode- Address mode for _dst_addr.
_dst_ep- Destination endpoint.
_ep- Current endpoint.
_prfl_id- profile identifier
_def_resp- enable/disable default zcl response
_cb- Callback which should be called when the ZCL stack receives APS ack.
_lpi_version- lpi_version field from zb_zcl_mdu_pairing_response_t payload
_eui64- eui64 field from zb_zcl_mdu_pairing_response_t payload
Example
// The command is used as is
ZB_ZCL_MDU_PAIRING_SEND_PAIRING_REQUEST(param, remote.addr, ZB_APS_ADDR_MODE_16_ENDP_PRESENT, remote.ep, this.ep, ZB_AF_SE_PROFILE_ID, 0, NULL, lpi, this.addr);

Typedef Documentation

§ zb_zcl_mdu_pairing_request_t

typedef struct zb_zcl_mdu_pairing_request_s zb_zcl_mdu_pairing_request_t

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

Pairing Request command payload.

See also
SE spec, subclause 13.3.3.1

§ zb_zcl_mdu_pairing_response_t

typedef struct zb_zcl_mdu_pairing_response_s zb_zcl_mdu_pairing_response_t

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

Pairing Response command payload.

See also
SE spec, subclause 13.2.3.1

Enumeration Type Documentation

§ zb_zcl_mdu_pairing_cmd_client_e

enum zb_zcl_mdu_pairing_cmd_client_e

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

MDU Pairing cluster client commands.

See also
SE spec, subclause 13.3.3
Enumerator
ZB_ZCL_MDU_PAIRING_CLI_CMD_PAIRING_REQUEST 

The PairingRequest command allows a device joining a MDU network to determine the devices that will constitute the 'virtual HAN' for the household in which it is to operate.Pairing Request

§ zb_zcl_mdu_pairing_cmd_server_e

enum zb_zcl_mdu_pairing_cmd_server_e

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

MDU Pairing cluster server commands.

See also
SE spec, subclause 13.2.3
Enumerator
ZB_ZCL_MDU_PAIRING_SRV_CMD_PAIRING_RESPONSE 

The PairingResponse command provides a device joining a MDU network with a list of the devices that will constitute the 'virtual HAN' for the household in which the joining device is to operate.Pairing Request response

Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA. http://www.dsr-zboss.com http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.