* @brief The structure type for the #ZB_ZDP_ENABLE_EVENT callback data.
* @details The result of enabling zigbee system service.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned char status; /**< Status of enabling zigbee system service */
* @brief The structure type for the #ZB_ZDP_FORM_NETWORK_DONE callback data.
* @details This event comes from coming network operation completed.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
zb_nwk_addr pan_id; /**< Pan ID */
* @brief The structure type for the #ZB_ZDP_JOIN_EVENT callback data.
* @details This event takes place when new device joined.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned char count; /**< Number of endpoint list */
* @brief The structure type for the #ZB_ZDP_CHILD_LEFT callback data.
* @details This event takes place when a child device leave current network explicitly.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned char status; /**< Left status of child device */
* @brief The structure type for the #ZB_ZCL_GLOBAL_DEFAULT_RSP_EVENT callback data.
* @details This event is used when global default response.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned char ep; /**< End-point */
* @brief The structure type for the #ZB_ZCL_GLOBAL_ATTRIBUTE_REPORT_EVENT callback data.
* @details This event is took place when report attribute command received.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
void* records; /**< Array of attribute report record */
* @brief The structure type for the #ZB_ZCL_ALARM_EVENT callback data.
* @details This event is related to alarm cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned short count; /**< Alarm count */
* @brief The structure type for the #ZB_ZCL_IAS_ZONE_ENROLL_REQUEST_EVENT callback data.
* @details A Device which supports IAS zone cluster want to register its ability.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned char src_ep; /**< Source endpoint */
* @brief The structure type for the #ZB_ZCL_IAS_ZONE_STATUS_CHANGE_NOTIFICATION_EVENT callback data.
* @details A Device which supports IAS zone cluster announces its status change.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned char src_ep; /**< Source endpoint */
* @brief The structure type for the #ZB_ZCL_IAS_ZONE_STATUS_CHANGE_EXTENDED_NOTIFICATION_EVENT callback data.
* @details A Device which supports IAS zone cluster announces its status change.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
unsigned char src_ep; /**< Source endpoint */
* @details This function can receive events from the devices in the network.
* ex) join, re-join, leave and attribute change report
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef struct {
union {
* @brief Fields of the Simple Descriptor
* @details Device descriptions contained in node.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_simple_desc_s {
unsigned char ep; /**< Endpoint ID */
* @brief Fields of the Node Power Descriptor .
* @details Node power characteristics.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_node_power_descriptor_s {
unsigned char current_power_mode; /**< Current Power Mode */
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Structure for end-device information.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_end_device_info_s {
zb_nwk_addr addr16; /**< 16bit network address */
* @brief Fields of the Node Descriptor
* @details Type and capabilities of the node.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_node_descriptor_s {
unsigned char logical_type; /**< Logical Role */
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief NetworkList Record Format.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_network_list_record_s {
zb_ieee_addr extended_pan_id; /**< Extended PAN ID */
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief NeighborTableList Record Format.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_neighbor_table_desc_s {
zb_ieee_addr extended_pan_id; /**< Extended PAN ID */
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief RoutingTableList Record Format.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_routing_table_s {
zb_nwk_addr dst_addr; /**< Network Address */
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief BindingTableList Record Format.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_binding_table_s {
zb_ieee_addr src_addr64; /**< IEEE address */
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief DiscoveryCacheList Record Format.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_zdo_discovery_cache_s {
zb_ieee_addr addr64; /**< IEEE Address */
/**
* @brief Format of Attribute Value Field for string
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct attribute_str_s {
unsigned char n; /**< number of elements */
/**
* @brief Format of Attribute Value Field for wide-string
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct attribute_wstr_s {
unsigned short n; /**< number of elements */
/**
* @brief value format for the cluster attribute data
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zb_value_s {
unsigned char type; /**< value type */
/**
* @brief Format of Attribute Value Field for an array, Set or Bag in Zigbee Cluster Libarry
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct attribute_array_s {
unsigned char t; /**< element type */
/**
* @brief Attribute value sequence
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct attribute_element_value {
unsigned char t; /**< element type */
/**
* @brief Format of the Attribute Value Field for a Structure
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct attribute_struct_s {
unsigned short n; /**< number of elements */
/**
* @brief Format of the Read Attribute Status Record Field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct read_attribute_status_record_s {
unsigned short id; /**< attribute identifier */
/**
* @brief write attributes data structure
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct write_attribute_record_s {
unsigned short id; /**< attribute identifier */
/**
* @brief For write attribute response command
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct write_attribute_status_record_s {
unsigned char status; /**< attribute status */
/**
* @brief reporting configuration record structure
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct reporting_configuration_record_s {
unsigned char dir; /*(< direction */
/**
* @brief Format of the Attribute Status Record Field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct reporting_configuration_response_record_s {
unsigned char status; /**< status */
/**
* @brief Read reporting configuration record
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct read_reporting_configuration_record_s {
unsigned char dir; /**< direction */
/**
* @brief Format of the Attribute Report Fields
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct attribute_report_s {
unsigned short id; /**< attribute identifier */
/**
* @brief Format of the Attribute Report Fields
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct discover_attribute_info_record_s {
unsigned short id; /**< attribute identifier */
/**
* @brief Format of the Extended Attribute Information Fields
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct extended_attribute_infomation_s {
unsigned short id; /**< attribute identifier */
/**
* @brief Events
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct zbl_event_s {
/**
* @brief Duplicate string.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks The returned string should be released using free().
* @param[in] src Messge to be duplicated
* @return pointer of error message id string
/**
* @brief Returns readable ZDO error code.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] id ZDO id
* @return pointer of error message id string
*/
/**
* @brief Returns readable Zigbee profile id.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] profileid ZigBee profile id
* @return pointer of profile id string
*/
/**
* @brief Returns readable Zigbee device id.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] deviceid ZigBee device id
* @return pointer of device id string
*/
/**
* @brief Returns readable Zigbee Cluster Library error code for human.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] id ZigBee Cluster Library Status code
* @return pointer of status code string
*/
/**
* @brief Returns readable cluster name for human.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] id ZigBee Cluster ID
* @return pointer of cluster name string
*/
/**
* @brief Returns type of attribute type.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] type attribute type
* @return #zb_zcl_data_category_e
* @retval #ZB_ZCL_DATA_TYPE_NONE Data type none
/**
* @brief Returns size of data type.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] type attribute type
* @return size of attribute data type
*/
/**
* @brief Returns data type name.
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @param[in] type Data type
* @return pointer of data type string
*/
*
* More details on using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* to send NWK_addr_req , for example. But on the server side of this equation (a node
* receiving a NWK_addr_req and responding to it), the ZDP service is mandatory.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* an application. The simple descriptor contains many of the fields: an endpoint ID, a
* profile ID, cluster IDs and a device ID.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
*
* More details on using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
*
* Generation of these commands is application dependent
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* original read attributes or read attributes structured command. The status field
* shall contain a suitable status code.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* The write attributes response status record is generated in response to a write
* attributes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* record shall contain the identifier and the actual value of the attribute to be
* written.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* Note that attributes with data types of array, structure, set or bag cannot be
* reported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* Note that attributes with data types of array, structure, set or bag cannot be
* reported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* 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
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* zone device. IAS Zone supports up to two alarm types per zone, low battery
* reports and supervision of the IAS network.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* @section CAPI_NETWORK_ZIGBEE_ZCL_ON_OFF_CLUSTER_MODULE_OVERVIEW Overview
* Attributes and commands for switching devices between 'On' and 'Off' states.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief The data type abbreviation : Zigbee APS frame control.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned char zb_aps_frame_ctl;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief The data type abbreviation : Zigbee ZCL frame control.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned char zb_zcl_frame_ctl;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief APS Delivery Mode.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_APS_DELIVERY_UNICAST = 0, /**< Unicast delivery */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief APS ACK Request.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_APS_NO_ACK_REQUEST = (0 << 6), /**< Not request ACK */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Frame type at ZCL Header.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_FC_GLOBALLY_USED = (0 << 0), /**< Profile widely used */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Manufacturer specific or not at ZCL Header.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_FC_NOT_MANUFACTURER = (0 << 2), /**< Manufacturer code not present */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Request or Response at ZCL Header.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_CLIENT_TO_SERVER = (0 << 3), /**< Request */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Disable default response or not at ZCL Header.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_DEFAULT_RESPONSE_ENABLED = (0 << 4), /**< Enable default response */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Default ZCL frame control at APS Header.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
#define ZB_ZCL_FC_DEFAULT 0x00 /**< Generally used / Not manufacture / Request / with Default Response */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Broadcast address type.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_BROADCAST_ADDRESS = 0xFFFC, /**< Broadcast to all routers. */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief ACL type.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_ACL_TYPE_WRITABLE = 1, /**< Writable */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Data measuring type.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_DATA_TYPE_NONE = 0, /**< Data type none */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_IAS_ZONE_CLUSTER_MODULE
* @brief Values of the ZoneType Attribute.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_IAS_ZONE_TYPE_STANDARD_CIE = 0x0000, /**< Zone type = Standard CIE, Alarm1 = System Alarm, Alarm2 = N/A */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief ZCL Enumerations Description in Zigbee Cluster Library.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Format of the Attribute Status Record in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_read_attr_status_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Format of the Write Attributes Data Structure in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_write_attr_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Format of the write attribute status record in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_write_attr_status_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Format of Reporting Configuration Record Structure in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_reporting_config_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Format of Read Reporting Configuration Record in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_read_report_config_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
* @brief Format of the Attribute Status Record Field in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_report_config_response_record_h;
* in the real world that vary continuously over a range. Values of discrete data types
* only have meaning as individual values, and may not be added or subtracted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_NO_DATA_ATTRIBUTE_TYPE = 0x00, /**< No data */
/**
* @brief Zigbee Cluster IDs for reference.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_CLUSTER_BASIC = 0x0000, /**< Basic Cluster */
/**
* @brief Attribute types for cluster: Basic.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Power Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Device Temperature Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Identify.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Groups.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Scenes.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: On/off.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: On/off Switch Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Level Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Alarms.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Time.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: RSSI Location.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Binary Input (Basic).
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Commissioning.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Partition.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Over the Air Bootloading.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Power Profile.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Appliance Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Poll Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Shade Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Door Lock.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Window Covering.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Pump Configuration and Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Thermostat.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Fan Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Dehumidification Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Thermostat User Interface Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Color Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Ballast Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Illuminance Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Illuminance Level Sensing.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Temperature Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Pressure Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Flow Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Relative Humidity Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Occupancy Sensing.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: IAS Zone.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: IAS WD.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Electrical Measurement.
* @details Cluster specification level: UNKNOWN
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
/**
* @brief Attribute types for cluster: Diagnostics.
* @details Cluster specification level: UNKNOWN
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
typedef enum {
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Global commands (Either direction).
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_CMD_READ_ATTRIBUTES = 0x00, /**< Read attributes */
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Command types for cluster: Basic.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Identify.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Identify.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Groups.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Groups.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Scenes.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Scenes.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: On/off.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Command types for cluster: Level Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Alarms Server side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Alarms Client side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Command types for cluster: RSSI Location Server side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Command types for cluster: RSSI Location Client side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Commissioning.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server Command types for cluster: Commissioning.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Serer to client command types for cluster: Partition.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server Command types for cluster: Partition.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Over the Air Bootloading.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Over the Air Bootloading.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Power Profile.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Power Profile.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Appliance Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Appliance Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Poll Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Poll Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Door Lock.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Door Lock.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Command types for cluster: Window Covering.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Thermostat.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Thermostat.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Command types for cluster: Color Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: IAS Zone.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief CLient to server command types for cluster: IAS Zone.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: IAS ACE.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: IAS ACE.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Command types for cluster: IAS WD.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: Electrical Measurement.
* @details Cluster specification level: UNKNOWN
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: Electrical Measurement.
* @details Cluster specification level: UNKNOWN
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Server to client command types for cluster: ZLL Commissioning.
* @details Cluster specification level: zll-1.0-11-0037-10
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Server to Client
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Client to server command types for cluster: ZLL Commissioning.
* @details Cluster specification level: zll-1.0-11-0037-10
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @remarks Direction : Client to Server
*
*/
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Format of the Attribute Report Fields in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_attr_report_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Format of the Extended Attribute Information Fields in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_extended_attr_info_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Format of the Discover Attribute Info Record in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_discover_attr_info_record_h;
* @details The discover attributes response command is generated in response to a discover
* attributes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a records can be used only in the callback. To use outside, make a copy.
* @remarks The @a records should not be released.
* discover the identifiers and types of the attributes on a device which are supported
* within the cluster to which this command is directed.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Creates discover attribute information record.
* @details This allocates heap for discover attribute information record
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Destroys discover attribute information record.
* @details This destroys discover attribute information record
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of discover attribute information record
*
* lowest attribute identifier that is greater than or equal to the start attribute
* identifier field of the received discover attributes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[out] id Attribute identifier
* lowest attribute identifier that is greater than or equal to the start attribute
* identifier field of the received discover attributes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[in] id Attribute identifier
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[out] type attribute data type
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[in] type Attribute data type
* @brief Creates reporting attribute.
* @details Allocate memory for reporting attribute
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Destroys reporting attribute.
* @details This destroys reporting attribute
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of reporting attribute
*
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that the reporting configuration details apply to.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that the reporting configuration details apply to.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] id Attribute identifier
* @details The attribute data type field contains the data type of the attribute that is
* being reported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] type attribute data type
* @details The attribute data type field contains the data type of the attribute that is
* being reported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] type attribute data type @see
* @details The attribute data field is variable in length and shall contain the actual
* value of the attribute being reported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a value should be released using free().
*
* @details The attribute data field is variable in length and shall contain the actual
* value of the attribute being reported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] type Attribute data type
* @brief Creates extended attribute information.
* @details Allocate memory for extended attribute information
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Destroys extended attribute information.
* @details This destroys extended attribute information
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of extended attribute information
*
* identifier that is greater than or equal to the start attribute identifier field of the
* received discover attributes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
* identifier that is greater than or equal to the start attribute identifier field of the
* received discover attributes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] id Attribute identifier
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] type attribute data type @see
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] type attribute data type @see
*
* The bits are in little endian order (bit 0 is listed first).
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] acl #ZB_ZCL_ACL_TYPE_WRITABLE : Bit-0., Writable \n
*
* The bits are in little endian order (bit 0 is listed first).
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] acl #ZB_ZCL_ACL_TYPE_WRITABLE : Bit-0., Writable \n
* Alarms may either reset automatically when the conditions that cause are no
* longer active, or may need to be explicitly reset.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* information from the alarm log, along with a time stamp indicating when the
* alarm situation was detected.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] ep The source end-point of the received information (ex. endpoint 1)
* then a new notification will be generated and, where implemented, a new record added
* to the alarm log.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* active will cause a new notification to be generated and, where implemented, a new
* record added to the alarm log.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* condition has been reported the corresponding entry in the table is removed.
* This command does not have a payload.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Sends 'reset all alarm log' command.
* @details This command causes the alarm table to be cleared, and does not have a payload.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* the same for every endpoint on the device. In such cases they can be implemented
* once for the node, and mapped to each endpoint.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* @brief Sends 'reset factory default' command.
* @details This function is aim to reset end-device as factory default settings.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* the HSV (aka HSB) color model.
*
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* generated, where not disabled, with status code equal to INVALID_VALUE.
*
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* value 0x00 and shall then move from its current hue in an up or down direction in
* a continuous fashion.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* value 0x00 and shall then move from its current hue in an up or down direction by
* one step.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* command shall not be carried out and a ZCL default response command shall be
* generated, where not disabled, with status code equal to INVALID_VALUE.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* command shall not be carried out and a ZCL default response command shall be
* generated, where not disabled, with status code equal to INVALID_VALUE
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* command shall not be carried out and a ZCL default response command shall be
* generated, where not disabled, with status code equal to INVALID_VALUE
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* command shall not be carried out and a ZCL default response command shall be
* generated, where not disabled, with status code equal to INVALID_VALUE
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* command shall not be carried out, and a ZCL default response command shall be
* generated, where not disabled, with status code equal to INVALID_VALUE
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* the operation of any previously received command of this cluster. This command
* can thus be used to stop the operation of any other command of this cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* command shall not be carried out, and a ZCL default response command shall be
* generated, where not disabled, with status code equal to INVALID_VALUE
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* command shall not be carried out, and a ZCL default response command shall be
* generated, where not disabled, with status code equal to INVALID_VALUE.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* Note that configuration of group addresses for outgoing commands is achieved
* using the APS binding mechanisms, and is not part of this cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* @details The add group response is sent by the groups cluster server in response to an
* add group command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] ep The source end-point of the received information (ex. endpoint 1)
* @details The view group response command is sent by the groups cluster server in
* response to a view group command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks @remarks The @a group_name should not be released.
* @remarks The @a group_name can be used only in the callback. To use outside, make a copy.
* @details The get group membership response command is sent by the groups cluster server
* in response to a get group membership command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks @remarks The @a group_list should not be released.
* @remarks The @a group_list can be used only in the callback. To use outside, make a copy.
* @details The add group response is sent by the groups cluster server in response to an
* remove group command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] ep The source end-point of the received information (ex. endpoint 1)
* @details The add group command allows the sending device to add group membership in a
* particular group for one or more endpoints on the receiving device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* entity or entities respond with a view group response command containing the
* application name string for a particular group.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details The get group membership command allows the sending device to inquire about
* the group membership of the receiving device and endpoint in a number of ways.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* Note that if a group is removed the scenes associated with that group should be
* removed.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* Note that removing all groups necessitates the removal of all associated scenes as
* well. (Note: scenes not associated with a group need not be removed).
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* This command might be used to assist configuring group membership in the
* absence of a commissioning tool.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* Note that this cluster cannot be disabled, and remains functional regardless of the
* setting of the DeviceEnable attribute in the Basic cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* @brief Makes devices as Identify mode within specific time.
* @details The identify command starts or stops the receiving device identifying itself.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* targets to respond if they are currently identifying themselves.
* This command has no payload.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] identify_time Identify time
* targets to respond if they are currently identifying themselves.
* This command has no payload.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* can be set to a level, for example the brightness of a light, the degree of closure of
* a door, or the power output of a heater.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* If the device is not able to move at a variable rate, the Transition time field may be
* disregarded.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details On receipt of this command, a device shall move from its current level in an
* up or down direction in a continuous fashion
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details On receipt of this command, a device shall move from its current level in an
* up or down direction in a continuous fashion
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* and one for their 'with On/Off' counterparts. This is solely for symmetry,
* to allow easy choice of one or other set of commands the, Stop commands are identical.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* allowed by the device, the OnOff attribute of the On/Off cluster on the same
* endpoint, if implemented, shall be set to Off.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* allowed by the device, the OnOff attribute of the On/Off cluster on the same
* endpoint, if implemented, shall be set to Off.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* allowed by the device, the OnOff attribute of the On/Off cluster on the same
* endpoint, if implemented, shall be set to Off.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* put the end device in a short poll mode or let the end device continue to function
* normally.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* It should be noted that for the Check-in Interval, 0 is a special value and does not
* apply to this equation.\n
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] ep The source end-point of the received information (ex. endpoint 1)
* device to stop fast polling when it is done sending messages to the fast polling
* device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details The Fast Poll Stop command is used to stop the fast poll mode initiated by the
* Check-in response. The Fast Poll Stop command has no payload.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* not acceptable, the Poll Control Server shall send a default response of
* INVALID_VALUE (0x87) and the LongPollInterval attribute value is not updated.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* not acceptable, the Poll Control Server shall send a default response of
* INVALID_VALUE (0x87) and the ShortPollInterval attribute value is not updated.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* commands related to scenes without a group may only be unicast, i.e.: they may
*not be multicast or broadcast.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* The Group ID and Scene ID fields are set to the corresponding fields of the
* received Add Scene command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] ep The source end-point of the received information (ex. endpoint 1)
* field fields are copied from the corresponding fields in the table entry, otherwise
* they are omitted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a scene_name can be used only in the callback. To use outside, make a copy.
* @remarks The @a extension_field_set can be used only in the callback. To use outside, make a copy.
* The Group ID and Scene ID fields are set to the corresponding fields of the received
* Remove Scene command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 Network address
* @param[out] ep Endpoint number
* (the group is not present in the Group Table) as appropriate. The Group ID field is
* set to the corresponding field of the received Remove All Scenes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] ep The source end-point of the received information (ex. endpoint 1)
* The Group ID and Scene ID fields are set to the corresponding fields of the received
* Store Scene command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] addr16 The source Network address of the received information
* @param[out] ep The source end-point of the received information (ex. endpoint 1)
* @details This command is generated in response to a received Get Scene Membership
* command
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a scene_list should not be released.
* @remarks The @a scene_list can be used only in the callback. To use outside, make a copy.
* @brief Sends 'add scenes' command.
* @details The Add Scene command shall be addressed to a single device (not a group)
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Sends 'view scene' command.
* @details The View Scene command shall be addressed to a single device (not a group)
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Sends 'remove scene' command.
* @details The Remove Scene command may be addressed to a single device or to a group.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Sends 'remove all scenes' command.
* @details The Remove All Scenes may be addressed to a single device or to a group.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Sends 'store scene' command.
* @details The Store Scene command may be addressed to a single device or to a group.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Sends 'recall scene' command.
* @details The Recall Scene command may be addressed to a single device or to a group.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* commissioning tool to get used scenes for a group on a single device or on all
* devices in the group.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @section CAPI_NETWORK_ZIGBEE_ZCL_THERMOSTAT_MODULE_OVERVIEW Overview
* This cluster provides an interface to the functionality of a thermostat.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @{
*/
* @details The attributes for the indicated setpoint(s) shall be increased by the amount
* specified in the Amount field.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Format of the Structure for Read Structured Attribute Record in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_read_structured_attr_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Format of the write attribute structured status record in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_write_attr_structured_status_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Format of the write attribute structured record in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_write_attr_structured_record_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Format of Attribute Value Field for an array, Set or Bag in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zcl_attr_array_h;
* device. Each attribute identifier field shall contain the identifier of the attribute
* to be read.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* with an index greater than the number of elements in an array or structure is
* always an error.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* @brief Creates reporting configuration response record.
* @details Allocate memory for reporting configuration response record
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* If the status field is not set to #ZB_ZCL_STATUS_SUCCESS, all fields except the
* direction and attribute identifier fields shall be omitted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] status status @see #zb_zcl_status_e
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that the reporting configuration details apply to.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
*
* All other values of this field are reserved.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] dir direction 00 : #ZB_ZCL_CLIENT_TO_SERVER \n
*
* All other values of this field are reserved.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] dir direction
* @details The attribute identifier field shall contain the identifier of the attribute
* whose reporting configuration details are to be read.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
* individual cluster instance may not be able to receive or generate all of the commands
* that are theoretically supported by the cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a commandids can be used only in the callback. To use outside, make a copy.
* @remarks The @a commandids should not be released.
* individual cluster instance may not be able to receive or generate all of the commands
* that are theoretically supported by the cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* individual cluster instance may not be able to receive or generate all of the commands
* that are theoretically supported by the cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* individual cluster instance may not be able to receive or generate all of the commands
* that are theoretically supported by the cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a records can be used only in the callback. To use outside, make a copy.
* @remarks The @a records should not be released.
* individual cluster instance may not be able to receive or generate all of the commands
* that are theoretically supported by the cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief ZDO Status Enumerations Description.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_STATUS_SUCCESS = 0, /**< Success */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief RequestType Enumeration.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_REQ_TYPE_SINGLE_DEVICE_RESPONSE = 0, /**< Single Device Response : 0*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Values of the Logical Type Field.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_LOGICAL_TYPE_COORDINATOR = 0, /**< Coordinator */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Values of the Frequency Band Field.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_FREQ_BAND_868_868_6_MHZ = 0, /**< 868~888.6MHz */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Alternative PAN coordinator bit in MAC capability Flags.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_DO_PAN_COORDINATOR_SUPPORTED = 1, /**< This node is capable of becoming a PAN coordinator. */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Device type bit in MAC capability Flags.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_DEV_TYPE_RFD = 0, /**< This node is a reduced function device (RFD) */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Power Source bit in MAC capability Flags.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_PWR_SRC_MAIN_POWER = 1, /**< Current power source is main power. This information is
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Receiver on when idle bit in MAC capability Flags.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_PM_DO_NOT_POWER_SAVE_MODE = 1, /**< The device does not disable its receiver to conserve power during idle periods. */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Security capability bit in MAC capability Flags.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_SECURITY_CAP_NOT_SUPPORTED = 0, /**< ZDP does not support security mode */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Indicates the device supports main-power in MAC capability Flags.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_POWER_NO_POWER = 0, /**< Not having mains-power */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Format of the MAC Capability Flags Field in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_ALTERNATIVE_PAN_COORDINATOR = (1 << 0), /**< Alternative Pan Coordinator (see #zb_zdp_do_pan_coordinator_e) */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Server Mask Bit Assignments.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_SERVER_MASK_PRIMARY_TRUST_CENTER = (1 << 0), /**< Primary Trust Center */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Values of the Current Power Mode Field in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_CUR_PWR_MODE_RECEIVER_SYNCHRONIZED_WITH_RECEIVER_ON = 0, /**< Register Synchronized with Receiver On */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Fields of the Node Power Descriptor.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_PWR_SRC_TYPE_CONSTANT_POWER = 0, /**< Constant Power */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Values of the Available Power Sources Field in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_PWR_SRC_LEVEL_CHARGE_LEVEL_CRITICAL = 0, /**< Charge Level Critical */
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
* @brief Cluster counts to handle with.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
#define MAX_ENDPOINT_CLUSTERS 32
* @details A #zb_end_dev_info_h is an opaque data structure.
* #zb_end_dev_info_h is a data type of network address, IEEE address, endpoint count
* and endpoint information structure.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_end_dev_info_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_MODULE
* @brief The handle of zigbee simple description.
* @details Device descriptions contained in node.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_simple_desc_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_MODULE
* @brief Fields of the Node Descriptor.
* @details Type and capabilities of the node.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_node_descriptor_h;
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_MODULE
* @brief The Node Power Descriptor in Zigbee Specification.
* @details Node power characteristics.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_node_power_descriptor_h;
* @internal
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE
* @brief Binding type.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_BINDING_TYPE_UNICAST = 0x03, /**< A unicast binding whose 64-bit identifier
* @internal
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE
* @brief NetworkList Record Format in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_network_list_record_h;
* @internal
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE
* @brief NeighborTableList Record Format in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_neighbor_table_desc_h;
* @internal
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE
* @brief RoutingTableList Record Format in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_routing_table_h;
* @internal
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE
* @brief BindingTableList Record Format in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_binding_table_h;
* @internal
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE
* @brief DiscoveryCacheList Record Format in Zigbee Specification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zdo_discovery_cache_h;
* have Binding Table resources for the request, a Status of #ZB_ZDP_STATUS_TABLE_FULL is
* returned.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_NOT_SUPPORTED \n
* device is also the ZigBee Coordinator) so that device shall issue a
* #ZB_ZDP_STATUS_NOT_SUPPORTED status to the Bind_req if not supported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* Binding Table entry corresponding to the parameters received in the request, a
* Status of #ZB_ZDP_STATUS_NO_ENTRY is returned.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_NOT_SUPPORTED \n
* The destination addressing on this command shall be unicast only and the destination
* address must be that of the a Primary binding table cache or the SrcAddress.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* Status field to NOT_ACTIVE, set the StartIndex field to the value supplied in the
* request, and not include the AppClusterList field.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a app_cluster_list can be used only in the callback. To use outside,
* make a copy.
* lists of active endpoints from devices whose list exceeds the size of a single ASDU and
* where fragmentation is not supported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* shall contain an ascending list of the endpoints on which a simple descriptor
* matched the criteria for the appropriate matching device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a match_list should not be released.
* @remarks The @a match_list can be used only in the callback. To use outside, make a copy.
* OutClusterList field shall contain the list of output cluster identifiers for which the
* match is being sought.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* field, the remote device shall set the Status field to #ZB_ZDP_STATUS_SUCCESS and
* include the node descriptor of the matching child device in the NodeDescriptor field.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a node_desc should not be released.
* @remarks The @a node_desc can be used only in the callback. To use outside, make a copy.
* illustrated in param list. The NWKAddrOfInterest field shall contain the network
* address of the remote device for which the node descriptor is required.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* the remote device shall set the Status field to #ZB_ZDP_STATUS_SUCCESS and include
* the power descriptor of the matching child device in the PowerDescriptor field.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a power_desc should not be released.
* @remarks The @a power_desc can be used only in the callback. To use outside, make a copy.
* illustrated in param list. The NWKAddrOfInterest field shall contain the network
* address of the remote device for which the power descriptor is required.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* descriptor for that device, and include the complex descriptor of the matching
* child device in the ComplexDescriptor field.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a complex_desc should not be released.
* @remarks The @a complex_desc can be used only in the callback. To use outside, make a copy.
* network address of the remote device for which the complex descriptor is
* required.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* that device, and include the user descriptor of the matching child device in the
* UserDescriptor field.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a user_desc should not be released.
* @remarks The @a user_desc can be used only in the callback. To use outside, make a copy.
* The NWKAddrOfInterest field shall contain the network
* address of the remote device for which the user descriptor is required.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* Status field to #ZB_ZDP_STATUS_SUCCESS and configure the user descriptor with the ASCII
* character string specified in the original User_Desc_set command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* returned value from NLME-GET.confirm primitive \n
* configured in the user descriptor. Characters with ASCII codes numbered 0x00
* through 0x1f are not permitted to be included in this string.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* The destination addressing on this primitive is
* broadcast to all devices for which macRxOnWhenIdle = TRUE.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Creates node power descriptor.
* @details Creates node power descriptor handle
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @internal
* @brief Clones a node power descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a src should be released using zb_node_power_desc_destroy().
* @remarks The @a dst should be released using zb_node_power_desc_destroy().
* @internal
* @brief Destroys node power descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
*
*
* The current power mode field shall be set to one of the non-reserved values
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[out] current_power_mode 0b0000 : Receiver synchronized with the receiver on when
*
* The current power mode field shall be set to one of the non-reserved values
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[in] current_power_mode 0b0000 : Receiver synchronized with the receiver on when
* For each power source supported on this node, the corresponding bit of the available power sources
* field, shall be set to 1. All other bits shall be set to 0.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[out] available_power_sources 0b0001 : Constant (mains) power \n
* source supported on this node, the corresponding bit of the available power sources
* field, shall be set to 1. All other bits shall be set to 0.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[in] available_power_sources 0b0001 : Constant (mains) power \n
* For the current power source selected, the corresponding bit of the current power
* source field, shall be set to 1. All other bits shall be set to 0.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[out] current_power_source 0b0001 : Constant (mains) power \n
* For the current power source selected, the corresponding bit of the current power
* source field, shall be set to 1. All other bits shall be set to 0.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[in] current_power_source 0b0001 : Constant (mains) power \n
* The current power
* source level field shall be set to one of the non-reserved values
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[out] current_power_source_level 0b0000 : Critical \n
* The current power
* source level field shall be set to one of the non-reserved values
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node power descriptor
* @param[in] current_power_source_level 0b0000 : Critical \n
* @internal
* @brief Creates node descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @internal
* @brief Copies node descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a src should be released using zb_node_desc_destroy().
* @remarks The @a dst should be released using zb_node_desc_destroy().
* @internal
* @brief Destroys node descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
*
*
* The logical type field shall be set to one of the non-reserved values.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] logical_type 0b000 : ZigBee coordinator \n
*
* The logical type field shall be set to one of the non-reserved values.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] logical_type 0b000 : ZigBee coordinator \n
* If this field is set to 1, a complex descriptor is available. \n\n
* If this field is set to 0, a complex descriptor is not available.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] complex_desciptor_available 1 : a complex descriptor is available \n
* If this field is set to 1, a complex descriptor is available. \n\n
* If this field is set to 0, a complex descriptor is not available.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] complex_desciptor_available 1 : a complex descriptor is available \n
* If this field is set to 1, a user descriptor is available.
* If this field is set to 0, a user descriptor is not available.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] user_descriptor_available 1 : a user descriptor is available \n
* If this field is set to 1, a user descriptor is available.
* If this field is set to 0, a user descriptor is not available.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] user_descriptor_available 1 : a user descriptor is available \n
*
* This field is currently not supported and shall be set to zero.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] aps_flags 0 : APS flags \n
*
* This field is currently not supported and shall be set to zero.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] aps_flags 0 : APS flags
*
* shall be set to 1. All other bits shall be set to 0.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] frequency_band 0b00001 : 868-868,6MHz \n
* 802.15.4 radio, the corresponding bit of the frequency band field.
* shall be set to 1. All other bits shall be set to 0.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] frequency_band 0b00001 : 868-868,6MHz \n
* specified in [B1]. Otherwise, the security capability sub-field shall be set to 0.
* The allocate address sub-field is one bit in length and shall be set to 0 or 1.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] mac_capability_flags Bit 0 : Alternative PAN coordinator \n
* specified in [B1]. Otherwise, the security capability sub-field shall be set to 0.
* The allocate address sub-field is one bit in length and shall be set to 0 or 1.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] mac_capability_flags Bit 0 : Alternative PAN coordinator \n
* and specifies a manufacturer code that is allocated by the ZigBee Alliance, relating
* the manufacturer to the device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] manufacturer_code manufacturer code
* and specifies a manufacturer code that is allocated by the ZigBee Alliance, relating
* the manufacturer to the device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] manufacturer_code manufacturer code
*
* This field can be used as a high-level indication for network management.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] maximum_buffer_size 0x00~0x7f
*
* This field can be used as a high-level indication for network management.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] maximum_buffer_size 0x00~0x7f
*
* This value can exceed the value of the node maximum buffer size field through the use of fragmentation.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] maximum_incoming_transfer_size 0x0000~0x7fff
*
* This value can exceed the value of the node maximum buffer size field through the use of fragmentation.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] maximum_incoming_transfer_size 0x0000~0x7fff
*
* The bit settings are defined in below table.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] server_mask Bit 0 : Primary Trust Center \n
*
* The bit settings are defined in below table.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] server_mask Bit 0 : Primary Trust Center \n
* This value can exceed the value of the node maximum buffer size field through the use
* of fragmentation.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] maximum_outgoing_transfer_size 0x0000~0x7ffff
* This value can exceed the value of the
* node maximum buffer size field through the use of fragmentation.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] maximum_outgoing_transfer_size 0x0000~0x7ffff
* It is used to facilitate discovery of particular features of the descriptor fields by
* other nodes on the system. The bit settings are defined in Table.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] descriptor_capability_field Bit 0 : Extended Active Endpoint List Available \n
* It is used to facilitate discovery of particular features of the descriptor fields by
* other nodes on the system. The bit settings are defined in Table.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[in] descriptor_capability_field Bit 0 : Extended Active Endpoint List Available \n
* The Network Management services are really handy optional services used for reading the
* various tables contained within ZigBee nodes, and to request certain common actions
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* parameter ServerMask contains the bits in the parameter of the request which
* match the server mask in the node descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* returned value from NLME-GET.confirm primitive \n
* The destination addressing on this request is 'broadcast to
* all devices for which macRxOnWhenIdle = TRUE.'
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* nformation for the NWKAddr and IEEEAddr in the request or the device of
* nterest itself and all other Remote Devices shall not supply a response.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] cache_nwk_addr NWK Address for the Primary Discovery Cache device holding
* the discovery information.
* meeting this criteria shall respond to the request generated by
* Find_node_cache_req.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* information for the NWKAddr and IEEEAddr in the request or the device of
* interest itself and all other Remote Devices shall not supply a response.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* returned value from NLME-GET.confirm primitive \n
* this primitive shall be broadcast to all devices for which macRxOnWhenIdle =
* TRUE.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* the request is unsupported (meaning the Remote Device is not a Primary
* Discovery Cache device), or insufficient space exists.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_INSUFFICIENT_SPACE \n
* Included in the request is the amount of storage space the Local Device requires.
* The destination addressing on this request is unicast.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* the request is not supported (meaning the Remote Device is not a Primary
* Discovery Cache device), or insufficient space exists.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_INSUFFICIENT_SPACE \n
*
* Included in this request is the Node Descriptor the Local Device wishes to cache.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* whether the request is not supported (meaning the Remote Device is not a Primary
* Discovery Cache device), or insufficient space exists.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_INSUFFICIENT_SPACE \n
* Discovery_store_req to the same Primary Discovery Cache device. Included in
* this request is the Power Descriptor the Local Device wishes to cache.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* the request is not supported (meaning the Remote Device is not a Primary
* Discovery Cache device), or insufficient space exists.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_INSUFFICIENT_SPACE \n
* The endpoint is a field within the Simple Descriptor and is accessed by the Remote
* Device to manage the discovery cache information for the Local Device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* the request is not supported (meaning the Remote Device is not a Primary
* Discovery Cache device), or insufficient space exists.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_INSUFFICIENT_SPACE \n
* endpoint is a field within the Simple Descriptor and is accessed by the Remote
* Device to manage the discovery cache information for the Local Device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* interest), or the request is not supported (meaning the Remote Device is not a
* Primary Discovery Cache device).
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_INSUFFICIENT_SPACE \n
* and additionally remove any cache information stored on behalf of the specified
* ZigBee end device on the Primary Discovery Cache device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* The Network Management services are really handy optional services used for reading the
* various tables contained within ZigBee nodes, and to request certain common actions
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
*/
* aMaxMACFrameSize is reached. The number of results reported shall be set in the
* NetworkListCount.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a nwk_list can be used only in the callback. To use outside, make a copy.
*
/**
* @internal
* @brief Bitmask to scan all 802.15.4 channels.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
#define ZB_802_15_4_CHANNELS_MASK 0x07FFF800UL
*
* The destination addressing on this command shall be unicast.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* backup source table, and SourceTableListCount is the number of entries which is being
* returned in the response.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a neighbor_table_list can be used only in the callback. To use outside, make a copy.
*
* neighbor. The destination addressing on this command shall be unicast only and
* the destination address must be that of a ZigBee Coordinator or ZigBee Router.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* NLME-GET.confirm primitive and if this was not #ZB_ZDP_STATUS_SUCCESS, all parameter
* fields after the status field shall be omitted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a routing_table_list can be used only in the callback. To use outside, make a copy.
*
* addressing on this command shall be unicast only and the destination address
* must be that of the ZigBee Router or ZigBee Coordinator.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* The BindingTableListCount field shall be the number of entries reported in the
* BindingTableList field of the Mgmt_Bind_req command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a binding_table_list can be used only in the callback. To use outside, make a copy.
*
* must be that of a Primary binding table cache or source device holding its own
* binding table.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* The Mgmt_Direct_Join_cb shall contain the same status that was
* contained in the NLME-DIRECT-JOIN.confirm primitive.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_NOT_SUPPORTED \n
* JOIN.request is to be executed using the parameter supplied by
* Mgmt_Direct_Join_req.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* the number of entries reported in the DiscoveryCacheList field of the
* Mgmt_Cache_cb command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a discover_cache_list can be used only in the callback. To use outside, make a copy.
*
*
* The destination addressing on this primitive shall be unicast.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
* Once a device has disassociated, it may execute pre-programmed logic to perform
* NLME-NETWORK-DISCOVERY and NLME-JOIN to join/re-join a network.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_NOT_SUPPORTED \n
* request to a Remote Device where the NLME-LEAVE.request is to be executed
* using the parameter supplied by Mgmt_Leave_req.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* The Mgmt_Permit-Joining_cb shall contain the same status that was contained in the
* NLME-PERMIT-JOINING.confirm primitive.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_NOT_SUPPORTED \n
* authentication policy will be affected. The addressing may be unicast or
* 'broadcast to all routers and coordinator'.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* operating environment. The destination addressing on this primitive shall be
* unicast or broadcast to all devices for which macRxOnWhenIdle = TRUE.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
*
* Therefore this function can help parsing parameter in network_list_record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] extended_pan_id The 64-bit extended PAN identifier of the discovered
*
* Therefore this function can help parsing parameter in network_list_record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] logical_channel The current logical channel occupied by the network.
*
* Therefore this function can help parsing parameter in network_list_record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] zigbee_version 0x0~0xf : The version of the ZigBee protocol in use
*
* Therefore this function can help parsing parameter in network_list_record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] stack_profile 0x0~0xf : A ZigBee stack profile identifier indicating
*
* Therefore this function can help parsing parameter in network_list_record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] beacon_order 0x0~0xf : This specifies how often the MAC sub-layer
*
* Therefore this function can help parsing parameter in network_list_record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] superframe_order 0x0~0xf : For beacon-oriented networks, i.e., beacon
*
* Therefore this function can help parsing parameter in network_list_record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] permit_joining 0 or 1 : A value of TRUE indicates that at least one
*
* Therefore this function can help parsing parameter in routing table records.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] dst_addr The destination address for the binding entry
*
* Therefore this function can help parsing parameter in routing table records.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] status 0x0=ACTIVE. \n
*
* Therefore this function can help parsing parameter in routing table records.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] memory_constrained A flag indicating whether the device is a memory
*
* Therefore this function can help parsing parameter in routing table records.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] many_to_one A flag indicating that the destination is a concentrator that
*
* Therefore this function can help parsing parameter in routing table records.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] route_record_required A flag indicating that a route record command frame
*
* Therefore this function can help parsing parameter in routing table records.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] next_hop_addr Next-hop address.
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] extended_pan_id The 64-bit extended PAN id of the neighboring device
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] addr64 64-bit IEEE address that is unique to every device.
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] addr16 16-bit network address that is unique to every device.
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] device_type The type of the neighbor device: \n
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] rx_on_when_idle Indicates if neighbor's receiver is
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] relationship The relationship between the
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] permit_joining An indication of whether the
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] depth The 0x00~nwkcMaxDepth (see. Zigbee Spec.) \n
*
* Therefore this function can help parsing parameter in neigbor_table_list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] lqi The estimated link quality for RF transmissions from this device. \n
*
* Therefore this function can help parsing parameter in binding_table structure.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] src_addr The source IEEE address for the binding entry.
*
* Therefore this function can help parsing parameter in binding_table structure.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] src_ep The source endpoint for the binding entry.
*
* Therefore this function can help parsing parameter in binding_table structure.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] clusterid The identifier of the cluster on the source device that is bound
*
* Therefore this function can help parsing parameter in binding_table structure.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] dst_addr_mode The addressing mode for the destination address. \n
*
* Therefore this function can help parsing parameter in binding_table structure.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] addr16 The destination address for the binding entry. \n
*
* Therefore this function can help parsing parameter in binding_table structure.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] addr64 The destination address for the binding entry. \n
*
* Therefore this function can help parsing parameter in binding_table structure.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] dst_ep 0x01~0xff : This field shall be present only if the DstAddrMode
*
* Therefore this function can help parsing parameter in discovery cache list record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] addr64 64-bit IEEE Address of the cached device.
*
* Therefore this function can help parsing parameter in discovery cache list record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of node descriptor
* @param[out] addr16 16-bit network Address of the cached device.
/**
* @brief Zigbee profile id.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_PROFILE_HOME_AUTOMATION = 0x0104, /**< Zigbee Home Automation profile */
/**
* @brief The device-specified HA profile.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
/* General devices */
/**
* @brief Enumeration for zigbee CAPI error code.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZIGBEE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : IEEE Address.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned char zb_ieee_addr[8];
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : Network Address.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned short zb_nwk_addr;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : End Point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned char zb_end_point;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : Device ID.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned short zb_device_id;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : Profile ID.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned short zb_profile_id;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : Cluster ID.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned short zb_cluster_id;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : Attribute ID.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned short zb_attribute_id;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : Command ID.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned char zb_command_id;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The data type abbreviation : 128 bit security key.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef unsigned char zb_aes128_key[16];
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The handle of zigbee.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_zigbee_h;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The event handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef void* zb_event_data_h;
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The events for zb_event_cb().
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_ENABLE_EVENT = 0x00, /**< This event is received after enabling zigbee system service */
/**
* @brief Creates handle to access the zigbee service.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a handle should be released using zb_destroy().
*
* @brief Destroys to the zigbee service handle.
* @details All this function to stop zigbee service
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of zigbee
*
* @brief Enables the zigbee service.
* @details All this function to start zigbee service
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/zigbee.admin
*
* @brief Disables the zigbee service.
* @details Call this function to stop the zigbee service.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/zigbee.admin
*
* @details This function can receive events from the devices in the network.
* ex) join, re-join, leave and attribute change report
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a ev should not be released.
* @remarks The @a ev can be used only in the callback.
/**
* @brief Sets the event handler to get events from the zigbee service.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of zigbee
* @param[in] event_handler The event handler
/**
* @brief Gets status code of enable commmand.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] status The result of enable command
/**
* @brief Gets PAN ID after forming a network.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] pan_id The result of enable command
/**
* @brief Gets the number of end-points of a joined device.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] count The number of end-points of a device joined to the network
/**
* @brief Gets the end-point list at a new device joined.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a ep should be released using free().
*
/**
* @brief Gets the status code of leave request commands.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] status The result of end-device left command
/**
* @brief Gets the end-point number of the device which sent this default response.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] ep Source end point
/**
* @brief Gets the cluster id of the device which sent this default response.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] clusterid The cluster id
/**
* @brief Gets the command id of the device which sent this default response.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] commandid The command id
/**
* @brief Gets status code of a default response of the global command request.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] status The result of the global command
/**
* @brief Gets the end-point number of the IAS notification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] src_ep Source end point
/**
* @brief Gets zone status of the IAS notification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] zone_status Zone status
/**
* @brief Gets the end-point number of the IAS extended notification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] src_ep Source end point
/**
* @brief Gets status of the IAS extended notification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] status Status
/**
* @brief Gets zone status of the IAS extended notification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] zone_status Zone status
/**
* @brief Gets delay of the IAS extended notification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] delay Delay
/**
* @brief Gets zone id of the IAS extended notification.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] zone_id Zone id
/**
* @brief Gets the end-point number of the device which sent this enroll request.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] src_ep Source end point
/**
* @brief Gets the zone type of the enroll request.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] zone_type Zone type \n
/**
* @brief Gets the manufacturer code of the enroll request.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] mfg_code Manufacturer code
* @brief Called after zigbee network formation is completed.
* @details Response of forming the zigbee network
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] panid PAN ID
* @param[out] user_data user data
/**
* @brief Makes the network work as a zigbee coordinator.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Called after disabling the zigbee network.
* @details Response of disabling the zigbee network
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[out] status #ZB_ZDP_STATUS_SUCCESS \n
* #ZB_ZDP_STATUS_NOT_SUPPORTED \n
* @brief Disables network and stops zigbee coordinator role.
* @details This function to stop zigbee coordinator
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details If @a remove_children is set to true, the target end device will reset its
* state-machine to factory defaults.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Allows or disallows the coordinator device to accept other device's association
* request.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details The function gets the coordinator's MAC address from the machine which runs
* zigbee-service daemon.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Gets information of the current network environment of coordinator.
* @details The function shows network environment
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details This function return end-point list and simple description per each end-point
* at each device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Gets endpoint list information.
* @details This function return end-point list of each device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Gets cluster list information.
* @details This function return in and out cluster list of each device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details This function return end-point list and simple description per each end-point
* at each device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] list The device information list
*
/**
* @brief Creates an end-device handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
/**
* @brief Clones an end-device handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a src should be released using zb_end_dev_destroy().
* @remarks The @a dst should be released using zb_end_dev_destroy().
/**
* @brief Destroys an end-device handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of end-device descriptor
*
/**
* @brief Gets network address of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[out] addr16 network address of the end-point
/**
* @brief Gets ieee address of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[out] addr64 ieee address of the end-point
/**
* @brief Gets a number of end-points of a specific end-device.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[out] count a number of endpoints of the end-point
/**
* @brief Gets pointer of end-points list.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The number of items on the list can be found with zb_end_dev_info_get_num_of_ep().
* @remarks The @a ep_list should be released using free().
/**
* @brief Gets 802.15.4 MAC capability of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[out] capability 802.15.4 MAC capability of the end-point
/**
* @brief Gets ability of alternative PAN coordinator of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[out] can_do_it alternative of PAN coordinator of the end-point
/**
* @brief Gets device id of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[in] ep endpoint number
/**
* @brief Gets profile id of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[in] ep endpoint number
/**
* @brief Gets power source type of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[out] power_src power source type of the end-point
/**
* @brief Gets security capability of a specific end-point.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a specific end-device
* @param[out] sec_capability security type of the end-point
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Creates a simple descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Clones a simple descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a dst should be released using zb_simple_desc_destroy().
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Destroys a simple a descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets active endpoint number from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[out] ep endpoint number
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets active endpoint number to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] ep endpoint number
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets profile id from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[out] profileid profile id
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets profile id to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] profileid profile id
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets device id from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[out] deviceid 16-bit device identifier
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets device id to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] deviceid 16-bit device identifier
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets device version from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[out] device_ver device version
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets device version to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] device_ver device version
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets the number of items in input clusters from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle Handle of a simple descriptor
* @param[out] num_of_in_clusters The number of input clusters
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets the number of input clusters to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] num_of_in_clusters number of input clusters
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets number of output clusters from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[out] num_of_out_clusters number of output clusters
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets number of output clusters to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] num_of_out_clusters number of output clusters
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets input cluster list from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a in_clusters should not be released.
* @remarks The @a in_clusters is available until handle is released
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets input cluster list to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] in_clusters input clusters
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Gets output cluster list from a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a out_clusters should not be released.
* @remarks The @a out_clusters is available until handle is released
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_SIMPLE_DESCRIPTOR_MODULE
* @brief Sets output cluster list to a simple descriptor handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of a simple descriptor
* @param[in] out_clusters output clusters
* Device or the NWK address of an address held in a local discovery cache.
* The destination addressing on this command is unicast.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a assoc_dev_addr_list should not be released.
* @remarks The @a assoc_dev_addr_list can be used only in the callback. To use outside, make a copy.
* destination addressing on this command shall be unicast or broadcast to all
* devices for which macRxOnWhenIdle = TRUE.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* the 64-bit IEEE address of the Remote Device based on their known 16-bit address.
* The destination addressing on this command shall be unicast.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* and include an ascending list of all the identifiers of the active endpoints on that
* device in the ActiveEPList field .
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a ep_list should not be released.
* @remarks The @a ep_list can be used only in the callback. To use outside, make a copy.
* illustrated in param list. The NWKAddrOfInterest field shall contain the network
* address of the remote device for which the active endpoint list is required.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* on that endpoint, and include the simple descriptor for that
* endpoint of the matching child device in the SimpleDescriptor field.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* The @a desc can be used only in the callback. To use outside, make a copy using zb_simple_desc_clone().
*
* endpoint field shall contain the endpoint identifier from which to obtain the
* required simple descriptor.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_READ_ATTRIBUTE_STATUS_RECORD_MODULE
* @brief Creates a read attribute status record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_READ_ATTRIBUTE_STATUS_RECORD_MODULE
* @brief Clones a read attribute status record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a dst should be released using zb_read_attr_status_record_destroy().
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_READ_ATTRIBUTE_STATUS_RECORD_MODULE
* @brief Destroys a read attribute status record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
*
* attribute identifier field of the original read attributes or read attributes
* structured command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[out] id Attribute identifier
* attribute identifier field of the original read attributes or read attributes
* structured command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[in] id Attribute identifier
* was successful, or an error code, as specified in #zb_zcl_status_e if the operation was
* not successful.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[out] status error code @see #zb_zcl_status_e
* @details The status field is 8 bits in length and specifies the status of the read
* operation on this attribute.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[in] status error code @see #zb_zcl_status_e
* This field shall only be included if the associated status
* field contains a value of #ZB_ZCL_STATUS_SUCCESS.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[out] type Data type
* @details The attribute data type field shall contain the data type of the attribute
* in the same read attributes status record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[in] type Data type
* For an attribute or element of simple type, this
* field has the format shown in the Table of Data Types .
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a value should be released using free().
*
* For an attribute or element of simple type, this
* field has the format shown in the #zb_zcl_data_type_e.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[in] type Attribute data type
* @details This callback is called when device attributes are requested with
* #zb_zcl_global_attr_read().
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a records can be used only in the callback.
* If you want to use them outside, copy each of them with #zb_read_attr_status_record_clone().
* @brief Sends 'read attributes' command.
* @details Call this function to read attributes of devices.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Creates write attribute status record.
* @details This allocates heap for write attribute status record
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_WRITE_ATTRIBUTE_STATUS_RECORD_MODULE
* @brief Clones a write attribute status record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a dst should be released using zb_write_attr_status_destroy().
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_WRITE_ATTRIBUTE_STATUS_RECORD_MODULE
* @brief Destroys a write attribute status record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
*
* was successful, or an error code, as specified in #zb_zcl_status_e if the operation was
* not successful.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[out] status error code @see #zb_zcl_status_e
* @details The status field is 8 bits in length and specifies the status of the read
* operation on this attribute.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of read attribute status record
* @param[in] status error code @see #zb_zcl_status_e
* attribute identifier field of the original write attributes or write attributes
* structured command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
* attribute identifier field of the original write attributes or write attributes
* structured command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] id Attribute identifier
* In other words, the write attributes response is generated in response to the write
* attributes command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a records can be used only in the callback.
* @remarks If you want to use them outside, copy them with #zb_write_attr_status_clone().
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_WRITE_ATTRIBUTE_RECORD_MODULE
* @brief Creates a write attribute record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_WRITE_ATTRIBUTE_RECORD_MODULE
* @brief Destroys a write attribute record handle.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute record
*
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that is to be written.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute record
* @param[in] id Attribute identifier
* @details The attribute data type field shall contain the data type of the attribute
* that is to be written.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute record
* @param[in] type attribute data type
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] type Attribute data type
* @brief Sends 'write Attributes' command.
* @details Call this function to write attributes of other devices.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Sends 'write attributes undivided' command.
* @details Call this function to write attributes without fragmentation to other devices.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @details Call this function to write attributes of other devices without receiving any
* response.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RESPONSE_RECORD_MODULE
* @brief Clones a report config response record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a dst should be released using zb_report_config_response_record_destroy().
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RESPONSE_RECORD_MODULE
* @brief Destroys a reporting configuration response record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of reporting configuration response record
*
* If the status field is not set to #ZB_ZCL_STATUS_SUCCESS, all fields except the
* direction and attribute identifier fields shall be omitted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] status status @see #zb_zcl_status_e
*
* All other values of this field are reserved.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] dir direction 00 : #ZB_ZCL_CLIENT_TO_SERVER \n
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that the reporting configuration details apply to.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
* @brief Called with configure reporting response.
* @details This callback is called after #zb_zcl_global_config_report_write() is called.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a records can be used only in the callback.
* @remarks The @a records should not be released.
* @brief Creates a reporting configuration record.
* @details Allocate memory for reporting configuration record
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RECORD_MODULE
* @brief Clones a reporting configuration record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a dst should be released using zb_report_config_record_destroy().
*
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RECORD_MODULE
* @brief Destroys a reporting configuration record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of reporting configuration record
*
* record is sent to a cluster client (or server) to configure how it should expect
* reports from a server (or client) of the same cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] dir 00 : The receiver of the Configure Reporting command shall configure
* record is sent to a cluster client (or server) to configure how it should expect
* reports from a server (or client) of the same cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] dir 00 : The receiver of the Configure Reporting command shall configure
* If instead the direction field is 0x01, the device shall expect reports of values
* of this attribute.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
* If instead the direction field is 0x01, the device shall expect reports of values
* of this attribute.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] id Attribute identifier
* @details The Attribute data type field contains the data type of the attribute that is
* to be reported.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] type attribute data type
* imposed by the specification of the cluster using this reporting mechanism or by
* the applicable profile.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] min_i minimum interval time
* imposed by the specification of the cluster using this reporting mechanism or by
* the applicable profile.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] min_i minimum interval time
* specified attribute, and the configuration information for that attribute need not be
* maintained.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] max_i maximum interval time
* specified attribute, and the configuration information for that attribute need not be
* maintained.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] max_i maximum interval time
* server) cluster must be set somewhat higher than the maximum reporting interval
* set for the attribute on the server (or client) cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] timeout timeout
* server) cluster must be set somewhat higher than the maximum reporting interval
* set for the attribute on the server (or client) cluster.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] timeout timeout
* For attributes of 'discrete' data type
* this field is omitted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a value should be released using free().
*
* For attributes of 'discrete' data type
* this field is omitted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] type attribute type
* @brief Sends 'setting configure reporting' command.
* @details Call this function to set the configuration of attribute status changing reporting.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Called with a configuration report.
* @details This callback is called after zb_zcl_global_config_report_read() is called.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a records can be used only in the callback.
* @remarks The @a records should not be released.
* @brief Creates a read reporting configuration record.
* @details Allocates memory for read reporting configuration record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @brief Destroys a read reporting configuration record.
* @details Removes allocated memory for read reporting configuration record.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute record
*
*
* All other values of this field are reserved.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] dir direction
* @details The attribute identifier field shall contain the identifier of the attribute
* whose reporting configuration details are to be read.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] id Attribute identifier
* @details Call this function to read the configuration of attribute status changing
* reporting.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
/**
* @brief Values of the Enroll Response Code in Zigbee Cluster Library.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_IAS_ZONE_ENROLL_SUCCESS = 0x00, /**< Success */
* checking the address of their sender against IAS_CIE_Address. This is to ensure
* that only messages from the correct CIE are accepted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
/**
* @brief On/Off/Toggle value.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZCL_OFF = 0x00, /**< Off */
* On receipt of 'toggle' command, if a device is in its 'Off' state it shall enter
* its 'On' state. Otherwise, if it is in its 'On' state it shall enter its 'Off' state.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @internal
* @brief Called after custom APS send command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a payload can be used only in the callback. To use outside, make a copy.
* @remarks The @a payload should not be released.
* @internal
* @brief Called after custom ZCL send command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a payload can be used only in the callback. To use outside, make a copy.
* @remarks The @a payload should not be released.
* @internal
* @brief Called after custom local send command.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a data can be used only in the callback. To use outside, make a copy.
* @remarks The @a data should not be released.
* @internal
* @brief Sends custom APS data.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @internal
* @brief Sends custom ZCL data.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @internal
* @brief Transmits data that needs to be processed locally.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @brief The events for zb_event_cb().
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
typedef enum {
ZB_ZDP_UPDATED_NETWORK_NOTIFICATION_EVENT = 0x06, /**< A device updated its network information */
* If the status field is not set to #ZB_ZCL_STATUS_SUCCESS, all fields except the
* direction and attribute identifier fields shall be omitted.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[in] status status @see #zb_zcl_status_e
*
* All other values of this field are reserved.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] dir direction 00 : #ZB_ZCL_CLIENT_TO_SERVER \n
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that the reporting configuration details apply to.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] handle The handle of write attribute status record
* @param[out] id Attribute identifier
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Uses this value as the return value to stop foreach function.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
#define ZIGBEE_FUNC_STOP false
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
* @brief Uses this value as the return value to continue foreach function.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
#define ZIGBEE_FUNC_CONTINUE true
* @internal
* @brief Called after getting end-device information.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The @a child should not be released.
* The @a child can be used only in the callback. To use outside, make a copy
* @internal
* @brief Calls a function for each children end-point of parent.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/zigbee
*
/**
* @internal
* @brief Gets the records of the received global command.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @remarks The returned records are managed by the platform and will be released when
* caller's stack is released
/**
* @internal
* @brief Gets the alarm count.
- * @since_tizen 4.0
+ * @since_tizen 5.0
*
* @param[in] ev Event data structure
* @param[out] count Alarm count
* @brief Resets chip for the zigbee transceiver.
* @details If the Zigbee transceiver works abnormally, this function do HW reset.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/zigbee.admin
*
* @brief Switches channel when an occupied channel is noisy.
* @details When noisy, do energy scan and active scan to switch operational channel.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/zigbee.admin
*
* @brief Stops channel switching operation.
* @details Halt current operation related to channel switching.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/zigbee.admin
*
* experience. The start up set parameters described by the Commissioning cluster
* provide a good basis to specify a HA startup set.
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/zigbee.admin
*
/**
* @brief Format of the Selector Field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct selector_s {
unsigned char indicator; /**< number of index */
/**
* @brief Stcuture for reading attribute
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct read_structured_attribute_record_s {
unsigned short id; /**< attribute identifier */
/**
* @brief Format of the Write Attribute Record Field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct write_attribute_structured_status_record_s {
unsigned char status; /**< status */
/**
* @brief Format of the Write Attribute Record Field
*
- * @since_tizen 4.0
+ * @since_tizen 5.0
*/
struct write_attribute_structured_record_s {
unsigned short id; /**< attribute identifier */
projects / platform / core / api / zigbee.git / commitdiff