nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
MDU Pairing cluster commands

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_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

#define ZB_ZCL_MDU_PAIRING_GET_PAIRING_REQUEST (   _data_ptr,
  _buffer,
  _status 
)
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)) \
{ \
} \
else \
{ \
ZB_HTOLE32(&(_data_ptr)->lpi_version, src_ptr); \
ZB_HTOLE64(&(_data_ptr)->eui64, src_ptr+4); \
} \
}
Pairing Request command payload.
Definition: zb_zcl_mdu_pairing.h:106
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115

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_buf_t *buf;
zb_uint8_t status;
{
(void)req.eui64; // use it
(void)req.lpi_version; // use it
}
#define ZB_ZCL_MDU_PAIRING_SEND_PAIRING_REQUEST (   _param,
  _addr,
  _dst_addr_mode,
  _dst_ep,
  _ep,
  _prfl_id,
  _def_resp,
  _cb,
  _lpi_version,
  _eui64 
)
Value:
{ \
zb_buf_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, \
0, /* No manuf_code */ \
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), \
}
#define ZB_ZCL_PACKET_PUT_DATA32(ptr, val)
Put 32 bit value to packet.
Definition: zb_zcl_common.h:1311
#define ZB_ZCL_PACKET_PUT_DATA64(ptr, val)
Put 64 bit value to packet.
Definition: zb_zcl_common.h:1358
Definition: zb_zcl_common.h:216
Standard profile command.
Definition: zb_zcl_common.h:756
Definition: zb_zcl_common.h:784
Definition: zb_zcl_common.h:744
#define ZB_BUF_FROM_REF(ref)
Definition: zboss_api_core.h:688
Definition: zb_zcl_mdu_pairing.h:86
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
struct zb_buf_s zb_buf_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115

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

Pairing Request command payload.

See also
SE spec, subclause 13.3.3.1

Pairing Response command payload.

See also
SE spec, subclause 13.2.3.1

Enumeration Type Documentation

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

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