* limitations under the License.
*/
-#ifndef __CAPI_NETWORK_ZIGBEE_ERROR_H__
-#define __CAPI_NETWORK_ZIGBEE_ERROR_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ERROR_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ERROR_H__
#include <tizen_error.h>
* @}
*/
-#endif /* __CAPI_NETWORK_ZIGBEE_ERROR_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ERROR_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_HA_H__
-#define __TIZEN_NETWORK_ZIGBEE_HA_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_HA_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_HA_H__
/**
- * @brief Zigbee profile id
+ * @brief Zigbee profile id.
*
* @since_tizen 4.0
*/
} zb_profile_id_e;
/**
- * @brief Devices specified the HA profile
+ * @brief Devices specified the HA profile.
*
* @since_tizen 4.0
*/
} ha_device_id_e;
-#endif /* __TIZEN_NETWORK_ZIGBEE_HA_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_HA_H__ */
* limitations under the License.
*/
-#ifndef __CAPI_NETWORK_ZIGBEE_CONSTANT_H__
-#define __CAPI_NETWORK_ZIGBEE_CONSTANT_H__
+#ifndef __TIZEN_CAPI_NETWORK_ZIGBEE_ZB_TYPE_H__
+#define __TIZEN_CAPI_NETWORK_ZIGBEE_ZB_TYPE_H__
#include <tizen_type.h>
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The data type abbreviation : IEEE Address
+ * @brief The data type abbreviation : IEEE Address.
*
* @since_tizen 4.0
*/
typedef unsigned char ieee_addr[8];
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The data type abbreviation : Network Address
+ * @brief The data type abbreviation : Network Address.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The data type abbreviation : 128 bit security key
+ * @brief The data type abbreviation : 128 bit security key.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The handle of zigbee
- * @details A zigbee_h is an opaque data structure.\n
- * zigbee_h is a data type of zigbee's response which consists of result, handler and etc.
+ * @brief The handle of zigbee.
+ * @details A #zigbee_h is an opaque data structure.\n
+ * #zigbee_h is a data type of zigbee's response which consists of result, handler and etc.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The events for zb_event_cb
+ * @brief The events for zb_event_cb.
*
* @since_tizen 4.0
*/
ZB_ZDP_ENABLE_EVENT = 0x00, /**< This event is received after enabling zigbee system service */
ZB_ZDP_FORM_NETWORK_DONE = 0x01, /**< This event comes from coming network operation completed */
ZB_ZDP_JOIN_EVENT = 0x02, /**< This event takes place when new device joined */
- ZB_ZDP_REJOIN_EVENT = 0x03, /**< This event takes place when existing device or devices which is(are) received 'leave_network' command is re-joined */
+ ZB_ZDP_REJOIN_EVENT = 0x03, /**< This event takes place when existing device or devices which are received 'leave_network' command is re-joined */
ZB_ZDP_CHILD_LEFT = 0x04, /**< This event takes place when a child device leave current network explicitly */
ZB_ZDP_LEAVE_DONE_EVENT = 0x05, /**< This event will take place after dismiss current network */
ZB_ZDP_UPDATED_NETWORK_NOTIFICATION_EVENT = 0x06, /**< A device updated its network information */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZDP_ENABLE_EVENT callback data.
+ * @brief The structure type for the #ZB_ZDP_ENABLE_EVENT callback data.
* @details The result of enabling zigbee system service.
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZDP_FORM_NETWORK_DONE callback data.
+ * @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
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZDP_JOIN_EVENT callback data.
+ * @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
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZDP_CHILD_LEFT callback data.
+ * @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
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZCL_GLOBAL_DEFAULT_RSP_EVENT callback data.
+ * @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
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZCL_GLOBAL_ATTRIBUTE_REPORT_EVENT callback data.
+ * @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
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZCL_ALARM_EVENT callback data.
+ * @brief The structure type for the #ZB_ZCL_ALARM_EVENT callback data.
* @details This event is related to alarm cluster.
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZCL_IAS_ZONE_ENROLL_REQUEST_EVENT callback data.
+ * @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
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZCL_IAS_ZONE_STATUS_CHANGE_NOTIFICATION_EVENT callback data.
+ * @brief The structure type for the #ZB_ZCL_IAS_ZONE_STATUS_CHANGE_NOTIFICATION_EVENT callback data.
* @details A Device which supports IAS zone cluster notifies its status change.
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief The structure type for the ZB_ZCL_IAS_ZONE_STATUS_CHANGE_EXTENDED_NOTIFICATION_EVENT callback data.
+ * @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 notifies its status change.
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief Request or Response at ZCL Header
+ * @brief Request or Response at ZCL Header.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief Disable default response or not at ZCL Header
+ * @brief Disable default response or not at ZCL Header.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief Default ZCL frame control at APS Header
+ * @brief Default ZCL frame control at APS Header.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief Broadcast address to all router device
+ * @brief Broadcast address to all router device.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief Broadcast address to devices which support 'rx_on_idle' feature
+ * @brief Broadcast address to devices which support 'rx_on_idle' feature.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
- * @brief Broadcast address to all devices
+ * @brief Broadcast address to all devices.
*
* @since_tizen 4.0
*/
#define ZIGBEE_FUNC_CONTINUE true
-#endif /* __CAPI_NETWORK_ZIGBEE_CONSTANT_H__ */
+#endif /* __TIZEN_CAPI_NETWORK_ZIGBEE_ZB_TYPE_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_H__
/**
* @file zb_zcl.h
* output cluster list shall contain the list of client clusters supported on the device.
*
* @section CAPI_NETWORK_ZIGBEE_ZCL_MODULE_FEATURE Related Features
- * This API is related with the following features:\n
+ * This function is related with the following features:\n
* - http://tizen.org/feature/network.zigbee\n
*
* It is recommended to design applications with regard to features, for reliability.\n
*
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
+ * You can check if a device supports the related features for this function by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
*
* To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
*
#include <zcl/zb_zcl_ias_zone_cluster.h>
/**
- * @brief Returns readable Zigbee Cluster Library status code for human
+ * @brief Returns readable Zigbee Cluster Library status code for human.
* @details Returns Zigbee Cluster Library status code
*
* @since_tizen 4.0
const char* zb_get_zcl_error_message(int id);
/**
- * @brief Returns readable cluster name for human
+ * @brief Returns readable cluster name for human.
* @details Returns Zigbee Cluster name and ID
*
* @since_tizen 4.0
const char* zb_get_cluster_name(int id);
/**
- * @brief Returns measuring unit of attribute type
+ * @brief Returns measuring unit of attribute type.
* @details This helps to know measuring unit of attribute type
*
* @since_tizen 4.0
int zb_get_analog_or_discret(unsigned char type);
/**
- * @brief Returns attribute size
+ * @brief Returns attribute size.
* @details Returns size of attribute data
*
* @since_tizen 4.0
int zb_get_data_size(zb_zcl_data_type_e type);
/**
- * @brief Creates simple value data
+ * @brief Creates simple value data.
* @details The simple value data shall contain the data type of the attribute value
* according to the data type in #zb_zcl_data_type_e.
*
zb_value_h *handle);
/**
- * @brief Destroys simple value data
+ * @brief Destroys simple value data.
* @details Remove allocated memory for simple value data
*
* @since_tizen 4.0
zb_value_h handle);
/**
- * @brief Sets value from zb_value_h
+ * @brief Sets value from zb_value_h.
* @details Sets data from zb_value_h, expected value type as follows : \n
* val : 16 byte buffer \n
* ieee_addr addr64 : 64-bit IEEE address \n
int zb_set_value(zb_value_h handle, unsigned char type, unsigned char *value, int count);
/**
- * @brief Gets value from zb_value_h
+ * @brief Gets value from zb_value_h.
* @details Gets data from zb_value_h, expected value type as follows : \n
* val : 16 byte buffer \n
* struct attribute_str_s *str : for 1 byte string \n
int zb_get_value(zb_value_h handle, unsigned char *type, unsigned char **value, int *count);
/**
- * @brief Creates read attribute status record
+ * @brief Creates read attribute status record.
* @details This allocates heap for read attribute status record
*
* @since_tizen 4.0
int zb_create_read_attr_status_record(read_attr_status_record_h *handle);
/**
- * @brief Destroys read attribute status record
+ * @brief Destroys read attribute status record.
* @details This destroys read attribute status record
*
* @since_tizen 4.0
int zb_destroy_read_attr_status_record(read_attr_status_record_h handle);
/**
- * @brief Gets identifier from read attribute status record
+ * @brief Gets identifier from read attribute status record.
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that has been read (or of which an element has been read).
* \n\n This field shall contain the same value that was included in the corresponding a
unsigned short* id);
/**
- * @brief Sets identifier to read attribute status record
+ * @brief Sets identifier to read attribute status record.
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that has been read (or of which an element has been read).
* \n\n This field shall contain the same value that was included in the corresponding a
unsigned short id);
/**
- * @brief Gets identifier from read attribute status record
+ * @brief Gets identifier from read attribute status record.
* @details The status field is 8 bits in length and specifies the status of the read
* operation on this attribute. \n\n This field shall be set to SUCCESS, if the operation
* was successful, or an error code, as specified in zb_zcl_status_e if the operation was
unsigned char* status);
/**
- * @brief Sets identifier to read attribute status record
+ * @brief Sets identifier to read attribute status record.
* @details The status field is 8 bits in length and specifies the status of the read
* operation on this attribute. \n\n This field shall be set to SUCCESS, if the operation
* was successful, or an error code, as specified in zb_zcl_status_e if the operation was
/**
- * @brief Gets identifier from read attribute status record
+ * @brief Gets identifier from read attribute status record.
* @details The attribute data type field shall contain the data type of the attribute
* in the same read attributes status record (see #zb_zcl_data_type_e). \n\n This field shall only
* be included in zb_zcl_data_type_e if the associated status field contains a value of
unsigned char *type);
/**
- * @brief Sets identifier to read attribute status record
+ * @brief Sets identifier to read attribute status record.
* @details The attribute data type field shall contain the data type of the attribute
* in the same read attributes status record (see #zb_zcl_data_type_e).
* \n\n This field shall only be included in zb_zcl_data_type_e if the associated status
unsigned char type);
/**
- * @brief Gets data value from read attribute status record
+ * @brief Gets data value from read attribute status record.
* @details The attribute value field is variable in length and shall contain the current
* value of this attribute. \n\n This field shall only be included if the associated
* status field contains a value of SUCCESS. \n\n
zb_value_h value);
/**
- * @brief Sets data value to read attribute status record
+ * @brief Sets data value to read attribute status record.
* @details The attribute value field is variable in length and shall contain the current
* value of this attribute. \n\n This field shall only be included if the associated
* status field contains a value of SUCCESS. \n\n
zb_value_h value);
/**
- * @brief Creates discover attribute information record
+ * @brief Creates discover attribute information record.
* @details This allocates heap for discover attribute information record
*
* @since_tizen 4.0
int zb_create_discover_attr_info(discover_attr_info_record_h *handle);
/**
- * @brief Destroys discover attribute information record
+ * @brief Destroys discover attribute information record.
* @details This destroys discover attribute information record
*
* @since_tizen 4.0
int zb_destroy_discover_attr_info(discover_attr_info_record_h handle);
/**
- * @brief Gets identifier from discover attribute info
+ * @brief Gets identifier from discover attribute info.
* @details The attribute identifier field shall contain the identifier of a discovered
* attribute. \n\n Attributes shall be included in ascending order, starting with the
* lowest attribute identifier that is greater than or equal to the start attribute
unsigned short *id);
/**
- * @brief Sets identifier to discover attribute info
+ * @brief Sets identifier to discover attribute info.
* @details The attribute identifier field shall contain the identifier of a discovered
* attribute. \n\n Attributes shall be included in ascending order, starting with the
* lowest attribute identifier that is greater than or equal to the start attribute
unsigned short id);
/**
- * @brief Gets data type from discover attribute info
+ * @brief Gets data type from discover attribute info.
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field (see #zb_zcl_data_type_e)
*
unsigned char *type);
/**
- * @brief Sets data type to discover attribute info
+ * @brief Sets data type to discover attribute info.
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field (see #zb_zcl_data_type_e)
*
unsigned char type);
/**
- * @brief Creates write attribute record
+ * @brief Creates write attribute record.
* @details Allocate memory for write attribute record
*
* @since_tizen 4.0
write_attr_record_h *handle);
/**
- * @brief Destroys write attribute record
+ * @brief Destroys write attribute record.
* @details Remove allocated memory for write attribute record
*
* @since_tizen 4.0
write_attr_record_h handle);
/**
- * @brief Sets attribute identifier write attribute record
+ * @brief Sets attribute identifier 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.
*
unsigned short id);
/**
- * @brief Sets attribute data type write attribute record
+ * @brief Sets attribute data type write attribute record.
* @details The attribute data type field shall contain the data type of the attribute
* that is to be written.
*
unsigned char type);
/**
- * @brief Sets attribute data write attribute record
+ * @brief Sets attribute data write attribute record.
* @details The attribute data type field shall contain the data type of the attribute
* that is to be written.
*
int count);
/**
- * @brief Sets data value to write attribute status record
+ * @brief Sets data value to write attribute status record.
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field (see #zb_zcl_data_type_e)
*
zb_value_h value);
/**
- * @brief Creates write attribute status record
+ * @brief Creates write attribute status record.
* @details This allocates heap for write attribute status record
*
* @since_tizen 4.0
int zb_create_write_attr_status(write_attr_status_record_h *handle);
/**
- * @brief Destroys write attribute status record
+ * @brief Destroys write attribute status record.
* @details This destroys write attribute status record
*
* @since_tizen 4.0
int zb_destroy_write_attr_status(write_attr_status_record_h handle);
/**
- * @brief Gets status from write attribute status record
+ * @brief Gets status from write attribute status record.
* @details The status field is 8 bits in length and specifies the status of the read
* operation on this attribute. \n\n This field shall be set to SUCCESS, if the operation
* was successful, or an error code, as specified in zb_zcl_status_e if the operation was
unsigned char *status);
/**
- * @brief Sets status to write attribute status record
+ * @brief Sets status to write attribute status record.
* @details The status field is 8 bits in length and specifies the status of the read
* operation on this attribute. \n\n This field shall be set to SUCCESS, if the operation
* was successful, or an error code, as specified in zb_zcl_status_e if the operation was
unsigned char status);
/**
- * @brief Gets identifier from write attribute status record
+ * @brief Gets identifier from write attribute status record.
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that has been write (or of which an element has been write).
* \n\n This field shall contain the same value that was included in the corresponding a
unsigned short *id);
/**
- * @brief Sets identifier to write attribute status record
+ * @brief Sets identifier to write attribute status record.
* @details The attribute identifier field is 16 bits in length and shall contain the
* identifier of the attribute that has been write (or of which an element has been write).
* \n\n This field shall contain the same value that was included in the corresponding a
unsigned short id);
/**
- * @brief Creates reporting configuration record
+ * @brief Creates reporting configuration record.
* @details Allocate memory for reporting configuration record
*
* @since_tizen 4.0
report_config_record_h *handle);
/**
- * @brief Destroys reporting configuration record
+ * @brief Destroys reporting configuration record.
* @details This destroys reporting configuration record
*
* @since_tizen 4.0
report_config_record_h handle);
/**
- * @brief Gets direction from reporting configuration record
+ * @brief Gets direction from reporting configuration record.
* @details The direction field specifies whether values of the attribute are be reported,
* or whether reports of the attribute are to be received. \n\n
* If this value is set to 0x00, then the attribute data type field, the minimum
unsigned char *dir);
/**
- * @brief Sets direction to reporting configuration record
+ * @brief Sets direction to reporting configuration record.
* @details The direction field specifies whether values of the attribute are be reported,
* or whether reports of the attribute are to be received. \n\n
* If this value is set to 0x00, then the attribute data type field, the minimum
unsigned char dir);
/**
- * @brief Gets attribute identifier from reporting configuration record
+ * @brief Gets attribute identifier from reporting configuration record.
* @details If the direction field is 0x00, this field contains the identifier of the
* attribute that is to be reported. \n\n If instead the direction field is 0x01,
* the device shall expect reports of values of this attribute.
unsigned short *id);
/**
- * @brief Sets attribute identifier to reporting configuration record
+ * @brief Sets attribute identifier to reporting configuration record.
* @details If the direction field is 0x00, this field contains the identifier of the
* attribute that is to be reported. \n\n If instead the direction field is 0x01,
* the device shall expect reports of values of this attribute.
unsigned short id);
/**
- * @brief Gets attribute data type from reporting configuration record
+ * @brief Gets attribute data type from reporting configuration record.
* @details The Attribute data type field contains the data type of the attribute that is
* to be reported.
*
unsigned char *type);
/**
- * @brief Sets attribute data type to reporting configuration record
+ * @brief Sets attribute data type to reporting configuration record.
* @details The Attribute data type field contains the data type of the attribute that is
* to be reported.
*
unsigned char type);
/**
- * @brief Gets minimum interval from reporting configuration record
+ * @brief Gets minimum interval from reporting configuration record.
* @details The minimum reporting interval field is 16 bits in length and shall contain
* the minimum interval, in seconds, between issuing reports of the specified attribute.
* \n\n
unsigned short *min_i);
/**
- * @brief Sets minimum interval to reporting configuration record
+ * @brief Sets minimum interval to reporting configuration record.
* @details The minimum reporting interval field is 16 bits in length and shall contain
* the minimum interval, in seconds, between issuing reports of the specified attribute.
* \n\n
unsigned short min_i);
/**
- * @brief Gets maximum interval from reporting configuration record
+ * @brief Gets maximum interval from reporting configuration record.
* @details The maximum reporting interval field is 16 bits in length and shall contain
* the maximum interval, in seconds, between issuing reports of the specified attribute.
* \n\n
unsigned short *max_i);
/**
- * @brief Sets maximum interval to reporting configuration record
+ * @brief Sets maximum interval to reporting configuration record.
* @details The maximum reporting interval field is 16 bits in length and shall contain
* the maximum interval, in seconds, between issuing reports of the specified attribute.
* \n\n
unsigned short max_i);
/**
- * @brief Gets timeout from reporting configuration record
+ * @brief Gets timeout from reporting configuration record.
* @details The timeout period field is 16 bits in length and shall contain the maximum
* expected time, in seconds, between received reports for the attribute specified in
* the attribute identifier field. If more time than this elapses between reports, this
unsigned short *timeout);
/**
- * @brief Sets timeout to reporting configuration record
+ * @brief Sets timeout to reporting configuration record.
* @details The timeout period field is 16 bits in length and shall contain the maximum
* expected time, in seconds, between received reports for the attribute specified in
* the attribute identifier field. If more time than this elapses between reports, this
unsigned short timeout);
/**
- * @brief Gets change from reporting configuration record
+ * @brief Gets change from reporting configuration record.
* @details The reportable change field shall contain the minimum change to the attribute
* that will result in a report being issued. This field is of variable length. \n\n
* For attributes with 'analog' data type (see #zb_zcl_data_type_e)
zb_value_h value);
/**
- * @brief Sets change to reporting configuration record
+ * @brief Sets change to reporting configuration record.
* @details The reportable change field shall contain the minimum change to the attribute
* that will result in a report being issued. This field is of variable length. \n\n
* For attributes with 'analog' data type (see #zb_zcl_data_type_e)
zb_value_h value);
/**
- * @brief Gets change from reporting configuration record
+ * @brief Gets change from reporting configuration record.
* @details The reportable change field shall contain the minimum change to the attribute
* that will result in a report being issued. This field is of variable length. \n\n
* For attributes with 'analog' data type (see #zb_zcl_data_type_e)
*
* @since_tizen 4.0
*
+ * @remarks value : generated from library you MUST free it
+ *
* @param[in] handle handle of write attribute status record
* @param[out] type attribute type
* @param[out] value attribute data which is allocated in library (only analog data type is allowed)
* @param[out] size attribute data size
*
- * @remark value : generated from library you MUST free it
- *
* @return 0 on success, otherwise a negative error value.
* @retval #ZIGBEE_ERROR_NONE Successful
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
int *size);
/**
- * @brief Sets change to reporting configuration record
+ * @brief Sets change to reporting configuration record.
* @details The reportable change field shall contain the minimum change to the attribute
* that will result in a report being issued. This field is of variable length. \n\n
* For attributes with 'analog' data type (see #zb_zcl_data_type_e)
unsigned char *value);
/**
- * @brief Gets change from reporting configuration record
+ * @brief Gets change from reporting configuration record.
* @details The reportable change field shall contain the minimum change to the attribute
* that will result in a report being issued. This field is of variable length. \n\n
* For attributes with 'analog' data type (see #zb_zcl_data_type_e)
int *size);
/**
- * @brief Gets change from reporting configuration record
+ * @brief Gets change from reporting configuration record.
* @details The reportable change field shall contain the minimum change to the attribute
* that will result in a report being issued. This field is of variable length. \n\n
* For attributes with 'analog' data type (see #zb_zcl_data_type_e)
int *size);
/**
- * @brief Creates read reporting configuration record
+ * @brief Creates read reporting configuration record.
* @details Allocate memory for read reporting configuration record
*
* @since_tizen 4.0
read_report_config_record_h *handle);
/**
- * @brief Destroys read reporting configuration record
+ * @brief Destroys read reporting configuration record.
* @details Remove allocated memory for read reporting configuration record
*
* @since_tizen 4.0
read_report_config_record_h handle);
/**
- * @brief Gets direction from read reporting configuration record
+ * @brief Gets direction from read reporting configuration record.
* @details The direction field specifies whether values of the attribute are reported
* (0x00), or whether reports of the attribute are received (0x01). \n\n
* All other values of this field are reserved.
unsigned char *dir);
/**
- * @brief Sets direction to read reporting configuration record
+ * @brief Sets direction to read reporting configuration record.
* @details The direction field specifies whether values of the attribute are reported
* (0x00), or whether reports of the attribute are received (0x01). \n\n
* All other values of this field are reserved.
unsigned char dir);
/**
- * @brief Gets attribute identifier from read reporting configuration record
+ * @brief Gets attribute identifier from read reporting configuration record.
* @details The attribute identifier field shall contain the identifier of the attribute
* whose reporting configuration details are to be read.
*
unsigned short *id);
/**
- * @brief Sets attribute identifier from read reporting configuration record
+ * @brief Sets attribute identifier from read reporting configuration record.
* @details The attribute identifier field shall contain the identifier of the attribute
* whose reporting configuration details are to be read.
*
unsigned short id);
/**
- * @brief Creates reporting configuration response record
+ * @brief Creates reporting configuration response record.
* @details Allocate memory for reporting configuration response record
*
* @since_tizen 4.0
report_config_response_record_h *handle);
/**
- * @brief Destroys reporting configuration response record
+ * @brief Destroys reporting configuration response record.
* @details This destroys reporting configuration response record
*
* @since_tizen 4.0
report_config_response_record_h handle);
/**
- * @brief Gets status from reporting configuration response record
+ * @brief Gets status from reporting configuration response record.
* @details If the attribute is not implemented on the sender or receiver of the command,
* whichever is relevant (depending on direction), this field shall be set to
* UNSUPPORTED_ATTRIBUTE. \n If the attribute is supported, but is not capable of
unsigned char *status);
/**
- * @brief Sets status to reporting configuration response record
+ * @brief Sets status to reporting configuration response record.
* @details If the attribute is not implemented on the sender or receiver of the command,
* whichever is relevant (depending on direction), this field shall be set to
* UNSUPPORTED_ATTRIBUTE. \n If the attribute is supported, but is not capable of
unsigned char status);
/**
- * @brief Gets direction from reporting configuration response record
+ * @brief Gets direction from reporting configuration response record.
* @details The direction field specifies whether values of the attribute are reported
* (0x00), or whether reports of the attribute are received (0x01). \n\n
* If this value is set to 0x00, then the attribute data type field, the minimum
unsigned char *dir);
/**
- * @brief Sets direction to reporting configuration response record
+ * @brief Sets direction to reporting configuration response record.
* @details The direction field specifies whether values of the attribute are reported
* (0x00), or whether reports of the attribute are received (0x01). \n\n
* If this value is set to 0x00, then the attribute data type field, the minimum
unsigned char dir);
/**
- * @brief Gets attribute identifier from reporting configuration response record
+ * @brief Gets attribute identifier from reporting configuration response record.
* @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.
*
unsigned short *id);
/**
- * @brief Sets attribute identifier to reporting configuration response record
+ * @brief Sets attribute identifier to reporting configuration response record.
* @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.
*
unsigned short id);
/**
- * @brief Creates reporting attribute
+ * @brief Creates reporting attribute.
* @details Allocate memory for reporting attribute
*
* @since_tizen 4.0
attr_report_h *handle);
/**
- * @brief Destroys reporting attribute
+ * @brief Destroys reporting attribute.
* @details This destroys reporting attribute
*
* @since_tizen 4.0
attr_report_h handle);
/**
- * @brief Gets attribute identifier from reporting attribute
+ * @brief Gets attribute identifier from 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.
*
unsigned short *id);
/**
- * @brief Sets attribute identifier to reporting attribute
+ * @brief Sets attribute identifier to 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.
*
unsigned short id);
/**
- * @brief Gets attribute type from reporting attribute
+ * @brief Gets attribute type from reporting attribute.
* @details The attribute data type field contains the data type of the attribute that is
* being reported.
*
unsigned char *type);
/**
- * @brief Sets attribute type to reporting attribute
+ * @brief Sets attribute type to reporting attribute.
* @details The attribute data type field contains the data type of the attribute that is
* being reported.
*
unsigned char type);
/**
- * @brief Gets attribute data from reporting attribute
+ * @brief Gets attribute data from reporting attribute.
* @details The attribute data field is variable in length and shall contain the actual
* value of the attribute being reported.
*
zb_value_h value);
/**
- * @brief Sets attribute data to reporting attribute
+ * @brief Sets attribute data to reporting attribute.
* @details The attribute data field is variable in length and shall contain the actual
* value of the attribute being reported.
*
zb_value_h value);
/**
- * @brief Creates extended attribute information
+ * @brief Creates extended attribute information.
* @details Allocate memory for extended attribute information
*
* @since_tizen 4.0
extended_attr_info_h *handle);
/**
- * @brief Destroys extended attribute information
+ * @brief Destroys extended attribute information.
* @details This destroys extended attribute information
*
* @since_tizen 4.0
extended_attr_info_h handle);
/**
- * @brief Gets attribute identifier from extended attribute information
+ * @brief Gets attribute identifier from extended attribute information.
* @details The attribute identifier field shall contain the identifier of a discovered
* attribute. \n
* Attributes shall be included in ascending order, starting with the lowest attribute
unsigned short *id);
/**
- * @brief Sets attribute identifier to extended attribute information
+ * @brief Sets attribute identifier to extended attribute information.
* @details The attribute identifier field shall contain the identifier of a discovered
* attribute. \n
* Attributes shall be included in ascending order, starting with the lowest attribute
unsigned short id);
/**
- * @brief Gets attribute identifier type from extended attribute information
+ * @brief Gets attribute identifier type from extended attribute information.
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field
*
unsigned char *type);
/**
- * @brief Sets attribute identifier type to extended attribute information
+ * @brief Sets attribute identifier type to extended attribute information.
* @details The attribute data type field shall contain the data type of the attribute in
* the same attribute report field
*
unsigned char type);
/**
- * @brief Gets access control field from extended attribute information
+ * @brief Gets access control field from extended attribute information.
* @details The attribute access control field shall indicate whether the attribute is
* readable, writable, and/or reportable. This is an 8-bit bitmask field. \n
* The bits are in little endian order (bit 0 is listed first).
unsigned char *acl);
/**
- * @brief Sets attribute access control field to extended attribute information
+ * @brief Sets attribute access control field to extended attribute information.
* @details The attribute access control field shall indicate whether the attribute is
* readable, writable, and/or reportable. This is an 8-bit bitmask field. \n
* The bits are in little endian order (bit 0 is listed first).
* @}
*/
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZDO_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZDO_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_H__
/**
* @file zb_zdo.h
#include <zdo/zb_zdo_bind_mgr.h>
/**
- * @brief Returns readable ZDO error code
+ * @brief Returns readable ZDO error code.
* @details Returns ZDO error code string
*
* @since_tizen 4.0
const char* zb_zdo_get_error_message(int id);
/**
- * @brief Returns readable Zigbee profile id
+ * @brief Returns readable Zigbee profile id.
* @details Returns Zigbee profile id
*
* @since_tizen 4.0
const char* zb_get_profile_id_string(int profile_id);
/**
- * @brief Return readable Zigbee device id
- * @details Return Zigbee device id
+ * @brief Returns readable Zigbee device id.
+ * @details Returns Zigbee device id
*
* @since_tizen 4.0
*
const char* zb_get_device_id_string(int device_id);
/**
- * @brief Creates simple descriptor
+ * @brief Creates simple descriptor.
* @details Creates simple descriptor handle
*
* @since_tizen 4.0
zb_zdo_simple_desc_h *handle);
/**
- * @brief Copies simple descriptor
+ * @brief Copies simple descriptor.
* @details Copies simple descriptor handle to another
*
* @since_tizen 4.0
zb_zdo_simple_desc_h dst);
/**
- * @brief Destroys simple descriptor handle
+ * @brief Destroys simple descriptor handle.
* @details Destroys simple descriptor allocated memory
*
* @since_tizen 4.0
zb_zdo_simple_desc_h handle);
/**
- * @brief Gets active endpoint number from simple descriptor handle
+ * @brief Gets active endpoint number from simple descriptor handle.
* @details Gets active endpoint number from simple descriptor handle
*
* @since_tizen 4.0
unsigned char *ep);
/**
- * @brief Set active endpoint number to simple descriptor handle
- * @details Set active endpoint number to simple descriptor handle
+ * @brief Sets active endpoint number to simple descriptor handle.
+ * @details Sets active endpoint number to simple descriptor handle
*
* @since_tizen 4.0
*
unsigned char ep);
/**
- * @brief Gets profile id from simple descriptor handle
+ * @brief Gets profile id from simple descriptor handle.
* @details Gets profile id from simple descriptor handle
*
* @since_tizen 4.0
unsigned short *profile_id);
/**
- * @brief Sets profile id to simple descriptor handle
+ * @brief Sets profile id to simple descriptor handle.
* @details Sets profile id to simple descriptor handle
*
* @since_tizen 4.0
unsigned short profile_id);
/**
- * @brief Gets device id from simple descriptor handle
+ * @brief Gets device id from simple descriptor handle.
* @details Gets device id from simple descriptor handle
*
* @since_tizen 4.0
unsigned short *device_id);
/**
- * @brief Sets device id to simple descriptor handle
+ * @brief Sets device id to simple descriptor handle.
* @details Sets device id to simple descriptor handle
*
* @since_tizen 4.0
unsigned short device_id);
/**
- * @brief Gets device version from simple descriptor handle
+ * @brief Gets device version from simple descriptor handle.
* @details Gets device version from simple descriptor handle
*
* @since_tizen 4.0
unsigned short *device_ver);
/**
- * @brief Sets device version to simple descriptor handle
+ * @brief Sets device version to simple descriptor handle.
* @details Sets device version to simple descriptor handle
*
* @since_tizen 4.0
unsigned short device_ver);
/**
- * @brief Gets number of input clusters from simple descriptor handle
+ * @brief Gets number of input clusters from simple descriptor handle.
* @details Gets number of input clusters from simple descriptor handle
*
* @since_tizen 4.0
unsigned char *num_of_in_clusters);
/**
- * @brief Sets number of input clusters to simple descriptor handle
+ * @brief Sets number of input clusters to simple descriptor handle.
* @details Sets number of input clusters to simple descriptor handle
*
* @since_tizen 4.0
unsigned char num_of_in_clusters);
/**
- * @brief Gets number of output clusters from simple descriptor handle
+ * @brief Gets number of output clusters from simple descriptor handle.
* @details Gets number of output clusters from simple descriptor handle
*
* @since_tizen 4.0
unsigned char *num_of_out_clusters);
/**
- * @brief Sets number of output clusters to simple descriptor handle
+ * @brief Sets number of output clusters to simple descriptor handle.
* @details Sets number of output clusters to simple descriptor handle
*
* @since_tizen 4.0
unsigned char num_of_out_clusters);
/**
- * @brief Gets input cluster list from simple descriptor handle
+ * @brief Gets input cluster list from simple descriptor handle.
* @details Gets input cluster list from simple descriptor handle
*
* @since_tizen 4.0
unsigned short **in_clusters);
/**
- * @brief Sets input cluster list to simple descriptor handle
+ * @brief Sets input cluster list to simple descriptor handle.
* @details Sets input cluster list to simple descriptor handle
*
* @since_tizen 4.0
int num);
/**
- * @brief Gets output cluster list from simple descriptor handle
+ * @brief Gets output cluster list from simple descriptor handle.
* @details Gets output cluster list from simple descriptor handle
*
* @since_tizen 4.0
unsigned short **out_clusters);
/**
- * @brief Sets output cluster list to simple descriptor handle
+ * @brief Sets output cluster list to simple descriptor handle.
* @details Sets output cluster list to simple descriptor handle
*
* @since_tizen 4.0
int num);
/**
- * @brief Creates node power descriptor
+ * @brief Creates node power descriptor.
* @details Creates node power descriptor handle
*
* @since_tizen 4.0
zb_zdo_node_power_descriptor_h *handle);
/**
- * @brief Copies node power descriptor
+ * @brief Copies node power descriptor.
* @details Copies node power descriptor handle
*
* @since_tizen 4.0
zb_zdo_node_power_descriptor_h dst);
/**
- * @brief Destroys node power descriptor
+ * @brief Destroys node power descriptor.
* @details Destroys node power descriptor handle
*
* @since_tizen 4.0
zb_zdo_node_power_descriptor_h handle);
/**
- * @brief Gets current power mode from node power descriptor
+ * @brief Gets current power mode from node power descriptor.
* @details The current power mode field of the node power descriptor is four bits in length
* and specifies the current sleep/power-saving mode of the node. \n\n The current power
* mode field shall be set to one of the non-reserved values
unsigned char* current_power_mode);
/**
- * @brief Sets current power mode from node power descriptor
+ * @brief Sets current power mode from node power descriptor.
* @details The current power mode field of the node power descriptor is four bits in length
* and specifies the current sleep/power-saving mode of the node. \n\n The current power
* mode field shall be set to one of the non-reserved values
unsigned char current_power_mode);
/**
- * @brief Gets available power mode from node power descriptor
+ * @brief Gets available power mode from node power descriptor.
* @details The available power sources field of the node power descriptor is four bits in
* length and specifies the power sources available on this node. \n\n For each power
* source supported on this node, the corresponding bit of the available power sources
unsigned char* available_power_sources);
/**
- * @brief Sets available power mode from node power descriptor
+ * @brief Sets available power mode from node power descriptor.
* @details The available power sources field of the node power descriptor is four bits in
* length and specifies the power sources available on this node. \n\n For each power
* source supported on this node, the corresponding bit of the available power sources
unsigned char available_power_sources);
/**
- * @brief Gets current power source from node power descriptor
+ * @brief Gets current power source from node power descriptor.
* @details The current power source field of the node power descriptor is four bits in
* length and specifies the current power source being utilized by the node. \n]n
* For the current power source selected, the corresponding bit of the current power \n\n
unsigned char* current_power_source);
/**
- * @brief Sets available power mode from node power descriptor
+ * @brief Sets current power source from node power descriptor.
* @details The current power source field of the node power descriptor is four bits in
* length and specifies the current power source being utilized by the node. \n]n
* For the current power source selected, the corresponding bit of the current power \n\n
unsigned char current_power_source);
/**
- * @brief Gets current power source level from node power descriptor
+ * @brief Gets current power source level from node power descriptor.
* @details The current power source level field of the node power descriptor is four bits
* in length and specifies the level of charge of the power source. \n\n The current power
* source level field shall be set to one of the non-reserved values
unsigned char* current_power_source_level);
/**
- * @brief Sets current power source level from node power descriptor
+ * @brief Sets current power source level from node power descriptor.
* @details The current power source level field of the node power descriptor is four bits
* in length and specifies the level of charge of the power source. \n\n The current power
* source level field shall be set to one of the non-reserved values
unsigned char current_power_source_level);
/**
- * @brief Creates node descriptor
+ * @brief Creates node descriptor.
* @details Creates node descriptor handle
*
* @since_tizen 4.0
zb_zdo_node_descriptor_h *handle);
/**
- * @brief Copies node descriptor
+ * @brief Copies node descriptor.
* @details Copies node descriptor handle
*
* @since_tizen 4.0
zb_zdo_node_descriptor_h dst);
/**
- * @brief Destroys node descriptor
+ * @brief Destroys node descriptor.
* @details Destroys node descriptor handle
*
* @since_tizen 4.0
zb_zdo_node_descriptor_h handle);
/**
- * @brief Gets logical type from node descriptor
+ * @brief Gets logical type from node descriptor.
* @details The logical type field of the node descriptor is three bits in length and
* specifies the device type of the ZigBee node. \n\n The logical type field shall be set
* to one of the non-reserved values.
unsigned char* logical_type);
/**
- * @brief Sets logical type from to descriptor
+ * @brief Sets logical type from to descriptor.
* @details The logical type field of the node descriptor is three bits in length and
* specifies the device type of the ZigBee node. \n\n The logical type field shall be set
* to one of the non-reserved values.
unsigned char logical_type);
/**
- * @brief Gets complex descriptor available from node descriptor
+ * @brief Gets complex descriptor available from node descriptor.
* @details The complex descriptor available field of the node descriptor is one bit in
* length and specifies whether a complex descriptor is available on this device. \n\n
* If this field is set to 1, a complex descriptor is available. \n\n
unsigned char* complex_desciptor_available);
/**
- * @brief Sets complex descriptor available to node descriptor
+ * @brief Sets complex descriptor available to node descriptor.
* @details The complex descriptor available field of the node descriptor is one bit in
* length and specifies whether a complex descriptor is available on this device. \n\n
* If this field is set to 1, a complex descriptor is available. \n\n
unsigned char complex_desciptor_available);
/**
- * @brief Gets user descriptor available from node descriptor
+ * @brief Gets user descriptor available from node descriptor.
* @details The user descriptor available field of the node descriptor is one bit in
* length and specifies whether a user descriptor is available on this device. \n\n
* If this field is set to 1, a user descriptor is available.
unsigned char* user_descriptor_available);
/**
- * @brief Sets user descriptor available to node descriptor
+ * @brief Sets user descriptor available to node descriptor.
* @details The user descriptor available field of the node descriptor is one bit in
* length and specifies whether a user descriptor is available on this device. \n\n
* If this field is set to 1, a user descriptor is available.
unsigned char user_descriptor_available);
/**
- * @brief Gets APS flags available from node descriptor
+ * @brief Gets APS flags available from node descriptor.
* @details The APS flags field of the node descriptor is three bits in length and
* specifies the application support sub-layer capabilities of the node. \n\n
* This field is currently not supported and shall be set to zero.
zb_zdo_node_descriptor_h handle,
unsigned char* aps_flags);
/**
- * @brief Sets APS flags available to node descriptor
+ * @brief Sets APS flags available to node descriptor.
* @details The APS flags field of the node descriptor is three bits in length and
* specifies the application support sub-layer capabilities of the node. \n\n
* This field is currently not supported and shall be set to zero.
unsigned char aps_flags);
/**
- * @brief Gets frequency band from node descriptor
+ * @brief Gets frequency band from node descriptor.
* @details The frequency band field of the node descriptor is five bits in length and
* specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio
* utilized by the node. \n\n For each frequency band supported by the underlying IEEE
unsigned char* frequency_band);
/**
- * @brief Sets frequency band to node descriptor
+ * @brief Sets frequency band to node descriptor.
* @details The frequency band field of the node descriptor is five bits in length and
* specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio
* utilized by the node. \n\n For each frequency band supported by the underlying IEEE
unsigned char frequency_band);
/**
- * @brief Gets MAC capability from node descriptor
+ * @brief Gets MAC capability from node descriptor.
* @details The MAC capability flags field is eight bits in length and specifies the node
* capabilities, as required by the IEEE 802.15.4-2003 MAC sub-layer. \n\n The
* MAC capability flags field shall be formatted as illustrated in below table. \n\n
unsigned char* mac_capability_flags);
/**
- * @brief Sets MAC capability to node descriptor
+ * @brief Sets MAC capability to node descriptor.
* @details The MAC capability flags field is eight bits in length and specifies the node
* capabilities, as required by the IEEE 802.15.4-2003 MAC sub-layer. \n\n The
* MAC capability flags field shall be formatted as illustrated in below table.\n\n
unsigned char mac_capability_flags);
/**
- * @brief Gets manufacturer code from node descriptor
+ * @brief Gets manufacturer code from node descriptor.
* @details The manufacturer code field of the node descriptor is sixteen bits in length
* and specifies a manufacturer code that is allocated by the ZigBee Alliance, relating
* the manufacturer to the device.
unsigned short* manufacturer_code);
/**
- * @brief Sets manufacturer code to node descriptor
+ * @brief Sets manufacturer code to node descriptor.
* @details The manufacturer code field of the node descriptor is sixteen bits in length
* and specifies a manufacturer code that is allocated by the ZigBee Alliance, relating
* the manufacturer to the device.
unsigned short manufacturer_code);
/**
- * @brief Gets maximum buffer size from node descriptor
+ * @brief Gets maximum buffer size from node descriptor.
* @details The maximum buffer size field of the node descriptor is eight bits in length,
* with a valid range of 0x00-0x7f. \n\n This field specifies the maximum size, in octets,
* of the network sub-layer data unit (NSDU) for this node. This is the maximum size of
unsigned char* maximum_buffer_size);
/**
- * @brief Sets maximum buffer size to node descriptor
+ * @brief Sets maximum buffer size to node descriptor.
* @details The maximum buffer size field of the node descriptor is eight bits in length,
* with a valid range of 0x00-0x7f. \n\n This field specifies the maximum size, in octets,
* of the network sub-layer data unit (NSDU) for this node. This is the maximum size of
unsigned char maximum_buffer_size);
/**
- * @brief Gets maximum incoming transfer size from node descriptor
+ * @brief Gets maximum incoming transfer size from node descriptor.
* @details The maximum transfer size field of the node descriptor is sixteen bits in
* length, with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum
* size, in octets, of the application sub-layer data unit (ASDU) that can be transferred
unsigned short* maximum_incoming_transfer_size);
/**
- * @brief Sets maximum incoming transfer size to node descriptor
+ * @brief Sets maximum incoming transfer size to node descriptor.
* @details The maximum transfer size field of the node descriptor is sixteen bits in
* length, with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum
* size, in octets, of the application sub-layer data unit (ASDU) that can be transferred
unsigned short maximum_incoming_transfer_size);
/**
- * @brief Gets server mask from node descriptor
+ * @brief Gets server mask from node descriptor.
* @details The server mask field of the node descriptor is sixteen bits in length,
* with bit settings signifying the system server capabilities of this node. \n\n
* It is used to facilitate discovery of particular system servers by other nodes on the
unsigned short* server_mask);
/**
- * @brief Sets server mask to node descriptor
+ * @brief Sets server mask to node descriptor.
* @details The server mask field of the node descriptor is sixteen bits in length,
* with bit settings signifying the system server capabilities of this node. \n\n
* It is used to facilitate discovery of particular system servers by other nodes on the
unsigned short server_mask);
/**
- * @brief Gets maximum outgoing transfer size from node descriptor
+ * @brief Gets maximum outgoing transfer size from node descriptor.
* @details The maximum transfer size field of the node descriptor is sixteen bits in,
* length with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum size,
* in octets, of the application sub-layer data unit (ASDU) that can be transferred from
unsigned short* maximum_outgoing_transfer_size);
/**
- * @brief Sets maximum outgoing transfer size to node descriptor
+ * @brief Sets maximum outgoing transfer size to node descriptor.
* @details The maximum transfer size field of the node descriptor is sixteen bits in,
* length with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum size,
* in octets, of the application sub-layer data unit (ASDU) that can be transferred from
unsigned short maximum_outgoing_transfer_size);
/**
- * @brief Gets descriptor capability from node descriptor
+ * @brief Gets descriptor capability from node descriptor.
* @details The descriptor capability field of the node descriptor is eight bits in length
* , with bit settings signifying the descriptor capabilities of this node. \n\n
* It is used to facilitate discovery of particular features of the descriptor fields by
unsigned short* descriptor_capability_field);
/**
- * @brief Sets descriptor capability to node descriptor
+ * @brief Sets descriptor capability to node descriptor.
* @details The descriptor capability field of the node descriptor is eight bits in length
* , with bit settings signifying the descriptor capabilities of this node. \n\n
* It is used to facilitate discovery of particular features of the descriptor fields by
unsigned short descriptor_capability_field);
/**
- * @brief Gets extended pan id from network list record
+ * @brief Gets extended pan id from network list record.
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
ieee_addr extended_pan_id);
/**
- * @brief Gets logical channel number from network list record
+ * @brief Gets logical channel number from network list record.
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has multiple network_list_record.
* \n\n Therefore this function can help parsing parameter in network_list_record.
unsigned char* logical_channel);
/**
- * @brief Gets ZigBee version from network list record
+ * @brief Gets ZigBee version from network list record.
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* zigbee_version);
/**
- * @brief Gets stack profile from network list record
+ * @brief Gets stack profile from network list record.
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* stack_profile);
/**
- * @brief Gets beacon order from network list record
+ * @brief Gets beacon order from network list record.
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* beacon_order);
/**
- * @brief Gets superframe order from network list record
+ * @brief Gets superframe order from network list record.
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* superframe_order);
/**
- * @brief Gets permit joining from network list record
+ * @brief Gets permit joining from network list record.
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* permit_joining);
/**
- * @brief Gets destination address from routing table record
+ * @brief Gets destination address from routing table record.
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
nwk_addr* dst_addr);
/**
- * @brief Gets status bits (3bit) from routing table record
+ * @brief Gets status bits (3bit) from routing table record.
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
unsigned char* status);
/**
- * @brief Gets memory constrained (1bit) from routing table record
+ * @brief Gets memory constrained (1bit) from routing table record.
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
zb_zdo_routing_table_h handle, unsigned char* memory_constrained);
/**
- * @brief Gets many-to-one (1bit) from routing table record
+ * @brief Gets many-to-one (1bit) from routing table record.
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
unsigned char* many_to_one);
/**
- * @brief Gets routing record required (1bit) from routing table record
+ * @brief Gets routing record required (1bit) from routing table record.
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
zb_zdo_routing_table_h handle, unsigned char* route_record_required);
/**
- * @brief Gets next hop address from routing table record
+ * @brief Gets next hop address from routing table record.
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
zb_zdo_routing_table_h handle, nwk_addr* next_hop_addr);
/**
- * @brief Gets extended pan id from neighbor table list record
+ * @brief Gets extended pan id from neighbor table list record.
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
* @see zb_neighbor_table_desc_get_device_type()
* @see zb_neighbor_table_desc_get_rx_on_when_idle()
* @see zb_neighbor_table_desc_get_relationship()
- * @see zb_neighbor_table_desc_get_permit_joining
+ * @see zb_neighbor_table_desc_get_permit_joining()
* @see zb_neighbor_table_desc_get_depth()
* @see zb_neighbor_table_desc_get_lqi()
*/
ieee_addr extended_pan_id);
/**
- * @brief Gets IEEE address from neighbor table list record
+ * @brief Gets IEEE address from neighbor table list record.
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
* @see zb_neighbor_table_desc_get_device_type()
* @see zb_neighbor_table_desc_get_rx_on_when_idle()
* @see zb_neighbor_table_desc_get_relationship()
- * @see zb_neighbor_table_desc_get_permit_joining
+ * @see zb_neighbor_table_desc_get_permit_joining()
* @see zb_neighbor_table_desc_get_depth()
* @see zb_neighbor_table_desc_get_lqi()
*/
ieee_addr addr64);
/**
- * @brief Gets network address from neighbor table list record
+ * @brief Gets network address from neighbor table list record..
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
nwk_addr* addr16);
/**
- * @brief Gets device type from neighbor table list record
+ * @brief Gets device type from neighbor table list record..
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
* @see zb_neighbor_table_desc_get_device_type()
* @see zb_neighbor_table_desc_get_rx_on_when_idle()
* @see zb_neighbor_table_desc_get_relationship()
- * @see zb_neighbor_table_desc_get_permit_joining
+ * @see zb_neighbor_table_desc_get_permit_joining()
* @see zb_neighbor_table_desc_get_depth()
* @see zb_neighbor_table_desc_get_lqi()
*/
unsigned char* device_type);
/**
- * @brief Gets RxOnWhenIdle value from neighbor table list record
+ * @brief Gets RxOnWhenIdle value from neighbor table list record..
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
* @see zb_neighbor_table_desc_get_device_type()
* @see zb_neighbor_table_desc_get_rx_on_when_idle()
* @see zb_neighbor_table_desc_get_relationship()
- * @see zb_neighbor_table_desc_get_permit_joining
+ * @see zb_neighbor_table_desc_get_permit_joining()
* @see zb_neighbor_table_desc_get_depth()
* @see zb_neighbor_table_desc_get_lqi()
*/
unsigned char* rx_on_when_idle);
/**
- * @brief Gets Relationship value from neighbor table list record
+ * @brief Gets Relationship value from neighbor table list record.
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
unsigned char* relationship);
/**
- * @brief Gets Permit joining value from neighbor table list record
+ * @brief Gets Permit joining value from neighbor table list record.
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
* @see zb_neighbor_table_desc_get_device_type()
* @see zb_neighbor_table_desc_get_rx_on_when_idle()
* @see zb_neighbor_table_desc_get_relationship()
- * @see zb_neighbor_table_desc_get_permit_joining
+ * @see zb_neighbor_table_desc_get_permit_joining()
* @see zb_neighbor_table_desc_get_depth()
* @see zb_neighbor_table_desc_get_lqi()
*/
unsigned char* permit_joining);
/**
- * @brief Gets Depth value from neighbor table list record
+ * @brief Gets Depth value from neighbor table list record.
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
* @see zb_neighbor_table_desc_get_device_type()
* @see zb_neighbor_table_desc_get_rx_on_when_idle()
* @see zb_neighbor_table_desc_get_relationship()
- * @see zb_neighbor_table_desc_get_permit_joining
+ * @see zb_neighbor_table_desc_get_permit_joining()
* @see zb_neighbor_table_desc_get_depth()
* @see zb_neighbor_table_desc_get_lqi()
*/
unsigned char* depth);
/**
- * @brief Gets LQI(Link-Quality Indicator) value from neighbor table list record
+ * @brief Gets LQI (Link-Quality Indicator) value from neighbor table list record.
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
* @see zb_neighbor_table_desc_get_device_type()
* @see zb_neighbor_table_desc_get_rx_on_when_idle()
* @see zb_neighbor_table_desc_get_relationship()
- * @see zb_neighbor_table_desc_get_permit_joining
+ * @see zb_neighbor_table_desc_get_permit_joining()
* @see zb_neighbor_table_desc_get_depth()
* @see zb_neighbor_table_desc_get_lqi()
*/
unsigned char* lqi);
/**
- * @brief Gets source MAC address from binding table record
+ * @brief Gets source MAC address from binding table record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
ieee_addr src_addr);
/**
- * @brief Gets SrcEndpoint from binding table record
+ * @brief Gets SrcEndpoint from binding table record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned char *src_ep);
/**
- * @brief Gets ClusterId from binding table record
+ * @brief Gets ClusterId from binding table record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned short *cluster_id);
/**
- * @brief Gets DstAddrMode from binding table record
+ * @brief Gets DstAddrMode from binding table record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned char *dst_addr_mode);
/**
- * @brief Gets DstAddr from binding table record
+ * @brief Gets nwk DstAddr from binding table record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
nwk_addr *addr16);
/**
- * @brief Gets DstAddr from binding table record
+ * @brief Gets ieee DstAddr from binding table record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
ieee_addr addr64);
/**
- * @brief Gets DstEndPoint from binding table record
+ * @brief Gets DstEndPoint from binding table record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned char *dst_ep);
/**
- * @brief Gets ExtendedAddress from discovery cache record
+ * @brief Gets ExtendedAddress from discovery cache record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Cache_rsp (ClusterID = 0x8037) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in discovery cache list record.
ieee_addr addr64);
/**
- * @brief Gets NetworkAddress from discovery cache record
+ * @brief Gets NetworkAddress from discovery cache record.
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Cache_rsp (ClusterID = 0x8037) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in discovery cache list record.
* @}
*/
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZDO_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_ALARM_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_ALARM_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ALARM_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ALARM_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Called after 'get alarm' command
+ * @brief Called after 'get alarm' command.
* @details The get alarm response command returns the results of a request to retrieve
* information from the alarm log, along with a time stamp indicating when the
* alarm situation was detected.
*/
/**
- * @brief Sends 'reset alarm' command
+ * @brief Sends 'reset alarm' command.
* @details This command resets a specific alarm. This is needed for some alarms that do
* not reset automatically. If the alarm condition being reset was in fact still active
* then a new notification will be generated and, where implemented, a new record added
unsigned short cluster_id);
/**
- * @brief Sends 'reset all alarm' command
+ * @brief Sends 'reset all alarm' command.
* @details This command resets all alarms. Any alarm conditions that were in fact still
* active will cause a new notification to be generated and, where implemented, a new
* record added to the alarm log.
unsigned char ep);
/**
- * @brief Sends 'get alarm' coommand
+ * @brief Sends 'get alarm' coommand.
* @details This command causes the alarm with the earliest timestamp in the alarm table
* to be reported in a get alarm response command 3.11.2.5.2. This command enables
* the reading of logged alarm conditions from the alarm table. Once an alarm
void *user_data);
/**
- * @brief Sends 'reset all alarm log' command
+ * @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
*
* @return 0 on success, otherwise a negative error value.
* @retval #ZIGBEE_ERROR_NONE Successful
+ * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
* @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*/
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_ALARM_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ALARM_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_IDS_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_IDS_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ATTRIBUTE_IDS_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ATTRIBUTE_IDS_H__
/**
* @file zb_zcl_attribute_ids.h
*/
/**
- * @brief Attribute types for cluster: Basic
+ * @brief Attribute types for cluster: Basic.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_VERSION_ATTRIBUTE_ID = 0x0000, /**< Version */
} zb_zcl_basic_server_attributes_e;
/**
- * @brief Attribute types for cluster: Power Configuration
+ * @brief Attribute types for cluster: Power Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_MAINS_VOLTAGE_ATTRIBUTE_ID = 0x0000, /**< Mains voltage */
} zb_zcl_power_configuration_server_attributes_e;
/**
- * @brief Attribute types for cluster: Device Temperature Configuration
+ * @brief Attribute types for cluster: Device Temperature Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_CURRENT_TEMPERATURE_ATTRIBUTE_ID = 0x0000, /**< Current temperature */
} zb_zcl_device_temperature_configuration_server_attributes_e;
/**
- * @brief Attribute types for cluster: Identify
+ * @brief Attribute types for cluster: Identify.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_IDENTIFY_TIME_ATTRIBUTE_ID = 0x0000, /**< Identity time */
} zb_zcl_identify_server_attributes_e;
/**
- * @brief Attribute types for cluster: Groups
+ * @brief Attribute types for cluster: Groups.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_GROUP_NAME_SUPPORT_ATTRIBUTE_ID = 0x0000, /**< Group name support */
} zb_zcl_group_server_attributes_e;
/**
- * @brief Attribute types for cluster: Scenes
+ * @brief Attribute types for cluster: Scenes.
* @details Cluster specification level: zcl-1.0-07-5123-03\n
- *
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_SCENE_COUNT_ATTRIBUTE_ID = 0x0000, /**< Scene count */
} zb_zcl_scenes_server_attributes_e;
/**
- * @brief Attribute types for cluster: On/off
+ * @brief Attribute types for cluster: On/off.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_ON_OFF_ATTRIBUTE_ID = 0x0000, /**< On/off */
} zb_zcl_on_off_server_attributes_e;
/**
- * @brief Attribute types for cluster: On/off Switch Configuration
+ * @brief Attribute types for cluster: On/off Switch Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_SWITCH_TYPE_ATTRIBUTE_ID = 0x0000, /**< Switch type */
} zb_zcl_on_off_switc_configuration_server_attributes_e;
/**
- * @brief Attribute types for cluster: Level Control
+ * @brief Attribute types for cluster: Level Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_CURRENT_LEVEL_ATTRIBUTE_ID = 0x0000, /**< Current level */
} zb_zcl_level_control_server_attributes_e;
/**
- * @brief Attribute types for cluster: Alarms
+ * @brief Attribute types for cluster: Alarms.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_ALARM_COUNT_ATTRIBUTE_ID = 0x0000, /**< alarm count */
} zb_zcl_alarms_server_attributes_e;
/**
- * @brief Attribute types for cluster: Time
+ * @brief Attribute types for cluster: Time.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_TIME_ATTRIBUTE_ID = 0x0000, /**< Time */
} zb_zcl_time_server_attributes_e;
/**
- * @brief Attribute types for cluster: RSSI Location
+ * @brief Attribute types for cluster: RSSI Location.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_LOCATION_TYPE_ATTRIBUTE_ID = 0x0000, /**< Location type */
} zb_zcl_rssi_location_server_attributes_e;
/**
- * @brief Attribute types for cluster: Binary Input (Basic)
+ * @brief Attribute types for cluster: Binary Input (Basic).
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_ACTIVE_TEXT_ATTRIBUTE_ID = 0x0004, /**< Active text */
} zb_zcl_binary_input_basic_server_attributes_e;
/**
- * @brief Attribute types for cluster: Commissioning
+ * @brief Attribute types for cluster: Commissioning.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_SHORT_ADDRESS_ATTRIBUTE_ID = 0x0000, /**< Short address */
} zb_zcl_commissioning_server_attributes_e;
/**
- * @brief Attribute types for cluster: Partition
+ * @brief Attribute types for cluster: Partition.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_PARTITION_MAXIMUM_INCOMING_TRANSFER_SIZE_ATTRIBUTE_ID = 0x0000, /**< Partition maximum incoming transfer size */
} zb_zcl_partition_server_attributes_e;
/**
- * @brief Attribute types for cluster: Over the Air Bootloading
+ * @brief Attribute types for cluster: Over the Air Bootloading.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_UPGRADE_SERVER_ID_ATTRIBUTE_ID = 0x0000, /**< Upgrade server ID */
} zb_zcl_over_the_air_bootloading_client_attributes_e;
/**
- * @brief Attribute types for cluster: Power Profile
+ * @brief Attribute types for cluster: Power Profile.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_TOTAL_PROFILE_NUM_ATTRIBUTE_ID = 0x0000, /**< Total profile number */
} zb_zcl_power_profile_server_attributes_e;
/**
- * @brief Attribute types for cluster: Appliance Control
+ * @brief Attribute types for cluster: Appliance Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_START_TIME_ATTRIBUTE_ID = 0x0000, /**< Start time */
} zb_zcl_appliance_control_server_attributes_e;
/**
- * @brief Attribute types for cluster: Poll Control
+ * @brief Attribute types for cluster: Poll Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_CHECK_IN_INTERVAL_ATTRIBUTE_ID = 0x0000, /**< Check-in interval */
} zb_zcl_poll_control_server_attributes_e;
/**
- * @brief Attribute types for cluster: Shade Configuration
+ * @brief Attribute types for cluster: Shade Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_SHADE_CONFIG_PHYSICAL_CLOSED_LIMIT_ATTRIBUTE_ID = 0x0000, /**< Shade config physical close limit */
} zb_zcl_shade_configuration_server_attributes_e;
/**
- * @brief Attribute types for cluster: Door Lock
+ * @brief Attribute types for cluster: Door Lock.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_LOCK_STATE_ATTRIBUTE_ID = 0x0000, /**< Lock state */
} zb_zcl_door_lock_server_attributes_e;
/**
- * @brief Attribute types for cluster: Window Covering
+ * @brief Attribute types for cluster: Window Covering.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_COVERING_TYPE_ATTRIBUTE_ID = 0x0000, /**< Covering type */
} zb_zcl_window_covering_server_attributes_e;
/**
- * @brief Attribute types for cluster: Pump Configuration and Control
+ * @brief Attribute types for cluster: Pump Configuration and Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_MAX_PRESSURE_ATTRIBUTE_ID = 0x0000, /**< Max. pressure */
} zb_zcl_pump_configuration_and_control_server_attributes_e;
/**
- * @brief Attribute types for cluster: Thermostat
+ * @brief Attribute types for cluster: Thermostat.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_LOCAL_TEMPERATURE_ATTRIBUTE_ID = 0x0000, /**< Local temperature */
} zb_zcl_thermostat_server_attributes_e;
/**
- * @brief Attribute types for cluster: Fan Control
+ * @brief Attribute types for cluster: Fan Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_FAN_CONTROL_FAN_MODE_ATTRIBUTE_ID = 0x0000, /**< Fan mode */
} zb_zcl_fan_control_server_attributes_e;
/**
- * @brief Attribute types for cluster: Dehumidification Control
+ * @brief Attribute types for cluster: Dehumidification Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_RELATIVE_HUMIDITY_ATTRIBUTE_ID = 0x0000, /**< Relative humidity */
} zb_zcl_dehumidification_control_attributes_e;
/**
- * @brief Attribute types for cluster: Thermostat User Interface Configuration
+ * @brief Attribute types for cluster: Thermostat User Interface Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_TEMPERATURE_DISPLAY_MODE_ATTRIBUTE_ID = 0x0000, /**< Temperature display mode */
} zb_zcl_thermostat_user_interface_configuration_server_attributes_e;
/**
- * @brief Attribute types for cluster: Color Control
+ * @brief Attribute types for cluster: Color Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_COLOR_CONTROL_CURRENT_HUE_ATTRIBUTE_ID = 0x0000, /**< Current hue */
} zb_zcl_color_control_server_attributes_e;
/**
- * @brief Attribute types for cluster: Ballast Configuration
+ * @brief Attribute types for cluster: Ballast Configuration.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_PHYSICAL_MIN_LEVEL_ATTRIBUTE_ID = 0x0000, /**< Physical min. level */
} zb_zcl_ballast_configuration_server_attributes_e;
/**
- * @brief Attribute types for cluster: Illuminance Measurement
+ * @brief Attribute types for cluster: Illuminance Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_ILLUM_MEASURED_VALUE_ATTRIBUTE_ID = 0x0000, /**< Illuminance measured value */
} zb_zcl_illuminance_measurement_server_attributes_e;
/**
- * @brief Attribute types for cluster: Illuminance Level Sensing
+ * @brief Attribute types for cluster: Illuminance Level Sensing.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_ILLUS_LEVEL_STATUS_ATTRIBUTE_ID = 0x0000, /**< Illuminance level status */
} zb_zcl_illuminance_level_sensing_server_attributes_e;
/**
- * @brief Attribute types for cluster: Temperature Measurement
+ * @brief Attribute types for cluster: Temperature Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_TEMP_MEASURED_VALUE_ATTRIBUTE_ID = 0x0000, /**< Measured value */
} zb_zcl_temperature_measurement_server_attributes_e;
/**
- * @brief Attribute types for cluster: Pressure Measurement
+ * @brief Attribute types for cluster: Pressure Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_PRESSURE_MEASURED_VALUE_ATTRIBUTE_ID = 0x0000, /**< Measured value */
} zb_zcl_pressure_measurement_server_attributes_e;
/**
- * @brief Attribute types for cluster: Flow Measurement
+ * @brief Attribute types for cluster: Flow Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_FLOW_MEASURED_VALUE_ATTRIBUTE_ID = 0x0000, /**< Measured value */
} zb_zcl_flow_measurement_server_attributes_e;
/**
- * @brief Attribute types for cluster: Relative Humidity Measurement
+ * @brief Attribute types for cluster: Relative Humidity Measurement.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_RELATIVE_HUMIDITY_MEASURED_VALUE_ATTRIBUTE_ID = 0x0000, /**< Measured value */
} zb_zcl_relative_humidity_measurement_server_attributes_e;
/**
- * @brief Attribute types for cluster: Occupancy Sensing
+ * @brief Attribute types for cluster: Occupancy Sensing.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_OCCUPANCY_ATTRIBUTE_ID = 0x0000, /**< Occupancy */
} zb_zcl_occupancy_sensing_measurement_server_attributes_e;
/**
- * @brief Attribute types for cluster: IAS Zone
+ * @brief Attribute types for cluster: IAS Zone.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_ZONE_STATE_ATTRIBUTE_ID = 0x0000, /**< Zone state */
} zb_zcl_ias_zone_server_server_attributes_e;
/**
- * @brief Attribute types for cluster: IAS WD
+ * @brief Attribute types for cluster: IAS WD.
* @details Cluster specification level: zcl-1.0-07-5123-03
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_MAX_DURATION_ATTRIBUTE_ID = 0x0000, /**< Max. duration */
} zb_zcl_ias_wd_server_server_attributes_e;
/**
- * @brief Attribute types for cluster: Electrical Measurement
+ * @brief Attribute types for cluster: Electrical Measurement.
* @details Cluster specification level: UNKNOWN
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_MEASUREMENT_TYPE_ATTRIBUTE_ID = 0x0000, /**< Measurement type */
} zb_zcl_electrical_measurement_server_attributes_e;
/**
- * @brief Attribute types for cluster: Diagnostics
+ * @brief Attribute types for cluster: Diagnostics.
* @details Cluster specification level: UNKNOWN
+ * @since_tizen 4.0
* @pre Server attributes
*
- * @since_tizen 4.0
*/
typedef enum {
ZB_ZCL_NUMBER_OF_RESETS_ATTRIBUTE_ID = 0x0000, /**< Number of resets */
* @}
*/
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_IDS_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ATTRIBUTE_IDS_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_TYPE_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_TYPE_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ATTRIBUTE_TYPE_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ATTRIBUTE_TYPE_H__
/**
* @file zb_zcl_attribute_type.h
*/
/**
- * @brief ZCL attribute types (See Table 2.16 Data type of the Zigbee Cluster Library)
+ * @brief ZCL attribute types (See Table 2.16 Data type of the Zigbee Cluster Library).
* @details ZigBee devices, such as thermostats, lamps, etc., are defined in terms of the
* attributes they contain, which can be written, read or reported using the
* commands defined in clause 2.4. Table 2.16 details the data types and formats that
ZB_ZCL_SEMI_PRECISION = 0x38, /**< floating point, 2-byte */
ZB_ZCL_SINGLE_PRECISION = 0x39, /**< floating point, 4-byte */
ZB_ZCL_DOUBLE_PRECISION = 0x3a, /**< floating point, 8-byte */
- /**< Octat string, Defined in first two octat */
- ZB_ZCL_OCTAT_STRING = 0x41,
- /**< Character string, Defined in first two octat */
- ZB_ZCL_CHRACTER_STRING = 0x42,
- /**< Long octat string, Defined in first two octat */
- ZB_ZCL_LONG_OCTAT_STRING = 0x43,
- /**< Long character string, Defined in first 2-byte */
- ZB_ZCL_LONG_CHRACTER_STRING = 0x44,
- /**< Array 2(0xffff)+Sum of lengths of contents, but we ignore 2-byte prefix */
- ZB_ZCL_ARRAY = 0x48,
- /**< Structure 2(0xffff)+Sum of lengths of contents, but we ignore 2-byte prefix */
- ZB_ZCL_STRUCTURE = 0x4c,
+ ZB_ZCL_OCTAT_STRING = 0x41, /**< Octat string, Defined in first two octat */
+ ZB_ZCL_CHRACTER_STRING = 0x42, /**< Character string, Defined in first two octat */
+ ZB_ZCL_LONG_OCTAT_STRING = 0x43, /**< Long octat string, Defined in first two octat */
+ ZB_ZCL_LONG_CHRACTER_STRING = 0x44, /**< Long character string, Defined in first 2-byte */
+ ZB_ZCL_ARRAY = 0x48, /**< Array 2(0xffff)+Sum of lengths of contents, but we ignore 2-byte prefix */
+ ZB_ZCL_STRUCTURE = 0x4c, /**< Structure 2(0xffff)+Sum of lengths of contents, but we ignore 2-byte prefix */
ZB_ZCL_SET = 0x50, /**< Set, Sum of lengths of contents */
ZB_ZCL_BAG = 0x51, /**< Bag, Sum of lengths of contents */
ZB_ZCL_TIME_OF_DAY = 0xe0, /**< Time of day, 4-byte */
* @}
*/
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_TYPE_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ATTRIBUTE_TYPE_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_BASIC_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_BASIC_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_BASIC_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_BASIC_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Sends 'reset factory default' command
+ * @brief Sends 'reset factory default' command.
* @details This function is aim to reset end-device as factory default settings.
*
* @since_tizen 4.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
- * @param[in] handle handle of zigbee
* @param[in] addr16 Network address
* @param[in] ep target endpoint
*
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_BASIC_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_BASIC_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_CLUSTER_IDS_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_CLUSTER_IDS_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_CLUSTER_IDS_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_CLUSTER_IDS_H__
/**
* @file zb_zcl_cluster_ids.h
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Zigbee Cluster IDs for reference
+ * @brief Zigbee Cluster IDs for reference.
*
* @since_tizen 4.0
*/
ZB_ZCL_ZLL_COMMISSIONING_CLUSTER_ID = 0x1000, /**< ZLL Commissioning Cluster */
} zb_zcl_cluster_ids_e;
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_CLUSTER_IDS_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_CLUSTER_IDS_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_COLOR_CONTROL_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_COLOR_CONTROL_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_COLOR_CONTROL_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_COLOR_CONTROL_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Sends 'move to hue' command
+ * @brief Sends 'move to hue' command.
* @details On receipt of this command, a device shall also set the ColorMode attribute to the
* value 0x00 and then shall move from its current hue to the value given in the Hue
* field. \n\n
unsigned short transition_time);
/**
- * @brief Sends 'move hue' command
+ * @brief Sends 'move hue' command.
* @details On receipt of this command, a device shall set the ColorMode attribute to the
* value 0x00 and shall then move from its current hue in an up or down direction in
* a continuous fashion.
unsigned char rate);
/**
- * @brief Sends 'step hue' command
+ * @brief Sends 'step hue' command.
* @details On receipt of this command, a device shall set the ColorMode attribute to the
* value 0x00 and shall then move from its current hue in an up or down direction by
* one step.
unsigned char transition_time);
/**
- * @brief Sends 'move to saturation' command
+ * @brief Sends 'move to saturation' command.
* @details On receipt of this command, a device set the ColorMode attribute to the value
* 0x00 and shall then move from its current saturation to the value given in the
* Saturation field.\n\n
unsigned short transition_time);
/**
- * @brief Sends 'move saturation' command
+ * @brief Sends 'move saturation' command.
* @details On receipt of this command, a device shall set the ColorMode attribute to the
* value 0x00 and shall then move from its current saturation in an up or down
* direction in a continuous fashion.\n]n
unsigned char rate);
/**
- * @brief Sends 'step saturation' command
+ * @brief Sends 'step saturation' command.
* @details On receipt of this command, a device shall set the ColorMode attribute to the
* value 0x00 and shall then move from its current saturation in an up or down
* direction in a continuous fashion.\n]n
unsigned char transition_time);
/**
- * @brief Sends 'move to hue and saturation' command
+ * @brief Sends 'move to hue and saturation' command.
* @details On receipt of this command, a device shall set the ColorMode attribute to the
* value 0x00 and shall then move from its current hue and saturation to the values
* given in the Hue and Saturation fields.\n\n
unsigned short transition_time);
/**
- * @brief Sends 'move to color' command
+ * @brief Sends 'move to color' command.
* @details On receipt of this command, a device shall set the value of the ColorMode
* attribute, where implemented, to 0x01, and shall then move from its current color
* to the color given in the ColorX and ColorY fields.\n\n
unsigned short transition_time);
/**
- * @brief Sends 'move color' commmand
+ * @brief Sends 'move color' commmand.
* @details On receipt of this command, a device shall set the value of the ColorMode
* attribute, where implemented, to 0x01, and shall then move from its current color
* in a continuous fashion according to the rates specified. This movement shall
unsigned short rate_y);
/**
- * @brief Sends 'step color' command
+ * @brief Sends 'step color' command.
* @details On receipt of this command, a device shall set the value of the ColorMode
* attribute, where implemented, to 0x01, and shall then move from its current color
* by the color step indicated.\n\n
unsigned short transition_time);
/**
- * @brief Sends 'move to color temperature' command
+ * @brief Sends 'move to color temperature' command.
* @details On receipt of this command, a device shall set the value of the ColorMode
* attribute, where implemented, to 0x02, and shall then move from its current color
* to the color given by the Color Temperature field.\n\n
* @}
*/
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_COLOR_CONTROL_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_COLOR_CONTROL_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_COMMAND_IDS_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_COMMAND_IDS_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_COMMANDS_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_COMMANDS_H__
/**
* @file zb_zcl_commands.h
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Global commands (Either direction)
+ * @brief Global commands (Either direction).
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Basic
+ * @brief Command types for cluster: Basic.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to server
+ *
*/
typedef enum {
ZB_ZCL_RESET_TO_FACTORY_DEFAULTS_COMMAND_ID = 0x00, /**< Reset to factory default mode */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Identify
+ * @brief Command types for cluster: Identify.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to client
+ *
*/
typedef enum {
ZB_ZCL_IDENTIFY_QUERY_RESPONSE_COMMAND_ID = 0x00, /**< Identify query response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Identify
+ * @brief Command types for cluster: Identify.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to server
+ *
*/
typedef enum {
ZB_ZCL_IDENTIFY_COMMAND_ID = 0x00, /**< Identify */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Groups
+ * @brief Command types for cluster: Groups.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_ADD_GROUP_RESPONSE_COMMAND_ID = 0x00, /**< Add group response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Groups
+ * @brief Command types for cluster: Groups.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to server
+ *
*/
typedef enum {
ZB_ZCL_ADD_GROUP_COMMAND_ID = 0x00, /**< Add group */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Scenes
+ * @brief Command types for cluster: Scenes.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_ADD_SCENE_RESPONSE_COMMAND_ID = 0x00, /**< Add scene response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Scenes
+ * @brief Command types for cluster: Scenes.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_ADD_SCENE_COMMAND_ID = 0x00, /**< Add scene */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: On/off
+ * @brief Command types for cluster: On/off.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_OFF_COMMAND_ID = 0x00, /**< Off */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Level Control
+ * @brief Command types for cluster: Level Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_MOVE_TO_LEVEL_COMMAND_ID = 0x00, /**< Move to level */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Alarms
+ * @brief Command types for cluster: Alarms Server side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_ALARM_COMMAND_ID = 0x00, /**< Alarm */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Alarms
+ * @brief Command types for cluster: Alarms Client side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_RESET_ALARM_COMMAND_ID = 0x00, /**< Reset alarm */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: RSSI Location
+ * @brief Command types for cluster: RSSI Location Server side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_DEVICE_CONFIGURATION_RESPONSE_COMMAND_ID = 0x00, /**< Device configuration response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: RSSI Location
+ * @brief Command types for cluster: RSSI Location Client side.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_SET_ABSOLUTE_LOCATION_COMMAND_ID = 0x00, /**< Set absolute location */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Commissioning
+ * @brief Command types for cluster: Commissioning.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_RESTART_DEVICE_RESPONSE_COMMAND_ID = 0x00, /**< Restart device response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Commissioning
+ * @brief Command types for cluster: Commissioning.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_RESTART_DEVICE_COMMAND_ID = 0x00, /**< Restart device */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Partition
+ * @brief Command types for cluster: Partition.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_MULTIPLE_ACK_COMMAND_ID = 0x00, /**< Multiple ACK */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Partition
+ * @brief Command types for cluster: Partition.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_TRANSFER_PARTITIONED_FRAME_COMMAND_ID = 0x00, /**< Transfer partitioned frame */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Over the Air Bootloading
+ * @brief Command types for cluster: Over the Air Bootloading.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_IMAGE_NOTIFY_COMMAND_ID = 0x00, /**< Image notify */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Over the Air Bootloading
+ * @brief Command types for cluster: Over the Air Bootloading.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_QUERY_NEXT_IMAGE_REQUEST_COMMAND_ID = 0x01, /**< Query next image request */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Power Profile
+ * @brief Command types for cluster: Power Profile.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_POWER_PROFILE_NOTIFICATION_COMMAND_ID = 0x00, /**< Power profile notification */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Power Profile
+ * @brief Command types for cluster: Power Profile.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_POWER_PROFILE_REQUEST_COMMAND_ID = 0x00, /**< Power profile request */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Appliance Control
+ * @brief Command types for cluster: Appliance Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_SIGNAL_STATE_RESPONSE_COMMAND_ID = 0x00, /**< Signal state response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Appliance Control
+ * @brief Command types for cluster: Appliance Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_EXECUTION_OF_A_COMMAND_COMMAND_ID = 0x00, /**< Execution of a command */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Poll Control
+ * @brief Command types for cluster: Poll Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_CHECK_IN_COMMAND_ID = 0x00, /**< Check-in */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Poll Control
+ * @brief Command types for cluster: Poll Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_CHECK_IN_RESPONSE_COMMAND_ID = 0x00, /**< Check-in response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Door Lock
+ * @brief Command types for cluster: Door Lock.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_LOCK_DOOR_RESPONSE_COMMAND_ID = 0x00, /**< Lock door response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Door Lock
+ * @brief Command types for cluster: Door Lock.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_LOCK_DOOR_COMMAND_ID = 0x00, /**< Lock door */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Window Covering
+ * @brief Command types for cluster: Window Covering.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
- ZB_ZCL_WINDOW_COVERING_UP_OPEN_COMMAND_ID = 0x00, /**< Window covering up(open) */
- ZB_ZCL_WINDOW_COVERING_DOWN_CLOSE_COMMAND_ID = 0x01, /**< Window covering down(close) */
+ ZB_ZCL_WINDOW_COVERING_UP_OPEN_COMMAND_ID = 0x00, /**< Window covering up (open) */
+ ZB_ZCL_WINDOW_COVERING_DOWN_CLOSE_COMMAND_ID = 0x01, /**< Window covering down (close) */
ZB_ZCL_WINDOW_COVERING_STOP_COMMAND_ID = 0x02, /**< Window covering stop */
ZB_ZCL_WINDOW_COVERING_GO_TO_LIFT_VALUE_COMMAND_ID = 0x04, /**< Window covering go to lift value */
ZB_ZCL_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE_COMMAND_ID = 0x05, /**< Window covering go to lift percentage */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Thermostat
+ * @brief Command types for cluster: Thermostat.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_CURRENT_WEEKLY_SCHEDULE_COMMAND_ID = 0x00, /**< Current weekly schedule (since ha-1.2-05-3520-29) */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Thermostat
+ * @brief Command types for cluster: Thermostat.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_SETPOINT_RAISE_LOWER_COMMAND_ID = 0x00, /**< Setpoint raise or lower */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Color Control
+ * @brief Command types for cluster: Color Control.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_MOVE_TO_HUE_COMMAND_ID = 0x00, /**< Move to hue */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: IAS Zone
+ * @brief Command types for cluster: IAS Zone.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_ZONE_STATUS_CHANGE_NOTIFICATION_COMMAND_ID = 0x00, /**< Zone status change notification */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: IAS Zone
+ * @brief Command types for cluster: IAS Zone.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_ZONE_ENROLL_RESPONSE_COMMAND_ID = 0x00, /**< Zone enroll response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: IAS ACE
+ * @brief Command types for cluster: IAS ACE.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_ARM_RESPONSE_COMMAND_ID = 0x00, /**< Arm response */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: IAS ACE
+ * @brief Command types for cluster: IAS ACE.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_ARM_COMMAND_ID = 0x00, /**< Arm */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: IAS WD
+ * @brief Command types for cluster: IAS WD.
* @details Cluster specification level: zcl-1.0-07-5123-03
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_START_WARNING_COMMAND_ID = 0x00, /**< Start warning */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Electrical Measurement
+ * @brief Command types for cluster: Electrical Measurement.
* @details Cluster specification level: UNKNOWN
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_GET_PROFILE_INFO_RESPONSE_COMMAND_COMMAND_ID = 0x00, /**< Get profile info. response command */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: Electrical Measurement
+ * @brief Command types for cluster: Electrical Measurement.
* @details Cluster specification level: UNKNOWN
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_GET_PROFILE_INFO_COMMAND_COMMAND_ID = 0x00, /**< Get profile info. command */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: ZLL Commissioning
+ * @brief Command types for cluster: ZLL Commissioning.
* @details Cluster specification level: zll-1.0-11-0037-10
- * @remark Direction : Server to Client
- *
* @since_tizen 4.0
+ * @remarks Direction : Server to Client
+ *
*/
typedef enum {
ZB_ZCL_SCAN_RESPONSE_COMMAND_ID = 0x01, /**< Scan response (since zll-1.0-11-0037-10) */
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Command types for cluster: ZLL Commissioning
+ * @brief Command types for cluster: ZLL Commissioning.
* @details Cluster specification level: zll-1.0-11-0037-10
- * @remark Direction : Client to Server
- *
* @since_tizen 4.0
+ * @remarks Direction : Client to Server
+ *
*/
typedef enum {
ZB_ZCL_SCAN_REQUEST_COMMAND_ID = 0x00, /**< Scan request (since zll-1.0-11-0037-10) */
} zb_zcl_zll_commissioning_client_commands_e;
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_COMMAND_IDS_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_COMMANDS_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_GLOBAL_COMMANDS_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_GLOBAL_COMMANDS_H__
#include <zb_type.h>
#include <zb_error.h>
*/
/**
- * @brief Called when receiving general response
+ * @brief Called when receiving general response.
* @details This function is used for global response corresponding.
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Sends 'reads attributes' commands
+ * @brief Sends 'reads attributes' commands.
* @details This function to read attributes in devices.
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Sends 'write Attributes' command
+ * @brief Sends 'write Attributes' command.
* @details This function to write attributes to other devices.
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Sends 'write attributes undivided' command
+ * @brief Sends 'write attributes undivided' command.
* @details This function to write attributes without fragmentation to other devices.
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Sends 'write Attributes' command
+ * @brief Sends 'write Attributes' command.
* @details This function to write attributes to other devices without any response.
*
* @since_tizen 4.0
int records_len);
/**
- * @brief Sends 'setting configure reporting' command
+ * @brief Sends 'setting configure reporting' command.
* @details This function to set configuration about attribute status changing reporting.
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Sends 'reading configure reporting' command
+ * @brief Sends 'reading configure reporting' command.
* @details This function to read configuration about attribute status changing reporting.
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Called after 'discover attribute' command
+ * @brief Called after 'discover attribute' command.
* @details The discover attributes response command is generated in response to a discover
* attributes command.
*
* @param[in] addr16 source network address
* @param[in] ep where is sent from (ex. 1)
* @param[in] cluster_id ZCL cluster id
+ * @param[in] discovery_complete Discovery complete
* @param[in] records Discover attribute information record
* @param[in] records_len Length of Discover attribute information record
* @param[in] user_data User data
void *user_data);
/**
- * @brief Sends 'discovering attributes' command
+ * @brief Sends 'discovering attributes' command.
* @details The discover attributes command is generated when a remote device wishes to
* discover the identifiers and types of the attributes on a device which are supported
* within the cluster to which this command is directed.
/**
* @brief Called after zb_zcl_global_discover_commands_received() and
- * zb_zcl_global_discover_cmds_generated()
+ * zb_zcl_global_discover_cmds_generated().
* @details The ZCL provides the facility to discover the commands that a cluster
* instance on a remote device can receive and generate. This is useful since an
* individual cluster instance may not be able to receive or generate all of the commands
void *user_data);
/**
- * @brief Sends 'discover command recevied' command
+ * @brief Sends 'discover command recevied' command.
* @details This function to know remote cluster on remote device can handle specific commands.
* The ZCL provides the facility to discover the commands that a cluster
* instance on a remote device can receive and generate. This is useful since an
void *user_data);
/**
- * @brief Sends 'discover command generated' command
+ * @brief Sends 'discover command generated' command.
* @details The ZCL provides the facility to discover the commands that a cluster
* instance on a remote device can receive and generate. This is useful since an
* individual cluster instance may not be able to receive or generate all of the commands
void *user_data);
/**
- * @brief Called after zb_zcl_global_discover_attr_extended()
+ * @brief Called after zb_zcl_global_discover_attr_extended().
* @details The ZCL provides the facility to discover the commands that a cluster
* instance on a remote device can receive and generate. This is useful since an
* individual cluster instance may not be able to receive or generate all of the commands
void *user_data);
/**
- * @brief Sends 'discover attributes extended' command
+ * @brief Sends 'discover attributes extended' command.
* @details This function to know remote cluster on remote device has extended commands.
* The ZCL provides the facility to discover the commands that a cluster
* instance on a remote device can receive and generate. This is useful since an
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_GLOBAL_COMMANDS_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_GROUPS_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_GROUPS_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_GROUPS_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_GROUPS_CLUSTER_H__
#ifdef __cplusplus
extern "C" {
*/
/**
- * @brief Called after 'add group' command
+ * @brief Called after 'add group' command.
* @details The add group response is sent by the groups cluster server in response to an\n
* add group command.\n
*
void *user_data);
/**
- * @brief Called after 'view group' command
+ * @brief Called after 'view group' command.
* @details The view group response command is sent by the groups cluster server in\n
* response to a view group command.\n
*
void *user_data);
/**
- * @brief Called after 'view group membership' command
+ * @brief Called after 'view group membership' command.
* @details The get group membership response command is sent by the groups cluster server\n
* in response to a get group membership command.\n
*
void *user_data);
/**
- * @brief Called after 'remove group' command
+ * @brief Called after 'remove group' command.
* @details The add group response is sent by the groups cluster server in response to an\n
* remove group command.\n
*
*/
/**
- * @brief Sends 'add groups' command
+ * @brief Sends 'add groups' command.
* @details The add group command allows the sending device to add group membership in a\n
* particular group for one or more endpoints on the receiving device.\n
*
void *user_data);
/**
- * @brief Sends 'view group' command
+ * @brief Sends 'view group' command.
* @details The view group command allows the sending device to request that the receiving\n
* entity or entities respond with a view group response command containing the\n
* application name string for a particular group.\n
void *user_data);
/**
- * @brief Sends 'get group membership' command
+ * @brief Sends 'get group membership' command.
* @details The get group membership command allows the sending device to inquire about\n
* the group membership of the receiving device and endpoint in a number of ways.\n
*
void *user_data);
/**
- * @brief Sends 'remove group' command
+ * @brief Sends 'remove group' command.
* @details The remove group command allows the sender to request that the receiving entity\n
* or entities remove their membership, if any, in a particular group.\n
* Note that if a group is removed the scenes associated with that group should be\n
void *user_data);
/**
- * @brief Sends 'remove group' command
+ * @brief Sends 'remove group' command.
* @details The remove all groups command allows the sending device to direct the receiving\n
* entity or entities to remove all group associations.\n
* \n
unsigned char ep);
/**
- * @brief Sends 'remove group if identifying' command
+ * @brief Sends 'remove group if identifying' command.
* @details The add group if identifying command allows the sending device to add group\n
* membership in a particular group for one or more endpoints on the receiving\n
* device, on condition that it is identifying itself. Identifying functionality is\n
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_ON_OFF_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_GROUPS_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_IAS_ZONE_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_IAS_ZONE_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_IAS_ZONE_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_IAS_ZONE_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Table 8.9 Values of the Enroll Response Code in Zigbee Cluster Library
+ * @brief Table 8.9 Values of the Enroll Response Code in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
} zb_ias_zone_enroll_response_e;
/**
- * @brief Sends 'zone enroll response' command
+ * @brief Sends 'zone enroll response' command.
* @details On receipt, the device embodying the Zone server is notified that it is now
* enrolled as an active alarm device.\n
* The device embodying the Zone server must authenticate received messages by
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_IAS_ZONE_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_IAS_ZONE_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_IDENTIFY_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_IDENTIFY_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_IDENTIFY_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_IDENTIFY_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Makes devices as Identify mode within specific time
+ * @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
unsigned short identify_time);
/**
- * @brief Called after receiving identify query command
+ * @brief Called after receiving identify query command.
* @details The identify query command allows the sending device to request the target or
* targets to respond if they are currently identifying themselves.\n
* This command has no payload.\n
void *user_data);
/**
- * @brief Finds devices which sustains identify mode
+ * @brief Finds devices which sustains identify mode.
* @details The identify query command allows the sending device to request the target or
* targets to respond if they are currently identifying themselves.\n
* This command has no payload.\n
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_IDENTIFY_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_IDENTIFY_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_LEVEL_CONTROL_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_LEVEL_CONTROL_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_LEVEL_CONTROL_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_LEVEL_CONTROL_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Sends 'move to level' command
+ * @brief Sends 'move to level' command.
* @details On receipt of this command, a device shall move from its current level to the
* value given in the Level field. The meaning of 'level' is device dependent ? e.g.
* for a light it may mean brightness level.\n\n
unsigned short transition_time);
/**
- * @brief Sends 'move' command
+ * @brief Sends 'move' command.
* @details On receipt of this command, a device shall move from its current level in an
* up or down direction in a continuous fashion
*
unsigned char rate);
/**
- * @brief Sends 'step' command
+ * @brief Sends 'step' command.
* @details On receipt of this command, a device shall move from its current level in an
* up or down direction in a continuous fashion
*
unsigned short transition_time);
/**
- * @brief Sends 'stop' command
+ * @brief Sends 'stop' command.
* @details This command has no payload. Upon receipt of this command, any Move to
* Level, Move or Step command (and their 'with On/Off' variants) currently in
* process shall be terminated. The value of CurrentLevel shall be left at its value
unsigned char ep);
/**
- * @brief Sends 'move to level with on/off' command
+ * @brief Sends 'move to level with on/off' command.
* @details On receipt of this command, a device shall move from its current level to the
* value given in the Level field. The meaning of 'level' is device dependent ? e.g.
* for a light it may mean brightness level.\n\n
unsigned short transition_time);
/**
- * @brief Sends 'move with on/off' command
+ * @brief Sends 'move with on/off' command.
* @details On receipt of this command, a device shall move from its current level in an
* up or down direction in a continuous fashion.\n
* The Move to Level (with On/Off), Move (with On/Off) and Step (with On/Off)
unsigned char rate);
/**
- * @brief Sends 'step with on/off' command
+ * @brief Sends 'step with on/off' command.
* @details On receipt of this command, a device shall move from its current level in an
* up or down direction in a continuous fashion. \n\n
* The Move to Level (with On/Off), Move (with On/Off) and Step (with On/Off)
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_LEVEL_CONTROL_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_LEVEL_CONTROL_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_ON_OFF_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_ON_OFF_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ON_OFF_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ON_OFF_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief On/Off value
+ * @brief On/Off value.
*
* @since_tizen 4.0
*/
} zb_zcl_onoff_e;
/**
- * @brief Sends 'on/off/toogle' command
+ * @brief Sends 'on/off/toogle' command.
* @details On receipt of 'on' command, a device shall enter its 'Off' state.
* This state is device dependent, but it is recommended that it is used for power off or\n
* similar functions.\n
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_ON_OFF_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_ON_OFF_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_POLL_CONTROL_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_POLL_CONTROL_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_POLL_CONTROL_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_POLL_CONTROL_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Called after receiving 'check-in' event
+ * @brief Called after receiving 'check-in' event.
* @details The Poll Control Cluster server sends out a Check-in command to the devices to
* which it is paired based on the server's Check-inInterval attribute. It does this to
* find out if any of the Poll Control Cluster Clients with which it is paired are
*/
/**
- * @brief Sends 'check-in response'
+ * @brief Sends 'check-in response'.
* @details The Check-in Response is sent in response to the receipt of a Check-in command.\n
* The Check-in Response is used by the Poll Control Client to indicate whether it
* would like the device implementing the Poll Control Cluster Server to go into a
unsigned short fast_poll_timeout);
/**
- * @brief Sends 'fast poll stop' command
+ * @brief Sends 'fast poll stop' command.
* @details The Fast Poll Stop command is used to stop the fast poll mode initiated by the\n
* Check-in response. The Fast Poll Stop command has no payload.
*
unsigned char ep);
/**
- * @brief Sends 'set long poll interval' command
+ * @brief Sends 'set long poll interval' command.
* @details The Set Long Poll Interval command is used to set the read only LongPollInterval
* attribute.\n
* When the Poll Control Server receives the Set Long Poll Interval Command, it
void *user_data);
/**
- * @brief Sends 'set short poll interval' command
+ * @brief Sends 'set short poll interval' command.
* @details The Set Short Poll Interval command is used to set the read only
* ShortPollInterval attribute.\n
* When the Poll Control Server receives the Set Short Poll Interval Command, it
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_POLL_CONTROL_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_POLL_CONTROL_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_SCENES_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_SCENES_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_SCENES_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_SCENES_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Called after 'add scene' command
+ * @brief Called after 'add scene' command.
* @details This command is generated in response to a received Add Scene command.
* The Status field is set to SUCCESS, INSUFFICIENT_SPACE or
* INVALID_FIELD (the group is not present in the Group Table) as appropriate.
void *user_data);
/**
- * @brief Called after 'view scene' command
+ * @brief Called after 'view scene' command.
* @details This command is generated in response to a received View Scene command
* The entry in the Scene Table with Scene ID and Group ID given in the received
* View Scene command is located (if possible). The Status field is set to SUCCESS,
* @param[in] scene_id Scene id
* @param[in] transition_time Transition time
* @param[in] scene_name Scene name
- * @param[in] extension_field_sets Extension field sets, one per cluster\n
+ * @param[in] extension_field_set Extension field sets, one per cluster\n
* Extension field sets =\n
* {{ClusterID 1, length 1, {extension field set 1}},\n
* {ClusterID 2, length 2, {extension field set 2}}, ... }.
void *user_data);
/**
- * @brief Called after 'remove scene' command
+ * @brief Called after 'remove scene' command.
* @details This command is generated in response to a received Remove Scene command.
* The Status field is set to SUCCESS, NOT_FOUND (the scene is not
* present in the Scene Table) or INVALID_FIELD (the group is not present in the
void *user_data);
/**
- * @brief Called after 'remove all scene' command
+ * @brief Called after 'remove all scene' command.
* @details This command is generated in response to a received Remove All Scenes
* command. The Status field is set to SUCCESS or INVALID_FIELD
* (the group is not present in the Group Table) as appropriate. The Group ID field is
* #ZB_ZCL_SUCCESS \n
* #ZB_ZCL_INVALID_FIELD \n
* @param[in] group_id Group id
- * @param[in] scene_id Scene id
* @param[in] user_data user data
*
* @see zb_zcl_group_remove_all_scene()
void *user_data);
/**
- * @brief Called after 'store scene' command
+ * @brief Called after 'store scene' command.
* @details This command is generated in response to a received Store Scene command.
* The Status field is set to SUCCESS, INSUFFICIENT_SPACE or
* INVALID_FIELD (the group is not present in the Group Table) as appropriate.
void *user_data);
/**
- * @brief Called after 'get all scene membership' command
+ * @brief Called after 'get all scene membership' command.
* @details This command is generated in response to a received Get Scene Membership
* command
*
*/
/**
- * @brief Sends 'add scenes' command
+ * @brief Sends 'add scenes' command.
* @details The Add Scene command shall be addressed to a single device (not a group)
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Sends 'view scene' command
+ * @brief Sends 'view scene' command.
* @details The View Scene command shall be addressed to a single device (not a group)
*
* @since_tizen 4.0
void *user_data);
/**
- * @brief Sends 'remove scene' command
+ * @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
void *user_data);
/**
- * @brief Sends 'remove all scenes' command
+ * @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
void *user_data);
/**
- * @brief Sends 'store scene' command
+ * @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
void *user_data);
/**
- * @brief Sends 'recall scene' command
+ * @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
unsigned char scene_id);
/**
- * @brief Sends 'get scenes membership' command
+ * @brief Sends 'get scenes membership' command.
* @details The Get Scene Membership command can be used to find an unused scene
* number within the group when no commissioning tool is in the network, or for a
* commissioning tool to get used scenes for a group on a single device or on all
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_SCENES_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_SCENES_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_THERMOSTAT_CLUSTER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_THERMOSTAT_CLUSTER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_THERMOSTAT_CLUSTER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_THERMOSTAT_CLUSTER_H__
#include <zb_type.h>
*/
/**
- * @brief Sends 'setpoint raise/lower' command
+ * @brief Sends 'setpoint raise/lower' command.
* @details The attributes for the indicated setpoint(s) shall be increased by the amount
* specified in the Amount field.
*
* @}
*/
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_THERMOSTAT_CLUSTER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_THERMOSTAT_CLUSTER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZCL_TYPE_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZCL_TYPE_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_TYPE_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_TYPE_H__
#include <wchar.h>
#include <zb_type.h>
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief ACL type
+ * @brief ACL type.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Data measuring type
+ * @brief Data measuring type.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief ZCL Enumerations Description in Zigbee Cluster Library
- * see. http://www.zigbee.org/download/standards-zigbee-cluster-library/
- *
+ * @brief ZCL Enumerations Description in Zigbee Cluster Library.
* @since_tizen 4.0
+ *
*/
typedef enum {
ZB_ZCL_SUCCESS = 0x00, /**< Operation was successful */
ZB_ZCL_FAILURE = 0x01, /**< Operation was not successful. */
- /**< The sender of the command does not have authorization to carry out this command. */
- ZB_ZCL_NOT_AUTHORIZED = 0x7E,
- /**< Reserved field/subfield/bit contains a non-zero value. */
- ZB_ZCL_RESERVED_FIELD_NOT_ZERO = 0x7F,
- /**< The command appears to contain the wrong fields, as
+ ZB_ZCL_NOT_AUTHORIZED = 0x7E, /**< The sender of the command does not have authorization to carry out this command. */
+ ZB_ZCL_RESERVED_FIELD_NOT_ZERO = 0x7F, /**< Reserved field/subfield/bit contains a non-zero value. */
+ ZB_ZCL_MALFORMED_COMMAND = 0x80, /**< The command appears to contain the wrong fields, as
detected either by the presence of one or more invalid
field entries or by there being missing fields. Command
not carried out. Implementer has discretion as to
whether to return this error or INVALID_FIELD. */
- ZB_ZCL_MALFORMED_COMMAND = 0x80,
- /**< The specified cluster command is not supported on the device. */
- ZB_ZCL_UNSUP_CLUSTER_COMMAND = 0x81,
- /**< The specified general ZCL command is not supported on the device. */
- ZB_ZCL_UNSUP_GENERAL_COMMAND = 0x82,
- /**< A manufacturer specific unicast, cluster specific
- command was received with an unknown manufacturer
- code, or the manufacturer code was recognized but the
- command is not supported. */
- ZB_ZCL_UNSUP_MANUF_CLUSTER_COMMAND = 0x83,
- /**< A manufacturer specific unicast, ZCL specific command
+ ZB_ZCL_UNSUP_CLUSTER_COMMAND = 0x81, /**< The specified cluster command is not supported on the device. */
+ ZB_ZCL_UNSUP_GENERAL_COMMAND = 0x82, /**< The specified general ZCL command is not supported on the device. */
+ ZB_ZCL_UNSUP_MANUF_CLUSTER_COMMAND = 0x83, /**< A manufacturer specific unicast, cluster specific
+ command was received with an unknown manufacturer
+ code, or the manufacturer code was recognized but the
+ command is not supported. */
+ ZB_ZCL_UNSUP_MANUF_GENERAL_COMMAND = 0x84, /**< A manufacturer specific unicast, ZCL specific command
was received with an unknown manufacturer code, or
the manufacturer code was recognized but the command
is not supported. */
- ZB_ZCL_UNSUP_MANUF_GENERAL_COMMAND = 0x84,
- /**< At least one field of the command contains an incorrect
+ ZB_ZCL_INVALID_FIELD = 0x85, /**< At least one field of the command contains an incorrect
value, according to the specification the device is
implemented to. */
- ZB_ZCL_INVALID_FIELD = 0x85,
- /**< The specified attribute does not exist on the device. */
- ZB_ZCL_UNSUPPORTED_ATTRIBUTE = 0x86,
- /**< Out of range error, or set to a reserved value. Attribute
- keeps its old value.
- Note that an attribute value may be out of range if an
- attribute is related to another, e.g. with minimum and
- maximum attributes. See the individual attribute
- descriptions for specific details. */
- ZB_ZCL_INVALID_VALUE = 0x87,
- /**< Attempt to write a read only attribute. */
- ZB_ZCL_READ_ONLY = 0x88,
- /**< An operation (e.g. an attempt to create an entry in a
- table) failed due to an insufficient amount of free space
- available. */
- ZB_ZCL_INSUFFICIENT_SPACE = 0x89,
- /**< An attempt to create an entry in a table failed due to a
+ ZB_ZCL_UNSUPPORTED_ATTRIBUTE = 0x86, /**< The specified attribute does not exist on the device. */
+ ZB_ZCL_INVALID_VALUE = 0x87, /**< Out of range error, or set to a reserved value. Attribute
+ keeps its old value.
+ Note that an attribute value may be out of range if an
+ attribute is related to another, e.g. with minimum and
+ maximum attributes. See the individual attribute
+ descriptions for specific details. */
+ ZB_ZCL_READ_ONLY = 0x88, /**< Attempt to write a read only attribute. */
+ ZB_ZCL_INSUFFICIENT_SPACE = 0x89, /**< An operation (e.g. an attempt to create an entry in a
+ table) failed due to an insufficient amount of free space
+ available. */
+ ZB_ZCL_DUPLICATE_EXISTS = 0x8A, /**< An attempt to create an entry in a table failed due to a
duplicate entry already being present in the table. */
- ZB_ZCL_DUPLICATE_EXISTS = 0x8A,
- /**< The requested information (e.g. table entry) could not be found. */
- ZB_ZCL_NOT_FOUND = 0x8B,
- /**< Periodic reports cannot be issued for this attribute. */
- ZB_ZCL_UNREPORTABLE_ATTRIBUTE = 0x8C,
- /**< The data type given for an attribute is incorrect.
- Command not carried out. */
- ZB_ZCL_INVALID_DATA_TYPE = 0x8D,
- /**< The selector for an attribute is incorrect. */
- ZB_ZCL_INVALID_SELECTOR = 0x8E,
- /**< A request has been made to read an attribute that the
- requester is not authorized to read. No action taken. */
- ZB_ZCL_WRITE_ONLY = 0x8F,
- /**< Setting the requested values would put the device in an
- inconsistent state on startup. No action taken. */
- ZB_ZCL_INCONSISTENT_STARTUP_STATE = 0x90,
- /**< An attempt has been made to write an attribute that is
- present but is defined using an out-of-band method and
- not over the air. */
- ZB_ZCL_DEFINED_OUT_OF_BAND = 0x91,
- /**< The supplied values (e.g. contents of table cells) are
- inconsistent. */
- ZB_ZCL_INCONSISTENT = 0x92,
- /**< The credentials presented by the device sending the
+ ZB_ZCL_NOT_FOUND = 0x8B, /**< The requested information (e.g. table entry) could not be found. */
+ ZB_ZCL_UNREPORTABLE_ATTRIBUTE = 0x8C, /**< Periodic reports cannot be issued for this attribute. */
+ ZB_ZCL_INVALID_DATA_TYPE = 0x8D, /**< The data type given for an attribute is incorrect.
+ Command not carried out. */
+ ZB_ZCL_INVALID_SELECTOR = 0x8E, /**< The selector for an attribute is incorrect. */
+ ZB_ZCL_WRITE_ONLY = 0x8F, /**< A request has been made to read an attribute that the
+ requester is not authorized to read. No action taken. */
+ ZB_ZCL_INCONSISTENT_STARTUP_STATE = 0x90, /**< Setting the requested values would put the device in an
+ inconsistent state on startup. No action taken. */
+ ZB_ZCL_DEFINED_OUT_OF_BAND = 0x91, /**< An attempt has been made to write an attribute that is
+ present but is defined using an out-of-band method and
+ not over the air. */
+ ZB_ZCL_INCONSISTENT = 0x92, /**< The supplied values (e.g. contents of table cells) are
+ inconsistent. */
+ ZB_ZCL_ACTION_DENIED = 0x93, /**< The credentials presented by the device sending the
command are not sufficient to perform this action. */
- ZB_ZCL_ACTION_DENIED = 0x93,
- /**< The exchange was aborted due to excessive response time. */
- ZB_ZCL_TIMEOUT = 0x94,
- /**< Failed case when a client or a server decides to abort the
- upgrade process. */
- ZB_ZCL_ABORT = 0x95,
- /**< Invalid OTA upgrade image (ex. failed signature
+ ZB_ZCL_TIMEOUT = 0x94, /**< The exchange was aborted due to excessive response time. */
+ ZB_ZCL_ABORT = 0x95, /**< Failed case when a client or a server decides to abort the
+ upgrade process. */
+ ZB_ZCL_INVALID_IMAGE = 0x96, /**< Invalid OTA upgrade image (ex. failed signature
validation or signer information check or CRC check). */
- ZB_ZCL_INVALID_IMAGE = 0x96,
- /**< Server does not have data block available yet. */
- ZB_ZCL_WAIT_FOR_DATA = 0x97,
- /**< No OTA upgrade image available for a particular client. */
- ZB_ZCL_NO_IMAGE_AVAILABLE = 0x98,
- /**< The client still requires more OTA upgrade image files
+ ZB_ZCL_WAIT_FOR_DATA = 0x97, /**< Server does not have data block available yet. */
+ ZB_ZCL_NO_IMAGE_AVAILABLE = 0x98, /**< No OTA upgrade image available for a particular client. */
+ ZB_ZCL_REQUIRE_MORE_IMAGE = 0x99, /**< The client still requires more OTA upgrade image files
in order to successfully upgrade. */
- ZB_ZCL_REQUIRE_MORE_IMAGE = 0x99,
} zb_zcl_status_e;
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Discover Attribute Info Record in Zigbee Cluster Library
+ * @brief Format of the Discover Attribute Info Record in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Structure for Read Structured Attribute Record in Zigbee Cluster Library
+ * @brief Format of the Structure for Read Structured Attribute Record in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Attribute Status Record in Zigbee Cluster Library
+ * @brief Format of the Attribute Status Record in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Write Attributes Data Structure in Zigbee Cluster Library
+ * @brief Format of the Write Attributes Data Structure in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Write Attribute Status Record Field in Zigbee Cluster Library
+ * @brief Format of the Write Attribute Status Record Field in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Write Attribute Record Field in Zigbee Cluster Library
+ * @brief Format of the Write Attribute Record Field in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Write Attribute Record Field in Zigbee Cluster Library
+ * @brief Format of the Write Attribute Record Field in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Attribute Report Fields in Zigbee Cluster Library
+ * @brief Format of the Attribute Report Fields in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of Reporting Configuration Record Structure in Zigbee Cluster Library
+ * @brief Format of Reporting Configuration Record Structure in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of Read Reporting Configuration Record in Zigbee Cluster Library
+ * @brief Format of Read Reporting Configuration Record in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Attribute Status Record Field in Zigbee Cluster Library
+ * @brief Format of the Attribute Status Record Field in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of the Extended Attribute Information Fields in Zigbee Cluster Library
+ * @brief Format of the Extended Attribute Information Fields in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief simple data type in Zigbee Cluster Library
+ * @brief simple data type in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Format of Attribute Value Field for an array, Set or Bag in Zigbee Cluster Library
+ * @brief Format of Attribute Value Field for an array, Set or Bag in Zigbee Cluster Library.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief Global record type
+ * @brief Global record type.
*
* @since_tizen 4.0
*/
* @}
*/
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZCL_TYPE_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZCL_TYPE_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZDO_BIND_MANAGER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZDO_BIND_MANAGER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_BIND_MANAGER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_BIND_MANAGER_H__
#include <zdo/zb_zdo_type.h>
*/
/**
- * @brief Called after 'bind' command
+ * @brief Called after 'bind' command.
* @details The Bind_rsp is generated in response to a Bind_req. If the Bind_req is
* processed and the Binding Table entry committed on the Remote Device, a Status of
* SUCCESS is returned.\n\n If the Remote Device is not a Primary binding table cache
void *user_data);
/**
- * @brief Sends 'bind' command
+ * @brief Sends 'bind' command.
* @details Binding request when destination address present but not endpoint present.
* The Bind_req is generated from a Local Device wishing to create a Binding
* Table entry for the source and destination addresses contained as parameters.\n\n The
* to the destination.
* @param[in] dst_addr64 The IEEE address of destination
* @param[in] type ZB_UNICAST_BINDING : A unicast binding whose 64-bit identifier is the
- * destination ieee_addr. \n
- * ZB_MANY_TO_ONE_BINDING : A unicast binding whose 64-bit identifier is
+ * destination ieee_addr. \n
+ * ZB_MANY_TO_ONE_BINDING : A unicast binding whose 64-bit identifier is
* the many-to-one destination ieee_addr.
* A Route discovery should be disabled when
* sending unicast via may-to-one binding \n
void *user_data);
/**
- * @brief Called after 'unbind' command
+ * @brief Called after 'unbind' command.
* @details The Unbind_rsp is generated in response to an Unbind_req. If the Unbind_req is
* processed and the corresponding Binding Table entry is removed from the Remote
* Device, a Status of SUCCESS is returned. If the Remote Device is not the ZigBee
void *user_data);
/**
- * @brief Sends 'bind' command
+ * @brief Sends 'Unbind' command.
* @details Binding request when destination address present but not endpoint present
* The Unbind_req is generated from a Local Device wishing to remove a Binding
* Table entry for the source and destination addresses contained as parameters.\n\n The
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZDO_BIND_MANAGER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_BIND_MANAGER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_DEV_DISC_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_DEV_DISC_H__
#include <zdo/zb_zdo_type.h>
/**
- * @brief Called after Network / IEEE address request
+ * @brief Called after Network / IEEE address request.
* @details The NWK_addr_rsp is generated by a Remote Device in response to a\n
* NWK_addr_req or IEEE_addr_req command inquiring as to the NWK address of the Remote
* Device or the NWK address of an address held in a local discovery cache.\n
void *user_data);
/**
- * @brief Sends 'Network address request' command
+ * @brief Sends 'Network address request' command.
* @details The NWK_addr_req is generated from a Local Device wishing to inquire as to the\n
* 16-bit address of the Remote Device based on its known IEEE address. The\n
* destination addressing on this command shall be unicast or broadcast to all\n
void *user_data);
/**
- * @brief Sends 'IEEE address request' command
+ * @brief Sends 'IEEE address request' command.
* @details The IEEE_addr_req is generated from a Local Device wishing to inquire as to
* 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.
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_ieee_addr_rsp()
void *user_data);
/**
- * @brief Called after active endpoint request command
+ * @brief Called after active endpoint request command.
* @details The Active_EP_rsp is generated by a remote device in response to an
* Active_EP_req directed to the remote device. This command shall be unicast to
* the originator of the Active_EP_req command.\n\n
void *user_data);
/**
- * @brief Sends 'active end-point request' command
+ * @brief Sends 'active end-point request' command.
* @details The Active_EP_req command is generated from a local device wishing to acquire
* the list of endpoints on a remote device with simple descriptors. This command
* shall be unicast either to the remote device itself or to an alternative device that
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_active_ep_rsp()
void *user_data);
/**
- * @brief Called after 'simple descriptor request' command
+ * @brief Called after 'simple descriptor request' command.
* @details The Simple_Desc_rsp is generated by a remote device in response to a
* Simple_Desc_req directed to the remote device. This command shall be unicast to
* the originator of the Simple_Desc_req command.
*
* @since_tizen 4.0
*
- * @param[in] status #ZB_ZDP_SUCCESS \n
- * #ZB_ZDP_INVALID_EP \n
- * #ZB_ZDP_NOT_ACTIVE \n
- * #ZB_ZDP_DEVICE_NOT_FOUND \n
- * #ZB_ZDP_INV_REQUESTTYPE \n
- * #ZB_ZDP_NO_DESCRIPTOR
* @param[in] addr16 Network address for the request
* @param[in] len Length in bytes of the simple descriptor to follow
* @param[in] handle Simple descriptor structure this filed shall only be included
void *user_data);
/**
- * @brief Sends 'simple descriptor request' command
+ * @brief Sends 'simple descriptor request' command.
* @details The Simple_Desc_req command is generated from a local device wishing to
* inquire as to the simple descriptor of a remote device on a specified endpoint. This
* command shall be unicast either to the remote device itself or to an alternative
* @retval #ZIGBEE_ERROR_INVALID_ENDPOINT Invalid endpoint. 0 is reserved for ZDP
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_simple_desc_rsp()
void *user_data);
/**
- * @brief Called after 'matching descriptor request' command
+ * @brief Called after 'matching descriptor request' command.
* @details The Match_Desc_rsp is generated by a remote device in response to a
* Match_Desc_req either broadcast or directed to the remote device. This command
* shall be unicast to the originator of the Match_Desc_req command.
void *user_data);
/**
- * @brief Sends 'matching descriptor request' command
+ * @brief Sends 'matching descriptor request' command.
* @details The Match_Desc_req command is generated from a local device wishing to find
* remote devices supporting a specific simple descriptor match criterion. This
* command shall either be broadcast to all devices for which macRxOnWhenIdle =
* @retval #ZIGBEE_ERROR_INVALID_ADDRESS Invalid address
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_match_desc_rsp()
void *user_data);
/**
- * @brief called after 'node descriptor request' command
+ * @brief called after 'node descriptor request' command.
* @details The Node_Desc_rsp is generated by a remote device in response to a
* Node_Desc_req directed to the remote device. This command shall be unicast to
* the originator of the Node_Desc_req command.
void *user_data);
/**
- * @brief Sends 'node descriptor request' command
+ * @brief Sends 'node descriptor request' command.
* @details The Node_Desc_req command is generated from a local device wishing to inquire
* as to the node descriptor of a remote device. This command shall be unicast either
* to the remote device itself or to an alternative device that contains the discovery
* @retval #ZIGBEE_ERROR_INVALID_ADDRESS Invalid address
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_node_desc_rsp()
void *user_data);
/**
- * @brief Called after 'power descriptor request' command
+ * @brief Called after 'power descriptor request' command.
* @details The Power_Desc_rsp is generated by a remote device in response to a
* Power_Desc_req directed to the remote device. This command shall be unicast to
* the originator of the Power_Desc_req command.\n
void *user_data);
/**
- * @brief Sends 'power descriptor request' command
+ * @brief Sends 'power descriptor request' command.
* @details The Power_Desc_req command is generated from a local device wishing to
* inquire as to the power descriptor of a remote device. This command shall be
* unicast either to the remote device itself or to an alternative device that contains
* @retval #ZIGBEE_ERROR_INVALID_ADDRESS Invalid address
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_power_desc_rsp()
void *user_data);
/**
- * @brief Called after 'complex descriptor request' command
+ * @brief Called after 'complex descriptor request' command.
* @details The Complex_Desc_rsp is generated by a remote device in response to a
* Complex_Desc_req directed to the remote device. This command shall be unicast
* to the originator of the Complex_Desc_req command.
void *user_data);
/**
- * @brief Sends 'complex descriptor request' command
+ * @brief Sends 'complex descriptor request' command.
* @details The Complex_Desc_req command is generated from a local device wishing to
* inquire as to the complex descriptor of a remote device. This command shall be
* unicast either to the remote device itself or to an alternative device that contains
* @retval #ZIGBEE_ERROR_INVALID_ADDRESS Invalid address
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_complex_desc_rsp()
void *user_data);
/**
- * @brief Called after 'user descriptor request' command
+ * @brief Called after 'user descriptor request' command.
* @details The User_Desc_rsp is generated by a remote device in response to a
* User_Desc_req directed to the remote device. This command shall be unicast to
* the originator of the User_Desc_req command.\n
* #ZB_ZDP_INV_REQUESTTYPE \n
* #ZB_ZDP_NO_DESCRIPTOR
* @param[in] addr16 Network address for the request
- * @param[in] length Length in bytes of the user_desc field
+ * @param[in] len Length in bytes of the user_desc field
* @param[in] user_desc This field shall only be included in the frame if the
* status field is equal to ZB_ZDP_SUCCESS.
* @param[in] user_data user data
void *user_data);
/**
- * @brief Sends 'complex descriptor request' command
+ * @brief Sends 'User descriptor request' command.
* @details The User_Desc_req command is generated from a local device wishing to inquire
* as to the user descriptor of a remote device. This command shall be unicast either
* to the remote device itself or to an alternative device that contains the discovery
* @retval #ZIGBEE_ERROR_INVALID_ADDRESS Invalid address
* @retval #ZIGBEE_ERROR_OUT_OF_MEMORY Out-of-memory
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_complex_desc_rsp()
zb_zdo_user_desc_rsp cb,
void *user_data);
/**
- * @brief Called after 'user descriptor confirm' request
+ * @brief Called after 'user descriptor confirm' request.
* @details The User_Desc_conf is generated by a remote device in response to a
* User_Desc_set directed to the remote device. This command shall be unicast to
* the originator of the User_Desc_set command.
void *user_data);
/**
- * @brief Sends 'user descriptor set request' command
+ * @brief Sends 'user descriptor set request' command.
* @details The User_Desc_set command is generated from a local device wishing to
* configure the user descriptor on a remote device. This command shall be unicast
* either to the remote device itself or to an alternative device that contains the
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_INVALID_ADDRESS Invalid address
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_user_desc_conf()
void *user_data);
/**
- * @brief Sends 'device announce request' command
+ * @brief Sends 'device announce request' command.
* @details The Device_annce is provided to enable ZigBee devices on the network to notify
* other ZigBee devices that the device has joined or re-joined the network,
* identifying the device's 64-bit IEEE address and new 16-bit NWK address, and
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_INVALID_ADDRESS Invalid address
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_user_desc_conf()
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_DEV_DISC_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __TIZEN_NETWORK_ZIGBEE_ZDO_NETWORK_MANAGER_H__
-#define __TIZEN_NETWORK_ZIGBEE_ZDO_NETWORK_MANAGER_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_NETWORK_MANAGER_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_NETWORK_MANAGER_H__
#include <zdo/zb_zdo_type.h>
*/
/**
- * @brief Called after 'network management discovery request' command
+ * @brief Called after 'network management discovery request' command.
* @details The Mgmt_NWK_Disc_rsp is generated in response to an Mgmt_NWK_Disc_req.
* If this management command is not supported, a status
* of NOT_SUPPORTED shall be returned and all parameter fields after the Status
/**
* @brief Bitmask to scan all 802.15.4 channels.
+ * @since_tizen 4.0
*/
#define ZB_802_15_4_CHANNELS_MASK 0x07FFF800UL
/**
- * @brief Sends 'network discover management request' command
+ * @brief Sends 'network discover management request' command.
* @details The Mgmt_NWK_Disc_req is generated from a Local Device requesting that the
* Remote Device execute a Scan to report back networks in the vicinity of the Local
* Device.\n\n The destination addressing on this command shall be unicast.
void *user_data);
/**
- * @brief Called after 'network management LQI request' command
+ * @brief Called after 'network management LQI request' command.
* @details The Recover_Source_Bind_rsp is generated from a backup binding table cache
* device in response to a Recover_Source_Bind_req from a primary binding table
* cache and contains the status of the request.\n\n This command shall be unicast to the
* #ZB_ZDP_NOT_SUPPORTED \n
* #ZB_ZDP_TABLE_FULL \n
* #ZB_ZDP_INV_REQUESTTYPE \n
- * @param[in] source_table_entries Total number of source table entries in the backup
+ * @param[in] neighbor_table_entries Total number of neighbor table entries in the backup
* binding cache.
* @param[in] start_idx Starting index within the neighbor table to begin reporting for
* the neighbor table list.
void *user_data);
/**
- * @brief Sends 'LQI management request' command
+ * @brief Sends 'LQI management request' command.
* @details The Mgmt_Lqi_req is generated from a Local Device wishing to obtain a
* neighbor list for the Remote Device along with associated LQI values to each
* neighbor. The destination addressing on this command shall be unicast only and
void *user_data);
/**
- * @brief Called after 'routing management request' command
+ * @brief Called after 'routing management request' command.
* @details The Mgmt_Rtg_rsp is generated in response to an Mgmt_Rtg_req. If this
* management command is not supported, a status of NOT_SUPPORTED shall be
* returned and all parameter fields after the Status field shall be omitted. Otherwise,
* the RoutingTableList.
* @param[in] routing_table_list_count The number of routing table entries included
* within RoutingTableList.
- * @param[in] neighbor_table_list A list of routing table list.
+ * @param[in] routing_table_list A list of routing table list.
* @param[in] user_data User data
*
* @see zb_zdo_mgmt_rtg_req()
void *user_data);
/**
- * @brief Sends 'routing management request' command
+ * @brief Sends 'routing management request' command.
* @details The Mgmt_Rtg_req is generated from a Local Device wishing to retrieve the
* contents of the Routing Table from the Remote Device. The destination
* addressing on this command shall be unicast only and the destination address
void *user_data);
/**
- * @brief Called after 'binding management request' command
+ * @brief Called after 'binding management request' command.
* @details The Mgmt_Bind_rsp is generated in response to a Mgmt_Bind_req. If this
* management command is not supported, a status of NOT_SUPPORTED shall be
* returned and all parameter fields after the Status field shall be omitted. Otherwise,
* the BindingTableList.
* @param[in] binding_table_list_count The number of binding table entries included
* within BindingTableList.
- * @param[in] neighbor_table_list A list of routing table list.
+ * @param[in] binding_table_list A list of routing table list.
* @param[in] user_data User data
*
* @see zb_zdo_mgmt_bind_req()
void *user_data);
/**
- * @brief Sends 'binding management request' command
+ * @brief Sends 'binding management request' command.
* @details The Mgmt_Bind_req is generated from a Local Device wishing to retrieve the
* contents of the Binding Table from the Remote Device. \n\n The destination
* addressing on this command shall be unicast only and the destination address
void *user_data);
/**
- * @brief Called after 'leave management request' command
+ * @brief Called after 'leave management request' command.
* @details The Mgmt_Leave_rsp is generated in response to a Mgmt_Leave_req. \n\n If this
* management command is not supported, a status of NOT_SUPPORTED shall be
* returned. \n\n Otherwise, the Remote Device shall implement the following
void *user_data);
/**
- * @brief Send 'leave device management request' command
+ * @brief Sends 'leave device management request' command.
* @details The Mgmt_Leave_req is generated from a Local Device requesting that a Remote
* Device leave the network or to request that another device leave the network.
* The Mgmt_Leave_req is generated by a management application which directs the
void *user_data);
/**
- * @brief Called after 'permit joining management request' command
+ * @brief Called after 'permit joining management request' command.
* @details The Mgmt_Permit_Joining_rsp is generated in response to a unicast
* Mgmt_Permit_Joining_req.\n\n In the description which follows, note that no
* response shall be sent if the Mgmt_Permit_Joining_req was received as a
void *user_data);
/**
- * @brief Sends 'permit join device management request' command
+ * @brief Sends 'permit join device management request' command.
* @details The Mgmt_Permit_Joining_req is generated from a Local Device requesting that
* a remote device or devices allow or disallow association.\n\n The
* Mgmt_Permit_Joining_req is generated by a management application or
void *user_data);
/**
- * @brief Sends 'update network management request' command
+ * @brief Sends 'update network management request' command.
* @details This command is provided to allow updating of network configuration parameters
* or to request information from devices on network conditions in the local
* operating environment.\n\n The destination addressing on this primitive shall be
}
#endif
-#endif /* __TIZEN_NETWORK_ZIGBEE_ZDO_NETWORK_MANAGER_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_NETWORK_MANAGER_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __ZB_ZDO_TYPE_H__
-#define __ZB_ZDO_TYPE_H__
+#ifndef __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_TYPE_H__
+#define __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_TYPE_H__
#include <zb_type.h>
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Table 2.138 ZDP Enumerations Description
+ * @brief Table 2.138 ZDP Enumerations Description.
* See more http://www.zigbee.org/download/standards-zigbee-specification/
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief RequestType Enumeration
+ * @brief RequestType Enumeration.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Table 2.30 Values of the Logical Type Field
+ * @brief Table 2.30 Values of the Logical Type Field.
* See more http://www.zigbee.org/download/standards-zigbee-specification/
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Table 2.31 Values of the Frequency Band Field
+ * @brief Table 2.31 Values of the Frequency Band Field.
* See more http://www.zigbee.org/download/standards-zigbee-specification/
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Alternative PAN coordinator bit in MAC capability Flags
+ * @brief Alternative PAN coordinator bit in MAC capability Flags.
* See more http://www.zigbee.org/download/standards-zigbee-specification/
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Device type bit in MAC capability Flags
+ * @brief Device type bit in MAC capability Flags.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Power Source bit in MAC capability Flags
+ * @brief Power Source bit in MAC capability Flags.
* See more http://www.zigbee.org/download/standards-zigbee-specification/
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Receiver on when idle bit in MAC capability Flags
+ * @brief Receiver on when idle bit in MAC capability Flags.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Security capability bit in MAC capability Flags
+ * @brief Security capability bit in MAC capability Flags.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Table 2.32 Server Mask Bit Assignments
+ * @brief Table 2.32 Server Mask Bit Assignments.
*
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Table 2.29 Fields of the Node Descriptor
+ * @brief Table 2.29 Fields of the Node Descriptor.
* See more http://www.zigbee.org/download/standards-zigbee-specification/
* @details Type and capabilities of the node.
*
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Table 2.34 Fields of the Node Power Descriptor
+ * @brief Table 2.34 Fields of the Node Power Descriptor.
* See more http://www.zigbee.org/download/standards-zigbee-specification/
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief Binding type
+ * @brief Binding type.
*
* @since_tizen 4.0
*/
*/
typedef void* zb_zdo_node_power_descriptor_h;
-
-#define MAX_ENDPOINT_CLUSTERS 32 /**< Cluster counts to handle with */
+/**
+ * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
+ * @brief Cluster counts to handle with.
+ *
+ * @since_tizen 4.0
+ */
+#define MAX_ENDPOINT_CLUSTERS 32
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
+ * @brief The handle of zigbee simple description.
* @details Device descriptions contained in node.
*
* @since_tizen 4.0
/**
* @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief The handle of zigbee end-device information
- * @details A zb_end_device_info_h is an opaque data structure.\n
- * zb_end_device_info_h is a data type of network address, IEEE address, endpoint count
+ * @brief The handle of zigbee end-device information.
+ * @details A #zb_end_device_info_h is an opaque data structure.\n
+ * #zb_end_device_info_h is a data type of network address, IEEE address, endpoint count
* and endpoint information structure.
*
* @since_tizen 4.0
* @}
*/
-#endif /* __ZB_ZDO_TYPE_H__ */
+#endif /* __TIZEN_NETWORK_ZIGBEE_ZB_ZDO_TYPE_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __CAPI_NETWORK_ZIGBEE_H__
-#define __CAPI_NETWORK_ZIGBEE_H__
-
-/* For test */
-#define ZIGBEE_SUPPORT_ORDERED_SEQUENCE_DATA 0
+#ifndef __TIZEN_CAPI_NETWORK_ZIGBEE_H__
+#define __TIZEN_CAPI_NETWORK_ZIGBEE_H__
#ifdef __cplusplus
extern "C" {
int zb_destroy(zigbee_h handle);
/**
- * @brief Called after receiving events from zigbee service
+ * @brief Called after receiving events from zigbee service.
* @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
*
- * @remarks You can receive below events.
+ * @remarks You can receive below events. Please see the "see" section.
+ *
+ * @param[in] addr16 Network address (16 bit) from the source device
+ * @param[in] addr64 IEEE address (EUI64) from the source device
+ * @param[in] event_type The event identification
+ * @param[in] user_data parameter data pointer
+ *
+ * @pre The callback must be registered when using zb_set_event_handler()
+ *
* @see #ZB_ZDP_ENABLE_EVENT
* @see #ZB_ZDP_JOIN_EVENT
* @see #ZB_ZDP_REJOIN_EVENT
* @see #ZB_ZCL_DOOR_LOCK_PROGRAMING_NOTIFICATION_EVENT
* @see #ZB_ZCL_SIMPLE_METERING_REMOVE_MIRROR_EVENT
* @see #ZB_ZCL_SIMPLE_METERING_REQUEST_MIRROR_EVENT
- *
- * @param[in] addr16 Network address (16 bit) from the source device
- * @param[in] addr64 IEEE address (EUI64) from the source device
- * @param[in] event_type The event identification
- * @param[in] lparam parameter data pointer
- *
- * @pre The callback must be registered when using zb_set_event_handler()
- *
* @see zb_event_cb()
*/
typedef void (*zb_event_cb)(nwk_addr addr16, ieee_addr addr64, zb_event_e event_type,
- zb_event_data_s lparam);
+ zb_event_data_s user_data);
/**
* @brief Sets event handler for the zigbee service.
typedef void (*zb_form_network_cb)(nwk_addr panid, void *user_data);
/**
- * @brief Makes network works as a zigbee coordinator
+ * @brief Makes network works as a zigbee coordinator.
* @details This function to enable the zigbee coordinator.
*
* @since_tizen 4.0
* call zb_zdo_set_compatible_startup_parameters() API
*
* @param[in] handle The handle of zigbee
- * @param[in] cb zb_form_network_cb
+ * @param[in] cb zb_form_network_cb()
* @param[in] user_data user data
*
* @return 0 on success, otherwise a negative error value.
int zb_form_network(zigbee_h handle, zb_form_network_cb cb, void *user_data);
/**
- * @brief Called after disabling the zigbee network
+ * @brief Called after disabling the zigbee network.
* @details Response of disabling the zigbee network
*
* @since_tizen 4.0
*/
typedef void (*zb_disable_network_cb)(unsigned char status, void *user_data);
/**
- * @brief Disables network and stops zigbee coordinator role
+ * @brief Disables network and stops zigbee coordinator role.
* @details This function to stop zigbee coordinator
*
* @since_tizen 4.0
* @privilege %http://tizen.org/privilege/zigbee
*
* @param[in] handle The handle of zigbee
- * @param[in] cb zb_disable_network_cb
+ * @param[in] cb zb_disable_network_cb()
* @param[in] user_data user data
*
* @return 0 on success, otherwise a negative error value.
int zb_disable_network(zigbee_h handle, zb_disable_network_cb cb, void *user_data);
/**
- * @brief Forces a node to leave one network and to rejoin the other
+ * @brief Forces a node to leave one network and to rejoin the other.
* @details Force a node to leave one network and to rejoin the other. If remove_children
* sets true, the the target end device will reset its state-machine as factory default.
*
int zb_leave_device(zigbee_h handle, ieee_addr addr, bool remove_children, bool rejoin);
/**
- * @brief Enables or disables coordinator device can accept other device's association request
+ * @brief Enables or disables coordinator device can accept other device's association request.
* @details The function is generated from a Local Device requesting that
* a remote device or devices allow or disallow association.
*
int zb_permit_join(zigbee_h handle, unsigned char timeout);
/**
- * @brief Shows current coordinator's IEEE MAC address
+ * @brief Shows current coordinator's IEEE MAC address.
* @details The function gets the coordinator's MAC address from the machine which runs
* zigbee-service daemon.
*
int zb_get_controller_mac_address(zigbee_h handle, ieee_addr addr64);
/**
- * @brief Gets information of the current network environment of coordinator
+ * @brief Gets information of the current network environment of coordinator.
* @details The function shows network environment
*
* @since_tizen 4.0
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see struct zb_end_device_info_s
+ *
*/
int zb_get_all_device_list(zigbee_h handle, int *count, zb_end_device_info_h **list);
* @param[in] child handle of a end-device
* @param[in] user_data user data
*
- * @pre The callback must be registered when using zb_devices_info_foreach_end_device()
- *
* @return #ZIGBEE_FUNC_CONTINUE to continue iteration, otherwise #ZIGBEE_FUNC_STOP to stop iteration.
* @retval #ZIGBEE_FUNC_CONTINUE Continue iteration
* @retval #ZIGBEE_FUNC_STOP Stop iteration
*
+ * @pre The callback must be registered when using zb_devices_info_foreach_end_device()
+ *
* @see zb_devices_info_foreach_end_device()
*/
typedef bool (*zb_end_device_cb)(int index, zb_end_device_info_h child, void *user_data);
zb_end_device_cb cb, void *user_data);
/**
- * @brief Gets network address of a specific end-point
+ * @brief Gets network address of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_network_address(zb_end_device_info_h handle, nwk_addr *addr16);
/**
- * @brief Gets ieee address of a specific end-point
+ * @brief Gets ieee address of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_ieee_address(zb_end_device_info_h handle, ieee_addr addr64);
/**
- * @brief Gets a number of end-points of a specific end-point
+ * @brief Gets a number of end-points of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_num_of_ep(zb_end_device_info_h handle, unsigned char *count);
/**
- * @brief Gets list of end-points of a specific end-point
+ * @brief Gets list of end-points of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_ep_list(zb_end_device_info_h handle, unsigned char *ep_list);
/**
- * @brief Gets 802.15.4 MAC capability of a specific end-point
+ * @brief Gets 802.15.4 MAC capability of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_mac_capability(zb_end_device_info_h handle, unsigned char *capability);
/**
- * @brief Gets ability of alternative PAN coordinator of a specific end-point
+ * @brief Gets ability of alternative PAN coordinator of a specific end-point.
*
* @since_tizen 4.0
*
unsigned char *can_do_it);
/**
- * @brief Gets device id of a specific end-point
+ * @brief Gets device id of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_device_id(zb_end_device_info_h handle, unsigned char ep, unsigned short *device_id);
/**
- * @brief Gets profile id of a specific end-point
+ * @brief Gets profile id of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_profile_id(zb_end_device_info_h handle, unsigned char ep, unsigned short *profile_id);
/**
- * @brief Gets power source type of a specific end-point
+ * @brief Gets power source type of a specific end-point.
*
* @since_tizen 4.0
*
int zb_get_power_source(zb_end_device_info_h handle, unsigned char *power_src);
/**
- * @brief Gets security capability of a specific end-point
+ * @brief Gets security capability of a specific end-point.
*
* @since_tizen 4.0
*
}
#endif
-#endif /* __CAPI_NETWORK_ZIGBEE_H__ */
+#endif /* __TIZEN_CAPI_NETWORK_ZIGBEE_H__ */
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-#ifndef __CAPI_NETWORK_ZIGBEE_INTERNAL_H__
-#define __CAPI_NETWORK_ZIGBEE_INTERNAL_H__
+#ifndef __TIZEN_CAPI_NETWORK_ZIGBEE_INTERNAL_H__
+#define __TIZEN_CAPI_NETWORK_ZIGBEE_INTERNAL_H__
#ifdef __cplusplus
extern "C" {
*/
/**
+ * @platform
* @internal
* @brief Enables the zigbee service.
* @details All this function to start zigbee service
int zb_enable(zigbee_h handle);
/**
+ * @platform
* @internal
* @brief Disables the zigbee service.
* @details All this function to stop zigbee service
* @privlevel platform
* @privilege %http://tizen.org/privilege/zigbee.admin
*
- * @param[in] handle The handle of zigbee
- *
* @remarks You must free all resources of the zigbee by calling zb_destroy()
* if zigbee service is no longer needed.
*
+ * @param[in] handle The handle of zigbee
*
* @return 0 on success, otherwise a negative error value.
* @retval #ZIGBEE_ERROR_NONE Successful
int zb_disable(zigbee_h handle);
/**
+ * @platform
* @internal
* @brief Resets chip for the zigbee transceiver.
* @details If the Zigbee transceiver works abnormally, this function do HW reset.
int zb_hw_reset(zigbee_h handle);
/**
+ * @platform
* @internal
* @brief Switches channel when an occupied channel is noisy.
* @details When noisy, do energy scan and active scan to switch operational channel.
* @retval #ZIGBEE_ERROR_NONE Successful
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
*
* @see zb_coex_stop()
*
int zb_coex_start(zigbee_h handle, unsigned char channel);
/**
+ * @platform
* @internal
* @brief Stops channel switching operation.
* @details Halt current operation related to channel switching.
* @retval #ZIGBEE_ERROR_NONE Successful
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
*
* @see zb_coex_start()
*
/**
* @internal
- * @brief APS Delivery Mode
+ * @brief APS Delivery Mode.
*
* @since_tizen 4.0
*/
/**
* @internal
- * @brief APS ACK Request
+ * @brief APS ACK Request.
*
* @since_tizen 4.0
*/
/**
* @internal
- * @brief Frame type at ZCL Header
+ * @brief Frame type at ZCL Header.
*
* @since_tizen 4.0
*/
/**
* @internal
- * @brief Manufacturer specific or not at ZCL Header
+ * @brief Manufacturer specific or not at ZCL Header.
*
* @since_tizen 4.0
*/
/**
* @internal
- * @brief Called after custom APS send command
+ * @brief Called after custom APS send command.
*
* @since_tizen 4.0
*
/**
* @internal
- * @brief Called after custom ZCL send command
+ * @brief Called after custom ZCL send command.
*
* @since_tizen 4.0
*
/**
* @internal
- * @brief Called after custom local send command
+ * @brief Called after custom local send command.
*
* @since_tizen 4.0
*
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends custom APS data
+ * @brief Sends custom APS data.
*
* @since_tizen 4.0
* @privlevel platform
* @retval #ZIGBEE_ERROR_NONE Successful
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
*
* @see zb_aps_send_rsp()
*/
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends custom ZCL data
+ * @brief Sends custom ZCL data.
*
* @since_tizen 4.0
* @privlevel platform
* @retval #ZIGBEE_ERROR_NONE Successful
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
*
* @see zb_zcl_send_rsp()
*/
void *user_data);
/**
+ * @platform
* @internal
* @brief Transmits data that needs to be processed locally.
*
* @retval #ZIGBEE_ERROR_NONE Successful
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
*
* @see zb_send_to_local_rsp()
*/
*/
/**
+ * @platform
* @internal
- * @brief Sets start-up attribute set
+ * @brief Sets start-up attribute set.
* @details In order to ensure interoperability, all ZigBee HA devices should implement
* compatible Startup Attribute Sets (SAS). This does not mean that set must be
* modifiable through a commissioning cluster, but that the device must internally
* @param[in] handle The handle of zigbee
* @param[in] pan_id Short address
* @param[in] epan_id Usually 00-50-C2-77-10-00-00-00 is the global commissioning EPID
- * @param[in] channel_mask
- * @param[in] start_control
- * @param[in] trust_center_addr
- * @param[in] master_key
- * @param[in] master_key_len
- * @param[in] network_key
- * @param[in] network_key_len
- * @param[in] default_link_key_join
+ * @param[in] channel_mask Channel mask
+ * @param[in] start_control Start control
+ * @param[in] trust_center_addr Trust center addr
+ * @param[in] master_key Master key
+ * @param[in] master_key_len Master key length
+ * @param[in] network_key Network key
+ * @param[in] network_key_len Network key length
+ * @param[in] default_link_key_join Default link key join
*
* @return 0 on success, otherwise a negative error value.
* @retval #ZIGBEE_ERROR_NONE Successful
*/
int zb_zdo_set_compatible_startup_parameters(
zigbee_h handle,
- nwk_addr pan_id, /* default : NULL (0xFFFF) */
- ieee_addr epan_id, /* default : NULL (0x0000000000000000) */
- unsigned int channel_mask, /* default : NULL (0x07FFF800) */
- unsigned char start_control, /* default : 3 (un-comissioned, simlely push end-device's button when joining) */
- ieee_addr trust_center_addr, /* default : NULL (0x0000000000000000) */
- const unsigned char *master_key, /* default : NULL */
- unsigned char master_key_len, /* default : 0 */
- const unsigned char *network_key, /* default : NULL */
- unsigned char network_key_len, /* default : 0 */
- unsigned char default_link_key_join /* default : 0 */
- );
+ nwk_addr pan_id,
+ ieee_addr epan_id,
+ unsigned int channel_mask,
+ unsigned char start_control,
+ ieee_addr trust_center_addr,
+ const unsigned char *master_key,
+ unsigned char master_key_len,
+ const unsigned char *network_key,
+ unsigned char network_key_len,
+ unsigned char default_link_key_join);
/**
* @}
*/
/**
+ * @platform
* @internal
* @brief Sends 'read attributes structured' command
* details The read attributes command is generated when a device wishes to determine the
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'write attributes structured' command
+ * @brief Sends 'write attributes structured' command.
* @details When writing an element to an array or structure, the Indicator subfield indicates
* the number of index fields that follow it. This number is limited to the range 0 - 15
* (i.e. the upper 4 bits of the Indicator field are set to zero). It may be further limited
#ifdef ZB_SUPPORT_PRIORITY_5
/**
+ * @platform
* @internal
- * @brief Called after 'direct join management request' command
+ * @brief Called after 'direct join management request' command.
* @details The Mgmt_Direct_Join_rsp is generated in response to a Mgmt_Direct_Join_req.
* If this management command is not supported, a status of NOT_SUPPORTED
* shall be returned.\n\n Otherwise, the Remote Device shall implement the following
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'direct join device management request' command
+ * @brief Sends 'direct join device management request' command.
* @details The Mgmt_Direct_Join_req is generated from a Local Device requesting that a
* Remote Device permit a device designated by DeviceAddress to join the network
* directly.\n\n The Mgmt_Direct_Join_req is generated by a management application
/**
* @internal
- * @brief Called after 'cache management request' command
+ * @brief Called after 'cache management request' command.
* @details The Mgmt_Cache_rsp is generated in response to an Mgmt_Cache_req. If this
* management command is not supported, or the Remote Device is not a Primary
* Cache Device, a status of NOT_SUPPORTED shall be returned and all parameter
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'cache management request' command
+ * @brief Sends 'cache management request' command.
* @details The Mgmt_Cache_req is provided to enable ZigBee devices on the network to
* retrieve a list of ZigBee End Devices registered with a Primary Discovery Cache
* device.\n\n The destination addressing on this primitive shall be unicast.
#ifdef ZB_SUPPORT_PRIORITY_5
/**
* @internal
- * @brief Called after 'extended simple descriptor request' command
+ * @brief Called after 'extended simple descriptor request' command.
* @details The Extended_Simple_Desc_rsp is generated by a remote device in response to an
* Extended_Simple_Desc_req directed to the remote device. This command shall
* be unicast to the originator of the Extended_Simple_Desc_req command.
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'extended simple descriptor request' command
+ * @brief Sends 'extended simple descriptor request' command.
* @details The Extended_Active_EP_req command is generated from a local device wishing
* to acquire the list of endpoints on a remote device with simple descriptors. This
* command shall be unicast either to the remote device itself or to an alternative
* @retval #ZIGBEE_ERROR_NONE Successful
* @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
* @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
*
* @see zb_zdo_extended_simple_desc_rsp()
* \#include <zigbee.h>
*
* @section CAPI_NETWORK_ZIGBEE_ZDO_SERVICE_DISCOVERY_OVERVIEW Overview
- * This API set consists of ZDP service discovery API
+ * This function set consists of ZDP service discovery API
*
* @{
*/
/**
* @internal
- * @brief Called after receiving 'find system server request'
+ * @brief Called after receiving 'find system server request'.
* @details The System_Server_Discovery_rsp is generated from Remote Devices on receipt
* of a System_Server_Discovery_req primitive if the parameter matches the Server
* Mask field in its node descriptor. If there is no match, the
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'find system server request' command
+ * @brief Sends 'find system server request' command.
* @details The System_Server_Discovery_req is generated from a Local Device wishing to
* discover the location of a particular system server or servers as indicated by the
* ServerMask parameter.\n\n The destination addressing on this request is 'broadcast to
/**
* @internal
- * @brief Called after 'find node cache request' command
+ * @brief Called after 'find node cache request' command.
* @details The Find_node_cache_rsp is provided to notify a Local Device of the successful
* iscovery of the Primary Discovery Cache device for the given NWKAddr and
* EEEAddr fields supplied in the request, or to signify that the device of interest is
void *user_data);
/**
+ * @platform
* @internal
- * @brief Send 'find Node cache store request' command
+ * @brief Sends 'find Node cache store request' command.
* @details The Find_node_cache_req is provided to enable ZigBee devices on the network to
* broadcast to all devices for which macRxOnWhenIdle = TRUE a request to find a
* device on the network that holds discovery information for the device of interest,
/**
* @internal
- * @brief Called after 'find discovery cache request' command
+ * @brief Called after 'find discovery cache request' command.
* @details The Find_node_cache_rsp is provided to notify a Local Device of the successful
* discovery of the Primary Discovery Cache device for the given NWKAddr and
* IEEEAddr fields supplied in the request, or to signify that the device of interest is
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'discovery cache request' command
+ * @brief Sends 'discovery cache request' command.
* @details The Discovery_Cache_req is provided to enable devices on the network to locate
* a Primary Discovery Cache device on the network.\n\n The destination addressing on
* this primitive shall be broadcast to all devices for which macRxOnWhenIdle =
/**
* @internal
- * @brief Called after 'find discovery store request' command
+ * @brief Called after 'find discovery store request' command.
* @details The Discovery_store_rsp is provided to notify a Local Device of the request status
* from a Primary Discovery Cache device. Included in the response is a status code
* to notify the Local Device whether the request is successful (the Primary Cache
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'discovery store request' command
+ * @brief Sends 'discovery store request' command.
* @details The Discovery_store_req is provided to enable ZigBee end devices on the
* network to request storage of their discovery cache information on a Primary
* Discovery Cache device.\n\n Included in the request is the amount of storage space
/**
* @internal
- * @brief Called after 'node description store request' command
+ * @brief Called after 'node description store request' command.
* @details The Node_store_rsp is provided to notify a Local Device of the request status
* from a Primary Discovery Cache device.\n\n Included in the response is a status code
* to notify the Local Device whether the request is successful (the Primary Cache
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'node description store request' command
+ * @brief Sends 'node description store request' command.
* @details The Node_Desc_store_req is provided to enable ZigBee end devices on the
* network to request storage of their Node Descriptor on a Primary Discovery
* Cache device which has previously received a SUCCESS status from a
/**
* @internal
- * @brief Called after 'power description store request' command
+ * @brief Called after 'power description store request' command.
* @details The Power_Desc_store_rsp is provided to notify a Local Device of the request
* status from a Primary Discovery Cache device. Included in the response is a status
* code to notify the Local Device whether the request is successful (the Primary
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'power description store request' command
+ * @brief Sends 'power description store request' command.
* @details The Power_Desc_store_req is provided to enable ZigBee end devices on the
* network to request storage of their Power Descriptor on a Primary Discovery
* Cache device which has previously received a SUCCESS status from a
void *user_data);
/**
+ * @platform
* @internal
- * @brief Called after 'active end-point store request' command
+ * @brief Called after 'active end-point store request' command.
* @details The Active_EP_store_rsp is provided to notify a Local Device of the request
* status from a Primary Discovery Cache device.\n\n Included in the response is a status
* code to notify the Local Device whether the request is successful (the Primary
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'active end-point store request' command
+ * @brief Sends 'active end-point store request' command.
* @details The Simple_desc_store_req is provided to enable ZigBee end devices on the
* network to request storage of their list of Simple Descriptors on a Primary
* Discovery Cache device which has previously received a SUCCESS status from a
/**
* @internal
- * @brief Called after 'simple description store request' command
+ * @brief Called after 'simple description store request' command.
* @details The Simple_Desc_store_rsp is provided to notify a Local Device of the request
* status from a Primary Discovery Cache device.\n\n Included in the response is a status
* code to notify the Local Device whether the request is successful (the Primary
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'simple description store request' command
+ * @brief Sends 'simple description store request' command.
* @details The Simple_desc_store_req is provided to enable ZigBee end devices on the
* network to request storage of their list of Simple Descriptors on a Primary
* Discovery Cache device which has previously received a SUCCESS status from a
/**
* @internal
- * @brief Called after 'simple description remove request' command
+ * @brief Called after 'simple description remove request' command.
* @details The Remove_node_cache_rsp is provided to notify a Local Device of the request
* status from a Primary Discovery Cache device.\n\n Included in the response is a status
* code to notify the Local Device whether the request is successful (the Primary
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'remove node cache request' command
+ * @brief Sends 'remove node cache request' command.
* @details The Remove_node_cache_req is provided to enable ZigBee devices on the
* network to request removal of discovery cache information for a specified ZigBee
* end device from a Primary Discovery Cache device.\n\n The effect of a successful
/**
* @internal
- * @brief Called after 'direct join management request' command
+ * @brief Called after 'direct join management request' command.
* @details The Mgmt_Direct_Join_rsp is generated in response to a Mgmt_Direct_Join_req.
* If this management command is not supported, a status of NOT_SUPPORTED
* shall be returned.\n\n Otherwise, the Remote Device shall implement the following
void *user_data);
/**
+ * @platform
* @internal
- * @brief Sends 'direct join device management request' command
+ * @brief Sends 'direct join device management request' command.
* @details The Mgmt_Direct_Join_req is generated from a Local Device requesting that a
* Remote Device permit a device designated by DeviceAddress to join the network
* directly.\n\n The Mgmt_Direct_Join_req is generated by a management application
}
#endif
-#endif /* __CAPI_NETWORK_ZIGBEE_INTERNAL_H__ */
+#endif /* __TIZEN_CAPI_NETWORK_ZIGBEE_INTERNAL_H__ */
projects / platform / core / api / zigbee.git / commitdiff