Fixed ACR issues 95/187595/3 accepted/tizen/unified/20180827.160635 submit/tizen/20180827.074353
authorsaerome.kim <saerome.kim@samsung.com>
Fri, 24 Aug 2018 11:30:30 +0000 (20:30 +0900)
committersaerome.kim <saerome.kim@samsung.com>
Mon, 27 Aug 2018 07:34:59 +0000 (16:34 +0900)
- Fixed typo
- The term ZigBee is unified into Zigbee.
- Delete links that indicate functions which do not exist.
- Remove un-documented descriptions in header files.
- Remove @sice tizen_5.0 at zigbee_doc.h
- Fix svace issues: 37822, 37818, 37817

Change-Id: If90d237a734b048a107d671f3a9d347685773af7
Signed-off-by: saerome.kim <saerome.kim@samsung.com>
13 files changed:
common/zb-utils.h
doc/zigbee_doc.h
include/zigbee-zcl-type.h
include/zigbee-zcl_internal.h
include/zigbee-zcl_private.h
include/zigbee-zdo-type.h
include/zigbee-zdo_internal.h
include/zigbee.h
include/zigbee_internal.h
include/zigbee_private.h
src/zbl-dbus.c
src/zbl-zdo.c
test/main.c

index ffc9aa3..1d4b7f3 100644 (file)
@@ -39,7 +39,7 @@ const char* zb_zdo_get_status_str(int id);
 /**
  * @brief Returns readable Zigbee profile id.
  * @since_tizen 5.0
- * @param[in] profileid ZigBee profile id
+ * @param[in] profileid Zigbee profile id
  * @return pointer of profile id string
  */
 const char* zb_end_dev_get_profile_id_str(zb_profile_id profileid);
@@ -47,7 +47,7 @@ const char* zb_end_dev_get_profile_id_str(zb_profile_id profileid);
 /**
  * @brief Returns readable Zigbee device id.
  * @since_tizen 5.0
- * @param[in] deviceid ZigBee device id
+ * @param[in] deviceid Zigbee device id
  * @return pointer of device id string
  */
 const char* zb_end_dev_get_device_id_str(zb_device_id deviceid);
@@ -55,7 +55,7 @@ const char* zb_end_dev_get_device_id_str(zb_device_id deviceid);
 /**
  * @brief Returns readable Zigbee Cluster Library error code for human.
  * @since_tizen 5.0
- * @param[in] id ZigBee Cluster Library Status code
+ * @param[in] id Zigbee Cluster Library Status code
  * @return pointer of status code string
  */
 const char* zb_zcl_get_status_str(int id);
@@ -63,7 +63,7 @@ const char* zb_zcl_get_status_str(int id);
 /**
  * @brief Returns readable cluster name for human.
  * @since_tizen 5.0
- * @param[in] id ZigBee Cluster ID
+ * @param[in] id Zigbee Cluster ID
  * @return pointer of cluster name string
  */
 const char* zb_zcl_get_cluster_id_str(int id);
index ead1ab9..b4ed637 100644 (file)
@@ -18,7 +18,7 @@
 
 /**
  * @ingroup CAPI_NETWORK_FRAMEWORK
- * @defgroup CAPI_NETWORK_ZIGBEE_MODULE ZigBee
+ * @defgroup CAPI_NETWORK_ZIGBEE_MODULE Zigbee
  *
  * @brief The Zigbee API provides functions for IoT connectivity.
  *
  *  \#include <zigbee.h>
  *
  * @section CAPI_NETWORK_ZIGBEE_ZDO_MODULE_OVERVIEW Overview
- * The ZigBee Device Object (ZDO) is simply the application running
- * on endpoint 0 in every ZigBee device. (Remember, application endpoints are numbered
+ * The Zigbee Device Object (ZDO) is simply the application running
+ * on endpoint 0 in every Zigbee device. (Remember, application endpoints are numbered
  * 1 through 240.)
  *
- * This application, ZDO, keeps track of the state of the ZigBee device on and off the
- * network, and provides an interface to the ZigBee Device Profile (ZDP), a specialized
+ * This application, ZDO, keeps track of the state of the Zigbee device on and off the
+ * network, and provides an interface to the Zigbee Device Profile (ZDP), a specialized
  * Application Profile (with profile ID 0x0000) for discovering, configuring, and
- * maintaining ZigBee devices and services on the network.
+ * maintaining Zigbee devices and services on the network.
  *
  * ZDO not only interacts with APS, but also interacts directly with the network layer.
  * ZDO controls the network layer, telling it when to form or join a network,
  * to join a network until it is successful, or until a user-specified number-of-retries has
  * occurred before giving up, and informing the application of the join failure.
  *
- * The over-the-air Application Profile supported by ZDO, called the ZigBee Device Profile
+ * The over-the-air Application Profile supported by ZDO, called the Zigbee Device Profile
  * (ZDP), is no different than any other, and in most stacks is handled just like any other
  * application object on an endpoint. ZDP services are separated into client and server.
- * Client side services (also called requests), are always optional in ZigBee, but many of the
+ * Client side services (also called requests), are always optional in Zigbee, but many of the
  * server side ZDP services (also called responses), are mandatory.
  * Nearly every service follows the same pattern when used. A client device (the node which
  * is doing the asking) first makes a request. The server device then sends the response back
  *
  * More details on using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  *  \#include <zigbee.h>
  *
  * @section CAPI_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_OVERVIEW Overview
- * The ZigBee Device Profile (ZDP) contains a set of commands for discovering various
- * aspects about nodes in the network. The ZigBee specification calls these "device
+ * The Zigbee Device Profile (ZDP) contains a set of commands for discovering various
+ * aspects about nodes in the network. The Zigbee specification calls these "device
  * discovery services," which can be confusing because endpoints contain device IDs which
- * really describe individual ZigBee applications running in that node. So, when you see
+ * really describe individual Zigbee applications running in that node. So, when you see
  * ZDP Device Discovery, think node-wide (not application/endpoint specific) services.
  *
  * Device discovery services have a few things in common:
  *
  * - They provide additional information about a node.
  * - They are all optional from the client side, but some server side processing is
- * mandatory (a common subset among all ZigBee devices).
+ * mandatory (a common subset among all Zigbee devices).
  * - They are node-wide, and do not represent any particular application, or
  * Application Profile residing on an endpoint in the node.
  *
  * The ZDP device discovery services are listed below in the section. Notice that all the
- * ZDP services on the client side are optional. ZigBee does not require that a node be able
+ * ZDP services on the client side are optional. Zigbee does not require that a node be able
  * to send NWK_addr_req , for example. But on the server side of this equation (a node
  * receiving a NWK_addr_req and responding to it), the ZDP service is mandatory.
  *
- * @since_tizen 5.0
- *
  */
 
   /**
  * an application. The simple descriptor contains many of the fields: an endpoint ID, a
  * profile ID, cluster IDs and a device ID.
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  *  \#include <zigbee.h>
  *
  * @section CAPI_NETWORK_ZIGBEE_ZCL_MODULE_OVERVIEW Overview
- * The ZigBee Cluster Library (ZCL) is intended to act as a repository for cluster
- * functionality that is developed by ZigBee and, as a consequence, it will be a
+ * The Zigbee Cluster Library (ZCL) is intended to act as a repository for cluster
+ * functionality that is developed by Zigbee and, as a consequence, it will be a
  * working library with regular updates as new functionality is added. A developer
  * constructing a new application profile should use the ZCL to find relevant cluster
  * functionality that can be incorporated into the new profile so as not to "re-invent
- * the wheel". This also allows ZigBee profiles to be developed with more of an
+ * the wheel". This also allows Zigbee profiles to be developed with more of an
  * object oriented style approach.
  *
  * @subsection CAPI_NETWORK_ZIGBEE_ZCL_MODULE_CLIENT_SERVER_MODEL Client/Server Model
  *
  * More details on using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  *
  * Generation of these commands is application dependent
  *
- * @since_tizen 5.0
- *
  */
 
  /**
  * original read attributes or read attributes structured command. The status field
  * shall contain a suitable status code.
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  * The write attributes response status record is generated in response to a write
  * attributes command.
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  * record shall contain the identifier and the actual value of the attribute to be
  * written.
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  * Note that attributes with data types of array, structure, set or bag cannot be
  * reported.
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  * Note that attributes with data types of array, structure, set or bag cannot be
  * reported.
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  * The Read Reporting Configuration Record is used to read the configuration
  * details of the reporting mechanism for one or more of the attributes of a cluster
  *
- * @since_tizen 5.0
- *
  */
 
 
  * zone device. IAS Zone supports up to two alarm types per zone, low battery
  * reports and supervision of the IAS network.
  *
- * @since_tizen 5.0
- *
  */
 
 /**
  * @section CAPI_NETWORK_ZIGBEE_ZCL_ON_OFF_CLUSTER_MODULE_OVERVIEW Overview
  * Attributes and commands for switching devices between 'On' and 'Off' states.
  *
- * @since_tizen 5.0
- *
  */
 
 
index 71ee77f..1b87d48 100644 (file)
@@ -150,24 +150,24 @@ typedef enum {
 
 /**
  * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_IAS_ZONE_CLUSTER_MODULE
- * @brief Values of the ZoneType Attribute.
+ * @brief Values of the Zone type attribute.
  *
  * @since_tizen 5.0
  */
 typedef enum {
        ZB_ZCL_IAS_ZONE_TYPE_STANDARD_CIE = 0x0000, /**< Zone type = Standard CIE, Alarm1 = System Alarm, Alarm2 = N/A */
-       ZB_ZCL_IAS_ZONE_TYPE_MOTION_SENSOR = 0x000d, /**< Zone type = Motion Sensor, Alarm1 = Intrusion indication, Alarm2 = Presence indication */
+       ZB_ZCL_IAS_ZONE_TYPE_MOTION_SENSOR = 0x000d, /**< Zone type = Motion sensor, Alarm1 = Intrusion indication, Alarm2 = Presence indication */
        ZB_ZCL_IAS_ZONE_TYPE_CONTACT_SWITCH = 0x0015, /**< Zone type = Contact switch, Alarm1 = 1st portal Open-Close, Alarm2 = 2nd portal Open-Close */
        ZB_ZCL_IAS_ZONE_TYPE_FIRE_SENSOR = 0x0028, /**< Zone type = Fire sensor, Alarm1 = Fire indication, Alarm2 : N/A */
        ZB_ZCL_IAS_ZONE_TYPE_WATER_SENSOR = 0x002a, /**< Zone type = Water sensor, Alarm1 = Water overflow indication, Alarm2 = N/A */
-       ZB_ZCL_IAS_ZONE_TYPE_GAS_SENSOR = 0x002b, /**< Zone type : Gas Sensor, Alarm1 = CO indication, Alarm2 = Cooking indication */
+       ZB_ZCL_IAS_ZONE_TYPE_GAS_SENSOR = 0x002b, /**< Zone type : Gas sensor, Alarm1 = CO indication, Alarm2 = Cooking indication */
        ZB_ZCL_IAS_ZONE_TYPE_PERSONAL_EMERGENCY_SENSOR = 0x002c, /**< Zone type = Personal emergency Sensor, Alarm1 = Fall / Concussion, Alarm2 = Emergency button */
-       ZB_ZCL_IAS_ZONE_TYPE_MOVEMENT_SENSOR = 0x002d, /**< Zone type = Vibration or Movement Sensor, Alarm1 = Movement indication, Alarm2 = Vibration */
+       ZB_ZCL_IAS_ZONE_TYPE_MOVEMENT_SENSOR = 0x002d, /**< Zone type = Vibration or Movement sensor, Alarm1 = Movement indication, Alarm2 = Vibration */
        ZB_ZCL_IAS_ZONE_TYPE_REMOTE_CONTROL = 0x010f, /**< Zone type = Remote control, Alarm1 = Panic, Alarm2 = Emergency  */
        ZB_ZCL_IAS_ZONE_TYPE_KEY_FOB = 0x0115, /**< Zone type : Key fob, Alarm1 = Panic, Alarm2 = Emergency */
        ZB_ZCL_IAS_ZONE_TYPE_KEYPAD = 0x021d, /**< Zone type : Keypad, Alarm1 = Panic, Alarm2 = Emergency */
        ZB_ZCL_IAS_ZONE_TYPE_STANDARD_WARNING_DEVICE = 0x0225, /**< Zone type = Standard Warning Device (e.g.,  Intruder Alarm Systems), Alarm1 = N/A, Alarm2 = N/A */
-       ZB_ZCL_IAS_ZONE_TYPE_INVALID = 0xffff, /**< Zone type : Invalid Zone Type, Alarm1 = N/A, Alarm2 = N/A */
+       ZB_ZCL_IAS_ZONE_TYPE_INVALID = 0xffff, /**< Zone type : Invalid zone type, Alarm1 = N/A, Alarm2 = N/A */
 } zb_zcl_ias_zone_type_e;
 
 /**
@@ -260,7 +260,7 @@ typedef void* zb_zcl_report_config_response_record_h;
 /**
  * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE
  * @brief ZCL attribute types (See #zb_zcl_data_type_e).
- * @details ZigBee devices, such as thermostats, lamps, etc., are defined in terms of the
+ * @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 #zb_zcl_data_type_e details the data types and formats that
  * can be used for these attributes. Note that individual clusters, which may use
@@ -631,7 +631,7 @@ typedef enum {
        ZB_ZCL_ATTR_DST_SHIFT = 0x0005, /**< Time shift. This represents a signed offset in seconds from the standard time, to be applied between the times #ZB_ZCL_ATTR_DST_START and ZB_ZCL_ATTR_DST_END to calculate the Local Time */
        ZB_ZCL_ATTR_STANDARD_TIME = 0x0006, /**< Standard time. The value 0xffffffff indicates an invalid Standard Time. */
        ZB_ZCL_ATTR_LOCAL_TIME = 0x0007, /**< Local time. The value 0xffffffff indicates an invalid Local Time. */
-       ZB_ZCL_ATTR_LAST_SET_TIME = 0x0008, /**< The most recent time that the Time attribute was set, either internally or over the ZigBee network. The value 0xffffffff indicates an invalid lst set Time*/
+       ZB_ZCL_ATTR_LAST_SET_TIME = 0x0008, /**< The most recent time that the Time attribute was set, either internally or over the Zigbee network. The value 0xffffffff indicates an invalid lst set Time*/
        ZB_ZCL_ATTR_VALID_UNTIL_TIME = 0x0009, /**< Valid until time indicates a time, later than LastSetTime, up to which the Time attribute may be trusted. 'Trusted' means that the difference between the Time attribute and the true UTC time is less than an acceptable error. */
 } zb_zcl_attr_time_e;
 
@@ -2002,7 +2002,7 @@ typedef enum {
 
 /**
  * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE
- * @brief CLient to server command types for cluster: IAS Zone.
+ * @brief Client to server command types for cluster: IAS Zone.
  * @details Cluster specification level: zcl-1.0-07-5123-03
  * @since_tizen 5.0
  * @remarks Direction : Client to Server
index 9347804..e2982f7 100644 (file)
@@ -836,16 +836,6 @@ int zb_extended_attr_info_set_acl(
  * @{
  */
 
-/* Generated Command IDs for the Alarms Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Alarm                                |     M      |
- * |             0x01               | Get alarm response                   |     O      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Called after 'get alarm' command.
  * @details The get alarm response command returns the results of a request to retrieve
@@ -878,18 +868,6 @@ typedef void (*zb_zcl_alarm_get_alarm_cb)(
                unsigned int time_stamp,
                void *user_data);
 
-/* Received Command IDs for the Alarms Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Reset Alarm                          |     M      |
- * |             0x01               | Reset all alarms                     |     M      |
- * |             0x02               | Get Alarm                            |     O      |
- * |             0x03               | Reset alarm log                      |     O      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Sends 'reset alarm' command.
  * @details This command resets a specific alarm. This is needed for some alarms that do
@@ -1034,7 +1012,7 @@ int zb_zcl_alarm_reset_all_alarm_log(
  * Attributes and commands for determining basic information about a device,
  * setting user device information such as location, enabling a device and resetting it
  * to factory defaults.
- * Note: Where a physical ZigBee node supports multiple endpoints it will often be
+ * Note: Where a physical Zigbee node supports multiple endpoints it will often be
  * the case that many of these settings will apply to the whole node, that is they are
  * the same for every endpoint on the device. In such cases they can be implemented
  * once for the node, and mapped to each endpoint.
@@ -1064,7 +1042,7 @@ int zb_zcl_alarm_reset_all_alarm_log(
  * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  */
 int zb_zcl_basic_reset_factory_default(
                zb_zigbee_h handle,
@@ -1102,25 +1080,6 @@ int zb_zcl_basic_reset_factory_default(
  * @{
  */
 
-/* Command IDs for the Color Control Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Move to Hue                          |     O      |
- * |             0x01               | Move Hue                             |     O      |
- * |             0x02               | Step Hue                             |     O      |
- * |             0x03               | Move to Saturation                   |     O      |
- * |             0x04               | Move Saturation                      |     O      |
- * |             0x05               | Step Saturation                      |     O      |
- * |             0x06               | Move to Hue and Saturation           |     O      |
- * |             0x07               | Move to Color                        |     M      |
- * |             0x08               | Move Color                           |     M      |
- * |             0x09               | Step Color                           |     M      |
- * |             0x0a               | Move to Color Temperature            |     O      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Sends 'move to hue' command.
  * @details On receipt of this command, a device shall also set the ColorMode attribute to the
@@ -1642,7 +1601,7 @@ int zb_zcl_ccontrol_move_to_color_temperature(
  *  \#include <zigbee.h>
  *
  * @section CAPI_NETWORK_ZIGBEE_ZCL_GROUP_CLUSTER_MODULE_OVERVIEW Overview
- * The ZigBee specification provides the capability for group addressing. That is,
+ * The Zigbee specification provides the capability for group addressing. That is,
  * any endpoint on any device may be assigned to one or more groups, each labeled
  * with a 16-bit identifier (0x0001 . 0xfff7), which acts for all intents and purposes
  * like a network address. Once a group is established, frames, sent having a DstAddrMode
@@ -1674,18 +1633,6 @@ int zb_zcl_ccontrol_move_to_color_temperature(
  * @{
  */
 
-/* Generated Command IDs for the Groups Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Add group response                   |     M      |
- * |             0x01               | View group response                  |     M      |
- * |             0x02               | Get group membership response        |     M      |
- * |             0x03               | Remove group response                |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Called after 'add group' command.
  * @details The add group response is sent by the groups cluster server in response to an
@@ -1791,20 +1738,6 @@ typedef void (*zb_zcl_group_remove_group_cb)(
                unsigned short group_id,
                void *user_data);
 
-/* Received Command IDs for the Groups Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Add group                            |     M      |
- * |             0x01               | View group                           |     M      |
- * |             0x02               | Get group membership                 |     M      |
- * |             0x03               | Remove group                         |     M      |
- * |             0x04               | Remove all group                     |     M      |
- * |             0x05               | Add group if identifying             |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Sends 'add groups' command.
  * @details The add group command allows the sending device to add group membership in a
@@ -2120,7 +2053,7 @@ typedef void (*zb_zcl_identify_query_cb)(
  * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  */
 int zb_zcl_identify_query(
                zb_zigbee_h handle,
@@ -2153,22 +2086,6 @@ int zb_zcl_identify_query(
  * @{
  */
 
-/* Command IDs for the Level Control Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Move to Level                        |     M      |
- * |             0x01               | Move                                 |     M      |
- * |             0x02               | Step                                 |     M      |
- * |             0x03               | Stop                                 |     M      |
- * |             0x04               | Move to Level (with On/Off)          |     M      |
- * |             0x05               | Move (with On/Off)                   |     M      |
- * |             0x06               | Step (with On/Off)                   |     M      |
- * |             0x07               | Stop                                 |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Sends 'move to level' command.
  * @details On receipt of this command, a device shall move from its current level to the
@@ -2534,16 +2451,6 @@ int zb_zcl_levelctrl_step_with_on_off(
  * @{
  */
 
-
-/* Commands Generated by the Poll Control Server
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Check-in                             |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Called after receiving 'check-in' event.
  * @details The Poll Control Cluster server sends out a Check-in command to the devices to
@@ -2599,18 +2506,6 @@ typedef void (*zb_zcl_pollctrl_check_in_cb)(
                zb_end_point ep,
                void *user_data);
 
-/* Commands Generated by the Poll Control Client in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Check-in Response                    |     M      |
- * |             0x00               | Fast Poll Stop                       |     M      |
- * |             0x00               | Set Long Poll Interval               |     O      |
- * |             0x00               | Set Short Poll Interval              |     O      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Sends 'check-in response'.
  * @details The Check-in Response is sent in response to the receipt of a Check-in command.
@@ -2805,21 +2700,6 @@ int zb_zcl_pollctrl_set_short_poll_interval(
  * @{
  */
 
-/* Generated Command IDs for the Scenes Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Add scene response                   |     M      |
- * |             0x01               | View scene response                  |     M      |
- * |             0x02               | Remove scene response                |     M      |
- * |             0x03               | Remove all scene response            |     M      |
- * |             0x04               | Store scene response                 |     M      |
- * |             0x05               | Reserved                             |     -      |
- * |             0x06               | Get scene membership response        |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Called after 'add scene' command.
  * @details This command is generated in response to a received Add Scene command.
@@ -3028,26 +2908,6 @@ typedef void (*zb_zcl_scene_get_scene_membership_cb)(
                unsigned char *scene_list,
                void *user_data);
 
-/* Received Command IDs for the Scenes Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Add scene                            |     M      |
- * |             0x01               | View scene                           |     M      |
- * |             0x02               | Remove scene                         |     M      |
- * |             0x03               | Remove all scene                     |     M      |
- * |             0x04               | Store scene                          |     M      |
- * |             0x05               | Recall scene                         |     M      |
- * |             0x06               | Get scene membership                 |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
-/* Reference : Extension field sets =
- *  {{ClusterID 1, length 1, {extension field set 1}}, {ClusterID 2, length 2,
- *  {extension field set 2}}, ... }.
- */
-
 /**
  * @brief Sends 'add scenes' command.
  * @details The Add Scene command shall be addressed to a single device (not a group)
@@ -3332,15 +3192,6 @@ int zb_zcl_scene_get_scene_membership(
  * @{
  */
 
-/* Command IDs for the Thermostat Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Setpoint Raise/Lower                 |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Sends 'setpoint raise/lower' command.
  * @details The attributes for the indicated setpoint(s) shall be increased by the amount
index 9ebcde7..f2db704 100644 (file)
@@ -187,6 +187,7 @@ int zb_zcl_global_attr_write_structured(
                void *user_data);
 
 /**
+ * @internal
  * @brief Creates reporting configuration response record.
  * @details Allocate memory for reporting configuration response record
  *
@@ -220,6 +221,7 @@ int zb_report_config_response_record_create(
                zb_zcl_report_config_response_record_h *handle);
 
 /**
+ * @internal
  * @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
@@ -258,6 +260,7 @@ int zb_report_config_response_record_set_status(
                zb_zcl_status_e status);
 
 /**
+ * @internal
  * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RESPONSE_RECORD_MODULE
  * @brief Sets the attribute identifier to a reporting configuration response record.
  * @details The attribute identifier field is 16 bits in length and shall contain the
@@ -288,6 +291,7 @@ int zb_report_config_response_record_set_id(
                zb_attribute_id id);
 
 /**
+ * @internal
  * @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).
@@ -328,6 +332,7 @@ int zb_report_config_response_record_set_dir(
                zb_zcl_fc_direction_e dir);
 
 /**
+ * @internal
  * @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).
@@ -356,6 +361,7 @@ int zb_read_report_config_record_get_dir(
                zb_zcl_fc_direction_e *dir);
 
 /**
+ * @internal
  * @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.
@@ -382,6 +388,7 @@ int zb_read_report_config_record_get_id(
                unsigned short *id);
 
 /**
+ * @internal
  * @brief Called after zb_zcl_global_discover_commands_received() and
  *        zb_zcl_global_discover_cmds_generated().
  * @details The ZCL provides the facility to discover the commands that a cluster
@@ -417,6 +424,7 @@ typedef void (*zb_zcl_global_discover_cmds_cb)(
                void *user_data);
 
 /**
+ * @internal
  * @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
@@ -477,6 +485,7 @@ int zb_zcl_global_discover_cmds_received(
            void *user_data);
 
 /**
+ * @internal
  * @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
@@ -536,6 +545,7 @@ int zb_zcl_global_discover_cmds_generated(
                void *user_data);
 
 /**
+ * @internal
  * @brief Called after zb_zcl_global_attr_extended_discover().
  * @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
@@ -570,6 +580,7 @@ typedef void (*zb_zcl_global_attr_extended_discover_cb)(
                void *user_data);
 
 /**
+ * @internal
  * @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
index 0ac4009..2b229db 100644 (file)
@@ -42,7 +42,7 @@ typedef enum {
 
 /**
  * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE
- * @brief RequestType Enumeration.
+ * @brief Request type Enumeration.
  * @since_tizen 5.0
  */
 typedef enum {
index 52c8892..1556532 100644 (file)
@@ -58,8 +58,8 @@ typedef void* zb_zdo_node_power_descriptor_h;
  *
  * The binding table is smart, and keeps track of both the short (16-bit NwkAddr) and long
  * (IEEE) address of a node. If a destination device has changed its short address (either
- * due to a ZigBee End-Device moving from one parent to another in ZigBee stack profile
- * 0x01, or due to a address conflict in ZigBee Pro), the binding table entry is updated
+ * due to a Zigbee End-Device moving from one parent to another in Zigbee stack profile
+ * 0x01, or due to a address conflict in Zigbee Pro), the binding table entry is updated
  * automatically to point to that new address.
  *
  */
@@ -172,7 +172,7 @@ typedef void (*zb_zdo_bind_cb)(
  * The destination addressing on this command shall be unicast only, and the destination
  * address shall be that of a Primary binding table cache or to the SrcAddress itself.
  * The Binding Manager is optionally supported on the source device (unless that
- * device is also the ZigBee Coordinator) so that device shall issue a
+ * device is also the Zigbee Coordinator) so that device shall issue a
  * #ZB_ZDP_STATUS_NOT_SUPPORTED status to the Bind_req if not supported.
  *
  * @since_tizen 5.0
@@ -229,12 +229,12 @@ int zb_zdo_bind_req(
  * @details The Unbind_cb 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 #ZB_ZDP_STATUS_NOT_SUPPORTED is returned. If the Remote Device is not
- * the ZigBee Coordinator or the SrcAddress, a Status of #ZB_ZDP_STATUS_NOT_SUPPORTED is
+ * the Zigbee Coordinator or the SrcAddress, a Status of #ZB_ZDP_STATUS_NOT_SUPPORTED is
  * returned.
  *
  * The supplied endpoint shall be checked to determine whether it falls within the
  * specified range. If it does not, a Status of #ZB_ZDP_STATUS_INVALID_EP shall be returned.
- * If the Remote Device is the ZigBee Coordinator or SrcAddress but does not have a
+ * If the Remote Device is the Zigbee Coordinator or SrcAddress but does not have a
  * Binding Table entry corresponding to the parameters received in the request, a
  * Status of #ZB_ZDP_STATUS_NO_ENTRY is returned.
  *
@@ -1132,13 +1132,13 @@ int zb_zdo_user_desc_set(
 /**
  * @internal
  * @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,
+ * @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
- * informing the Remote Devices of the capability of the ZigBee device.
+ * informing the Remote Devices of the capability of the Zigbee device.
  *
- * This command shall be invoked for all ZigBee end devices upon join or rejoin. This
- * command may also be invoked by ZigBee routers upon join or rejoin as part of
+ * This command shall be invoked for all Zigbee end devices upon join or rejoin. This
+ * command may also be invoked by Zigbee routers upon join or rejoin as part of
  * NWK address conflict resolution.
  *
  * The destination addressing on this primitive is
@@ -1533,16 +1533,16 @@ int zb_node_desc_destroy(zb_zdo_node_descriptor_h handle);
  * @internal
  * @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.
+ * specifies the device type of the Zigbee node.
  *
  * The logical type field shall be set to one of the non-reserved values.
  *
  * @since_tizen 5.0
  *
  * @param[in] handle The handle of node descriptor
- * @param[out] logical_type  0b000 : ZigBee coordinator \n
- *                          0b001 : ZigBee router \n
- *                          0b010 : ZigBee end device \n
+ * @param[out] logical_type  0b000 : Zigbee coordinator \n
+ *                          0b001 : Zigbee router \n
+ *                          0b010 : Zigbee end device \n
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #ZIGBEE_ERROR_NONE Successful
@@ -1558,16 +1558,16 @@ int zb_node_desc_get_logical_type(zb_zdo_node_descriptor_h handle,
  * @internal
  * @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.
+ * specifies the device type of the Zigbee node.
  *
  *  The logical type field shall be set to one of the non-reserved values.
  *
  * @since_tizen 5.0
  *
  * @param[in] handle The handle of node descriptor
- * @param[in] logical_type  0b000 : ZigBee coordinator \n
- *                          0b001 : ZigBee router \n
- *                          0b010 : ZigBee end device \n
+ * @param[in] logical_type  0b000 : Zigbee coordinator \n
+ *                          0b001 : Zigbee router \n
+ *                          0b010 : Zigbee end device \n
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #ZIGBEE_ERROR_NONE Successful
@@ -1899,7 +1899,7 @@ int zb_node_desc_set_mac_capability_flags(
  * @internal
  * @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
+ *  and specifies a manufacturer code that is allocated by the Zigbee Alliance, relating
  * the manufacturer to the device.
  *
  * @since_tizen 5.0
@@ -1922,7 +1922,7 @@ int zb_node_desc_get_manufacturer_code(
  * @internal
  * @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
+ *  and specifies a manufacturer code that is allocated by the Zigbee Alliance, relating
  * the manufacturer to the device.
  *
  * @since_tizen 5.0
@@ -2252,7 +2252,7 @@ int zb_node_desc_set_descriptor_capability_field(
  *
  * @section CAPI_NETWORK_ZIGBEE_ZDO_NETWORK_MANAGER_OVERVIEW Overview
  * The Network Management services are really handy optional services used for reading the
- * various tables contained within ZigBee nodes, and to request certain common actions
+ * various tables contained within Zigbee nodes, and to request certain common actions
  *
  * @since_tizen 5.0
  *
@@ -2357,7 +2357,7 @@ typedef void (*zb_zdo_find_node_cache_cb)(
 /**
  * @internal
  * @brief Sends 'find Node cache store request' command.
- * @details The Find_node_cache_req is provided to enable ZigBee devices on the network to
+ * @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,
  * as specified in the request parameters.
@@ -2480,7 +2480,7 @@ typedef void (*zb_zdo_discovery_store_cb)(
 /**
  * @internal
  * @brief Sends 'discovery store request' command.
- * @details The Discovery_store_req is provided to enable ZigBee end devices on the
+ * @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.
  *
@@ -2551,7 +2551,7 @@ typedef void (*zb_zdo_node_desc_store_cb)(
 /**
  * @internal
  * @brief Sends 'node description store request' command.
- * @details The Node_Desc_store_req is provided to enable ZigBee end devices on the
+ * @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 #ZB_ZDP_STATUS_SUCCESS status from a
  * Discovery_store_req to the same Primary Discovery Cache device.
@@ -2612,7 +2612,7 @@ typedef void (*zb_zdo_power_desc_store_cb)(
 /**
  * @internal
  * @brief Sends 'power description store request' command.
- * @details The Power_Desc_store_req is provided to enable ZigBee end devices on the
+ * @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 #ZB_ZDP_STATUS_SUCCESS status from a
  * Discovery_store_req to the same Primary Discovery Cache device. Included in
@@ -2674,7 +2674,7 @@ typedef void (*zb_zdo_active_ep_store_cb)(
 /**
  * @internal
  * @brief Sends 'active end-point store request' command.
- * @details The Simple_desc_store_req is provided to enable ZigBee end devices on the
+ * @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 #ZB_ZDP_STATUS_SUCCESS status
  * from a Discovery_store_req to the same Primary Discovery Cache device. Note that each
@@ -2746,7 +2746,7 @@ typedef void (*zb_zdo_simple_desc_store_cb)(
 /**
  * @internal
  * @brief Sends 'simple description store request' command.
- * @details The Simple_desc_store_req is provided to enable ZigBee end devices on the
+ * @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 #ZB_ZDP_STATUS_SUCCESS status
  * from a Discovery_store_req to the same Primary Discovery Cache device.
@@ -2817,14 +2817,14 @@ typedef void (*zb_zdo_remove_node_cache_cb)(
 /**
  * @internal
  * @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
+ * @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.
  *
  * The effect of a successful
  * Remove_node_cache_req is to undo a previously successful Discovery_store_req
  * and additionally remove any cache information stored on behalf of the specified
- * ZigBee end device on the Primary Discovery Cache device.
+ * Zigbee end device on the Primary Discovery Cache device.
  *
  * @since_tizen 5.0
  * @privilege %http://tizen.org/privilege/zigbee
@@ -2869,7 +2869,7 @@ int zb_zdo_remove_node_cache_req(
  *
  * @section CAPI_NETWORK_ZIGBEE_ZDO_NETWORK_MANAGER_OVERVIEW Overview
  * The Network Management services are really handy optional services used for reading the
- * various tables contained within ZigBee nodes, and to request certain common actions
+ * various tables contained within Zigbee nodes, and to request certain common actions
  *
  * @since_tizen 5.0
  *
@@ -3044,7 +3044,7 @@ typedef void (*zb_zdo_mgmt_lqi_cb)(
  * @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
- * the destination address must be that of a ZigBee Coordinator or ZigBee Router.
+ * the destination address must be that of a Zigbee Coordinator or Zigbee Router.
  *
  * @since_tizen 5.0
  * @privlevel public
@@ -3122,7 +3122,7 @@ typedef void (*zb_zdo_mgmt_rtg_cb)(
  * @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
- * must be that of the ZigBee Router or ZigBee Coordinator.
+ * must be that of the Zigbee Router or Zigbee Coordinator.
  *
  * @since_tizen 5.0
  * @privlevel public
@@ -3317,7 +3317,7 @@ int zb_zdo_mgmt_direct_join_req(
  * implement the following processing.
  *
  * Upon receipt of the Mgmt_Cache_req and after support for the Mgmt_Cache_req has been verified,
- * the Remote Device shall access an internally maintained list of registered ZigBee End Devices utilizing the
+ * the Remote Device shall access an internally maintained list of registered Zigbee End Devices utilizing the
  * discovery cache on this Primary Discovery Cache device. The entries reported
  * shall be those, starting with StartIndex and including whole DiscoveryCacheList
  * records until the limit on MSDU size, i.e., aMaxMACFrameSize is reached.
@@ -3354,8 +3354,8 @@ typedef void (*zb_zdo_mgmt_cache_cb)(
 /**
  * @internal
  * @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
+ * @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.
  *
  * The destination addressing on this primitive shall be unicast.
@@ -3511,7 +3511,7 @@ typedef void (*zb_zdo_mgmt_permit_joining_cb)(
  *
  * @param[in] handle The handle of zigbee
  * @param[in] addr16 destination network address
- * @param[in] permit_duration The length of time in seconds during which the ZigBee
+ * @param[in] permit_duration The length of time in seconds during which the Zigbee
  *                            coordinator or router will allow associations. \n
  *                            The value 0x00 and 0xff indicate that permission is
  *                            disabled or enabled, respectively, without a specified time
@@ -3598,7 +3598,7 @@ int zb_zdo_mgmt_nwk_update_req(
 /**
  * @internal
  * @brief Gets extended pan id from network list record.
- * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, Zigbee
  * called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record.
  *
  * Therefore this function can help parsing parameter in network_list_record.
@@ -3623,7 +3623,7 @@ int zb_network_list_record_get_extended_pan_id(
 /**
  * @internal
  * @brief Gets logical channel number from network list record.
- * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, Zigbee
  * called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has multiple network_list_record.
  *
  *  Therefore this function can help parsing parameter in network_list_record.
@@ -3648,8 +3648,8 @@ int zb_network_list_record_get_logical_channel(
 
 /**
  * @internal
- * @brief Gets ZigBee version from network list record.
- * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, ZigBee
+ * @brief Gets Zigbee version from network list record.
+ * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, Zigbee
  * called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record.
  *
  * Therefore this function can help parsing parameter in network_list_record.
@@ -3657,7 +3657,7 @@ int zb_network_list_record_get_logical_channel(
  * @since_tizen 5.0
  *
  * @param[in] handle The handle of node descriptor
- * @param[out] zigbee_version 0x0~0xf : The version of the ZigBee protocol in use
+ * @param[out] zigbee_version 0x0~0xf : The version of the Zigbee protocol in use
  *                             in the discovered network.
  *
  * @return 0 on success, otherwise a negative error value.
@@ -3674,7 +3674,7 @@ int zb_network_list_record_get_zigbee_version(
 /**
  * @internal
  * @brief Gets stack profile from network list record.
- * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, Zigbee
  * called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record.
  *
  * Therefore this function can help parsing parameter in network_list_record.
@@ -3682,7 +3682,7 @@ int zb_network_list_record_get_zigbee_version(
  * @since_tizen 5.0
  *
  * @param[in] handle The handle of node descriptor
- * @param[out] stack_profile 0x0~0xf : A ZigBee stack profile identifier indicating
+ * @param[out] stack_profile 0x0~0xf : A Zigbee stack profile identifier indicating
  *                             the stack profile in use in the discovered network.
  *
  * @return 0 on success, otherwise a negative error value.
@@ -3699,7 +3699,7 @@ int zb_network_list_record_get_stack_profile(
 /**
  * @internal
  * @brief Gets beacon order from network list record.
- * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, Zigbee
  * called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record.
  *
  * Therefore this function can help parsing parameter in network_list_record.
@@ -3726,7 +3726,7 @@ int zb_network_list_record_get_beacon_order(
 /**
  * @internal
  * @brief Gets superframe order from network list record.
- * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, Zigbee
  * called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record.
  *
  * Therefore this function can help parsing parameter in network_list_record.
@@ -3753,7 +3753,7 @@ int zb_network_list_record_get_superframe_order(
 /**
  * @internal
  * @brief Gets permit joining from network list record.
- * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_nwk_disc_cb() callback (originally, Zigbee
  * called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record.
  *
  * Therefore this function can help parsing parameter in network_list_record.
@@ -3762,7 +3762,7 @@ int zb_network_list_record_get_superframe_order(
  *
  * @param[in] handle The handle of node descriptor
  * @param[out] permit_joining 0 or 1 : A value of TRUE indicates that at least one
- * ZigBee router on the network currently permits joining, i.e., its NWK has been
+ * Zigbee router on the network currently permits joining, i.e., its NWK has been
  * issued an NLME-PERMIT-JOINING primitive and the time limit, if given, has
  * not yet expired.
  *
@@ -3963,7 +3963,7 @@ int zb_routing_table_get_next_hop_addr(
 /**
  * @internal
  * @brief Gets extended pan id from neighbor table list record.
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -3996,7 +3996,7 @@ int zb_neighbor_table_desc_get_extended_pan_id(
 /**
  * @internal
  * @brief Gets IEEE address from neighbor table list record.
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  * Therefore this function can help parsing parameter in neigbor_table_list.
  *
@@ -4030,7 +4030,7 @@ int zb_neighbor_table_desc_get_ieee_addr(
 /**
  * @internal
  * @brief Gets network address from neighbor table list record..
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -4066,7 +4066,7 @@ int zb_neighbor_table_desc_get_nwk_addr(
 /**
  * @internal
  * @brief Gets device type from neighbor table list record..
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -4075,9 +4075,9 @@ int zb_neighbor_table_desc_get_nwk_addr(
  *
  * @param[in] handle The handle of node descriptor
  * @param[out] device_type The type of the neighbor device: \n
- *                         0x0 = ZigBee coordinator \n
- *                         0x1 = ZigBee router \n
- *                         0x2 = ZigBee end device \n
+ *                         0x0 = Zigbee coordinator \n
+ *                         0x1 = Zigbee router \n
+ *                         0x2 = Zigbee end device \n
  *                         0x3 = Unknown \n
  *
  * @return 0 on success, otherwise a negative error value.
@@ -4103,7 +4103,7 @@ int zb_neighbor_table_desc_get_device_type(
 /**
  * @internal
  * @brief Gets RxOnWhenIdle value from neighbor table list record..
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -4141,7 +4141,7 @@ int zb_neighbor_table_desc_get_rx_on_when_idle(
 /**
  * @internal
  * @brief Gets Relationship value from neighbor table list record.
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -4180,7 +4180,7 @@ int zb_neighbor_table_desc_get_relationship(
 /**
  * @internal
  * @brief Gets Permit joining value from neighbor table list record.
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -4217,7 +4217,7 @@ int zb_neighbor_table_desc_get_permit_joining(
 /**
  * @internal
  * @brief Gets Depth value from neighbor table list record.
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -4227,7 +4227,7 @@ int zb_neighbor_table_desc_get_permit_joining(
  * @param[in] handle The handle of node descriptor
  * @param[out] depth The 0x00~nwkcMaxDepth (see. Zigbee Spec.) \n
  *                   tree depth of the neighbor device. \n
- *                   A value of 0x00 indicates that the device is the ZigBee
+ *                   A value of 0x00 indicates that the device is the Zigbee
  *                   coordinator for the network.
  *
  * @return 0 on success, otherwise a negative error value.
@@ -4253,7 +4253,7 @@ int zb_neighbor_table_desc_get_depth(
 /**
  * @internal
  * @brief Gets LQI (Link-Quality Indicator) value from neighbor table list record.
- * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_lqi_cb() callback (originally, Zigbee
  * called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list.
  *
  * Therefore this function can help parsing parameter in neigbor_table_list.
@@ -4262,7 +4262,7 @@ int zb_neighbor_table_desc_get_depth(
  *
  * @param[in] handle The handle of node descriptor
  * @param[out] lqi The estimated link quality for RF transmissions from this device. \n
- *                 (see ZigBee specification for discussion of how this is calculated.)
+ *                 (see Zigbee specification for discussion of how this is calculated.)
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #ZIGBEE_ERROR_NONE Successful
@@ -4287,7 +4287,7 @@ int zb_neighbor_table_desc_get_lqi(
 /**
  * @internal
  * @brief Gets source MAC address from binding table record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in binding_table structure.
@@ -4311,7 +4311,7 @@ int zb_binding_table_get_src_addr(
 /**
  * @internal
  * @brief Gets SrcEndpoint from binding table record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in binding_table structure.
@@ -4335,7 +4335,7 @@ int zb_binding_table_get_src_ep(
 /**
  * @internal
  * @brief Gets ClusterId from binding table record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in binding_table structure.
@@ -4360,7 +4360,7 @@ int zb_binding_table_get_cluster_id(
 /**
  * @internal
  * @brief Gets DstAddrMode from binding table record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in binding_table structure.
@@ -4392,7 +4392,7 @@ int zb_binding_table_get_dst_addr_mode(
 /**
  * @internal
  * @brief Gets nwk DstAddr from binding table record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in binding_table structure.
@@ -4418,7 +4418,7 @@ int zb_binding_table_get_dst_addr16(
 /**
  * @internal
  * @brief Gets ieee DstAddr from binding table record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in binding_table structure.
@@ -4444,7 +4444,7 @@ int zb_binding_table_get_dst_addr64(
 /**
  * @internal
  * @brief Gets DstEndPoint from binding table record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in binding_table structure.
@@ -4470,7 +4470,7 @@ int zb_binding_table_get_dst_ep(
 /**
  * @internal
  * @brief Gets ExtendedAddress from discovery cache record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Cache_rsp (ClusterID = 0x8037) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in discovery cache list record.
@@ -4494,7 +4494,7 @@ int zb_discovery_cache_get_ieee_addr(
 /**
  * @internal
  * @brief Gets NetworkAddress from discovery cache record.
- * @details When received zb_zdo_mgmt_bind_cb() callback (originally, ZigBee
+ * @details When received zb_zdo_mgmt_bind_cb() callback (originally, Zigbee
  * called Mgmt_Cache_rsp (ClusterID = 0x8037) ), it has multiple binding table.
  *
  * Therefore this function can help parsing parameter in discovery cache list record.
index 2892e9a..0d97fe4 100644 (file)
@@ -26,7 +26,7 @@ extern "C" {
 
 /**
  * @ingroup CAPI_NETWORK_FRAMEWORK
- * @addtogroup CAPI_NETWORK_ZIGBEE_MODULE ZigBee
+ * @addtogroup CAPI_NETWORK_ZIGBEE_MODULE Zigbee
  *
  * @{
  */
@@ -369,7 +369,7 @@ typedef void (*zb_event_cb)(zb_nwk_addr addr16, zb_ieee_addr addr64, zb_event_e
 int zb_set_event_cb(zb_zigbee_h handle, zb_event_cb event_handler);
 
 /**
- * @brief Gets status code of enable commmand.
+ * @brief Gets status code of enable command.
  * @since_tizen 5.0
  *
  * @param[in] ev Event data structure
@@ -1001,7 +1001,7 @@ int zb_end_dev_get_cluster_list(zb_zigbee_h handle, zb_ieee_addr addr64, zb_end_
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_list_free(zb_end_dev_info_h *list);
 
@@ -1079,8 +1079,7 @@ int zb_end_dev_info_destroy(zb_end_dev_info_h handle);
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_foreach_end_dev_info()
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_network_address(zb_end_dev_info_h handle,
                zb_nwk_addr *addr16);
@@ -1098,7 +1097,7 @@ int zb_end_dev_info_get_network_address(zb_end_dev_info_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_ieee_address(zb_end_dev_info_h handle, zb_ieee_addr addr64);
 
@@ -1115,7 +1114,7 @@ int zb_end_dev_info_get_ieee_address(zb_end_dev_info_h handle, zb_ieee_addr addr
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_num_of_ep(zb_end_dev_info_h handle, unsigned char *count);
 
@@ -1135,7 +1134,7 @@ int zb_end_dev_info_get_num_of_ep(zb_end_dev_info_h handle, unsigned char *count
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  # @see zb_end_dev_info_get_num_of_ep()
  */
 int zb_end_dev_info_get_ep_list(zb_end_dev_info_h handle, zb_end_point **ep_list);
@@ -1155,7 +1154,7 @@ int zb_end_dev_info_get_ep_list(zb_end_dev_info_h handle, zb_end_point **ep_list
  * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_mac_capability(zb_end_dev_info_h handle,
        zb_zdp_mac_capability_field_e *capability);
@@ -1175,7 +1174,7 @@ int zb_end_dev_info_get_mac_capability(zb_end_dev_info_h handle,
  * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_alternative_pan_coordinator(
                zb_end_dev_info_h handle, zb_zdp_do_pan_coordinator_e *can_do_it);
@@ -1196,7 +1195,7 @@ int zb_end_dev_info_get_alternative_pan_coordinator(
  * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_device_id(zb_end_dev_info_h handle, zb_end_point ep,
                zb_device_id *deviceid);
@@ -1217,7 +1216,7 @@ int zb_end_dev_info_get_device_id(zb_end_dev_info_h handle, zb_end_point ep,
  * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_profile_id(zb_end_dev_info_h handle, zb_end_point ep,
                zb_profile_id *profileid);
@@ -1237,7 +1236,7 @@ int zb_end_dev_info_get_profile_id(zb_end_dev_info_h handle, zb_end_point ep,
  * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
 int zb_end_dev_info_get_power_source(zb_end_dev_info_h handle,
                zb_zdp_power_e *power_src);
@@ -1257,9 +1256,9 @@ int zb_end_dev_info_get_power_source(zb_end_dev_info_h handle,
  * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_get_end_dev_info_list()
+ * @see zb_end_dev_get_end_dev_info_list()
  */
-int zb_end_dev_info_get_security_capabilty(zb_end_dev_info_h handle,
+int zb_end_dev_info_get_security_capability(zb_end_dev_info_h handle,
                zb_zdp_security_cap_e *sec_capability);
 
 /**
@@ -1674,7 +1673,7 @@ int zb_simple_desc_set_out_clusters(zb_zdo_simple_desc_h handle,
  * @param[out] start_idx Starting index into the list of associated devices for this
  *                       report. If the RequestType in the request is Extended Response
  *                       and there are no associated devices on the Remote Device,
- *                       this field shall not be included in the ZigBee data frame.
+ *                       this field shall not be included in the Zigbee data frame.
  *                       If an error occurs or the RequestType in the request is
  *                       for a Single Device Response, this field shall not
  *                       be included.
@@ -1684,7 +1683,7 @@ int zb_simple_desc_set_out_clusters(zb_zdo_simple_desc_h handle,
  *                               in the NumAssocDev field.
  *                               If the RequestType in the request is Extended Response
  *                               and there are no associated devices on the Remote Device,
- *                               this field shall not be included in the ZigBee data frame.
+ *                               this field shall not be included in the Zigbee data frame.
  *                               If an error occurs or the RequestType in the request is
  *                               for a Single Device Response, this field shall not
  *                               be included.
@@ -1726,7 +1725,7 @@ typedef void (*zb_zdo_addr_cb)(zb_zdp_status_e status, zb_ieee_addr remote_dev_a
  * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zdo_nwk_addr_cb()
+ * @see zb_zdo_addr_cb()
  */
 int zb_zdo_nwk_addr_req(zb_zigbee_h handle, zb_ieee_addr addr64,
                zb_zdp_req_type_e request_type, unsigned char start_idx, zb_zdo_addr_cb cb,
@@ -1755,7 +1754,7 @@ int zb_zdo_nwk_addr_req(zb_zigbee_h handle, zb_ieee_addr addr64,
  * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zdo_ieee_addr_cb()
+ * @see zb_zdo_addr_cb()
  */
 int zb_zdo_ieee_addr_req(zb_zigbee_h handle, zb_nwk_addr addr16, zb_zdo_addr_cb cb,
                void *user_data);
@@ -2434,7 +2433,7 @@ int zb_zcl_global_attr_read(
  * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error
  * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  * @see zb_write_attr_status_clone()
  * @see zb_write_attr_status_destroy()
  * @see zb_write_attr_status_get_status()
@@ -2460,7 +2459,7 @@ int zb_write_attr_status_create(zb_zcl_write_attr_status_record_h *handle);
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  * @see zb_write_attr_status_create()
  * @see zb_write_attr_status_destroy()
  * @see zb_write_attr_status_get_status()
@@ -2484,7 +2483,7 @@ int zb_write_attr_status_clone(zb_zcl_write_attr_status_record_h src,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  * @see zb_write_attr_status_create()
  * @see zb_write_attr_status_clone()
  * @see zb_write_attr_status_get_status()
@@ -2514,7 +2513,7 @@ int zb_write_attr_status_destroy(zb_zcl_write_attr_status_record_h handle);
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  * @see zb_write_attr_status_create()
  * @see zb_write_attr_status_clone()
  * @see zb_write_attr_status_destroy()
@@ -2542,7 +2541,7 @@ int zb_write_attr_status_get_status(
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  * @see zb_write_attr_status_create()
  * @see zb_write_attr_status_clone()
  * @see zb_write_attr_status_destroy()
@@ -2574,7 +2573,7 @@ int zb_write_attr_status_set_status(
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  * @see zb_write_attr_status_create()
  * @see zb_write_attr_status_clone()
  * @see zb_write_attr_status_destroy()
@@ -2606,7 +2605,7 @@ int zb_write_attr_status_get_id(
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_write_attr_cb()
+ * @see zb_zcl_global_attr_write_cb()
  * @see zb_write_attr_status_create()
  * @see zb_write_attr_status_clone()
  * @see zb_write_attr_status_destroy()
@@ -2667,7 +2666,7 @@ typedef void (*zb_zcl_global_attr_write_cb)(
  *
  * @see zb_zcl_global_attr_write()
  * @see zb_zcl_global_attr_write_undivided()
- * @see zb_zcl_global_write_attr_no_rep()
+ * @see zb_zcl_global_attr_write_no_rsp()
  * @see zb_write_attr_record_destroy()
  * @see zb_write_attr_record_set_id()
  * @see zb_write_attr_record_set_value()
@@ -2689,9 +2688,8 @@ int zb_write_attr_record_create(zb_zcl_write_attr_record_h *handle);
  *
  * @see zb_zcl_global_attr_write()
  * @see zb_zcl_global_attr_write_undivided()
- * @see zb_zcl_global_write_attr_no_rep()
+ * @see zb_zcl_global_attr_write_no_rsp()
  * @see zb_write_attr_record_create()
- * @see zb_write_attr_record_clone()
  * @see zb_write_attr_record_set_id()
  * @see zb_write_attr_record_set_value()
  */
@@ -2715,7 +2713,7 @@ int zb_write_attr_record_destroy(zb_zcl_write_attr_record_h handle);
  *
  * @see zb_zcl_global_attr_write()
  * @see zb_zcl_global_attr_write_undivided()
- * @see zb_zcl_global_write_attr_no_rep()
+ * @see zb_zcl_global_attr_write_no_rsp()
  * @see zb_write_attr_record_create()
  * @see zb_write_attr_record_destroy()
  * @see zb_write_attr_record_set_value()
@@ -2741,7 +2739,7 @@ int zb_write_attr_record_set_id(zb_zcl_write_attr_record_h handle,
  *
  * @see zb_zcl_global_attr_write()
  * @see zb_zcl_global_attr_write_undivided()
- * @see zb_zcl_global_write_attr_no_rep()
+ * @see zb_zcl_global_attr_write_no_rsp()
  * @see zb_write_attr_record_create()
  * @see zb_write_attr_record_destroy()
  * @see zb_write_attr_record_set_id()
@@ -2772,7 +2770,7 @@ int zb_write_attr_record_set_type(zb_zcl_write_attr_record_h handle,
  *
  * @see zb_zcl_global_attr_write()
  * @see zb_zcl_global_attr_write_undivided()
- * @see zb_zcl_global_write_attr_no_rep()
+ * @see zb_zcl_global_attr_write_no_rsp()
  * @see zb_write_attr_record_create()
  * @see zb_write_attr_record_destroy()
  * @see zb_write_attr_record_set_id()
@@ -3139,7 +3137,7 @@ typedef void (*zb_zcl_global_config_report_write_cb)(
  * @retval #ZIGBEE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
  * @see zb_report_config_record_get_id()
@@ -3175,7 +3173,7 @@ int zb_report_config_record_create(zb_zcl_reporting_config_record_h *handle);
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  * @retval #ZIGBEE_ERROR_NO_DATA No data
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_destroy()
  * @see zb_report_config_record_get_id()
@@ -3208,7 +3206,7 @@ int zb_report_config_record_clone(zb_zcl_reporting_config_record_h src,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_get_id()
@@ -3262,7 +3260,7 @@ int zb_report_config_record_destroy(zb_zcl_reporting_config_record_h handle);
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3317,7 +3315,7 @@ int zb_report_config_record_get_dir(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3356,7 +3354,7 @@ int zb_report_config_record_set_dir(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3395,7 +3393,7 @@ int zb_report_config_record_get_id(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3431,7 +3429,7 @@ int zb_report_config_record_set_id(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3471,7 +3469,7 @@ int zb_report_config_record_get_type(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3510,7 +3508,7 @@ int zb_report_config_record_get_min_interval(zb_zcl_reporting_config_record_h ha
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3549,7 +3547,7 @@ int zb_report_config_record_set_min_interval(zb_zcl_reporting_config_record_h ha
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3588,7 +3586,7 @@ int zb_report_config_record_get_max_interval(zb_zcl_reporting_config_record_h ha
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3631,7 +3629,7 @@ int zb_report_config_record_set_max_interval(zb_zcl_reporting_config_record_h ha
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3674,7 +3672,7 @@ int zb_report_config_record_get_timeout(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3728,7 +3726,7 @@ int zb_report_config_record_set_timeout(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -3771,7 +3769,7 @@ int zb_report_config_record_get_change(zb_zcl_reporting_config_record_h handle,
  * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported
  *
- * @see zb_zcl_global_read_report_config_cb()
+ * @see zb_zcl_global_config_report_read_cb()
  * @see zb_report_config_record_create()
  * @see zb_report_config_record_clone()
  * @see zb_report_config_record_destroy()
@@ -4042,27 +4040,6 @@ int zb_zcl_global_config_report_read(
  * @{
  */
 
-/* Generated Command IDs for the IAS Zone Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Zone Status Change Notification      |     M      |
- * |             0x01               | Zone Enroll Request                  |     M      |
- * |             0x11               | Zone Status Change Notification (Ext)|     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
-
-/* Received Command IDs for the IAS Zone Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Zone Enroll Response                 |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief Values of the Enroll Response Code in Zigbee Cluster Library.
  *
@@ -4125,17 +4102,6 @@ int zb_zcl_zone_enroll_response(
  * @{
  */
 
-/* Command IDs for the On/Off Cluster in Zigbee Cluster Library
- * +--------------------------------+--------------------------------------+------------+
- * |Command Identifier Field Value  |              Description             | Mandatory/ |
- * |                                |                                      | Optional   |
- * +--------------------------------+--------------------------------------+------------+
- * |             0x00               | Off                                  |     M      |
- * |             0x01               | On                                   |     M      |
- * |             0x02               | Toggle                               |     M      |
- * +--------------------------------+--------------------------------------+------------+
- */
-
 /**
  * @brief On/Off/Toggle value.
  *
index 565ac3d..44bd2b2 100644 (file)
@@ -32,7 +32,7 @@ extern "C" {
 
 /**
  * @ingroup CAPI_NETWORK_FRAMEWORK
- * @addtogroup CAPI_NETWORK_ZIGBEE_MODULE ZigBee
+ * @addtogroup CAPI_NETWORK_ZIGBEE_MODULE Zigbee
  *
  * @{
  */
index 4929595..1484022 100644 (file)
@@ -346,7 +346,7 @@ int zb_coex_stop(zb_zigbee_h handle);
  * @platform
  * @internal
  * @brief Sets start-up attribute set.
- * @details In order to ensure interoperability, all ZigBee HA devices should implement
+ * @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
  * implement these stack settings to ensure compatibility and consistent user
index 0951abe..005db6a 100644 (file)
@@ -3743,10 +3743,14 @@ int zbl_get_all_device_info(zb_end_dev_info_h **dev_list, unsigned char* num)
                                        list = NULL;
                                }
                                g_variant_iter_free(iter);
-                               if (NULL != mac_iter)
+                               if (mac_iter) {
                                        g_variant_iter_free(mac_iter);
-                               if (NULL != endpoint_iter)
+                                       mac_iter = NULL;
+                               }
+                               if (endpoint_iter) {
                                        g_variant_iter_free(endpoint_iter);
+                                       endpoint_iter = NULL;
+                               }
                                g_variant_unref(variant);
                                return ZIGBEE_ERROR_IO_ERROR;
                        }
@@ -3770,14 +3774,20 @@ int zbl_get_all_device_info(zb_end_dev_info_h **dev_list, unsigned char* num)
                                DBG("Endpoint : %d", value_endpoint);
                                k++;
                        }
-                       g_variant_iter_free(endpoint_iter);
+                       if (endpoint_iter) {
+                               g_variant_iter_free(endpoint_iter);
+                               endpoint_iter = NULL;
+                       }
 
                        /* Get IEEE address */
                        while (g_variant_iter_loop(mac_iter, "y", &value)) {
                                node_mac_address[j] = value;
                                j++;
                        }
-                       g_variant_iter_free(mac_iter);
+                       if (mac_iter) {
+                               g_variant_iter_free(mac_iter);
+                               mac_iter = NULL;
+                       }
 
                        memcpy(list[i]->addr64, node_mac_address, sizeof(zb_ieee_addr));
                        DBG("Node MAC Addr : %02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X",
index b716a8c..45e261b 100644 (file)
@@ -50,11 +50,16 @@ API int zb_end_dev_get_ep_list(zb_zigbee_h handle, zb_ieee_addr addr64,
        RETV_IF(NULL == ep_list, ZIGBEE_ERROR_INVALID_PARAMETER);
 
        ret = zbl_get_endpoint_list(addr64, &cnt, eplist);
-       *count = cnt;
-       if (cnt > 0) {
-               *ep_list = calloc(cnt + 1, sizeof(unsigned char));
-               RETV_IF(NULL == *ep_list, ZIGBEE_ERROR_OUT_OF_MEMORY);
-               memcpy(*ep_list, eplist, cnt);
+       if (ZIGBEE_ERROR_NONE == ret) {
+               if (cnt > 0) {
+                       *ep_list = calloc(cnt + 1, sizeof(unsigned char));
+                       if (NULL == *ep_list) {
+                               *count = 0;
+                               return ZIGBEE_ERROR_OUT_OF_MEMORY;
+                       }
+                       memcpy(*ep_list, eplist, cnt);
+                       *count = cnt;
+               }
        }
        return ret;
 }
@@ -79,17 +84,26 @@ API int zb_end_dev_get_cluster_list(zb_zigbee_h handle, zb_ieee_addr addr64,
 
        ret = zbl_get_cluster_list(addr64, ep, &in_cnt, in_clusters,
                        &out_cnt, out_clusters);
-       *in_cluster_count = in_cnt;
-       if (in_cnt > 0) {
-               *in_cluster_list = calloc(in_cnt + 1, sizeof(unsigned short));
-               RETV_IF(NULL == *in_cluster_list, ZIGBEE_ERROR_OUT_OF_MEMORY);
-               memcpy(*in_cluster_list, in_clusters, in_cnt * sizeof(unsigned short));
-       }
-       *out_cluster_count = out_cnt;
-       if (out_cnt > 0) {
-               *out_cluster_list = calloc(out_cnt + 1, sizeof(unsigned short));
-               RETV_IF(NULL == *out_cluster_list, ZIGBEE_ERROR_OUT_OF_MEMORY);
-               memcpy(*out_cluster_list, out_clusters, out_cnt * sizeof(unsigned short));
+       if (ZIGBEE_ERROR_NONE == ret) {
+               if (in_cnt > 0) {
+                       *in_cluster_list = calloc(in_cnt + 1, sizeof(unsigned short));
+                       RETV_IF(NULL == *in_cluster_list, ZIGBEE_ERROR_OUT_OF_MEMORY);
+                       memcpy(*in_cluster_list, in_clusters, in_cnt * sizeof(unsigned short));
+                       *in_cluster_count = in_cnt;
+               }
+
+               if (out_cnt > 0) {
+                       *out_cluster_list = calloc(out_cnt + 1, sizeof(unsigned short));
+                       if (NULL == *out_cluster_list) {
+                               if (in_cluster_list) {
+                                       free(in_cluster_list);
+                                       in_cluster_list = NULL;
+                               }
+                               return ZIGBEE_ERROR_OUT_OF_MEMORY;
+                       }
+                       memcpy(*out_cluster_list, out_clusters, out_cnt * sizeof(unsigned short));
+                       *out_cluster_count = out_cnt;
+               }
        }
 
        return ret;
@@ -303,7 +317,7 @@ API int zb_end_dev_info_get_power_source(zb_end_dev_info_h handle,
        return ZIGBEE_ERROR_NONE;
 }
 
-API int zb_end_dev_info_get_security_capabilty(zb_end_dev_info_h handle,
+API int zb_end_dev_info_get_security_capability(zb_end_dev_info_h handle,
        zb_zdp_security_cap_e*sec_capability)
 {
        struct zb_end_device_info_s *h = handle;
index b721676..5eac0cd 100644 (file)
@@ -208,7 +208,7 @@ static void _init_endpoints()
        st_ep4.in_clusters[4] = 0xFC46;
        st_ep4.out_clusters[0] = ZB_ZCL_CLUSTER_OTA_BOOTLOAD;
 
-       /* Things Simulator - GE_ZigBeeDimmer */
+       /* Things Simulator - GE_ZigbeeDimmer */
        dimmer_ep1.ep = 1;
        dimmer_ep1.profileid = 0x0104;
        dimmer_ep1.deviceid = 0xffff;
@@ -918,6 +918,14 @@ static int run_get_cluster_list(MManager *mm, struct menu_data *menu)
        if (ZIGBEE_ERROR_NONE != ret) {
                msg("zb_end_dev_get_cluster_list (%d) - FAILED!!! [%s]",
                        ret, zigbee_error_to_string(ret));
+               if (in_cluster_list) {
+                       free(in_cluster_list);
+                       in_cluster_list = NULL;
+               }
+               if (out_cluster_list) {
+                       free(out_cluster_list);
+                       out_cluster_list = NULL;
+               }
                return RET_FAILURE;
        }
 
@@ -1337,7 +1345,7 @@ int main(int arg, char **argv)
        mainloop = g_main_loop_new(NULL, FALSE);
 
        msg("");
-       msg("* ZigBee Test application ");
+       msg("* Zigbee Test application ");
        msg("* Build On: %s  %s", __DATE__, __TIME__);
 
        if (__create_init_menu(init_menu) == FALSE)