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

Functions

zb_void_t zb_zcl_ias_zone_write_attr_hook (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value)
 Hook on Write attribute send Zone Status Change Notification Command if change ZoneStatus attribute.
 

IAS Zone cluster attributes

enum  zb_zcl_ias_zone_attr_e {
  ZB_ZCL_ATTR_IAS_ZONE_ZONESTATE_ID = 0x0000, ZB_ZCL_ATTR_IAS_ZONE_ZONETYPE_ID = 0x0001, ZB_ZCL_ATTR_IAS_ZONE_ZONESTATUS_ID = 0x0002, ZB_ZCL_ATTR_IAS_ZONE_IAS_CIE_ADDRESS_ID = 0x0010,
  ZB_ZCL_ATTR_CUSTOM_ZGP_CALIBRATION = 0x8000, ZB_ZCL_ATTR_CUSTOM_ZGP_CLOUD_ACK = 0x8003, ZB_ZCL_ATTR_CUSTOM_CIE_EP = 0xF001, ZB_ZCL_ATTR_CUSTOM_CIE_SHORT_ADDR = 0xF002
}
 IAS Zone cluster attribute identifiers. More...
 
enum  zb_zcl_ias_zone_zonestate_e { ZB_ZCL_IAS_ZONE_ZONESTATE_NOT_ENROLLED = 0, ZB_ZCL_IAS_ZONE_ZONESTATE_ENROLLED = 1 }
 IAS Zone ZoneState value. More...
 
enum  zb_zcl_ias_zone_zonetype_e {
  ZB_ZCL_IAS_ZONE_ZONETYPE_STANDARD_CIE = 0x0000, ZB_ZCL_IAS_ZONE_ZONETYPE_MOTION = 0x000d, ZB_ZCL_IAS_ZONE_ZONETYPE_CONTACT_SWITCH = 0x0015, ZB_ZCL_IAS_ZONE_ZONETYPE_FIRE_SENSOR = 0x0028,
  ZB_ZCL_IAS_ZONE_ZONETYPE_WATER_SENSOR = 0x002a, ZB_ZCL_IAS_ZONE_ZONETYPE_GAS_SENSOR = 0x002b, ZB_ZCL_IAS_ZONE_ZONETYPE_PERSONAL_EMERGENCY = 0x002c, ZB_ZCL_IAS_ZONE_ZONETYPE_VIBRATION_MOVEMENT = 0x002d,
  ZB_ZCL_IAS_ZONE_ZONETYPE_REMOTE_CONTROL = 0x010f, ZB_ZCL_IAS_ZONE_ZONETYPE_KEY_FOB = 0x0115, ZB_ZCL_IAS_ZONE_ZONETYPE_KEYPAD = 0x021d, ZB_ZCL_IAS_ZONE_ZONETYPE_STANDARD_WARNING = 0x0225,
  ZB_ZCL_IAS_ZONE_ZONETYPE_INVALID = 0xffff
}
 IAS Zone ZoneType value. More...
 
enum  zb_zcl_ias_zone_zonestatus_e {
  ZB_ZCL_IAS_ZONE_ZONE_STATUS_ALARM1 = 1 << 0, ZB_ZCL_IAS_ZONE_ZONE_STATUS_ALARM2 = 1 << 1, ZB_ZCL_IAS_ZONE_ZONE_STATUS_TAMPER = 1 << 2, ZB_ZCL_IAS_ZONE_ZONE_STATUS_BATTERY = 1 << 3,
  ZB_ZCL_IAS_ZONE_ZONE_STATUS_SUPERVISION = 1 << 4, ZB_ZCL_IAS_ZONE_ZONE_STATUS_RESTORE = 1 << 5, ZB_ZCL_IAS_ZONE_ZONE_STATUS_TROUBLE = 1 << 6, ZB_ZCL_IAS_ZONE_ZONE_STATUS_AC_MAINS = 1 << 7
}
 IAS Zone ZoneStatus attribute flags. More...
 
#define ZB_ZCL_IAS_ZONE_ZONESTATE_DEF_VALUE   ZB_ZCL_IAS_ZONE_ZONESTATE_NOT_ENROLLED
 IAS Zone ZoneState attribute default value.
 
#define ZB_ZCL_IAS_ZONE_ZONE_STATUS_DEF_VALUE   0
 IAS Zone ZoneStatus attribute default value.
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_CUSTOM_CIE_EP(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_CUSTOM_CIE_SHORT_ADDR(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_ZONESTATE_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_ZONETYPE_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_ZONESTATUS_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_IAS_CIE_ADDRESS_ID(data_ptr)
 
#define ZB_ZCL_DECLARE_IAS_ZONE_ATTRIB_LIST(attr_list, zone_state, zone_type, zone_status, ias_cie_address,cie_short_addr, cie_ep)
 
#define ZB_ZCL_IAS_ZONE_REPORT_ATTR_COUNT   1
 

Detailed Description

IAS Zone cluster definitions

Macro Definition Documentation

#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_CUSTOM_CIE_EP (   data_ptr)
Value:
{ \
ZB_ZCL_ATTR_CUSTOM_CIE_EP, \
(zb_voidp_t) data_ptr \
}
Definition: zb_zcl_common.h:490
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:455
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_CUSTOM_CIE_SHORT_ADDR (   data_ptr)
Value:
{ \
ZB_ZCL_ATTR_CUSTOM_CIE_SHORT_ADDR, \
(zb_voidp_t) data_ptr \
}
Definition: zb_zcl_common.h:456
Definition: zb_zcl_common.h:490
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_IAS_CIE_ADDRESS_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:491
Definition: zb_zcl_common.h:477
IAS_CIE_Address attribute, ZCL spec 8.2.2.2.2.1.
Definition: zb_zcl_ias_zone.h:81
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_ZONESTATE_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
Definition: zb_zcl_common.h:470
ZoneState attribute, ZCL spec 8.2.2.2.1.1.
Definition: zb_zcl_ias_zone.h:75
Definition: zb_zcl_common.h:490
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_ZONESTATUS_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
Definition: zb_zcl_common.h:492
ZoneStatus attribute, ZCL spec 8.2.2.2.1.3.
Definition: zb_zcl_ias_zone.h:79
Definition: zb_zcl_common.h:490
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:448
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_IAS_ZONE_ZONETYPE_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
Definition: zb_zcl_common.h:471
Definition: zb_zcl_common.h:490
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
ZoneType attribute, ZCL spec 8.2.2.2.1.2.
Definition: zb_zcl_ias_zone.h:77
#define ZB_ZCL_DECLARE_IAS_ZONE_ATTRIB_LIST (   attr_list,
  zone_state,
  zone_type,
  zone_status,
  ias_cie_address,
  cie_short_addr,
  cie_ep 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_IAS_ZONE_ZONESTATE_ID, (zone_state)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_IAS_ZONE_ZONETYPE_ID, (zone_type)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_IAS_ZONE_ZONESTATUS_ID, (zone_status)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_IAS_ZONE_IAS_CIE_ADDRESS_ID, (ias_cie_address)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_CUSTOM_CIE_SHORT_ADDR, (cie_short_addr)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_CUSTOM_CIE_EP, (cie_ep)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
ZoneStatus attribute, ZCL spec 8.2.2.2.1.3.
Definition: zb_zcl_ias_zone.h:79
ZoneState attribute, ZCL spec 8.2.2.2.1.1.
Definition: zb_zcl_ias_zone.h:75
ZoneType attribute, ZCL spec 8.2.2.2.1.2.
Definition: zb_zcl_ias_zone.h:77
IAS_CIE_Address attribute, ZCL spec 8.2.2.2.2.1.
Definition: zb_zcl_ias_zone.h:81

Enumeration Type Documentation

IAS Zone cluster attribute identifiers.

See also
ZCL spec, IAS Zone Cluster 8.2.2.2
Enumerator
ZB_ZCL_ATTR_IAS_ZONE_ZONESTATE_ID 

ZoneState attribute, ZCL spec 8.2.2.2.1.1.

ZB_ZCL_ATTR_IAS_ZONE_ZONETYPE_ID 

ZoneType attribute, ZCL spec 8.2.2.2.1.2.

ZB_ZCL_ATTR_IAS_ZONE_ZONESTATUS_ID 

ZoneStatus attribute, ZCL spec 8.2.2.2.1.3.

ZB_ZCL_ATTR_IAS_ZONE_IAS_CIE_ADDRESS_ID 

IAS_CIE_Address attribute, ZCL spec 8.2.2.2.2.1.

IAS Zone ZoneState value.

Enumerator
ZB_ZCL_IAS_ZONE_ZONESTATE_NOT_ENROLLED 

ZoneState not enrolled value.

ZB_ZCL_IAS_ZONE_ZONESTATE_ENROLLED 

ZoneState enrolled value.

IAS Zone ZoneStatus attribute flags.

See also
ZCL spec 8.2.2.2.1.3
Enumerator
ZB_ZCL_IAS_ZONE_ZONE_STATUS_ALARM1 

Alarm 1

ZB_ZCL_IAS_ZONE_ZONE_STATUS_ALARM2 

Alarm 2

ZB_ZCL_IAS_ZONE_ZONE_STATUS_TAMPER 

Tamper

ZB_ZCL_IAS_ZONE_ZONE_STATUS_BATTERY 

Battery

ZB_ZCL_IAS_ZONE_ZONE_STATUS_SUPERVISION 

Supervision reports

ZB_ZCL_IAS_ZONE_ZONE_STATUS_RESTORE 

Restore reports

ZB_ZCL_IAS_ZONE_ZONE_STATUS_TROUBLE 

Trouble

ZB_ZCL_IAS_ZONE_ZONE_STATUS_AC_MAINS 

AC (mains)

IAS Zone ZoneType value.

Enumerator
ZB_ZCL_IAS_ZONE_ZONETYPE_STANDARD_CIE 

ZoneType Standard CIE System Alarm value.

ZB_ZCL_IAS_ZONE_ZONETYPE_MOTION 

ZoneType Motion value.

ZB_ZCL_IAS_ZONE_ZONETYPE_CONTACT_SWITCH 

ZoneType Contact switch value.

ZB_ZCL_IAS_ZONE_ZONETYPE_FIRE_SENSOR 

ZoneType Fire sensor value.

ZB_ZCL_IAS_ZONE_ZONETYPE_WATER_SENSOR 

ZoneType Water sensor value.

ZB_ZCL_IAS_ZONE_ZONETYPE_GAS_SENSOR 

ZoneType Gas sensor value.

ZB_ZCL_IAS_ZONE_ZONETYPE_PERSONAL_EMERGENCY 

ZoneType Personal emergency value.

ZB_ZCL_IAS_ZONE_ZONETYPE_VIBRATION_MOVEMENT 

ZoneType Vibration / Movement sensor value.

ZB_ZCL_IAS_ZONE_ZONETYPE_REMOTE_CONTROL 

ZoneType Remote Control value.

ZB_ZCL_IAS_ZONE_ZONETYPE_KEY_FOB 

ZoneType Key fob value.

ZB_ZCL_IAS_ZONE_ZONETYPE_KEYPAD 

ZoneType Keypad value.

ZB_ZCL_IAS_ZONE_ZONETYPE_STANDARD_WARNING 

ZoneType Standard Warning Device value.

ZB_ZCL_IAS_ZONE_ZONETYPE_INVALID 

ZoneType Invalid Zone Type value.