nRF5 SDK for Thread and Zigbee v3.0.0
Macros
ZCL IAS Zone cluster

Macros

#define ZB_ZCL_DECLARE_IAS_ZONE_ATTRIB_LIST(attr_list, zone_state, zone_type, zone_status, ias_cie_address,cie_short_addr, cie_ep)
 Declare attribute list for IAS Zone cluster - server side. More...
 
#define ZB_ZCL_DECLARE_IAS_ZONE_ATTRIB_LIST_EXT(attr_list, zone_state, zone_type, zone_status, number_of_zone_sens_levels_supported, current_zone_sens_level,ias_cie_address, zone_id, cie_short_addr, cie_ep)
 Declare attribute list for IAS Zone cluster - server side (extended attribute set) More...
 

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_IAS_ZONE_ZONEID_ID = 0x0011, ZB_ZCL_ATTR_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_ID = 0x0012, ZB_ZCL_ATTR_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_ID = 0x0013, ZB_ZCL_ATTR_CUSTOM_ZGP_CALIBRATION = 0x8000,
  ZB_ZCL_ATTR_CUSTOM_ZGP_CLOUD_ACK = 0x8003, ZB_ZCL_ATTR_CUSTOM_CIE_EP = 0xE001, ZB_ZCL_ATTR_CUSTOM_CIE_SHORT_ADDR = 0xE002, ZB_ZCL_ATTR_IAS_ZONE_INT_CTX_ID = 0xeffe
}
 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_MANUF_SPEC = 0x8000, 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,
  ZB_ZCL_IAS_ZONE_ZONE_STATUS_TEST = 1 << 8, ZB_ZCL_IAS_ZONE_ZONE_STATUS_BATTERY_DEFECT = 1 << 9
}
 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_ZCL_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_MIN_VALUE   ((zb_uint8_t)0x02)
 Min value for NumberOfZoneSensitivityLevelsSupported attribute.
 
#define ZB_ZCL_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_DEFAULT_VALUE   ZB_ZCL_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_MIN_VALUE
 Default value for NumberOfZoneSensitivityLevelsSupported attribute.
 
#define ZB_ZCL_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_DEFAULT_VALUE   ((zb_uint8_t)0x00)
 Default value for CurrentZoneSensitivityLevel attribute.
 
#define ZB_ZCL_IAS_ZONEID_ID_DEF_VALUE   0xff
 IAS Zone ZoneID attribute default value.
 

Detailed Description

IAS Zone cluster definitions

Macro Definition Documentation

#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

Declare attribute list for IAS Zone cluster - server side.

Parameters
attr_list- attribure list name
zone_state- pointer to variable to store ZoneState attribute
zone_type- pointer to variable to store ZoneType attribute
zone_status- pointer to variable to store ZoneStatus attribute
ias_cie_address- pointer to variable to store IAS-CIE address attribute
cie_short_addr- custom attribute to store CIE short address
cie_ep- custom attribute to store CIE Endpoint number
#define ZB_ZCL_DECLARE_IAS_ZONE_ATTRIB_LIST_EXT (   attr_list,
  zone_state,
  zone_type,
  zone_status,
  number_of_zone_sens_levels_supported,
  current_zone_sens_level,
  ias_cie_address,
  zone_id,
  cie_short_addr,
  cie_ep 
)
Value:
zb_uint16_t last_change_##attr_list; \
zb_zcl_ias_zone_int_ctx_t int_ctx_##attr_list; \
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_IAS_ZONE_ZONEID_ID, (zone_id)) \
(number_of_zone_sens_levels_supported)) \
(current_zone_sens_level)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_IAS_ZONE_INT_CTX_ID, &(int_ctx_##attr_list)) \
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
unsigned short zb_uint16_t
Project-local 2-byte unsigned int type.
Definition: zb_types.h:120
ZoneState attribute, ZCL spec 8.2.2.2.1.1.
Definition: zb_zcl_ias_zone.h:75
NumberOfZoneSensitivityLevelsSupported attribute, ZCL spec 8.2.2.1.2.3.
Definition: zb_zcl_ias_zone.h:85
CurrentZoneSensitivityLevel attribute, ZCL spec 8.2.2.1.2.4.
Definition: zb_zcl_ias_zone.h:87
Struct with pointers on User App callbacks.
Definition: zb_zcl_ias_zone.h:95
ZoneType attribute, ZCL spec 8.2.2.2.1.2.
Definition: zb_zcl_ias_zone.h:77
ZoneID attribute, ZCL spec 8.2.2.1.2.2.
Definition: zb_zcl_ias_zone.h:83
IAS_CIE_Address attribute, ZCL spec 8.2.2.2.2.1.
Definition: zb_zcl_ias_zone.h:81

Declare attribute list for IAS Zone cluster - server side (extended attribute set)

Parameters
attr_list- attribure list name
zone_state- pointer to variable to store ZoneState attribute
zone_type- pointer to variable to store ZoneType attribute
zone_status- pointer to variable to store ZoneStatus attribute
ias_cie_address- pointer to variable to store IAS-CIE address attribute
zone_id- pointer to variable to store Zone ID attribute
number_of_zone_sens_levels_supported- pointer to variable to store NumberOfZoneSensitivityLevelsSupported attribute
current_zone_sens_level- pointer to variable to store CurrentZoneSensitivityLevel attribute
cie_short_addr- custom attribute to store CIE short address
cie_ep- custom attribute to store CIE Endpoint number

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.

ZB_ZCL_ATTR_IAS_ZONE_ZONEID_ID 

ZoneID attribute, ZCL spec 8.2.2.1.2.2.

ZB_ZCL_ATTR_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_ID 

NumberOfZoneSensitivityLevelsSupported attribute, ZCL spec 8.2.2.1.2.3.

ZB_ZCL_ATTR_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_ID 

CurrentZoneSensitivityLevel attribute, ZCL spec 8.2.2.1.2.4.

ZB_ZCL_ATTR_IAS_ZONE_INT_CTX_ID 

Struct with pointers on User App callbacks.

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)

ZB_ZCL_IAS_ZONE_ZONE_STATUS_TEST 

Test

ZB_ZCL_IAS_ZONE_ZONE_STATUS_BATTERY_DEFECT 

Battery Defect

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_MANUF_SPEC 

Manufacturer specific ZoneType value.

ZB_ZCL_IAS_ZONE_ZONETYPE_INVALID 

ZoneType Invalid Zone Type value.


Documentation feedback | Developer Zone | Subscribe | Updated