Data Structures
struct	zb_zcl_identify_callbacks_s
	callback specific to Identify HA extension More...

struct	zb_zcl_identify_ez_mode_invoke_ha_s
	Structure representation of EZ-Mode Invoke - HA extension see HA spec 8.3.12.1. More...

struct	zb_zcl_identify_update_commission_state_ha_s
	Structure representation of Update Commission State - HA extension see HA spec 8.3.12.2. More...

Identify cluster attributes Identify HA extension
enum	zb_zcl_identify_attr_ha_e { ZB_ZCL_ATTR_IDENTIFY_COMMISSION_STATE_HA_ID = 0x0001, ZB_ZCL_ATTR_IDENTIFY_CALLBACKS_HA_ID = 0xfffe }
	Identify cluster - extension for HA attribute identifiers. More...

enum	zb_zcl_identify_commission_state_ha_e { ZB_ZCL_ATTR_IDENTIFY_COMMISSION_STATE_NETWORK = 1 << 0, ZB_ZCL_ATTR_IDENTIFY_COMMISSION_STATE_OPERATIONAL = 1 << 1 }
	Identify Commission State extension for HA attribute flags. More...

typedef zb_uint8_t(*	zb_zcl_identify_ez_mode_invoke_cb )(zb_uint8_t action)

typedef zb_uint8_t(*	zb_zcl_identify_update_commission_state_cb )(zb_uint8_t action, zb_uint8_t commission_state_mask)

typedef struct zb_zcl_identify_callbacks_s	zb_zcl_identify_callbacks_t
	callback specific to Identify HA extension

zb_void_t	zb_zcl_identify_register (zb_uint8_t endpoint, zb_zcl_identify_ez_mode_invoke_cb ez_mode_invoke_cb, zb_zcl_identify_update_commission_state_cb update_commission_state_cb)
	Set User App callbacks for Identify cluster request command,. More...

#define	ZB_ZCL_ATTR_IDENTIFY_COMMISSION_STATE_HA_ID_DEF_VALUE 0x00
	Identify Commission State attribute default value.

Identify cluster commands - extension for HA
enum	zb_zcl_identify_req_cmd_ha_e { ZB_ZCL_CMD_IDENTIFY_EZ_MODE_INVOKE_ID = 0x02, ZB_ZCL_CMD_IDENTIFY_UPDATE_COMMISSION_STATE_ID = 0x03 }
	Identify cluster request command identifiers - HA extension. More...

enum	zb_zcl_identify_ez_mode_invoke_action_ha_e { ZB_ZCL_ATTR_IDENTIFY_EZ_MODE_INVOKE_FACTORY_FRESH = 1 << 0, ZB_ZCL_ATTR_IDENTIFY_EZ_MODE_INVOKE_NETWORK_STEERING = 1 << 1, ZB_ZCL_ATTR_IDENTIFY_EZ_MODE_INVOKE_FINDING_BINDING = 1 << 2 }
	EZ-Mode Invoke command Action attribute flags. More...

enum	zb_zcl_identify_update_commission_state_action_ha_e { ZB_ZCL_ATTR_IDENTIFY_UPDATE_COMMISSION_STATE_NULL = 1 << 0, ZB_ZCL_ATTR_IDENTIFY_UPDATE_COMMISSION_STATE_SET = 1 << 1, ZB_ZCL_ATTR_IDENTIFY_UPDATE_COMMISSION_STATE_CLEAR = 1 << 2 }
	Update Commission State command Action attribute flags. More...

typedef struct zb_zcl_identify_ez_mode_invoke_ha_s	zb_zcl_identify_ez_mode_invoke_ha_t
	Structure representation of EZ-Mode Invoke - HA extension see HA spec 8.3.12.1.

typedef struct zb_zcl_identify_update_commission_state_ha_s	zb_zcl_identify_update_commission_state_ha_t
	Structure representation of Update Commission State - HA extension see HA spec 8.3.12.2.

#define	ZB_ZCL_IDENTIFY_SEND_EZ_MODE_INVOKE_HA_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, action)
	EZ-Mode Invoke command - HA extension, see HA spec 8.3.12.1. More...

#define	ZB_ZCL_IDENTIFY_GET_EZ_MODE_INVOKE_HA_REQ(data_ptr, buffer, status)
	Macro for getting EZ-Mode Invoke command - HA extension, see HA spec 8.3.12.1. More...

#define	ZB_ZCL_IDENTIFY_SEND_UPDATE_COMMISSION_STATE_HA_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,action, commission_state_mask)
	Update Commission State command - HA extension, see HA spec 8.3.12.2. More...

#define	ZB_ZCL_IDENTIFY_GET_UPDATE_COMMISSION_STATE_HA_REQ(data_ptr, buffer, status)
	Macro for getting Update Commission State command - HA extension, see HA spec 8.3.12.2. More...

Detailed Description

HA extensions for Identify cluster

Macro Definition Documentation

#define ZB_ZCL_IDENTIFY_GET_EZ_MODE_INVOKE_HA_REQ	(	data_ptr,
		buffer,
		status
	)

Value:

{ \
 if (ZB_BUF_LEN((buffer)) != sizeof(zb_zcl_identify_ez_mode_invoke_ha_t)) \
 { \
 (status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
 } \
 else \
 { \
 zb_zcl_identify_ez_mode_invoke_ha_t *src_ptr = \
 (zb_zcl_identify_ez_mode_invoke_ha_t*)ZB_BUF_BEGIN((buffer)); \
 (status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
 (data_ptr)->action = src_ptr->action; \
 } \
}

Macro for getting EZ-Mode Invoke command - HA extension, see HA spec 8.3.12.1.

Attention: Assumes that ZCL header already cut

Parameters

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

#define ZB_ZCL_IDENTIFY_GET_UPDATE_COMMISSION_STATE_HA_REQ	(	data_ptr,
		buffer,
		status
	)

Value:

{ \
 if (ZB_BUF_LEN((buffer)) != sizeof(zb_zcl_identify_update_commission_state_ha_t)) \
 { \
 (status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
 } \
 else \
 { \
 zb_zcl_identify_update_commission_state_ha_t *src_ptr = \
 (zb_zcl_identify_update_commission_state_ha_t*)ZB_BUF_BEGIN((buffer)); \
 (status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
 (data_ptr)->action = src_ptr->action; \
 (data_ptr)->commission_state_mask = src_ptr->commission_state_mask; \
 } \
}

Macro for getting Update Commission State command - HA extension, see HA spec 8.3.12.2.

Attention: Assumes that ZCL header already cut

Parameters

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

#define ZB_ZCL_IDENTIFY_SEND_EZ_MODE_INVOKE_HA_REQ	(	buffer,
		addr,
		dst_addr_mode,
		dst_ep,
		ep,
		prfl_id,
		def_resp,
		cb,
		action
	)

Value:

{ \
 zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer); \
 ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)); \
 ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, ZB_ZCL_GET_SEQ_NUM(), \
 ZB_ZCL_CMD_IDENTIFY_EZ_MODE_INVOKE_ID); \
 ZB_ZCL_PACKET_PUT_DATA8(ptr, (action)); \
 ZB_ZCL_FINISH_PACKET((buffer), ptr) \
 ZB_ZCL_SEND_COMMAND_SHORTbuffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
 ZB_ZCL_CLUSTER_ID_IDENTIFY, cb); \
}

EZ-Mode Invoke command - HA extension, see HA spec 8.3.12.1.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- default response
cb	- callback for getting command send status
action	- Action, see zb_zcl_identify_ez_mode_invoke_action_ha_e

#define ZB_ZCL_IDENTIFY_SEND_UPDATE_COMMISSION_STATE_HA_REQ	(	buffer,
		addr,
		dst_addr_mode,
		dst_ep,
		ep,
		prfl_id,
		def_resp,
		cb,
		action,
		commission_state_mask
	)

Value:

{ \
 zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer); \
 ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)); \
 ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, ZB_ZCL_GET_SEQ_NUM(), \
 ZB_ZCL_CMD_IDENTIFY_UPDATE_COMMISSION_STATE_ID); \
 ZB_ZCL_PACKET_PUT_DATA8(ptr, (action)); \
 ZB_ZCL_PACKET_PUT_DATA8(ptr, (commission_state_mask)); \
 ZB_ZCL_FINISH_PACKET((buffer), ptr) \
 ZB_ZCL_SEND_COMMAND_SHORTbuffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
 ZB_ZCL_CLUSTER_ID_IDENTIFY, cb); \
}

Update Commission State command - HA extension, see HA spec 8.3.12.2.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- default response
cb	- callback for getting command send status
action	- Action, see zb_zcl_identify_update_commission_state_action_ha_e
commission_state_mask	- Commission State Mask, see zb_zcl_identify_commission_state_ha_e

Typedef Documentation

typedef zb_uint8_t(* zb_zcl_identify_ez_mode_invoke_cb)(zb_uint8_t action)

Callback for EZ-Mode Invoke command, see HA Spec 8.3.12.1

typedef zb_uint8_t(* zb_zcl_identify_update_commission_state_cb)(zb_uint8_t action, zb_uint8_t commission_state_mask)

Callback for EZ-Mode Invoke command, see HA Spec 8.3.12.2

Enumeration Type Documentation

enum zb_zcl_identify_attr_ha_e

Identify cluster - extension for HA attribute identifiers.

See also: HA spec, Identify Cluster 8.3.11

Enumerator
ZB_ZCL_ATTR_IDENTIFY_COMMISSION_STATE_HA_ID	Commission State attribute, HA spec 8.3.11.1.
ZB_ZCL_ATTR_IDENTIFY_CALLBACKS_HA_ID	Struct with pointers on User App callbacks for EZ-Mode Invoke and Update Commission State commands see zb_zcl_identify_callbacks_t, HA Spec 8.3.12.

enum zb_zcl_identify_commission_state_ha_e

Identify Commission State extension for HA attribute flags.

See also: HA spec 8.3.11.1

Enumerator
ZB_ZCL_ATTR_IDENTIFY_COMMISSION_STATE_NETWORK	Network State
ZB_ZCL_ATTR_IDENTIFY_COMMISSION_STATE_OPERATIONAL	Operational State

enum zb_zcl_identify_ez_mode_invoke_action_ha_e

EZ-Mode Invoke command Action attribute flags.

See also: HA spec 8.3.12.1

Enumerator
ZB_ZCL_ATTR_IDENTIFY_EZ_MODE_INVOKE_FACTORY_FRESH	Factory Fresh - Clear all bindings, group table entries and the ComissionState attribute and revert to Factory
ZB_ZCL_ATTR_IDENTIFY_EZ_MODE_INVOKE_NETWORK_STEERING	Network Steering - Invoke the EZ-Mode Network Steering process
ZB_ZCL_ATTR_IDENTIFY_EZ_MODE_INVOKE_FINDING_BINDING	Finding and Binding - Invoke the EZ-Mode Finding and Binding process if Network Steering is successful

enum zb_zcl_identify_req_cmd_ha_e

Identify cluster request command identifiers - HA extension.

See also: HA spec, 8.3.12

Enumerator
ZB_ZCL_CMD_IDENTIFY_EZ_MODE_INVOKE_ID	EZ-Mode Invoke command, HA spec, 8.3.12.1
ZB_ZCL_CMD_IDENTIFY_UPDATE_COMMISSION_STATE_ID	Update Commission State command, HA spec, 8.3.12.2

enum zb_zcl_identify_update_commission_state_action_ha_e

Update Commission State command Action attribute flags.

See also: HA spec 8.3.12.1.2

Enumerator
ZB_ZCL_ATTR_IDENTIFY_UPDATE_COMMISSION_STATE_NULL	Do nothing
ZB_ZCL_ATTR_IDENTIFY_UPDATE_COMMISSION_STATE_SET	For each bit set in the CommissionStateMask, set the same bit in the CommissionState attribute
ZB_ZCL_ATTR_IDENTIFY_UPDATE_COMMISSION_STATE_CLEAR	For each bit set in the CommissionStateMask, clear the same bit in the CommissionState attribute

Function Documentation

zb_void_t zb_zcl_identify_register	(	zb_uint8_t	endpoint,
		zb_zcl_identify_ez_mode_invoke_cb	ez_mode_invoke_cb,
		zb_zcl_identify_update_commission_state_cb	update_commission_state_cb
	)

Set User App callbacks for Identify cluster request command,.

Parameters

endpoint	- endpoint for which callbacks are to be registered
ez_mode_invoke_cb	- see zb_zcl_identify_ez_mode_invoke_cb
update_commission_state_cb	- see zb_zcl_identify_update_commission_state_cb

Data Structures

Identify cluster attributes Identify HA extension

Identify cluster commands - extension for HA

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation