ZCL attributes reporting

Data Structures
union	zb_zcl_attr_var_u

Macros
#define	ZB_ZCL_MIN_REPORTING_INTERVAL_DEFAULT   0x0005
#define	ZB_ZCL_MAX_REPORTING_INTERVAL_DEFAULT   0x0000
#define	ZB_ZCL_REPORTING_NOT_NEEDED   0xFFFF
	If Maximum reporting interval is set to value 0xFFFF,reporting is not needed for current attribute. More...

Typedefs
typedef void(*	zb_zcl_no_reporting_cb_t) (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint16_t attr_id)
	Informs application that some attribute value was not reported during defined time interval. More...
typedef void(*	zb_zcl_report_attr_cb_t) (zb_zcl_addr_t *addr, zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint16_t attr_id, zb_uint8_t attr_type, zb_uint8_t *value)
	Informs application about received attribute report. More...

Functions
zb_ret_t	zb_zcl_start_attr_reporting (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint8_t cluster_role, zb_uint16_t attr_id)
	Start attribute reporting. More...
zb_ret_t	zb_zcl_start_attr_reporting_manuf (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint8_t cluster_role, zb_uint16_t attr_id, zb_uint16_t manuf_code)
	Start attribute reporting. More...
zb_ret_t	zb_zcl_stop_attr_reporting (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint8_t cluster_role, zb_uint16_t attr_id)
	Stop attribute reporting. More...
zb_ret_t	zb_zcl_stop_attr_reporting_manuf (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint8_t cluster_role, zb_uint16_t attr_id, zb_uint16_t manuf_code)
	Stop attribute reporting. More...
zb_bool_t	zcl_is_attr_reported (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint8_t cluster_role, zb_uint16_t attr_id)
	Check if an attribute is configured for reporting or not. More...
zb_bool_t	zcl_is_attr_reported_manuf (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint8_t cluster_role, zb_uint16_t attr_id, zb_uint16_t manuf_code)
	Check if an attribute is configured for reporting or not. More...
zb_ret_t	zb_zcl_put_reporting_info (zb_zcl_reporting_info_t *rep_info_ptr, zb_bool_t override)
	Set reporting configuration for the attribute. More...

Detailed Description

ZCL attribute reporting being described in ZCL spec, subclauses 2.4.7 through 2.4.11, and subclauses covering clusters with reportable attributes.

API for attribute reporting configuring and configuration details reading documented in: Configure reporting command sending and parsing, and Report attribute command parsing respectively.

Since all events related to attribute reporting are being handled internally, application can be provided with information on attribute report receipt event, and attribute report not received within predefined interval event. To handle these events, application may set "report attribute" and "no reporting" callbacks with ZB_ZCL_SET_REPORT_ATTR_CB() and ZB_ZCL_SET_NO_REPORTING_CB() macros respectively.

Example

  /* Sets a callback being called on receive attribute report */
  ZB_ZCL_SET_REPORT_ATTR_CB(report_attribute_cb);

void report_attribute_cb(zb_zcl_addr_t *addr, zb_uint8_t ep, zb_uint16_t cluster_id,
                              zb_uint16_t attr_id, zb_uint8_t attr_type, zb_uint8_t *value)
{
  ZVUNUSED(ep);
  ZVUNUSED(attr_type);
  ZVUNUSED(value);

  /* Unused without trace. */
  ZVUNUSED(addr);
  ZVUNUSED(cluster_id);
  ZVUNUSED(attr_id);

  TRACE_MSG(TRACE_APP1, ">> report_attribute_cb addr %d ep %hd, cluster 0x%x, attr %d",
            (FMT__D_H_D_D, addr->u.short_addr, ep, cluster_id, attr_id));
  TRACE_MSG(TRACE_APP1, "<< report_attribute_cb", (FMT__0));
}

Macro Definition Documentation

ZB_ZCL_MAX_REPORTING_INTERVAL_DEFAULT

#define ZB_ZCL_MAX_REPORTING_INTERVAL_DEFAULT   0x0000

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

Default value for maximum reporting interval

ZB_ZCL_MIN_REPORTING_INTERVAL_DEFAULT

#define ZB_ZCL_MIN_REPORTING_INTERVAL_DEFAULT   0x0005

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

Default value for minimum reporting interval

ZB_ZCL_REPORTING_NOT_NEEDED

#define ZB_ZCL_REPORTING_NOT_NEEDED   0xFFFF

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

If Maximum reporting interval is set to value 0xFFFF,reporting is not needed for current attribute.

Typedef Documentation

zb_zcl_no_reporting_cb_t

typedef void(* zb_zcl_no_reporting_cb_t) (zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint16_t attr_id)

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

Informs application that some attribute value was not reported during defined time interval.

Parameters

ep	- endpoint number
cluster_id	- cluster ID
attr_id	- attribute ID

zb_zcl_report_attr_cb_t

typedef void(* zb_zcl_report_attr_cb_t) (zb_zcl_addr_t *addr, zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint16_t attr_id, zb_uint8_t attr_type, zb_uint8_t *value)

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

Informs application about received attribute report.

Parameters

addr	- source address
ep	- source endpoint number
cluster_id	- cluster ID
attr_id	- attribute ID
attr_type	- attribute type
value	- pointer to reported data value

Function Documentation

zb_zcl_put_reporting_info()

zb_ret_t zb_zcl_put_reporting_info	(	zb_zcl_reporting_info_t *	rep_info_ptr,
		zb_bool_t	override
	)

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

Set reporting configuration for the attribute.

Parameters

rep_info_ptr	- structure storing reporting configuration
override	- ZB_TRUE if you wand to allow overriding of existing reporting configuration, ZB_FALSE otherwise

Returns

zb_ret_t - RET_OK on success

zb_zcl_start_attr_reporting()

zb_ret_t zb_zcl_start_attr_reporting	(	zb_uint8_t	ep,
		zb_uint16_t	cluster_id,
		zb_uint8_t	cluster_role,
		zb_uint16_t	attr_id
	)

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

Start attribute reporting.

Deprecated:

This function will be removed in the next Major release after February 2023 Use zb_zcl_start_attr_reporting_manuf() instead

Parameters

ep	- endpoint number
cluster_id	- cluster ID
cluster_role	- cluster role
attr_id	- attribute ID

Returns

RET_OK if reporting is successfully started
RET_DOES_NOT_EXIST if reporting can't be configured with given parameters (i.e cluster not present)

zb_zcl_start_attr_reporting_manuf()

zb_ret_t zb_zcl_start_attr_reporting_manuf	(	zb_uint8_t	ep,
		zb_uint16_t	cluster_id,
		zb_uint8_t	cluster_role,
		zb_uint16_t	attr_id,
		zb_uint16_t	manuf_code
	)

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

Start attribute reporting.

Parameters

ep	- endpoint number
cluster_id	- cluster ID
cluster_role	- cluster role
attr_id	- attribute ID
manuf_code	- manufacturer specific code

Returns

RET_OK if reporting is successfully started
RET_DOES_NOT_EXIST if reporting can't be configured with given parameters (i.e cluster not present)

zb_zcl_stop_attr_reporting()

zb_ret_t zb_zcl_stop_attr_reporting	(	zb_uint8_t	ep,
		zb_uint16_t	cluster_id,
		zb_uint8_t	cluster_role,
		zb_uint16_t	attr_id
	)

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

Stop attribute reporting.

Deprecated:

This function will be removed in the next Major release after February 2023 Use zb_zcl_stop_attr_reporting_manuf() instead

Parameters

ep	- endpoint number
cluster_id	- cluster ID
cluster_role	- cluster role
attr_id	- attribute ID

Returns

RET_OK if reporting is successfully stopped
RET_DOES_NOT_EXIST if reporting was not set up with given parameters

zb_zcl_stop_attr_reporting_manuf()

zb_ret_t zb_zcl_stop_attr_reporting_manuf	(	zb_uint8_t	ep,
		zb_uint16_t	cluster_id,
		zb_uint8_t	cluster_role,
		zb_uint16_t	attr_id,
		zb_uint16_t	manuf_code
	)

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

Stop attribute reporting.

Parameters

ep	- endpoint number
cluster_id	- cluster ID
cluster_role	- cluster role
attr_id	- attribute ID
manuf_code	- manufacturer specific code

Returns

RET_OK if reporting is successfully stopped
RET_DOES_NOT_EXIST if reporting was not set up with given parameters

zcl_is_attr_reported()

zb_bool_t zcl_is_attr_reported	(	zb_uint8_t	ep,
		zb_uint16_t	cluster_id,
		zb_uint8_t	cluster_role,
		zb_uint16_t	attr_id
	)

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

Check if an attribute is configured for reporting or not.

Deprecated:

This function will be removed in the next Major release after February 2023 Use zcl_is_attr_reported_manuf() instead

Parameters

ep	- endpoint number
cluster_id	- cluster ID
cluster_role	- cluster role
attr_id	- attribute ID

Returns

ZB_TRUE if attribute is reported

zcl_is_attr_reported_manuf()

zb_bool_t zcl_is_attr_reported_manuf	(	zb_uint8_t	ep,
		zb_uint16_t	cluster_id,
		zb_uint8_t	cluster_role,
		zb_uint16_t	attr_id,
		zb_uint16_t	manuf_code
	)

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

Check if an attribute is configured for reporting or not.

Parameters

ep	- endpoint number
cluster_id	- cluster ID
cluster_role	- cluster role
attr_id	- attribute ID
manuf_code	- manufacturer specific code

Returns

ZB_TRUE if attribute is reported