IAS Ancillary Control Equipment

Macros
#define	ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_VER   0
#define	ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_CLUSTER_LIST( cluster_list_name, basic_attr_list, identify_attr_list, ias_zone_attr_list)
	Declare cluster list for IAS Ancillary Control Equipment. More...
#define	ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_SIMPLE_DESC( ep_name, ep_id, in_clust_num, out_clust_num)
	Declare simple descriptor for IAS Ancillary Control Equipment. More...
#define	ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_EP(ep_name, ep_id, cluster_list)
	Declare endpoint for IAS Ancillary Control Equipment. More...
#define	ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_CTX(device_ctx, ep_name)   ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)
	Declare application's device context for Ancillary Control Equipment. More...

Detailed Description

IAS Ancillary Control Equipment has 5 clusters (see spec 7.8.2):

• ZCL Basic cluster
  
• ZCL Identify cluster
  
• ZCL IAS Zone cluster
  
• ZCL IAS ACE cluster
  
• ZCL Identify cluster

IAS Ancillary Control Equipment sample

Example

• Declaring clusters:

• Registering device list:

• Example of command handler:

Macro Definition Documentation

ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_CLUSTER_LIST

#define ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_CLUSTER_LIST	(		cluster_list_name,
			basic_attr_list,
			identify_attr_list,
			ias_zone_attr_list
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/ha/zb_ha_ias_ancillary_control_equipment.h>

Declare cluster list for IAS Ancillary Control Equipment.

Parameters

cluster_list_name	[IN] - cluster list variable name.
basic_attr_list	[IN] - attribute list for Basic cluster.
identify_attr_list	[IN] - attribute list for Identify cluster.
ias_zone_attr_list	[IN] - attribute list for IAS Zone cluster

ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_CTX

#define ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_CTX	(		device_ctx,
			ep_name
	)		ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/ha/zb_ha_ias_ancillary_control_equipment.h>

Declare application's device context for Ancillary Control Equipment.

Parameters

device_ctx	- device context variable
ep_name	- endpoint variable name

ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_EP

#define ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_EP	(		ep_name,
			ep_id,
			cluster_list
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/ha/zb_ha_ias_ancillary_control_equipment.h>

Value:

ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_SIMPLE_DESC(                    \
          ep_name,                                                                  \
          ep_id,                                                                    \
          ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_IN_CLUSTER_NUM,                     \
          ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_OUT_CLUSTER_NUM);                   \
      ZBOSS_DEVICE_DECLARE_REPORTING_CTX(reporting_info## ep_name,                  \
          ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_REPORT_ATTR_COUNT);                 \
      ZB_AF_DECLARE_ENDPOINT_DESC(                                                  \
        ep_name,                                                                    \
            ep_id,                                                                  \
            ZB_AF_HA_PROFILE_ID,                                                    \
            0,                                                                      \
            NULL,                                                                   \
            ZB_ZCL_ARRAY_SIZE(                                                      \
                cluster_list,                                                       \
                zb_zcl_cluster_desc_t),                                             \
            cluster_list,                                                           \
        (zb_af_simple_desc_1_1_t*)&simple_desc_##ep_name,                           \
        ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_REPORT_ATTR_COUNT, reporting_info## ep_name, 0, NULL)

Declare endpoint for IAS Ancillary Control Equipment.

Parameters

ep_name	[IN] - endpoint variable name.
ep_id	[IN] - endpoint ID.
cluster_list	[IN] - endpoint cluster list.

ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_SIMPLE_DESC

#define ZB_HA_DECLARE_IAS_ANCILLARY_CONTROL_EQUIPMENT_SIMPLE_DESC	(		ep_name,
			ep_id,
			in_clust_num,
			out_clust_num
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/ha/zb_ha_ias_ancillary_control_equipment.h>

Value:

ZB_DECLARE_SIMPLE_DESC(in_clust_num, out_clust_num);                         \
      ZB_AF_SIMPLE_DESC_TYPE(in_clust_num, out_clust_num)  simple_desc_##ep_name = \
      {                                                                            \
        ep_id,                                                                     \
        ZB_AF_ZLL_PROFILE_ID,                                                      \
        ZB_HA_IAS_CONTROL_INDICATING_EQUIPMENT_ID,                                 \
        ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_VER,                                 \
        0,                                                                         \
        in_clust_num,                                                              \
        out_clust_num,                                                             \
        {                                                                          \
          ZB_ZCL_CLUSTER_ID_BASIC,                                                 \
          ZB_ZCL_CLUSTER_ID_IDENTIFY,                                              \
          ZB_ZCL_CLUSTER_ID_IAS_ZONE,                                              \
          ZB_ZCL_CLUSTER_ID_IAS_ACE,                                               \
          ZB_ZCL_CLUSTER_ID_IDENTIFY,                                              \
        }                                                                          \
      }

Declare simple descriptor for IAS Ancillary Control Equipment.

Parameters

ep_name	- endpoint variable name.
ep_id	[IN] - endpoint ID.
in_clust_num	[IN] - number of supported input clusters.
out_clust_num	[IN] - number of supported output clusters.

Note

in_clust_num, out_clust_num should be defined by numeric constants, not variables or any definitions, because these values are used to form simple descriptor type name.

ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_VER

#define ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT_VER   0

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/ha/zb_ha_ias_ancillary_control_equipment.h>

IAS ACE device version