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

Data Structures

struct  zb_zcl_ias_ace_arm_ha_s
 Structure representsation of Arm command - HA extended, HA spec 10.8.4.3.1.1. More...
 
struct  zb_zcl_ias_ace_zone_status_changed_s
 Structure representsation of Zone Status Changed command, HA spec, 10.8.4.4. More...
 
struct  zb_zcl_ias_ace_panel_status_changed_s
 Structure representsation of Panel Status Changed command, HA spec, 10.8.4.5. More...
 

IAS Ace cluster commands

enum  zb_zcl_ias_ace_resp_cmd_ha_e { ZB_ZCL_CMD_IAS_ACE_ZONE_STATUS_CHANGED_ID = 0x40, ZB_ZCL_CMD_IAS_ACE_PANEL_STATUS_CHANGED_ID = 0x01 }
 IAS Ace cluster responce command identifiers - HA extension. More...
 
enum  zb_zcl_ias_ace_panel_status_e {
  ZB_ZCL_IAS_ACE_PANEL_STATUS_DISARMED = 0x00, ZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_STAY = 0x01, ZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_NIGHT = 0x02, ZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_AWAY = 0x03,
  ZB_ZCL_IAS_ACE_PANEL_STATUS_EXIT_DELAY = 0x04, ZB_ZCL_IAS_ACE_PANEL_STATUS_ENTRY_DELAY = 0x05, ZB_ZCL_IAS_ACE_PANEL_STATUS_NOT_READY = 0x06
}
 Panel Status, see HA spec 10.8.4.5.0.2. More...
 
typedef struct
zb_zcl_ias_ace_arm_ha_s 
zb_zcl_ias_ace_arm_ha_t
 Structure representsation of Arm command - HA extended, HA spec 10.8.4.3.1.1.
 
typedef struct
zb_zcl_ias_ace_zone_status_changed_s 
zb_zcl_ias_ace_zone_status_changed_t
 Structure representsation of Zone Status Changed command, HA spec, 10.8.4.4.
 
typedef struct
zb_zcl_ias_ace_panel_status_changed_s 
zb_zcl_ias_ace_panel_status_changed_t
 Structure representsation of Panel Status Changed command, HA spec, 10.8.4.5.
 
#define ZB_ZCL_IAS_ACE_SEND_ARM_HA_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, arm_mode, arm_code, zone_id)
 Arm command - HA extended, HA spec 10.8.4.3.1. More...
 
#define ZB_ZCL_IAS_ACE_GET_ARM_HA_REQ(data_ptr, buffer, status)
 Macro for getting Arm command - HA extended, HA spec 10.8.4.3.1. More...
 
#define ZB_ZCL_IAS_ACE_SEND_ZONE_STATUS_CHANGED_RESP(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, cb,zone_id, zone_status, zone_label)
 Zone Status Changed command, HA spec, 10.8.4.4. More...
 
#define ZB_ZCL_IAS_ACE_ZONE_STATUS_CHANGED_RESP(data_ptr, buffer, status)
 Macro for getting Zone Status Changed command, HA spec, 10.8.4.4. More...
 
#define ZB_ZCL_IAS_ACE_SEND_PANEL_STATUS_CHANGED_RESP(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, cb,panel_status, seconds_remaining)
 Panel Status Changed command, HA spec, 10.8.4.5. More...
 
#define ZB_ZCL_IAS_ACE_PANEL_STATUS_CHANGED_RESP(data_ptr, buffer, status)
 Macro for getting Panel Status Changed command, HA spec, 10.8.4.4. More...
 

Detailed Description

HA extensions for IAS ACE cluster

Macro Definition Documentation

#define ZB_ZCL_IAS_ACE_GET_ARM_HA_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zcl_ias_ace_arm_ha_t)) \
{ \
} \
else \
{ \
ZB_MEMCPY((data_ptr), src_ptr, sizeof(zb_zcl_ias_ace_arm_ha_t)); \
} \
}
struct zb_zcl_ias_ace_arm_ha_s zb_zcl_ias_ace_arm_ha_t
Structure representsation of Arm command - HA extended, HA spec 10.8.4.3.1.1.
Definition: zb_zcl_common.h:252
Structure representsation of Arm command - HA extended, HA spec 10.8.4.3.1.1.
Definition: zb_zcl_ias_ace_ha_adds.h:79
#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 Arm command - HA extended, HA spec 10.8.4.3.1.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_arm_ha_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZCL_IAS_ACE_PANEL_STATUS_CHANGED_RESP (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_MEMCPY((data_ptr), src_ptr, sizeof(zb_zcl_ias_ace_panel_status_changed_t)); \
} \
}
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_panel_status_changed_s zb_zcl_ias_ace_panel_status_changed_t
Structure representsation of Panel Status Changed command, HA spec, 10.8.4.5.
Structure representsation of Panel Status Changed command, HA spec, 10.8.4.5.
Definition: zb_zcl_ias_ace_ha_adds.h:232

Macro for getting Panel Status Changed command, HA spec, 10.8.4.4.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_panel_status_changed_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_HA_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb,
  arm_mode,
  arm_code,
  zone_id 
)
Value:
{ \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (arm_mode)); \
ZB_ZCL_PACKET_PUT_DATA_N(ptr, (arm_code), 8); \
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_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_DATA_N(ptr, val, n)
Put N byte data to packet.
Definition: zb_zcl_common.h:1457
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 - HA extended, HA spec 10.8.4.3.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
arm_code- Arm/Disarm Code
zone_id- Zone ID
#define ZB_ZCL_IAS_ACE_SEND_PANEL_STATUS_CHANGED_RESP (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  cb,
  panel_status,
  seconds_remaining 
)
Value:
{ \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (panel_status)); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (seconds_remaining)); \
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_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_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_ias_ace_ha_adds.h:72
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

Panel Status Changed command, HA spec, 10.8.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
cb- callback for getting command send status
panel_status- Panel Status, see HA spec 10.8.4.5.0.2, see zb_zcl_ias_ace_panel_status_e
seconds_remaining- Seconds Remaining, see HA spec 10.8.4.5.0.3
#define ZB_ZCL_IAS_ACE_SEND_ZONE_STATUS_CHANGED_RESP (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  cb,
  zone_id,
  zone_status,
  zone_label 
)
Value:
{ \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (zone_id)); \
ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (zone_status)); \
ZB_ZCL_PACKET_PUT_DATA_N(ptr, (zone_label), 16); \
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_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_DATA_N(ptr, val, n)
Put N byte data to packet.
Definition: zb_zcl_common.h:1457
#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
Definition: zb_zcl_ias_ace_ha_adds.h:71
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

Zone Status Changed command, HA spec, 10.8.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
cb- callback for getting command send status
zone_id- Zone ID
zone_status- Zone Status
zone_label- Zone Label
#define ZB_ZCL_IAS_ACE_ZONE_STATUS_CHANGED_RESP (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_MEMCPY((data_ptr), src_ptr, sizeof(zb_zcl_ias_ace_zone_status_changed_t)); \
ZB_HTOLE16(&((data_ptr)->zone_status), &(src_ptr->zone_status)); \
} \
}
Structure representsation of Zone Status Changed command, HA spec, 10.8.4.4.
Definition: zb_zcl_ias_ace_ha_adds.h:146
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_zone_status_changed_s zb_zcl_ias_ace_zone_status_changed_t
Structure representsation of Zone Status Changed command, HA spec, 10.8.4.4.

Macro for getting Zone Status Changed command, HA spec, 10.8.4.4.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_ias_ace_zone_status_changed_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).

Enumeration Type Documentation

Panel Status, see HA spec 10.8.4.5.0.2.

Enumerator
ZB_ZCL_IAS_ACE_PANEL_STATUS_DISARMED 

Panel disarmed (all zones disarmed) and ready to arm

ZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_STAY 

Armed stay

ZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_NIGHT 

Armed night

ZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_AWAY 

Armed away

ZB_ZCL_IAS_ACE_PANEL_STATUS_EXIT_DELAY 

Exit delay

ZB_ZCL_IAS_ACE_PANEL_STATUS_ENTRY_DELAY 

Entry delay

ZB_ZCL_IAS_ACE_PANEL_STATUS_NOT_READY 

Not ready to arm

IAS Ace cluster responce command identifiers - HA extension.

See also
HA spec, 10.8.4.4, 10.8.4.5
Enumerator
ZB_ZCL_CMD_IAS_ACE_ZONE_STATUS_CHANGED_ID 

Zone Status Changed command, HA spec, 10.8.4.4

ZB_ZCL_CMD_IAS_ACE_PANEL_STATUS_CHANGED_ID 

Panel Status Changed command, HA spec, 10.8.4.5