The read reporting configuration record.

Note that attributes with data types of array, structure, set or bag cannot be reported.

Required Header

#include <zigbee.h>

Overview

The Read Reporting Configuration Record is used to read the configuration details of the reporting mechanism for one or more of the attributes of a cluster

Functions
int	zb_read_report_config_record_create (zb_zcl_read_report_config_record_h *handle)
	Creates a read reporting configuration record.
int	zb_read_report_config_record_destroy (zb_zcl_read_report_config_record_h handle)
	Destroys a read reporting configuration record.
int	zb_read_report_config_record_set_dir (zb_zcl_read_report_config_record_h handle, zb_zcl_fc_direction_e dir)
	Sets the direction of a read reporting configuration record.
int	zb_read_report_config_record_set_id (zb_zcl_read_report_config_record_h handle, unsigned short id)
	Sets the attribute identifier of a read reporting configuration record.

Function Documentation

int zb_read_report_config_record_create ( zb_zcl_read_report_config_record_h * handle )

Creates a read reporting configuration record.

Allocates memory for read reporting configuration record.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/zigbee

Remarks:: The handle should be released using zb_read_report_config_record_destroy().

Parameters:

[out] handle The handle of read configuration record

Returns:: 0 on success, otherwise a negative error value.

Return values:

ZIGBEE_ERROR_NONE	Successful
ZIGBEE_ERROR_INVALID_PARAMETER	Invalid parameter
ZIGBEE_ERROR_OUT_OF_MEMORY	Out-of-memory
ZIGBEE_ERROR_PERMISSION_DENIED	Permission denied
ZIGBEE_ERROR_NOT_SUPPORTED	Not supported

See also:: zb_read_report_config_record_create(); zb_read_report_config_record_destroy(); zb_read_report_config_record_set_id(); zb_read_report_config_record_set_dir()

int zb_read_report_config_record_destroy ( zb_zcl_read_report_config_record_h handle )

Destroys a read reporting configuration record.

Removes allocated memory for read reporting configuration record.

Since :: 5.0

Parameters:

[in] handle The handle of write attribute record

Returns:: 0 on success, otherwise a negative error value.

Return values:

ZIGBEE_ERROR_NONE	Successful
ZIGBEE_ERROR_INVALID_PARAMETER	Invalid parameter
ZIGBEE_ERROR_NOT_SUPPORTED	Not supported

See also:: zb_read_report_config_record_create(); zb_read_report_config_record_destroy(); zb_read_report_config_record_set_id(); zb_read_report_config_record_set_dir()

int zb_read_report_config_record_set_dir	(	zb_zcl_read_report_config_record_h	handle,
		zb_zcl_fc_direction_e	dir
	)

Sets the direction of a read reporting configuration record.

The direction field specifies whether values of the attribute are reported (0x00), or whether reports of the attribute are received (0x01).

All other values of this field are reserved.

Since :: 5.0

Parameters:

[in]	handle	The handle of write attribute status record
[in]	dir	direction

Returns:: 0 on success, otherwise a negative error value.

Return values:

ZIGBEE_ERROR_NONE	Successful
ZIGBEE_ERROR_INVALID_PARAMETER	Invalid parameter
ZIGBEE_ERROR_NOT_SUPPORTED	Not supported

See also:: zb_read_report_config_record_create(); zb_read_report_config_record_destroy(); zb_read_report_config_record_set_id(); zb_read_report_config_record_set_dir()

int zb_read_report_config_record_set_id	(	zb_zcl_read_report_config_record_h	handle,
		unsigned short	id
	)

Sets the attribute identifier of a read reporting configuration record.

The attribute identifier field shall contain the identifier of the attribute whose reporting configuration details are to be read.

Since :: 5.0

Parameters:

[in]	handle	The handle of write attribute status record
[in]	id	Attribute identifier

Returns:: 0 on success, otherwise a negative error value.

Return values:

ZIGBEE_ERROR_NONE	Successful
ZIGBEE_ERROR_INVALID_PARAMETER	Invalid parameter
ZIGBEE_ERROR_NOT_SUPPORTED	Not supported

See also:: zb_read_report_config_record_create(); zb_read_report_config_record_destroy(); zb_read_report_config_record_set_id(); zb_read_report_config_record_set_dir()

Required Header

Overview

Functions

Function Documentation