From 8b444542d5aa11f717eb5192abbc3d60ed5f8224 Mon Sep 17 00:00:00 2001 From: "saerome.kim" Date: Fri, 27 Jul 2018 11:25:59 +0900 Subject: [PATCH] supplemented an insufficient description of the ZB_ZCL_FC_DEFAULT. Change-Id: I7efe967d70fca2c04177d2235b279bc3da17fea3 Signed-off-by: saerome.kim --- include/zigbee-zcl-type.h | 6 +++++- include/zigbee-zcl_internal.h | 4 +++- include/zigbee-zcl_private.h | 20 +++++++++++++++----- include/zigbee.h | 24 ++++++++++++++++++------ include/zigbee_internal.h | 8 ++++++-- 5 files changed, 47 insertions(+), 15 deletions(-) diff --git a/include/zigbee-zcl-type.h b/include/zigbee-zcl-type.h index 03b0cd8..71ee77f 100644 --- a/include/zigbee-zcl-type.h +++ b/include/zigbee-zcl-type.h @@ -107,7 +107,11 @@ typedef enum { * * @since_tizen 5.0 */ -#define ZB_ZCL_FC_DEFAULT 0x00 /**< Generally used / Not manufacture / Request / with Default Response */ +#define ZB_ZCL_FC_DEFAULT 0x00 /**< \n\n This value is a combination of the following bits. \n + #ZB_ZCL_FC_GLOBALLY_USED \n + #ZB_ZCL_FC_NOT_MANUFACTURER \n + #ZB_ZCL_CLIENT_TO_SERVER \n + #ZB_ZCL_DEFAULT_RESPONSE_ENABLED */ /** * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE diff --git a/include/zigbee-zcl_internal.h b/include/zigbee-zcl_internal.h index 5a0ec15..9347804 100644 --- a/include/zigbee-zcl_internal.h +++ b/include/zigbee-zcl_internal.h @@ -97,12 +97,14 @@ typedef void (*zb_zcl_global_attr_discover_cb)( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n diff --git a/include/zigbee-zcl_private.h b/include/zigbee-zcl_private.h index a1dcd10..9ebcde7 100644 --- a/include/zigbee-zcl_private.h +++ b/include/zigbee-zcl_private.h @@ -69,12 +69,14 @@ typedef void* zb_zcl_attr_array_h; * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -141,12 +143,14 @@ int zb_zcl_global_attr_read_structured( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -428,12 +432,14 @@ typedef void (*zb_zcl_global_discover_cmds_cb)( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -485,12 +491,14 @@ int zb_zcl_global_discover_cmds_received( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -577,12 +585,14 @@ typedef void (*zb_zcl_global_attr_extended_discover_cb)( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n diff --git a/include/zigbee.h b/include/zigbee.h index 398d22c..94fbece 100644 --- a/include/zigbee.h +++ b/include/zigbee.h @@ -2367,12 +2367,14 @@ typedef void (*zb_zcl_global_attr_read_cb)( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -2789,12 +2791,14 @@ int zb_write_attr_record_set_value( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -2842,12 +2846,14 @@ int zb_zcl_global_attr_write( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -2896,12 +2902,14 @@ int zb_zcl_global_attr_write_undivided( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -3790,12 +3798,14 @@ int zb_report_config_record_set_change(zb_zcl_reporting_config_record_h handle, * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -3973,12 +3983,14 @@ int zb_read_report_config_record_set_id( * @param[in] addr16 target network address * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n diff --git a/include/zigbee_internal.h b/include/zigbee_internal.h index fa5cd37..565ac3d 100644 --- a/include/zigbee_internal.h +++ b/include/zigbee_internal.h @@ -140,12 +140,14 @@ typedef void (*zb_send_to_local_cb)( * @param[in] dst_ep destination end-point (ex. 1) * @param[in] clusterid ZCL cluster id * @param[in] profileid Profile id - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n @@ -196,12 +198,14 @@ int zb_aps_send( * @param[in] src_ep source end-point (ex. 1) * @param[in] dst_ep destination end-point (ex. 1) * @param[in] clusterid ZCL cluster id - * @param[in] zcl_fc frame control bits (default 0x00). \n + * @param[in] zcl_fc frame control bits (default #ZB_ZCL_FC_DEFAULT). \n * Only OR operation is allowed in ZCL header \n * - Frame Type : \n * #ZB_ZCL_FC_GLOBALLY_USED (default) \n * #ZB_APS_FC_CLUSTER_SPECIFIC \n * - Manufacturer Specific : \n + * #ZB_ZCL_FC_NOT_MANUFACTURER \n + * #ZB_ZCL_FC_MANUFACTURER \n * - Direction : \n * #ZB_ZCL_CLIENT_TO_SERVER (default) \n * #ZB_ZCL_SERVER_TO_CLIENT \n -- 2.34.1