Tizen Native API
5.0
|
The reporting configuration response record.
#include <zigbee.h>
The Reporting Configuration Response Record is generated in response to a zb_zcl_global_config_report_write().
Note that attributes with data types of array, structure, set or bag cannot be reported.
Functions | |
int | zb_report_config_response_record_clone (zb_zcl_report_config_response_record_h src, zb_zcl_report_config_response_record_h *dst) |
Clones a report config response record. | |
int | zb_report_config_response_record_destroy (zb_zcl_report_config_response_record_h handle) |
Destroys a reporting configuration response record. | |
int | zb_report_config_response_record_get_status (zb_zcl_report_config_response_record_h handle, zb_zcl_status_e *status) |
Gets status from a reporting configuration response record. | |
int | zb_report_config_response_record_get_dir (zb_zcl_report_config_response_record_h handle, zb_zcl_fc_direction_e *dir) |
Gets the direction from a reporting configuration response record. | |
int | zb_report_config_response_record_get_id (zb_zcl_report_config_response_record_h handle, zb_attribute_id *id) |
Gets the attribute identifier from a reporting configuration response record. |
int zb_report_config_response_record_clone | ( | zb_zcl_report_config_response_record_h | src, |
zb_zcl_report_config_response_record_h * | dst | ||
) |
Clones a report config response record.
[in] | src | Source handle of report config response record |
[in] | dst | Destination handle of report config response record |
ZIGBEE_ERROR_NONE | Successful |
ZIGBEE_ERROR_INVALID_PARAMETER | Invalid parameter |
ZIGBEE_ERROR_NOT_SUPPORTED | Not supported |
Destroys a reporting configuration response record.
[in] | handle | The handle of reporting configuration response record |
ZIGBEE_ERROR_NONE | Successful |
ZIGBEE_ERROR_INVALID_PARAMETER | Invalid parameter |
ZIGBEE_ERROR_NOT_SUPPORTED | Not supported |
int zb_report_config_response_record_get_dir | ( | zb_zcl_report_config_response_record_h | handle, |
zb_zcl_fc_direction_e * | dir | ||
) |
Gets the direction from a reporting configuration response record.
The direction field specifies whether values of the attribute are reported (0x00), or whether reports of the attribute are received (0x01).
If this value is set to 0x00, then the attribute data type field, the minimum reporting interval field, the maximum reporting interval field and the reportable change field are included in the payload, and the timeout period field is omitted. If this value is set to 0x01, then the timeout period field is included in the payload, and the attribute data type field, the minimum reporting interval field, the maximum reporting interval field and the reportable change field are omitted.
All other values of this field are reserved.
[in] | handle | The handle of write attribute status record |
[out] | dir | direction 00 : ZB_ZCL_CLIENT_TO_SERVER 01 : ZB_ZCL_SERVER_TO_CLIENT |
ZIGBEE_ERROR_NONE | Successful |
ZIGBEE_ERROR_INVALID_PARAMETER | Invalid parameter |
ZIGBEE_ERROR_NOT_SUPPORTED | Not supported |
int zb_report_config_response_record_get_id | ( | zb_zcl_report_config_response_record_h | handle, |
zb_attribute_id * | id | ||
) |
Gets the attribute identifier from a reporting configuration response record.
The attribute identifier field is 16 bits in length and shall contain the identifier of the attribute that the reporting configuration details apply to.
[in] | handle | The handle of write attribute status record |
[out] | id | Attribute identifier |
ZIGBEE_ERROR_NONE | Successful |
ZIGBEE_ERROR_INVALID_PARAMETER | Invalid parameter |
ZIGBEE_ERROR_NOT_SUPPORTED | Not supported |
int zb_report_config_response_record_get_status | ( | zb_zcl_report_config_response_record_h | handle, |
zb_zcl_status_e * | status | ||
) |
Gets status from a reporting configuration response record.
If the attribute is not implemented on the sender or receiver of the command, whichever is relevant (depending on direction), the result shall be set to ZB_ZCL_STATUS_UNSUPPORTED_ATTRIBUTE.
If the attribute is supported, but is not capable of being reported, this field shall be set to ZB_ZCL_STATUS_UNREPORTABLE_ATTRIBUTE.
Otherwise, this field shall be set to ZB_ZCL_STATUS_SUCCESS.
If the status field is not set to ZB_ZCL_STATUS_SUCCESS, all fields except the direction and attribute identifier fields shall be omitted.
[in] | handle | The handle of write attribute status record |
[out] | status | status |
ZIGBEE_ERROR_NONE | Successful |
ZIGBEE_ERROR_INVALID_PARAMETER | Invalid parameter |
ZIGBEE_ERROR_NOT_SUPPORTED | Not supported |