Configuration Tool

Macros
#define	ZB_HA_DEVICE_VER_CONFIGURATION_TOOL   0
#define	ZB_HA_DECLARE_CONFIGURATION_TOOL_CLUSTER_LIST( cluster_list_name, basic_attr_list, identify_attr_list)
	Declare cluster list for Configuration tool device. More...
#define	ZB_HA_DECLARE_CONFIGURATION_TOOL_EP(ep_name, ep_id, cluster_list)
	Declare endpoint for Configuration tool device. More...
#define	ZB_HA_DECLARE_CONFIGURATION_TOOL_CTX(device_ctx, ep_name)   ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)
	Declare Configuration Tool device context. More...

Detailed Description

Configuration Tool device has 3 clusters (see spec 7.4.6):

• ZCL Identify cluster
  
• ZCL Basic cluster
  
• ZCL Groups cluster

Configuration Tool device 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);

  /* 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);
  /********************* Declare device **************************/
  ZB_HA_DECLARE_CONFIGURATION_TOOL_CLUSTER_LIST(configuration_tool_clusters, basic_attr_list, identify_attr_list);
  ZB_HA_DECLARE_CONFIGURATION_TOOL_EP(configuration_tool_ep, ENDPOINT_C, configuration_tool_clusters);
  ZB_HA_DECLARE_CONFIGURATION_TOOL_CTX(device_ctx, configuration_tool_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;
  
    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));
  }

  The complete set of Configuration Tool device samples can be found in /application/HA_samples/configuration_tool

Macro Definition Documentation

ZB_HA_DECLARE_CONFIGURATION_TOOL_CLUSTER_LIST

#define ZB_HA_DECLARE_CONFIGURATION_TOOL_CLUSTER_LIST	(		cluster_list_name,
			basic_attr_list,
			identify_attr_list
	)

Declare cluster list for Configuration tool device.

Parameters

cluster_list_name	- cluster list variable name
basic_attr_list	- attribute list for Basic cluster
identify_attr_list	- attribute list for Identify cluster

ZB_HA_DECLARE_CONFIGURATION_TOOL_CTX

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

Declare Configuration Tool device context.

Parameters

device_ctx	- device context variable name.
ep_name	- endpoint variable name.

ZB_HA_DECLARE_CONFIGURATION_TOOL_EP

#define ZB_HA_DECLARE_CONFIGURATION_TOOL_EP	(		ep_name,
			ep_id,
			cluster_list
	)

Value:

ZB_ZCL_DECLARE_CONFIGURATION_TOOL_SIMPLE_DESC(ep_name, ep_id,                           \
      ZB_HA_CONFIGURATION_TOOL_IN_CLUSTER_NUM, ZB_HA_CONFIGURATION_TOOL_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 Configuration tool device.

Parameters

ep_name	- endpoint variable name
ep_id	- endpoint ID
cluster_list	- endpoint cluster list

ZB_HA_DEVICE_VER_CONFIGURATION_TOOL

#define ZB_HA_DEVICE_VER_CONFIGURATION_TOOL   0

Configuration tool device version