From: Jiwan Kim Date: Wed, 22 Mar 2017 04:21:54 +0000 (+0900) Subject: Fix ACR issues X-Git-Tag: submit/tizen/20170512.045637~27 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5b3e747f6f9766f35cc182c3864efa040ab27d69;p=platform%2Fcore%2Fapi%2Fzigbee.git Fix ACR issues - @details : Change to use upper case - @brief : Change to use upper case - @enum : Change to use upper case - Fix typos Change-Id: I7f238f091ff721b8ac7820329de993aead640d31 Signed-off-by: Jiwan Kim --- diff --git a/include/zb_error.h b/include/zb_error.h index 05c756a..1a4fc15 100644 --- a/include/zb_error.h +++ b/include/zb_error.h @@ -36,14 +36,14 @@ */ typedef enum { ZIGBEE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ - ZIGBEE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< parameter error */ - ZIGBEE_ERROR_PARAMETER_OUT_OF_RANGE = TIZEN_ERROR_RESULT_OUT_OF_RANGE, /**< out of range error */ - ZIGBEE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< out of memory */ + ZIGBEE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Parameter error */ + ZIGBEE_ERROR_PARAMETER_OUT_OF_RANGE = TIZEN_ERROR_RESULT_OUT_OF_RANGE, /**< Out of range error */ + ZIGBEE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ ZIGBEE_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< DBus error */ ZIGBEE_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< No data available */ - ZIGBEE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< not supported */ - ZIGBEE_ERROR_INVALID_ENDPOINT = TIZEN_ERROR_ZIGBEE | 0x01, /**< endpoint 0 is reserved for ZDP */ - ZIGBEE_ERROR_INVALID_ADDRESS = TIZEN_ERROR_ZIGBEE | 0x02, /**< wrong address */ + ZIGBEE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ + ZIGBEE_ERROR_INVALID_ENDPOINT = TIZEN_ERROR_ZIGBEE | 0x01, /**< Endpoint 0 is reserved for ZDP */ + ZIGBEE_ERROR_INVALID_ADDRESS = TIZEN_ERROR_ZIGBEE | 0x02, /**< Wrong address */ } zb_error_e; /** diff --git a/include/zb_ha.h b/include/zb_ha.h index 06335d0..e64b77e 100644 --- a/include/zb_ha.h +++ b/include/zb_ha.h @@ -60,7 +60,7 @@ typedef enum { ZB_HA_LIGHT_SENSOR = 0x0106, /**< Light sensor device */ ZB_HA_OCUPANCY_SENSOR = 0x0107, /**< Ocupancy sensor device */ /* Closures devices */ - ZB_HA_SHADE = 0x0200, /**< shade device */ + ZB_HA_SHADE = 0x0200, /**< Shade device */ ZB_HA_SHADE_CONTROLLER = 0x0201, /**< Shade controller device */ ZB_HA_WINDOW_COVERING_DEVICE = 0x0202, /**< Window covering device */ ZB_HA_WINDOW_COVERING_CONTROLLER = 0x0203, /**< Window covering controller device */ @@ -74,10 +74,10 @@ typedef enum { ZB_HA_FLOW_SENSOR = 0x0306, /**< Flow sensor device */ ZB_HA_MINI_SPLIT_AC = 0x0307, /**< Mini split device */ /* Intruder Alarms system */ - ZB_HA_ISA_CONTROL_AND_INDICATING_EQUIPMENT = 0x0400, /**< ISA control and indicating equipment device */ - ZB_HA_ISA_ANCILLARY_CONTROL_EQUIPMENT = 0x0401, /**< ISA ancillary control device */ - ZB_HA_ISA_ZONE = 0x0402, /**< ISA zone device */ - ZB_HA_ISA_WARNIGN_DEVICE = 0x0403, /**< ISA warning device */ + ZB_HA_IAS_CONTROL_AND_INDICATING_EQUIPMENT = 0x0400, /**< IAS control and indicating equipment device */ + ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT = 0x0401, /**< IAS ancillary control device */ + ZB_HA_IAS_ZONE = 0x0402, /**< IAS zone device */ + ZB_HA_IAS_WARNIGN_DEVICE = 0x0403, /**< IAS warning device */ } ha_device_id_e; diff --git a/include/zb_type.h b/include/zb_type.h index 7f74a61..5fe8308 100644 --- a/include/zb_type.h +++ b/include/zb_type.h @@ -27,7 +27,7 @@ * @ingroup CAPI_NETWORK_ZIGBEE_MODULE * @defgroup CAPI_NETWORK_ZIGBEE_COMMON_MODULE Common * - * @brief zigbee common types provides the set of definitions to use zigbee service + * @brief Zigbee common types provides the set of definitions to use zigbee service * * @section CAPI_NETWORK_ZIGBEE_COMMON_MODULE_HEADER header * \#include @@ -60,7 +60,7 @@ typedef unsigned char aes128_key[16]; /** * @brief The handle of zigbee -* @details a zigbee_h is an opaque data structure.\n +* @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 @@ -293,8 +293,8 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_FC_GLOBALLY_USED = (0 << 0), /**< profile widely used */ - ZB_APS_FC_CLUSTER_SPECIFIC = (1 << 0), /**< cluster specific */ + ZB_ZCL_FC_GLOBALLY_USED = (0 << 0), /**< Profile widely used */ + ZB_APS_FC_CLUSTER_SPECIFIC = (1 << 0), /**< Cluster specific */ } zb_zcl_fc_type_e; /** @@ -303,8 +303,8 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_FC_NOT_MANUFACTURER = (0 << 2), /**< manufacturer code not present */ - ZB_ZCL_FC_MANUFACTURER = (1 << 2), /**< manufacturer code present */ + ZB_ZCL_FC_NOT_MANUFACTURER = (0 << 2), /**< Manufacturer code not present */ + ZB_ZCL_FC_MANUFACTURER = (1 << 2), /**< Manufacturer code present */ } zb_zcl_fc_manufacturer_present_e; /** @@ -313,8 +313,8 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_CLIENT_TO_SERVER = (0 << 3), /**< request */ - ZB_ZCL_SERVER_TO_CLIENT = (1 << 3), /**< response */ + ZB_ZCL_CLIENT_TO_SERVER = (0 << 3), /**< Request */ + ZB_ZCL_SERVER_TO_CLIENT = (1 << 3), /**< Response */ } zb_zcl_fc_direction_e; /** @@ -323,8 +323,8 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_LEAVE_WELL_ALONE = (0 << 4), /**< enable default response */ - ZB_ZCL_DISABLE_DEFAULT_RESPONSE = (1 << 4), /**< disable default response */ + ZB_ZCL_LEAVE_WELL_ALONE = (0 << 4), /**< Enable default response */ + ZB_ZCL_DISABLE_DEFAULT_RESPONSE = (1 << 4), /**< Disable default response */ } zb_zcl_fc_disable_default_response_e; /** diff --git a/include/zb_zcl.h b/include/zb_zcl.h index 7fa4aac..6c5e658 100644 --- a/include/zb_zcl.h +++ b/include/zb_zcl.h @@ -80,7 +80,7 @@ const char* zb_get_cluster_name(int id); /** * @brief Returns measuring unit of attribute type - * @details this help to know measuring unit of attribute type + * @details This helps to know measuring unit of attribute type * * @since_tizen 4.0 * @@ -143,7 +143,7 @@ void zb_destroy_value( /** * @brief Sets value from zb_value_h - * @details get data from zb_value_h, expected value type as follows : \n + * @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 * aes128_key key16 : 128-bit key \n @@ -171,7 +171,7 @@ int zb_set_value(zb_value_h handle, unsigned char type, unsigned char *value, in /** * @brief Gets value from zb_value_h - * @details get data from zb_value_h, expected value type as follows : \n + * @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 * -> 1st byte is string length, the other are string data.) \n @@ -1946,7 +1946,7 @@ int zb_get_id_from_read_report_config_record( unsigned short *id); /** - * @brief Gets 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. * diff --git a/include/zb_zdo.h b/include/zb_zdo.h index b1ff459..64327bf 100644 --- a/include/zb_zdo.h +++ b/include/zb_zdo.h @@ -24,7 +24,7 @@ * @ingroup CAPI_NETWORK_ZIGBEE_MODULE * @defgroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE Zigbee Device Object * - * @brief zigbee provides API for ZDO access. + * @brief Zigbee provides API for ZDO access. * * @section CAPI_NETWORK_ZIGBEE_ZDO_MODULE_HEADER Header * \#include @@ -43,8 +43,8 @@ #include /** - * @brief Return readable ZDO error code - * @details Return ZDO error code string + * @brief Returns readable ZDO error code + * @details Returns ZDO error code string * * @since_tizen 4.0 * @@ -56,8 +56,8 @@ const char* zb_zdo_get_error_message(int id); /** - * @brief Return readable Zigbee profile id - * @details Return Zigbee profile id + * @brief Returns readable Zigbee profile id + * @details Returns Zigbee profile id * * @since_tizen 4.0 * @@ -82,8 +82,8 @@ const char* zb_get_profile_id_string(int profile_id); const char* zb_get_device_id_string(int device_id); /** - * @brief Create simple descriptor - * @details Create simple descriptor handle + * @brief Creates simple descriptor + * @details Creates simple descriptor handle * * @since_tizen 4.0 * @@ -101,8 +101,8 @@ int zb_simple_desc_create( zb_zdo_simple_desc_h *handle); /** - * @brief copy simple descriptor - * @details copy simple descriptor handle to another + * @brief Copies simple descriptor + * @details Copies simple descriptor handle to another * * @since_tizen 4.0 * @@ -121,8 +121,8 @@ int zb_simple_desc_copy( zb_zdo_simple_desc_h dst); /** - * @brief destroy simple descriptor handle - * @details destroy simple descriptor allocated memory + * @brief Destroys simple descriptor handle + * @details Destroys simple descriptor allocated memory * * @since_tizen 4.0 * @@ -139,8 +139,8 @@ int zb_simple_desc_destroy( zb_zdo_simple_desc_h handle); /** - * @brief get active endpoint number from simple descriptor handle - * @details get 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 * @@ -158,8 +158,8 @@ int zb_simple_desc_get_ep( unsigned char *ep); /** - * @brief set active endpoint number to simple descriptor handle - * @details set active endpoint number to simple descriptor handle + * @brief Set active endpoint number to simple descriptor handle + * @details Set active endpoint number to simple descriptor handle * * @since_tizen 4.0 * @@ -177,8 +177,8 @@ int zb_simple_desc_set_ep( unsigned char ep); /** - * @brief get profile id from simple descriptor handle - * @details get 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 * @@ -196,8 +196,8 @@ int zb_simple_desc_get_profile_id( unsigned short *profile_id); /** - * @brief set profile id to simple descriptor handle - * @details set 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 * @@ -215,8 +215,8 @@ int zb_simple_desc_set_profile_id( unsigned short profile_id); /** - * @brief set device id from simple descriptor handle - * @details set 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 * @@ -234,8 +234,8 @@ int zb_simple_desc_get_device_id( unsigned short *device_id); /** - * @brief set device id to simple descriptor handle - * @details set 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 * @@ -253,8 +253,8 @@ int zb_simple_desc_set_device_id( unsigned short device_id); /** - * @brief get device version from simple descriptor handle - * @details get 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 * @@ -272,8 +272,8 @@ int zb_simple_desc_get_device_ver( unsigned short *device_ver); /** - * @brief set device version to simple descriptor handle - * @details set 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 * @@ -291,8 +291,8 @@ int zb_simple_desc_set_device_ver( unsigned short device_ver); /** - * @brief get number of input clusters from simple descriptor handle - * @details get 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 * @@ -310,8 +310,8 @@ int zb_simple_desc_get_num_of_in_clusters( unsigned char *num_of_in_clusters); /** - * @brief get number of input clusters to simple descriptor handle - * @details get 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 * @@ -329,8 +329,8 @@ int zb_simple_desc_set_num_of_in_clusters( unsigned char num_of_in_clusters); /** - * @brief get number of output clusters from simple descriptor handle - * @details get 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 * @@ -348,8 +348,8 @@ int zb_simple_desc_get_num_of_out_clusters( unsigned char *num_of_out_clusters); /** - * @brief set number of output clusters to simple descriptor handle - * @details set 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 * @@ -367,8 +367,8 @@ int zb_simple_desc_set_num_of_out_clusters( unsigned char num_of_out_clusters); /** - * @brief get input cluster list from simple descriptor handle - * @details get 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 * @@ -386,8 +386,8 @@ int zb_simple_desc_get_in_clusters( unsigned short **in_clusters); /** - * @brief set input cluster list to simple descriptor handle - * @details set 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 * @@ -407,8 +407,8 @@ int zb_simple_desc_set_in_clusters( int num); /** - * @brief get output cluster list from simple descriptor handle - * @details get 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 * @@ -426,8 +426,8 @@ int zb_simple_desc_get_out_clusters( unsigned short **out_clusters); /** - * @brief set output cluster list to simple descriptor handle - * @details set 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 * @@ -447,8 +447,8 @@ int zb_simple_desc_set_out_clusters( int num); /** - * @brief Create node power descriptor - * @details Create node power descriptor handle + * @brief Creates node power descriptor + * @details Creates node power descriptor handle * * @since_tizen 4.0 * @@ -466,8 +466,8 @@ int zb_node_power_desc_create( zb_zdo_node_power_descriptor_h *handle); /** - * @brief copy node power descriptor - * @details copy node power descriptor handle + * @brief Copies node power descriptor + * @details Copies node power descriptor handle * * @since_tizen 4.0 * @@ -486,8 +486,8 @@ int zb_node_power_desc_copy( zb_zdo_node_power_descriptor_h dst); /** - * @brief destroy node power descriptor - * @details destroy node power descriptor handle + * @brief Destroys node power descriptor + * @details Destroys node power descriptor handle * * @since_tizen 4.0 * @@ -504,7 +504,7 @@ int zb_node_power_desc_destroy( zb_zdo_node_power_descriptor_h handle); /** - * @brief get 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 @@ -530,7 +530,7 @@ int zb_node_power_desc_get_current_power_mode( unsigned char* current_power_mode); /** - * @brief set 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 @@ -557,7 +557,7 @@ int zb_node_power_desc_set_current_power_mode( unsigned char current_power_mode); /** - * @brief get 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 @@ -581,7 +581,7 @@ int zb_node_power_desc_get_available_power_sources( unsigned char* available_power_sources); /** - * @brief set 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 @@ -606,7 +606,7 @@ int zb_node_power_desc_set_available_power_sources( unsigned char available_power_sources); /** - * @brief get 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 @@ -630,7 +630,7 @@ int zb_node_power_desc_get_current_power_source( unsigned char* current_power_source); /** - * @brief set available power mode from node power descriptor + * @brief Sets available power mode 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 @@ -655,7 +655,7 @@ int zb_node_power_desc_set_current_power_source( unsigned char current_power_source); /** - * @brief get 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 @@ -679,7 +679,7 @@ int zb_node_power_desc_get_current_power_source_level( unsigned char* current_power_source_level); /** - * @brief set 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 @@ -703,8 +703,8 @@ int zb_node_power_desc_set_current_power_source_level( unsigned char current_power_source_level); /** - * @brief Create node descriptor - * @details Create node descriptor handle + * @brief Creates node descriptor + * @details Creates node descriptor handle * * @since_tizen 4.0 * @@ -722,8 +722,8 @@ int zb_node_desc_create( zb_zdo_node_descriptor_h *handle); /** - * @brief copy node descriptor - * @details copy node descriptor handle + * @brief Copies node descriptor + * @details Copies node descriptor handle * * @since_tizen 4.0 * @@ -742,8 +742,8 @@ int zb_node_desc_copy( zb_zdo_node_descriptor_h dst); /** - * @brief destroy node descriptor - * @details destroy node descriptor handle + * @brief Destroys node descriptor + * @details Destroys node descriptor handle * * @since_tizen 4.0 * @@ -760,7 +760,7 @@ int zb_node_desc_destroy( zb_zdo_node_descriptor_h handle); /** - * @brief get 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. @@ -783,7 +783,7 @@ int zb_node_desc_get_logical_type( unsigned char* logical_type); /** - * @brief set 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. @@ -807,7 +807,7 @@ int zb_node_desc_set_logical_type( unsigned char logical_type); /** - * @brief get 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 @@ -830,7 +830,7 @@ int zb_node_desc_get_complex_desciptor_available( unsigned char* complex_desciptor_available); /** - * @brief set 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 @@ -854,7 +854,7 @@ int zb_node_desc_set_complex_descriptor_available( unsigned char complex_desciptor_available); /** - * @brief get 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. @@ -877,7 +877,7 @@ int zb_node_desc_get_user_descriptor_available( unsigned char* user_descriptor_available); /** - * @brief set 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. @@ -901,7 +901,7 @@ int zb_node_desc_set_user_descriptor_available( unsigned char user_descriptor_available); /** - * @brief get 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. @@ -921,7 +921,7 @@ int zb_node_desc_get_aps_flags( zb_zdo_node_descriptor_h handle, unsigned char* aps_flags); /** - * @brief set 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. @@ -943,7 +943,7 @@ int zb_node_desc_set_aps_flags( unsigned char aps_flags); /** - * @brief get 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 @@ -969,7 +969,7 @@ int zb_node_desc_get_frequency_band( unsigned char* frequency_band); /** - * @brief set 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 @@ -996,7 +996,7 @@ int zb_node_desc_set_frequency_band( unsigned char frequency_band); /** - * @brief get 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 @@ -1045,7 +1045,7 @@ int zb_node_desc_get_mac_capability_flags( unsigned char* mac_capability_flags); /** - * @brief set 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 @@ -1094,7 +1094,7 @@ int zb_node_desc_set_mac_capability_flags( unsigned char mac_capability_flags); /** - * @brief get 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. @@ -1115,7 +1115,7 @@ int zb_node_desc_get_manufacturer_code( unsigned short* manufacturer_code); /** - * @brief set 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. @@ -1136,7 +1136,7 @@ int zb_node_desc_set_manufacturer_code( unsigned short manufacturer_code); /** - * @brief get 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 @@ -1160,7 +1160,7 @@ int zb_node_desc_get_maximum_buffer_size( unsigned char* maximum_buffer_size); /** - * @brief set 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 @@ -1185,7 +1185,7 @@ int zb_node_desc_set_maximum_buffer_size( unsigned char maximum_buffer_size); /** - * @brief get 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 @@ -1208,7 +1208,7 @@ int zb_node_desc_get_maximum_incoming_transfer_size( unsigned short* maximum_incoming_transfer_size); /** - * @brief set 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 @@ -1232,7 +1232,7 @@ int zb_node_desc_set_maximum_incoming_transfer_size( unsigned short maximum_incoming_transfer_size); /** - * @brief get 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 @@ -1261,7 +1261,7 @@ int zb_node_desc_get_server_mask( unsigned short* server_mask); /** - * @brief set 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 @@ -1291,7 +1291,7 @@ int zb_node_desc_set_server_mask( unsigned short server_mask); /** - * @brief get 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 @@ -1314,7 +1314,7 @@ int zb_node_desc_get_maximum_outgoing_transfer_size( unsigned short* maximum_outgoing_transfer_size); /** - * @brief set 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 @@ -1338,7 +1338,7 @@ int zb_node_desc_set_maximum_outgoing_transfer_size( unsigned short maximum_outgoing_transfer_size); /** - * @brief get 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 @@ -1361,7 +1361,7 @@ int zb_node_desc_get_descriptor_capability_field( unsigned short* descriptor_capability_field); /** - * @brief set 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 @@ -1385,7 +1385,7 @@ int zb_node_desc_set_descriptor_capability_field( unsigned short descriptor_capability_field); /** - * @brief get 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. @@ -1407,7 +1407,7 @@ int zb_network_list_record_get_extended_pan_id( ieee_addr extended_pan_id); /** - * @brief get 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. @@ -1430,7 +1430,7 @@ int zb_network_list_record_get_logical_channel( unsigned char* logical_channel); /** - * @brief get 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. @@ -1452,7 +1452,7 @@ int zb_network_list_record_get_zigbee_version( unsigned char* zigbee_version); /** - * @brief get 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. @@ -1474,7 +1474,7 @@ int zb_network_list_record_get_stack_profile( unsigned char* stack_profile); /** - * @brief get 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. @@ -1497,7 +1497,7 @@ int zb_network_list_record_get_beacon_order( unsigned char* beacon_order); /** - * @brief get 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. @@ -1520,7 +1520,7 @@ int zb_network_list_record_get_superframe_order( unsigned char* superframe_order); /** - * @brief get 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. @@ -1544,7 +1544,7 @@ int zb_network_list_record_get_permit_joining( unsigned char* permit_joining); /** - * @brief get 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. @@ -1570,7 +1570,7 @@ int zb_routing_table_get_dst_addr(zb_zdo_routing_table_h handle, nwk_addr* dst_addr); /** - * @brief get 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. @@ -1601,7 +1601,7 @@ int zb_routing_table_get_dst_status(zb_zdo_routing_table_h handle, unsigned char* status); /** - * @brief get 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. @@ -1628,7 +1628,7 @@ int zb_routing_table_get_memory_constrained( zb_zdo_routing_table_h handle, unsigned char* memory_constrained); /** - * @brief get 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. @@ -1655,7 +1655,7 @@ int zb_routing_table_get_many_to_one(zb_zdo_routing_table_h handle, unsigned char* many_to_one); /** - * @brief get 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. @@ -1683,7 +1683,7 @@ int zb_routing_table_get_route_record_required( zb_zdo_routing_table_h handle, unsigned char* route_record_required); /** - * @brief get 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. @@ -1709,7 +1709,7 @@ int zb_routing_table_get_next_hop_addr( zb_zdo_routing_table_h handle, nwk_addr* next_hop_addr); /** - * @brief get 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. @@ -1739,7 +1739,7 @@ int zb_neighbor_table_desc_get_extended_pan_id( ieee_addr extended_pan_id); /** - * @brief get 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. @@ -1771,7 +1771,7 @@ int zb_neighbor_table_desc_get_ieee_addr( ieee_addr addr64); /** - * @brief get 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. @@ -1803,7 +1803,7 @@ int zb_neighbor_table_desc_get_nwk_addr( nwk_addr* addr16); /** - * @brief get 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. @@ -1837,7 +1837,7 @@ int zb_neighbor_table_desc_get_device_type( unsigned char* device_type); /** - * @brief get 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. @@ -1872,7 +1872,7 @@ int zb_neighbor_table_desc_get_rx_on_when_idle( unsigned char* rx_on_when_idle); /** - * @brief get 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. @@ -1908,7 +1908,7 @@ int zb_neighbor_table_desc_get_relationship( unsigned char* releationship); /** - * @brief get 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. @@ -1942,7 +1942,7 @@ int zb_neighbor_table_desc_get_permit_joining( unsigned char* permit_joining); /** - * @brief get 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. @@ -1975,7 +1975,7 @@ int zb_neighbor_table_desc_get_depth( unsigned char* depth); /** - * @brief get 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. @@ -2006,7 +2006,7 @@ int zb_neighbor_table_desc_get_lqi( unsigned char* lqi); /** - * @brief get 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. @@ -2027,7 +2027,7 @@ int zb_binding_table_get_src_addr( ieee_addr src_addr); /** - * @brief get 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. @@ -2048,7 +2048,7 @@ int zb_binding_table_get_src_ep( unsigned char *src_ep); /** - * @brief get 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. @@ -2070,7 +2070,7 @@ int zb_binding_table_get_cluster_id( unsigned short *cluster_id); /** - * @brief get 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. @@ -2099,7 +2099,7 @@ int zb_binding_table_get_dst_addr_mode( unsigned char *dst_addr_mode); /** - * @brief get DstAddr from binding table record + * @brief Gets 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. @@ -2122,7 +2122,7 @@ int zb_binding_table_get_dst_addr16( nwk_addr *addr16); /** - * @brief get DstAddr from binding table record + * @brief Gets 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. @@ -2145,7 +2145,7 @@ int zb_binding_table_get_dst_addr64( ieee_addr addr64); /** - * @brief get 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. @@ -2168,7 +2168,7 @@ int zb_binding_table_get_dst_ep( unsigned char *dst_ep); /** - * @brief get 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. @@ -2189,7 +2189,7 @@ int zb_discovery_cache_get_ieee_addr( ieee_addr addr64); /** - * @brief get 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. diff --git a/include/zcl/zb_zcl_attribute_ids.h b/include/zcl/zb_zcl_attribute_ids.h index 5f34443..32b4ba7 100644 --- a/include/zcl/zb_zcl_attribute_ids.h +++ b/include/zcl/zb_zcl_attribute_ids.h @@ -209,7 +209,7 @@ typedef enum { */ typedef enum { ZB_ZCL_SWITCH_TYPE_ATTRIBUTE_ID = 0x0000, /**< Switch type */ - ZB_ZCL_SWITCH_ACTIONS_ATTRIBUTE_ID = 0x0010, /**< Swicth action */ + ZB_ZCL_SWITCH_ACTIONS_ATTRIBUTE_ID = 0x0010, /**< Switch action */ } zb_zcl_on_off_switc_configuration_server_attributes_e; /** @@ -857,7 +857,7 @@ typedef enum { ZB_ZCL_ZONE_ID_ATTRIBUTE_ID = 0x0011, /**< Zone ID */ ZB_ZCL_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_ATTRIBUTE_ID = 0x0012, /**< Number of zone sensitivity levels supported */ ZB_ZCL_CURRENT_ZONE_SENSITIVITY_LEVEL_ATTRIBUTE_ID = 0x0013, /**< Current zone sensitivity level */ -} zb_zcl_isa_zone_server_server_attributes_e; +} zb_zcl_ias_zone_server_server_attributes_e; /** * @brief Attribute types for cluster: IAS WD @@ -868,7 +868,7 @@ typedef enum { */ typedef enum { ZB_ZCL_MAX_DURATION_ATTRIBUTE_ID = 0x0000, /**< Max. duration */ -} zb_zcl_isa_wd_server_server_attributes_e; +} zb_zcl_ias_wd_server_server_attributes_e; /** * @brief Attribute types for cluster: Electrical Measurement @@ -919,11 +919,11 @@ typedef enum { ZB_ZCL_POWER_DIVISOR_ATTRIBUTE_ID = 0x0403, /**< Power divisor */ ZB_ZCL_HARMONIC_CURRENT_MULTIPLIER_ATTRIBUTE_ID = 0x0404, /**< Harmonic current multiplier */ ZB_ZCL_PHASE_HARMONIC_CURRENT_MULTIPLIER_ATTRIBUTE_ID = 0x0405, /**< Phase harmonic current multiplier */ - ZB_ZCL_INSTANTANEOUS_VOLTAGE_ATTRIBUTE_ID = 0x0500, /**< Instaneous voltage */ - ZB_ZCL_INSTANTANEOUS_LINE_CURRENT_ATTRIBUTE_ID = 0x0501, /**< Instaneous line current */ - ZB_ZCL_INSTANTANEOUS_ACTIVE_CURRENT_ATTRIBUTE_ID = 0x0502, /**< Instaneous active current */ - ZB_ZCL_INSTANTANEOUS_REACTIVE_CURRENT_ATTRIBUTE_ID = 0x0503, /**< Instaneous reactive current */ - ZB_ZCL_INSTANTANEOUS_POWER_ATTRIBUTE_ID = 0x0504, /**< Instaneous power */ + ZB_ZCL_INSTANTANEOUS_VOLTAGE_ATTRIBUTE_ID = 0x0500, /**< Instantaneous voltage */ + ZB_ZCL_INSTANTANEOUS_LINE_CURRENT_ATTRIBUTE_ID = 0x0501, /**< Instantaneous line current */ + ZB_ZCL_INSTANTANEOUS_ACTIVE_CURRENT_ATTRIBUTE_ID = 0x0502, /**< Instantaneous active current */ + ZB_ZCL_INSTANTANEOUS_REACTIVE_CURRENT_ATTRIBUTE_ID = 0x0503, /**< Instantaneous reactive current */ + ZB_ZCL_INSTANTANEOUS_POWER_ATTRIBUTE_ID = 0x0504, /**< Instantaneous power */ ZB_ZCL_RMS_VOLTAGE_ATTRIBUTE_ID = 0x0505, /**< RMS voltage */ ZB_ZCL_RMS_VOLTAGE_MIN_ATTRIBUTE_ID = 0x0506, /**< RMS voltage min. */ ZB_ZCL_RMS_VOLTAGE_MAX_ATTRIBUTE_ID = 0x0507, /**< RMS voltage max. */ diff --git a/include/zcl/zb_zcl_attribute_type.h b/include/zcl/zb_zcl_attribute_type.h index 2a98774..9778bde 100644 --- a/include/zcl/zb_zcl_attribute_type.h +++ b/include/zcl/zb_zcl_attribute_type.h @@ -24,7 +24,7 @@ * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE * @defgroup CAPI_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_DATA_TYPE_MODULE Cluster Attribute Data Type * - * @brief zigbee cluster attribute data type + * @brief Zigbee cluster attribute data type * * @section CAPI_NETWORK_ZIGBEE_ZCL_ATTRIBUTE_DATA_TYPE_MODULE_HEADER Header * \#include diff --git a/include/zcl/zb_zcl_commands.h b/include/zcl/zb_zcl_commands.h index 0b2dcf7..4f527fa 100644 --- a/include/zcl/zb_zcl_commands.h +++ b/include/zcl/zb_zcl_commands.h @@ -61,7 +61,7 @@ typedef enum { ZB_ZCL_DISCOVER_COMMANDS_RECEIVED_RESPONSE_COMMAND_ID = 0x12, /**< Discover commands received */ ZB_ZCL_DISCOVER_COMMANDS_GENERATED_COMMAND_ID = 0x13, /**< Discover commands generated */ ZB_ZCL_DISCOVER_COMMANDS_GENERATED_RESPONSE_COMMAND_ID = 0x14, /**< Discover commands generated response */ - ZB_ZCL_DISCOVER_ATTRIBUTES_EXTENDED_COMMAND_ID = 0x15, /**< Discover attributes exteneded */ + ZB_ZCL_DISCOVER_ATTRIBUTES_EXTENDED_COMMAND_ID = 0x15, /**< Discover attributes extended */ ZB_ZCL_DISCOVER_ATTRIBUTES_EXTENDED_RESPONSE_COMMAND_ID = 0x16, /**< Discover attributes extended response */ } zb_zcl_global_commands_e; @@ -99,7 +99,7 @@ typedef enum { ZB_ZCL_IDENTIFY_QUERY_COMMAND_ID = 0x01, /**< Identify query */ ZB_ZCL_E_Z_MODE_INVOKE_COMMAND_ID = 0x02, /**< EZ mode invoke */ ZB_ZCL_UPDATE_COMMISSION_STATE_COMMAND_ID = 0x03, /**< Update commission state */ - ZB_ZCL_TRIGGER_EFFECT_COMMAND_ID = 0x40, /**< (since zll-1.0-11-0037-10) */ + ZB_ZCL_TRIGGER_EFFECT_COMMAND_ID = 0x40, /**< Trigger effect (since zll-1.0-11-0037-10) */ } zb_zcl_identify_client_commands_e; /** @@ -160,9 +160,9 @@ typedef enum { */ typedef enum { ZB_ZCL_ADD_SCENE_COMMAND_ID = 0x00, /**< Add scene */ - ZB_ZCL_VIEW_SCENE_COMMAND_ID = 0x01, /**< View scenen */ - ZB_ZCL_REMOVE_SCENE_COMMAND_ID = 0x02, /**< Remove scnene */ - ZB_ZCL_REMOVE_ALL_SCENES_COMMAND_ID = 0x03, /**< Remove all scenens */ + ZB_ZCL_VIEW_SCENE_COMMAND_ID = 0x01, /**< View scene */ + ZB_ZCL_REMOVE_SCENE_COMMAND_ID = 0x02, /**< Remove scene */ + ZB_ZCL_REMOVE_ALL_SCENES_COMMAND_ID = 0x03, /**< Remove all scenes */ ZB_ZCL_STORE_SCENE_COMMAND_ID = 0x04, /**< Store scene */ ZB_ZCL_RECALL_SCENE_COMMAND_ID = 0x05, /**< Recall scene */ ZB_ZCL_GET_SCENE_MEMBERSHIP_COMMAND_ID = 0x06, /**< Get scene membership */ @@ -183,7 +183,7 @@ typedef enum { ZB_ZCL_ON_COMMAND_ID = 0x01, /**< On */ ZB_ZCL_TOGGLE_COMMAND_ID = 0x02, /**< Toggle */ ZB_ZCL_OFF_WITH_EFFECT_COMMAND_ID = 0x40, /**< Off with effect (since zll-1.0-11-0037-10) */ - ZB_ZCL_ON_WITH_RECALL_GLOBAL_SCENE_COMMAND_ID = 0x41, /**< On with recall golbal scene (since zll-1.0-11-0037-10) */ + ZB_ZCL_ON_WITH_RECALL_GLOBAL_SCENE_COMMAND_ID = 0x41, /**< On with recall global scene (since zll-1.0-11-0037-10) */ ZB_ZCL_ON_WITH_TIMED_OFF_COMMAND_ID = 0x42, /**< on with timed off (since zll-1.0-11-0037-10) */ } zb_zcl_on_off_client_commands_e; @@ -214,7 +214,7 @@ typedef enum { */ typedef enum { ZB_ZCL_ALARM_COMMAND_ID = 0x00, /**< Alarm */ - ZB_ZCL_GET_ALARM_RESPONSE_COMMAND_ID = 0x01, /**< Alarm reponse */ + ZB_ZCL_GET_ALARM_RESPONSE_COMMAND_ID = 0x01, /**< Alarm response */ } zb_zcl_alarms_server_commands_e; /** @@ -275,9 +275,9 @@ typedef enum { */ typedef enum { ZB_ZCL_RESTART_DEVICE_RESPONSE_COMMAND_ID = 0x00, /**< Restart device response */ - ZB_ZCL_SAVE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x01, /**< Svae startup parameters response */ - ZB_ZCL_RESTORE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x02, /**< Restrore startup parameters response */ - ZB_ZCL_RESET_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x03, /**< Reset startup parameters resonse */ + ZB_ZCL_SAVE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x01, /**< Save startup parameters response */ + ZB_ZCL_RESTORE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x02, /**< Restore startup parameters response */ + ZB_ZCL_RESET_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x03, /**< Reset startup parameters response */ } zb_zcl_commissioning_server_commands_e; /** @@ -302,7 +302,7 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_MULTIPLE_ACK_COMMAND_ID = 0x00, /**< Multiple ack */ + ZB_ZCL_MULTIPLE_ACK_COMMAND_ID = 0x00, /**< Multiple ACK */ ZB_ZCL_READ_HANDSHAKE_PARAM_RESPONSE_COMMAND_ID = 0x01, /**< Read handshake parameters response */ } zb_zcl_partition_server_commands_e; @@ -383,7 +383,7 @@ typedef enum { ZB_ZCL_POWER_PROFILE_STATE_REQUEST_COMMAND_ID = 0x01, /**< Power profile state request */ ZB_ZCL_GET_POWER_PROFILE_PRICE_RESPONSE_COMMAND_ID = 0x02, /**< Get power profile price response */ ZB_ZCL_GET_OVERALL_SCHEDULE_PRICE_RESPONSE_COMMAND_ID = 0x03, /**< Get overall schedule price response */ - ZB_ZCL_ENERGY_PHASES_SCHEDULE_NOTIFICATION_COMMAND_ID = 0x04, /**< Energy phrases schedules notificatoin */ + ZB_ZCL_ENERGY_PHASES_SCHEDULE_NOTIFICATION_COMMAND_ID = 0x04, /**< Energy phrases schedules notification */ ZB_ZCL_ENERGY_PHASES_SCHEDULE_RESPONSE_COMMAND_ID = 0x05, /**< Energy phrases schedules response */ ZB_ZCL_POWER_PROFILE_SCHEDULE_CONSTRAINTS_REQUEST_COMMAND_ID = 0x06, /**< Power profile schedule constraints request */ ZB_ZCL_ENERGY_PHASES_SCHEDULE_STATE_REQUEST_COMMAND_ID = 0x07, /**< Energy phrases schedules state request */ @@ -437,7 +437,7 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_CHECK_IN_RESPONSE_COMMAND_ID = 0x00, /**< Chec-in response */ + ZB_ZCL_CHECK_IN_RESPONSE_COMMAND_ID = 0x00, /**< Check-in response */ ZB_ZCL_FAST_POLL_STOP_COMMAND_ID = 0x01, /**< Fast poll stop */ ZB_ZCL_SET_LONG_POLL_INTERVAL_COMMAND_ID = 0x02, /**< Set long poll interval */ ZB_ZCL_SET_SHORT_POLL_INTERVAL_COMMAND_ID = 0x03, /**< Set short poll interval */ @@ -453,7 +453,7 @@ typedef enum { typedef enum { ZB_ZCL_LOCK_DOOR_RESPONSE_COMMAND_ID = 0x00, /**< Lock door response */ ZB_ZCL_UNLOCK_DOOR_RESPONSE_COMMAND_ID = 0x01, /**< Unlock door response */ - ZB_ZCL_TOGGLE_RESPONSE_COMMAND_ID = 0x02, /**< Toggle resposne (since ha-1.2-05-3520-29) */ + ZB_ZCL_TOGGLE_RESPONSE_COMMAND_ID = 0x02, /**< Toggle response (since ha-1.2-05-3520-29) */ ZB_ZCL_UNLOCK_WITH_TIMEOUT_RESPONSE_COMMAND_ID = 0x03, /**< Unlock with timeout response (since ha-1.2-05-3520-29) */ ZB_ZCL_GET_LOG_RECORD_RESPONSE_COMMAND_ID = 0x04, /**< Get log record response (since ha-1.2-05-3520-29) */ ZB_ZCL_SET_PIN_RESPONSE_COMMAND_ID = 0x05, /**< Set PIN response (since ha-1.2-05-3520-29) */ @@ -464,7 +464,7 @@ typedef enum { ZB_ZCL_GET_USER_STATUS_RESPONSE_COMMAND_ID = 0x0A, /**< Get user status response (since ha-1.2-05-3520-29) */ ZB_ZCL_SET_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0B, /**< Set weekday schedule response (since ha-1.2-05-3520-29) */ ZB_ZCL_GET_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0C, /**< Get weekday schedule response (since ha-1.2-05-3520-29) */ - ZB_ZCL_CLEAR_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0D, /**< Clear weekday schedule resposne (since ha-1.2-05-3520-29) */ + ZB_ZCL_CLEAR_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0D, /**< Clear weekday schedule response (since ha-1.2-05-3520-29) */ ZB_ZCL_SET_YEARDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0E, /**< Set yearday schedule response (since ha-1.2-05-3520-29) */ ZB_ZCL_GET_YEARDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0F, /**< Get yearday schedule response (since ha-1.2-05-3520-29) */ ZB_ZCL_CLEAR_YEARDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x10, /**< Clear yearday schedule response (since ha-1.2-05-3520-29) */ @@ -702,8 +702,8 @@ typedef enum { */ typedef enum { ZB_ZCL_SCAN_RESPONSE_COMMAND_ID = 0x01, /**< Scan response (since zll-1.0-11-0037-10) */ - ZB_ZCL_DEVICE_INFORMATION_RESPONSE_COMMAND_ID = 0x03, /**< Device informatio response (since zll-1.0-11-0037-10) */ - ZB_ZCL_NETWORK_START_RESPONSE_COMMAND_ID = 0x11, /**< Network start reponse (since zll-1.0-11-0037-10) */ + ZB_ZCL_DEVICE_INFORMATION_RESPONSE_COMMAND_ID = 0x03, /**< Device information response (since zll-1.0-11-0037-10) */ + ZB_ZCL_NETWORK_START_RESPONSE_COMMAND_ID = 0x11, /**< Network start response (since zll-1.0-11-0037-10) */ ZB_ZCL_NETWORK_JOIN_ROUTER_RESPONSE_COMMAND_ID = 0x13, /**< Network join router response (since zll-1.0-11-0037-10) */ ZB_ZCL_NETWORK_JOIN_END_DEVICE_RESPONSE_COMMAND_ID = 0x15, /**< Network join end device response (since zll-1.0-11-0037-10) */ ZB_ZCL_ENDPOINT_INFORMATION_COMMAND_ID = 0x40, /**< Endpoint information (since zll-1.0-11-0037-10) */ @@ -721,7 +721,7 @@ typedef enum { typedef enum { ZB_ZCL_SCAN_REQUEST_COMMAND_ID = 0x00, /**< Scan request (since zll-1.0-11-0037-10) */ ZB_ZCL_DEVICE_INFORMATION_REQUEST_COMMAND_ID = 0x02, /**< Device information (since zll-1.0-11-0037-10) */ - ZB_ZCL_IDENTIFY_REQUEST_COMMAND_ID = 0x06, /**< Idenfity request (since zll-1.0-11-0037-10) */ + ZB_ZCL_IDENTIFY_REQUEST_COMMAND_ID = 0x06, /**< Identify request (since zll-1.0-11-0037-10) */ ZB_ZCL_RESET_TO_FACTORY_NEW_REQUEST_COMMAND_ID = 0x07, /**< Reset to factory new request (since zll-1.0-11-0037-10) */ ZB_ZCL_NETWORK_START_REQUEST_COMMAND_ID = 0x10, /**< Network start request (since zll-1.0-11-0037-10) */ ZB_ZCL_NETWORK_JOIN_ROUTER_REQUEST_COMMAND_ID = 0x12, /**< Network join router request (since zll-1.0-11-0037-10) */ diff --git a/include/zcl/zb_zcl_ias_zone_cluster.h b/include/zcl/zb_zcl_ias_zone_cluster.h index 2f42ae7..7f63b06 100644 --- a/include/zcl/zb_zcl_ias_zone_cluster.h +++ b/include/zcl/zb_zcl_ias_zone_cluster.h @@ -79,7 +79,7 @@ typedef enum { /** * @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 + * enrolled as an active alarm device.\n * The device embodying the Zone server must authenticate received messages by * checking the address of their sender against IAS_CIE_Address. This is to ensure * that only messages from the correct CIE are accepted. diff --git a/include/zcl/zb_zcl_level_control_cluster.h b/include/zcl/zb_zcl_level_control_cluster.h index 92ad5b1..c6dcb71 100644 --- a/include/zcl/zb_zcl_level_control_cluster.h +++ b/include/zcl/zb_zcl_level_control_cluster.h @@ -106,7 +106,7 @@ int zb_zcl_levelctrl_move_to_level( * @param[in] handle The handle of zigbee * @param[in] addr16 Network address * @param[in] ep Endpoint ID - * @param[in] move_mode The Move mode field shall be one of the non-reserved values\n + * @param[in] move_mode The Move mode field shall be one of the non-reserved values.\n * 0x00 : Up\n * 0x01 : Down\n * @param[in] rate The Rate field specifies the rate of movement in units per second. \n @@ -139,7 +139,7 @@ int zb_zcl_levelctrl_move( * @param[in] handle The handle of zigbee * @param[in] addr16 Network address * @param[in] ep Endpoint ID - * @param[in] step_mode The Step mode field shall be one of the non-reserved values\n + * @param[in] step_mode The Step mode field shall be one of the non-reserved values.\n * 0x00 : Up\n * 0x01 : Down\n * @param[in] step_size Step size @@ -249,7 +249,7 @@ int zb_zcl_levelctrl_move_to_level_with_on_off( /** * @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 + * 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) * commands have identical payloads to the Move to Level, Move and Step * commands respectively. The also have the same effects, except for the following @@ -266,7 +266,7 @@ int zb_zcl_levelctrl_move_to_level_with_on_off( * @param[in] handle The handle of zigbee * @param[in] addr16 Network address * @param[in] ep Endpoint ID - * @param[in] move_mode The Move mode field shall be one of the non-reserved values\n + * @param[in] move_mode The Move mode field shall be one of the non-reserved values.\n * 0x00 : Up\n * 0x01 : Down\n * @param[in] rate The Rate field specifies the rate of movement in units per second. \n diff --git a/include/zcl/zb_zcl_on_off_cluster.h b/include/zcl/zb_zcl_on_off_cluster.h index a8c7cb3..feabfb3 100644 --- a/include/zcl/zb_zcl_on_off_cluster.h +++ b/include/zcl/zb_zcl_on_off_cluster.h @@ -57,9 +57,9 @@ extern "C" { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_OFF = 0x00, /**< off */ - ZB_ZCL_ON = 0x01, /**< on */ - ZB_ZCL_TOGGLE = 0x02, /**< toggle */ + ZB_ZCL_OFF = 0x00, /**< Off */ + ZB_ZCL_ON = 0x01, /**< On */ + ZB_ZCL_TOGGLE = 0x02, /**< Toggle */ } zb_zcl_onoff_e; /** @@ -71,7 +71,7 @@ typedef enum { * device dependent, but it is recommended that it is used for power on or similar * functions.\n * On receipt of this command, if a device is in its 'Off' state it shall enter\n - * its 'On' state. Otherwise, if it is in its 'On' state it shall enter its 'Off' state\n + * its 'On' state. Otherwise, if it is in its 'On' state it shall enter its 'Off' state.\n * * @since_tizen 4.0 * diff --git a/include/zcl/zb_zcl_type.h b/include/zcl/zb_zcl_type.h index e2bddbd..191c52a 100644 --- a/include/zcl/zb_zcl_type.h +++ b/include/zcl/zb_zcl_type.h @@ -36,7 +36,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE - * @brief data measuring type + * @brief Data measuring type * * @since_tizen 4.0 */ @@ -58,7 +58,7 @@ typedef enum { 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. */ + /**< 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 detected either by the presence of one or more invalid @@ -112,7 +112,7 @@ typedef enum { /**< The selector for an attribute is incorrect. */ ZB_ZCL_INVALID_SELECTOR = 0x8E, /**< A request has been made to read an attribute that the - requestor is not authorized to read. No action taken. */ + 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. */ diff --git a/include/zdo/zb_zdo_dev_disc.h b/include/zdo/zb_zdo_dev_disc.h index f202835..6d02a7f 100644 --- a/include/zdo/zb_zdo_dev_disc.h +++ b/include/zdo/zb_zdo_dev_disc.h @@ -417,7 +417,7 @@ typedef void (*zb_zdo_extended_simple_desc_rsp)( * Extended_Active_EP_req is used for devices which support more active * endpoints than can be returned by a single Active_EP_req. * The local device shall generate the Extended_Active_EP_req command using the - * format illustrated in Table 2.66. in Zigbee Specification\n\n + * format illustrated in Table 2.66. in Zigbee Specification.\n\n * The NWKAddrOfInterest field shall contain the * network address of the remote device for which the active endpoint list is * required.\n\n The StartIndex field shall be set in the request to enable retrieval of diff --git a/include/zdo/zb_zdo_type.h b/include/zdo/zb_zdo_type.h index e40f74c..7081ff5 100644 --- a/include/zdo/zb_zdo_type.h +++ b/include/zdo/zb_zdo_type.h @@ -55,8 +55,8 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZDP_SINGLE_DEVICE_RESPONSE = 0, /**< 0 : Single Device Response */ - ZB_ZDP_EXTENDED_RESPONSE = 1, /**< 1 : Extended Response */ + ZB_ZDP_SINGLE_DEVICE_RESPONSE = 0, /**< Single Device Response : 0*/ + ZB_ZDP_EXTENDED_RESPONSE = 1, /**< Extended Response : 1 */ } zb_zdo_request_type_e; /** @@ -93,7 +93,7 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZDP_DO_NOT_SUPPORT_PAN_COORDINATOR = 0, /**< Otherwise..*/ + ZB_ZDP_DO_NOT_SUPPORT_PAN_COORDINATOR = 0, /**< Otherwise */ ZB_ZDP_SUPPORT_PAN_COORDINATOR = 1, /**< This node is capable of becoming a PAN coordinator. */ } zb_zdo_alternative_pan_coordinator_e; @@ -117,7 +117,7 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZDP_NO_NODE_POWER_DESCRIPTION = 0, /**< Otherwise.. */ + ZB_ZDP_NO_NODE_POWER_DESCRIPTION = 0, /**< Otherwise */ ZB_ZDP_MAIN_POWER = 1, /**< Current power source is main power. This information is derived from the node current power source field of the node power descriptor */ } zb_zdo_power_source_e; @@ -129,7 +129,7 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZDP_KEEP_POWER_SAVE_MODE = 0, /**< Otherwise.. */ + ZB_ZDP_KEEP_POWER_SAVE_MODE = 0, /**< Otherwise */ ZB_ZDP_DO_NOT_POWER_SAVE_MODE = 1, /**< The device does not disable its receiver to conserve power during idle periods. */ } zb_zdo_receiver_on_when_idle_e; @@ -142,7 +142,7 @@ typedef enum { */ typedef enum { ZB_ZDP_DO_NOT_SUPPORT_SECURITY_MODE = 0, /**< ZDP does not support security mode */ - ZB_ZDP_SUPPORT_SECURITY_MODE = 1, /**< ZDP support security mode */ + ZB_ZDP_SUPPORT_SECURITY_MODE = 1, /**< ZDP supports security mode */ } zb_zdo_security_capability_e; /** @@ -162,7 +162,7 @@ typedef enum { ZB_ZDP_SECURITY_CAPABILITY = (1 << 6), /**< Security Capability see #zb_zdo_security_capability_e */ ZB_ZDP_ALLOCATE_ADDRESS = (1 << 7), /**< Allocated Address.\n - This mean device receive network address from coordinator\n + This mean device receive network address from coordinator.\n This field will always have a value of 1 in implementations of IEEE 802.15.4 spec, indicating that the joining device must be issued a 16-bit short address */ } zb_zdo_mac_capability_field_e; @@ -276,7 +276,7 @@ typedef struct zb_zdo_simple_desc_s* zb_zdo_simple_desc_h; /** * @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 + * @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. * diff --git a/include/zigbee.h b/include/zigbee.h index b9d268a..7b6fe50 100644 --- a/include/zigbee.h +++ b/include/zigbee.h @@ -45,7 +45,7 @@ extern "C" { /** * @brief Creates handle to access the zigbee service. - * @details all this function to start zigbee service + * @details All this function to start zigbee service * * @since_tizen 4.0 * @@ -66,7 +66,7 @@ int zb_create(zigbee_h *handle); /** * @brief Destroys to the zigbee service handle. - * @details all this function to stop zigbee service + * @details All this function to stop zigbee service * * @since_tizen 4.0 * @@ -83,7 +83,7 @@ void zb_destroy(zigbee_h handle); /** * @brief Called after enabling zigbee service - * @details response of enabling the zigbee service + * @details Response of enabling the zigbee service * * @since_tizen 4.0 * @@ -97,7 +97,7 @@ typedef void (*zb_enable_cb)(unsigned char status, void *user_data); /** * @brief Enables the zigbee service. - * @details all this function to start zigbee service + * @details All this function to start zigbee service * * @since_tizen 4.0 * @@ -161,7 +161,7 @@ typedef void (*zb_event_cb)(nwk_addr addr16, ieee_addr addr64, zb_event_e event_ /** * @brief Sets event handler for the zigbee service. - * @details to set event handler to get events from the zigbee service + * @details To set event handler to get events from the zigbee service * * @since_tizen 4.0 * @@ -184,7 +184,7 @@ int zb_set_event_cb(zigbee_h handle, zb_event_cb event_handler); /** * @brief Disables the zigbee service. - * @details all this function to stop zigbee service + * @details All this function to stop zigbee service * * @since_tizen 4.0 * @@ -223,7 +223,7 @@ int zb_disable(zigbee_h handle); int zb_hw_reset(zigbee_h handle); /** - * @brief Switchs channel when an occupied channel is noisy. + * @brief Switches channel when an occupied channel is noisy. * @details When noisy, do energy scan and active scan to switch operational channel. * * @since_tizen 4.0 @@ -261,7 +261,7 @@ int zb_coex_stop(zigbee_h handle); /** * @brief Called after zigbee network formation is completed. - * @details response of forming the zigbee network + * @details Response of forming the zigbee network * * @since_tizen 4.0 * @@ -298,8 +298,8 @@ typedef void (*zb_form_network_cb)(nwk_addr panid, void *user_data); int zb_form_network(zigbee_h handle, zb_form_network_cb cb, void *user_data); /** - * @brief Called after disabling the zigbee networl - * @details response of disabling the zigbee networl + * @brief Called after disabling the zigbee network + * @details Response of disabling the zigbee network * * @since_tizen 4.0 * @@ -468,7 +468,7 @@ int zb_get_endpoint_list(zigbee_h handle, ieee_addr addr64, unsigned char *count * @param[in] addr64 the Zigbee IEEE MAC address * @param[in] ep endpoint number * @param[out] in_cluster_count The number of in-clusters - * @param[out] in_cluster_list The device server clsuter list + * @param[out] in_cluster_list The device server cluster list * @param[out] out_cluster_count The number of out-clusters * @param[out] out_cluster_list The device client list * diff --git a/lib/zbl_zdo.c b/lib/zbl_zdo.c index e13eed1..577c973 100644 --- a/lib/zbl_zdo.c +++ b/lib/zbl_zdo.c @@ -107,9 +107,9 @@ API const char* zb_get_device_id_string(int device_id) CASE_TO_STR(ZB_HA_FLOW_SENSOR) CASE_TO_STR(ZB_HA_MINI_SPLIT_AC) /* Intruder Alarms system */ - CASE_TO_STR(ZB_HA_ISA_CONTROL_AND_INDICATING_EQUIPMENT) - CASE_TO_STR(ZB_HA_ISA_ANCILLARY_CONTROL_EQUIPMENT) - CASE_TO_STR(ZB_HA_ISA_ZONE) + CASE_TO_STR(ZB_HA_IAS_CONTROL_AND_INDICATING_EQUIPMENT) + CASE_TO_STR(ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT) + CASE_TO_STR(ZB_HA_IAS_ZONE) default: return "ZB_HA_UNKNOWN_DEVICE"; }