IAS Control and Indicating Equipment

Macros
#define	ZB_HA_IAS_CONTROL_INDICATING_EQUIPMENT_VER   0
#define	ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_CLUSTER_LIST( cluster_list_name, basic_attr_list, identify_attr_list, ias_ace_attr_list)
	Declare cluster list for IAS Control and Indicating Equipment. More...
#define	ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_SIMPLE_DESC( ep_name, ep_id, in_clust_num, out_clust_num)
	Declare simple descriptor for IAS Control and Indicating Equipment. More...
#define	ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_EP(ep_name, ep_id, cluster_list)
	Declare endpoint for IAS Control and Indicating Equipment. More...
#define	ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_CTX(device_ctx, ep_name)   ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)
	Declare application's device context for IAS Control Indicating Equipment. More...

Detailed Description

IAS Control and Indicating Equipment has 7 clusters (see spec 7.8.1):

• ZCL Basic cluster
  
• ZCL Identify cluster
  
• ZCL IAS ACE cluster
  
• ZCL IAS WD cluster
  
• ZCL IAS Zone cluster
  
• ZCL Scenes cluster
  
• ZCL Groups cluster

IAS Control and Indicating Equipment sample

Example

• Declaring clusters:

  /* Basic cluster attributes data */
  zb_uint8_t g_attr_basic_zcl_version = ZB_ZCL_BASIC_ZCL_VERSION_DEFAULT_VALUE;
  zb_uint8_t g_attr_basic_application_version = ZB_ZCL_BASIC_APPLICATION_VERSION_DEFAULT_VALUE;
  zb_uint8_t g_attr_basic_stack_version = ZB_ZCL_BASIC_STACK_VERSION_DEFAULT_VALUE;
  zb_uint8_t g_attr_basic_hw_version = ZB_ZCL_BASIC_HW_VERSION_DEFAULT_VALUE;
  zb_char_t g_attr_basic_manufacturer_name[] = ZB_ZCL_BASIC_MANUFACTURER_NAME_DEFAULT_VALUE;
  zb_char_t g_attr_basic_model_identifier[] = ZB_ZCL_BASIC_MODEL_IDENTIFIER_DEFAULT_VALUE;
  zb_char_t g_attr_basic_date_code[] = ZB_ZCL_BASIC_DATE_CODE_DEFAULT_VALUE;
  zb_uint8_t g_attr_basic_power_source = ZB_ZCL_BASIC_POWER_SOURCE_DEFAULT_VALUE;
  zb_char_t g_attr_basic_location_description[] = ZB_ZCL_BASIC_LOCATION_DESCRIPTION_DEFAULT_VALUE;
  zb_uint8_t g_attr_basic_physical_environment = ZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DEFAULT_VALUE;
  zb_char_t g_attr_sw_build_id[] = ZB_ZCL_BASIC_SW_BUILD_ID_DEFAULT_VALUE;
   
  ZB_ZCL_DECLARE_BASIC_ATTRIB_LIST_EXT(basic_attr_list, &g_attr_basic_zcl_version, &g_attr_basic_application_version, &g_attr_basic_stack_version, &g_attr_basic_hw_version, &g_attr_basic_manufacturer_name, &g_attr_basic_model_identifier, &g_attr_basic_date_code, &g_attr_basic_power_source, &g_attr_basic_location_description, &g_attr_basic_physical_environment, &g_attr_sw_build_id);

  /* IAS Zone cluster attributes data */
  zb_uint8_t g_attr_ias_zone_zonestate = ZB_ZCL_IAS_ZONE_ZONESTATE_DEF_VALUE;
  zb_uint16_t g_attr_ias_zone_zonetype = 0;
  zb_uint16_t g_attr_ias_zone_zonestatus = ZB_ZCL_IAS_ZONE_ZONE_STATUS_DEF_VALUE;
  zb_uint8_t g_attr_ias_zone_number_of_zone_sensitivity_levels_supported = ZB_ZCL_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_DEFAULT_VALUE;
  zb_uint8_t g_attr_ias_zone_current_zone_sensitivity_level = ZB_ZCL_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_DEFAULT_VALUE;
  zb_ieee_addr_t g_attr_ias_zone_ias_cie_address = {0, 0, 0, 0, 0, 0, 0, 0};
  zb_uint8_t g_attr_ias_zone_zoneid_ha = ZB_ZCL_IAS_ZONEID_ID_DEF_VALUE;
  zb_uint16_t cie_short_addr = 0;
  zb_uint8_t cie_ep = 0;
  ZB_ZCL_DECLARE_IAS_ZONE_ATTRIB_LIST_EXT(ias_zone_attr_list, &g_attr_ias_zone_zonestate, &g_attr_ias_zone_zonetype, &g_attr_ias_zone_zonestatus, &g_attr_ias_zone_number_of_zone_sensitivity_levels_supported, &g_attr_ias_zone_current_zone_sensitivity_level, &g_attr_ias_zone_ias_cie_address, &g_attr_ias_zone_zoneid_ha, &cie_short_addr, &cie_ep);

  /* Identify cluster attributes data */
  zb_uint16_t g_attr_identify_identify_time = ZB_ZCL_IDENTIFY_IDENTIFY_TIME_DEFAULT_VALUE;
  ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST(identify_attr_list, &g_attr_identify_identify_time);
  zb_zcl_ias_ace_zone_table_t g_attr_ace_table[1];
  zb_uint16_t g_attr_length = 1;
  ZB_ZCL_DECLARE_IAS_ACE_ATTRIB_LIST(ias_ace_attr_list, &g_attr_length, &g_attr_ace_table);
  /********************* Declare device **************************/
  ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_CLUSTER_LIST(ias_control_indicating_equipment_clusters, basic_attr_list, identify_attr_list, ias_ace_attr_list);
  ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_EP(ias_control_indicating_equipment_ep, ENDPOINT_C, ias_control_indicating_equipment_clusters);
  ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_CTX(device_ctx, ias_control_indicating_equipment_ep);

• Registering device list:

   /* Register device list */
   ZB_AF_REGISTER_DEVICE_CTX(&device_ctx);
   ZB_AF_SET_ENDPOINT_HANDLER(ZB_OUTPUT_ENDPOINT, zcl_specific_cluster_cmd_handler);
   ZB_ZCL_REGISTER_DEVICE_CB(test_device_interface_cb);

• Example of command handler:

  zb_uint8_t zcl_specific_cluster_cmd_handler(zb_uint8_t param)
  {
   zb_zcl_parsed_hdr_t cmd_info;
   zb_uint8_t lqi = ZB_MAC_LQI_UNDEFINED;
   zb_int8_t rssi = ZB_MAC_RSSI_UNDEFINED;
   
   TRACE_MSG(TRACE_APP1, "> zcl_specific_cluster_cmd_handler", (FMT__0));
   
   ZB_ZCL_COPY_PARSED_HEADER(param, &cmd_info);
   
   g_dst_addr = ZB_ZCL_PARSED_HDR_SHORT_DATA(&cmd_info).source.u.short_addr;
   g_endpoint = ZB_ZCL_PARSED_HDR_SHORT_DATA(&cmd_info).src_endpoint;
   g_addr_mode = ZB_APS_ADDR_MODE_16_ENDP_PRESENT;
   
   ZB_ZCL_DEBUG_DUMP_HEADER(&cmd_info);
   TRACE_MSG(TRACE_APP3, "payload size: %i", (FMT__D, zb_buf_len(param)));
   
   zb_zdo_get_diag_data(g_dst_addr, &lqi, &rssi);
   TRACE_MSG(TRACE_APP3, "lqi %hd rssi %d", (FMT__H_H, lqi, rssi));
   
   if (cmd_info.cmd_direction == ZB_ZCL_FRAME_DIRECTION_TO_CLI)
   {
   TRACE_MSG(
   TRACE_ERROR,
   "Unsupported \"from server\" command direction",
   (FMT__0));
   }
   
   TRACE_MSG(TRACE_APP1, "< zcl_specific_cluster_cmd_handler", (FMT__0));
   return ZB_FALSE;
  }

  void test_device_interface_cb(zb_uint8_t param)
  {
   
   zb_zcl_device_callback_param_t *device_cb_param =
   ZB_BUF_GET_PARAM(param, zb_zcl_device_callback_param_t);
   
   TRACE_MSG(TRACE_APP1, "> test_device_interface_cb param %hd id %hd", (FMT__H_H,
   param, device_cb_param->device_cb_id));
   
   device_cb_param->status = RET_OK;
   
   switch (device_cb_param->device_cb_id)
   {
   case ZB_ZCL_SET_ATTR_VALUE_CB_ID:
   if (device_cb_param->cb_param.set_attr_value_param.cluster_id == ZB_ZCL_CLUSTER_ID_ON_OFF &&
   device_cb_param->cb_param.set_attr_value_param.attr_id == ZB_ZCL_ATTR_ON_OFF_ON_OFF_ID)
   {
   if (device_cb_param->cb_param.set_attr_value_param.values.data8)
   {
   TRACE_MSG(TRACE_APP1, "set ON", (FMT__0));
  #ifdef ZB_USE_BUTTONS
   zb_osif_led_on(0);
  #endif
   }
   else
   {
   TRACE_MSG(TRACE_APP1, "set OFF", (FMT__0));
  #ifdef ZB_USE_BUTTONS
   zb_osif_led_off(0);
  #endif
   }
   }
   break;
   
   default:
   device_cb_param->status = RET_OK;
   break;
   }
   
   TRACE_MSG(TRACE_APP1, "< test_device_interface_cb %hd", (FMT__H, device_cb_param->status));
  }

Macro Definition Documentation

ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_CLUSTER_LIST

#define ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_CLUSTER_LIST	(		cluster_list_name,
			basic_attr_list,
			identify_attr_list,
			ias_ace_attr_list
	)

Declare cluster list for IAS Control and Indicating 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_ace_attr_list	[IN] - attribute list for IAS ACE cluster.

ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_CTX

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

Declare application's device context for IAS Control Indicating Equipment.

Parameters

device_ctx	- device context variable
ep_name	- endpoint variable name

ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_EP

#define ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_EP	(		ep_name,
			ep_id,
			cluster_list
	)

Value:

 ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_SIMPLE_DESC( \
 ep_name, \
 ep_id, \
 ZB_HA_IAS_CONTROL_INDICATING_EQUIPMENT_IN_CLUSTER_NUM, \
 ZB_HA_IAS_CONTROL_INDICATING_EQUIPMENT_OUT_CLUSTER_NUM); \
 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, \
 0, NULL, /* No reporting ctx */ \
 0, NULL) /* No CVC ctx */

Declare endpoint for IAS Control and Indicating Equipment.

Parameters

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

ZB_HA_DECLARE_IAS_CONTROL_INDICATING_EQUIPMENT_SIMPLE_DESC

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

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_CONTROL_INDICATING_EQUIPMENT_VER, \
 0, \
 in_clust_num, \
 out_clust_num, \
 { \
 ZB_ZCL_CLUSTER_ID_BASIC, \
 ZB_ZCL_CLUSTER_ID_IDENTIFY, \
 ZB_ZCL_CLUSTER_ID_IAS_ACE, \
 ZB_ZCL_CLUSTER_ID_IAS_WD, \
 ZB_ZCL_CLUSTER_ID_IAS_ZONE, \
 ZB_ZCL_CLUSTER_ID_SCENES, \
 ZB_ZCL_CLUSTER_ID_GROUPS, \
 ZB_ZCL_CLUSTER_ID_IDENTIFY, \
 } \
 }

Declare simple descriptor for IAS Control and Indicating 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_CONTROL_INDICATING_EQUIPMENT_VER

#define ZB_HA_IAS_CONTROL_INDICATING_EQUIPMENT_VER   0

IAS ACE device version