nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
ZCL IAS ACE cluster

Data Structures

struct  zb_zcl_ias_ace_zone_table_s
 Structure representsation of IAS ACE Zone Table see ZCL spec 8.3.2.3, table 8.11. More...
 
struct  zb_zcl_ias_ace_arm_s
 Structure representsation of Arm command, ZCL spec 8.3.2.4.1.1. More...
 
struct  zb_zcl_ias_ace_bypass_s
 Structure representsation of Bypass command, ZCL spec 8.3.2.4.2.1. More...
 
struct  zb_zcl_ias_ace_get_zone_info_s
 Structure representsation of Get Zone Information command, ZCL spec 8.3.2.4.5. More...
 
struct  zb_zcl_ias_ace_arm_resp_s
 Structure representation of Arm Response command, ZCL spec 8.3.2.5.1. More...
 
struct  zb_zcl_ias_ace_get_zone_id_map_resp_s
 Structure representsation of Get Zone ID Map Response command, ZCL spec 8.3.2.5.2.1. More...
 
struct  zb_zcl_ias_ace_get_zone_info_resp_s
 Structure representsation of Get Zone Information Response command, ZCL spec 8.3.2.5.3.1 see @ ref zb_zcl_ias_ace_zone_table_s. More...
 

IAS Ace cluster attributes

enum  zb_zcl_ias_ace_attr_e { ZB_ZCL_ATTR_IAS_ACE_ZONE_TABLE_LENGTH_ID = 0xfffe, ZB_ZCL_ATTR_IAS_ACE_ZONE_TABLE_ID = 0xffff }
 IAS Ace cluster custom attribute identifiers. More...
 
typedef struct
zb_zcl_ias_ace_zone_table_s 
zb_zcl_ias_ace_zone_table_t
 Structure representsation of IAS ACE Zone Table see ZCL spec 8.3.2.3, table 8.11.
 
#define ZB_ZCL_IAS_ACE_ZONE_TYPE_MAX_VALUE   0xfffe
 IAS ACE ZoneType attribute maximum value.
 
#define ZB_ZCL_IAS_ACE_ZONE_TABLE_LENGTH   256
 IAS ACE ZoneType attribute maximum value.
 

IAS Ace cluster commands

enum  zb_zcl_ias_ace_cmd_e {
  ZB_ZCL_CMD_IAS_ACE_ARM_ID = 0x00, ZB_ZCL_CMD_IAS_ACE_BYPASS_ID = 0x01, ZB_ZCL_CMD_IAS_ACE_EMERGENCY_ID = 0x02, ZB_ZCL_CMD_IAS_ACE_FIRE_ID = 0x03,
  ZB_ZCL_CMD_IAS_ACE_PANIC_ID = 0x04, ZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_ID = 0x05, ZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFO_ID = 0x06
}
 IAS Ace cluster command identifiers. More...
 
enum  zb_zcl_ias_ace_resp_cmd_e { ZB_ZCL_CMD_IAS_ACE_ARM_RESP_ID = 0x00, ZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_RESP_ID = 0x01, ZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFO_RESP_ID = 0x02 }
 IAS Ace cluster responce command identifiers. More...
 
enum  zb_zcl_ias_ace_arm_mode_e { ZB_ZCL_IAS_ACE_ARM_MODE_DISARM = 0x00, ZB_ZCL_IAS_ACE_ARM_MODE_DAY = 0x01, ZB_ZCL_IAS_ACE_ARM_MODE_NIGHT = 0x02, ZB_ZCL_IAS_ACE_ARM_MODE_ALL = 0x03 }
 Values of the Arm Mode see ZCL spec 8.3.2.4.1.2. More...
 
enum  zb_zcl_ias_ace_arm_not_e { ZB_ZCL_IAS_ACE_ARM_NOT_DISARM = 0x00, ZB_ZCL_IAS_ACE_ARM_NOT_DAY = 0x01, ZB_ZCL_IAS_ACE_ARM_NOT_NIGHT = 0x02, ZB_ZCL_IAS_ACE_ARM_NOT_ALL = 0x03 }
 Values of the Arm Notification see ZCL spec 8.3.2.5.1.2. More...
 
typedef struct zb_zcl_ias_ace_arm_s zb_zcl_ias_ace_arm_t
 Structure representsation of Arm command, ZCL spec 8.3.2.4.1.1.
 
typedef struct
zb_zcl_ias_ace_bypass_s 
zb_zcl_ias_ace_bypass_t
 Structure representsation of Bypass command, ZCL spec 8.3.2.4.2.1.
 
typedef struct
zb_zcl_ias_ace_get_zone_info_s 
zb_zcl_ias_ace_get_zone_info_t
 Structure representsation of Get Zone Information command, ZCL spec 8.3.2.4.5.
 
typedef struct
zb_zcl_ias_ace_arm_resp_s 
zb_zcl_ias_ace_arm_resp_t
 Structure representation of Arm Response command, ZCL spec 8.3.2.5.1.
 
typedef struct
zb_zcl_ias_ace_get_zone_id_map_resp_s 
zb_zcl_ias_ace_get_zone_id_map_resp_t
 Structure representsation of Get Zone ID Map Response command, ZCL spec 8.3.2.5.2.1.
 
typedef struct
zb_zcl_ias_ace_get_zone_info_resp_s 
zb_zcl_ias_ace_get_zone_info_resp_t
 Structure representsation of Get Zone Information Response command, ZCL spec 8.3.2.5.3.1 see @ ref zb_zcl_ias_ace_zone_table_s.
 
#define ZB_ZCL_IAS_ACE_SEND_ARM_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, arm_mode)
 Arm command, ZCL spec 8.3.2.4.1. More...
 
#define ZB_ZCL_IAS_ACE_GET_ARM_REQ(data_ptr, buffer, status)
 Macro for getting Arm command, see ZCL spec 8.3.2.4.1. More...
 
#define ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_START(buffer, def_resp, length, ptr)
 Start Bypass command, ZCL spec 8.3.2.4.1. More...
 
#define ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_ADD(ptr, zone_id)
 Add Zone Id to Bypass command, ZCL spec 8.3.2.4.1. More...
 
#define ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_END(ptr, buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, cb)
 End form Bypass command and send it, ZCL spec 8.3.2.4.1. More...
 
#define ZB_ZCL_IAS_ACE_GET_BYPASS_REQ(data_ptr, buffer, status)
 Macro for getting Bypass command, see ZCL spec 8.3.2.4.1. More...
 
#define ZB_ZCL_IAS_ACE_SEND_EMERGENCY_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
 Emergency command, ZCL spec 8.3.2.4.3. More...
 
#define ZB_ZCL_IAS_ACE_SEND_FIRE_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
 Fire command, ZCL spec 8.3.2.4.3. More...
 
#define ZB_ZCL_IAS_ACE_SEND_PANIC_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
 Panic command, ZCL spec 8.3.2.4.3. More...
 
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_ID_MAP_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
 Get Zone ID Map command, ZCL spec 8.3.2.4.4. More...
 
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_INFO_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, zone_id)
 Get Zone Information command, ZCL spec 8.3.2.4.5. More...
 
#define ZB_ZCL_IAS_ACE_GET_GET_ZONE_INFO_REQ(data_ptr, buffer, status)
 Macro for getting Get Zone Information command, ZCL spec 8.3.2.4.5. More...
 
#define ZB_ZCL_IAS_ACE_SEND_ARM_RESP(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,arm_notification)
 Arm Response command, ZCL spec 8.3.2.5.1. More...
 
#define ZB_ZCL_IAS_ACE_GET_ARM_RESP(data_ptr, buffer, status)
 Macro for getting Arm Response command, ZCL spec 8.3.2.5.1. More...
 
#define ZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_LENGTH   16
 Length of array of Bitmap of Zone ID Map, ZCL spec 8.3.2.5.2.1.
 
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_ID_MAP_RESP(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,zone_id_map)
 Get Zone ID Map Response command, ZCL spec 8.3.2.5.2. More...
 
#define ZB_ZCL_IAS_ACE_GET_GET_ZONE_ID_MAP_RESP(data_ptr, buffer, status)
 Macro for getting Get Zone ID Map Response command, ZCL spec 8.3.2.5.2. More...
 
#define ZB_ZCL_IAS_ACE_GET_ZONE_INFO_TYPE_NONE   0xffff
 Zone Type is empty, ZCL spec 8.3.2.5.3.1.
 
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_INFO_RESP(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq,zone_id, zone_type, address)
 Get Zone Information Response command, ZCL spec 8.3.2.5.3. More...
 
#define ZB_ZCL_IAS_ACE_GET_GET_ZONE_INFO_RESP(data_ptr, buffer, status)
 Macro for getting Get Zone Information Response command, ZCL spec 8.3.2.5.3. More...
 

Detailed Description

Macro Definition Documentation

#define ZB_ZCL_IAS_ACE_GET_ARM_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zcl_ias_ace_arm_t)) \
{ \
} \
else \
{ \
(data_ptr)->arm_mode = src_ptr->arm_mode; \
} \
}
Definition: zb_zcl_common.h:252
Structure representsation of Arm command, ZCL spec 8.3.2.4.1.1.
Definition: zb_zcl_ias_ace.h:184
#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
struct zb_zcl_ias_ace_arm_s zb_zcl_ias_ace_arm_t
Structure representsation of Arm command, ZCL spec 8.3.2.4.1.1.

Macro for getting Arm command, see ZCL spec 8.3.2.4.1.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_arm_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZCL_IAS_ACE_GET_ARM_RESP (   data_ptr,
  buffer,
  status 
)
Value:
{ \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zcl_ias_ace_arm_resp_t)) \
{ \
} \
else \
{ \
(data_ptr)->arm_notification = src_ptr->arm_notification; \
} \
}
Structure representation of Arm Response command, ZCL spec 8.3.2.5.1.
Definition: zb_zcl_ias_ace.h:496
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
struct zb_zcl_ias_ace_arm_resp_s zb_zcl_ias_ace_arm_resp_t
Structure representation of Arm Response command, ZCL spec 8.3.2.5.1.

Macro for getting Arm Response command, ZCL spec 8.3.2.5.1.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_arm_resp_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZCL_IAS_ACE_GET_BYPASS_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
if (ZB_BUF_LEN((buffer)) != src_ptr->length+1 /*1-sizeof(length)*/) \
{ \
} \
else \
{ \
ZB_MEMCPY((data_ptr), src_ptr, src_ptr->length+1); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
Structure representsation of Bypass command, ZCL spec 8.3.2.4.2.1.
Definition: zb_zcl_ias_ace.h:243
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
struct zb_zcl_ias_ace_bypass_s zb_zcl_ias_ace_bypass_t
Structure representsation of Bypass command, ZCL spec 8.3.2.4.2.1.

Macro for getting Bypass command, see ZCL spec 8.3.2.4.1.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_bypass_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZCL_IAS_ACE_GET_GET_ZONE_ID_MAP_RESP (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
{ \
ZB_HTOLE16(&((data_ptr)->zone_id_map[i]), &(src_ptr->zone_id_map[i])); \
} \
} \
}
struct zb_zcl_ias_ace_get_zone_id_map_resp_s zb_zcl_ias_ace_get_zone_id_map_resp_t
Structure representsation of Get Zone ID Map Response command, ZCL spec 8.3.2.5.2.1.
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
#define ZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_LENGTH
Length of array of Bitmap of Zone ID Map, ZCL spec 8.3.2.5.2.1.
Definition: zb_zcl_ias_ace.h:554
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Structure representsation of Get Zone ID Map Response command, ZCL spec 8.3.2.5.2.1.
Definition: zb_zcl_ias_ace.h:557

Macro for getting Get Zone ID Map Response command, ZCL spec 8.3.2.5.2.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_get_zone_id_map_resp_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZCL_IAS_ACE_GET_GET_ZONE_INFO_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zcl_ias_ace_get_zone_info_t)) \
{ \
} \
else \
{ \
(data_ptr)->zone_id = src_ptr->zone_id; \
} \
}
struct zb_zcl_ias_ace_get_zone_info_s zb_zcl_ias_ace_get_zone_info_t
Structure representsation of Get Zone Information command, ZCL spec 8.3.2.4.5.
Structure representsation of Get Zone Information command, ZCL spec 8.3.2.4.5.
Definition: zb_zcl_ias_ace.h:422
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

Macro for getting Get Zone Information command, ZCL spec 8.3.2.4.5.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_get_zone_info_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZCL_IAS_ACE_GET_GET_ZONE_INFO_RESP (   data_ptr,
  buffer,
  status 
)
Value:
{ \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zcl_ias_ace_get_zone_info_resp_t)) \
{ \
} \
else \
{ \
(data_ptr)->zone_id = src_ptr->zone_id; \
ZB_HTOLE16(&((data_ptr)->zone_type), &(src_ptr->zone_type)); \
ZB_IEEE_ADDR_COPY((data_ptr)->address, (src_ptr)->address); \
} \
}
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
Structure representsation of Get Zone Information Response command, ZCL spec 8.3.2.5.3.1 see @ ref zb_zcl_ias_ace_zone_table_s.
Definition: zb_zcl_ias_ace.h:627
struct zb_zcl_ias_ace_get_zone_info_resp_s zb_zcl_ias_ace_get_zone_info_resp_t
Structure representsation of Get Zone Information Response command, ZCL spec 8.3.2.5.3.1 see @ ref zb_zcl_ias_ace_zone_table_s.

Macro for getting Get Zone Information Response command, ZCL spec 8.3.2.5.3.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_get_zone_info_resp_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZCL_IAS_ACE_SEND_ARM_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb,
  arm_mode 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (arm_mode)); \
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_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Definition: zb_zcl_ias_ace.h:146
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202

Arm command, ZCL spec 8.3.2.4.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- enable/disable default response
cb- callback for getting command send status
arm_mode- Arm Mode, see zb_zcl_ias_ace_arm_mode_e
#define ZB_ZCL_IAS_ACE_SEND_ARM_RESP (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  seq,
  arm_notification 
)
Value:
{ \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (arm_notification)); \
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_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
Definition: zb_zcl_ias_ace.h:160
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Arm Response command, ZCL spec 8.3.2.5.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
seq- sequence
arm_notification- Arm Notification, see zb_zcl_ias_ace_arm_not_e
#define ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_ADD (   ptr,
  zone_id 
)
Value:
{ \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (zone_id)); \
}
#define ZB_ZCL_PACKET_PUT_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273

Add Zone Id to Bypass command, ZCL spec 8.3.2.4.1.

Parameters
ptr- [in/out] (zb_uint8_t*) current position
zone_id- Zone ID, see zb_zcl_ias_ace_zone_table_s
#define ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_END (   ptr,
  buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  cb 
)
Value:
{ \
ZB_ZCL_FINISH_PACKET((buffer), ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
}
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
Definition: zb_zcl_common.h:202

End form Bypass command and send it, ZCL spec 8.3.2.4.1.

Parameters
ptr- (zb_uint8_t*) current position
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
cb- callback for getting command send status
#define ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_START (   buffer,
  def_resp,
  length,
  ptr 
)
Value:
{ \
(ptr) = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), \
ZB_ZCL_PACKET_PUT_DATA8((ptr), (length)); \
}
#define ZB_ZCL_PACKET_PUT_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Definition: zb_zcl_ias_ace.h:147

Start Bypass command, ZCL spec 8.3.2.4.1.

Parameters
buffer- to put packet to
length- Number of Zones
def_resp- enable/disable default response
ptr- [out] (zb_uint8_t*) current position for ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_ADD and ZB_ZCL_IAS_ACE_SEND_BYPASS_REQ_END
#define ZB_ZCL_IAS_ACE_SEND_EMERGENCY_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), \
ZB_ZCL_FINISH_PACKET((buffer), ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Definition: zb_zcl_ias_ace.h:148
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202

Emergency command, ZCL spec 8.3.2.4.3.

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- enable/disable default response
cb- callback for getting command send status
#define ZB_ZCL_IAS_ACE_SEND_FIRE_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), \
ZB_ZCL_FINISH_PACKET((buffer), ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Definition: zb_zcl_ias_ace.h:149
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202

Fire command, ZCL spec 8.3.2.4.3.

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- enable/disable default response
cb- callback for getting command send status
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_ID_MAP_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), \
ZB_ZCL_FINISH_PACKET((buffer), ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Definition: zb_zcl_ias_ace.h:151
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202

Get Zone ID Map command, ZCL spec 8.3.2.4.4.

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- enable/disable default response
cb- callback for getting command send status
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_ID_MAP_RESP (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  seq,
  zone_id_map 
)
Value:
{ \
{ \
ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (zone_id_map)[i]); \
} \
ZB_ZCL_FINISH_PACKET((buffer), ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
}
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
#define ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, val)
Definition: zb_zcl_common.h:1291
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
#define ZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_LENGTH
Length of array of Bitmap of Zone ID Map, ZCL spec 8.3.2.5.2.1.
Definition: zb_zcl_ias_ace.h:554
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202
Definition: zb_zcl_ias_ace.h:161
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Get Zone ID Map Response command, ZCL spec 8.3.2.5.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
seq- sequence
zone_id_map- Zone ID Map, array[16] of zb_uint16_t
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_INFO_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb,
  zone_id 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (zone_id)); \
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_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202
Definition: zb_zcl_ias_ace.h:152

Get Zone Information command, ZCL spec 8.3.2.4.5.

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- enable/disable default response
cb- callback for getting command send status
zone_id- Zone ID, see zb_zcl_ias_ace_zone_table_s
#define ZB_ZCL_IAS_ACE_SEND_GET_ZONE_INFO_RESP (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  seq,
  zone_id,
  zone_type,
  address 
)
Value:
{ \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (zone_id)); \
ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (zone_type)); \
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_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
#define ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, val)
Definition: zb_zcl_common.h:1291
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
#define ZB_ZCL_PACKET_PUT_DATA_IEEE(dst_ptr, src_ptr)
Put IEEE address into packet.
Definition: zb_zcl_common.h:1448
Definition: zb_zcl_common.h:202
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114
Definition: zb_zcl_ias_ace.h:162

Get Zone Information Response command, ZCL spec 8.3.2.5.3.

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
seq- sequence
zone_id- Zone ID
zone_type- Zone Type, see zb_zcl_ias_zone_zonetype_e
address- Zone Address
#define ZB_ZCL_IAS_ACE_SEND_PANIC_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), \
ZB_ZCL_FINISH_PACKET((buffer), ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Definition: zb_zcl_ias_ace.h:150
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_common.h:202

Panic command, ZCL spec 8.3.2.4.3.

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- enable/disable default response
cb- callback for getting command send status

Enumeration Type Documentation

Values of the Arm Mode see ZCL spec 8.3.2.4.1.2.

Enumerator
ZB_ZCL_IAS_ACE_ARM_MODE_DISARM 

Disarm

ZB_ZCL_IAS_ACE_ARM_MODE_DAY 

Arm Day/Home Zones Only

ZB_ZCL_IAS_ACE_ARM_MODE_NIGHT 

Arm Night/Sleep Zones Only

ZB_ZCL_IAS_ACE_ARM_MODE_ALL 

Arm All Zones

Values of the Arm Notification see ZCL spec 8.3.2.5.1.2.

Enumerator
ZB_ZCL_IAS_ACE_ARM_NOT_DISARM 

All Zones Disarmed

ZB_ZCL_IAS_ACE_ARM_NOT_DAY 

Only Day/Home Zones Armed

ZB_ZCL_IAS_ACE_ARM_NOT_NIGHT 

Only Night/Sleep Zones Armed

ZB_ZCL_IAS_ACE_ARM_NOT_ALL 

All Zones Armed

IAS Ace cluster custom attribute identifiers.

Enumerator
ZB_ZCL_ATTR_IAS_ACE_ZONE_TABLE_LENGTH_ID 

Ace table length, ZCL spec 8.3.2.3.

ZB_ZCL_ATTR_IAS_ACE_ZONE_TABLE_ID 

Ace table ZCL spec 8.3.2.3.

IAS Ace cluster command identifiers.

See also
ZCL spec, IAS Ace Cluster, 8.3.2.4
Enumerator
ZB_ZCL_CMD_IAS_ACE_ARM_ID 

Arm command, ZCL spec 8.3.2.4.1

ZB_ZCL_CMD_IAS_ACE_BYPASS_ID 

Bypass command, ZCL spec 8.3.2.4.2

ZB_ZCL_CMD_IAS_ACE_EMERGENCY_ID 

Emergency command, ZCL spec 8.3.2.4.3

ZB_ZCL_CMD_IAS_ACE_FIRE_ID 

Fire command, ZCL spec 8.3.2.4.3

ZB_ZCL_CMD_IAS_ACE_PANIC_ID 

Panic command, ZCL spec 8.3.2.4.3

ZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_ID 

Get Zone ID Map command, ZCL spec 8.3.2.4.4

ZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFO_ID 

Get Zone Information command, ZCL spec 8.3.2.4.5

IAS Ace cluster responce command identifiers.

See also
ZCL spec, IAS Ace Cluster, 8.3.2.5
Enumerator
ZB_ZCL_CMD_IAS_ACE_ARM_RESP_ID 

Arm Response command, ZCL spec 8.3.2.5.1

ZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_RESP_ID 

Get Zone ID Map Response command, ZCL spec 8.3.2.5.2

ZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFO_RESP_ID 

Get Zone Information Response command, ZCL spec 8.3.2.5.3