BLE_Nano nRF51 Central heart rate
Embed:
(wiki syntax)
Show/hide line numbers
ble_srv_common.h
Go to the documentation of this file.
00001 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved. 00002 * 00003 * The information contained herein is property of Nordic Semiconductor ASA. 00004 * Terms and conditions of usage are described in detail in NORDIC 00005 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. 00006 * 00007 * Licensees are granted free, non-transferable use of the information. NO 00008 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from 00009 * the file. 00010 * 00011 */ 00012 00013 /** @file 00014 * 00015 * @defgroup ble_sdk_srv_common Common service definitions 00016 * @{ 00017 * @ingroup ble_sdk_srv 00018 * @brief Constants, type definitions, and functions that are common to all services. 00019 */ 00020 00021 #ifndef BLE_SRV_COMMON_H__ 00022 #define BLE_SRV_COMMON_H__ 00023 00024 #include <stdint.h> 00025 #include <stdbool.h> 00026 #include "ble_types.h" 00027 #include "app_util.h " 00028 #include "ble.h" 00029 #include "ble_gap.h" 00030 #include "ble_gatt.h" 00031 00032 /** @defgroup UUID_SERVICES Service UUID definitions 00033 * @{ */ 00034 #define BLE_UUID_ALERT_NOTIFICATION_SERVICE 0x1811 /**< Alert Notification service UUID. */ 00035 #define BLE_UUID_BATTERY_SERVICE 0x180F /**< Battery service UUID. */ 00036 #define BLE_UUID_BLOOD_PRESSURE_SERVICE 0x1810 /**< Blood Pressure service UUID. */ 00037 #define BLE_UUID_CURRENT_TIME_SERVICE 0x1805 /**< Current Time service UUID. */ 00038 #define BLE_UUID_CYCLING_SPEED_AND_CADENCE 0x1816 /**< Cycling Speed and Cadence service UUID. */ 00039 #define BLE_UUID_LOCATION_AND_NAVIGATION_SERVICE 0x1819 /**< Location and Navigation service UUID. */ 00040 #define BLE_UUID_DEVICE_INFORMATION_SERVICE 0x180A /**< Device Information service UUID. */ 00041 #define BLE_UUID_GLUCOSE_SERVICE 0x1808 /**< Glucose service UUID. */ 00042 #define BLE_UUID_HEALTH_THERMOMETER_SERVICE 0x1809 /**< Health Thermometer service UUID. */ 00043 #define BLE_UUID_HEART_RATE_SERVICE 0x180D /**< Heart Rate service UUID. */ 00044 #define BLE_UUID_HUMAN_INTERFACE_DEVICE_SERVICE 0x1812 /**< Human Interface Device service UUID. */ 00045 #define BLE_UUID_IMMEDIATE_ALERT_SERVICE 0x1802 /**< Immediate Alert service UUID. */ 00046 #define BLE_UUID_LINK_LOSS_SERVICE 0x1803 /**< Link Loss service UUID. */ 00047 #define BLE_UUID_NEXT_DST_CHANGE_SERVICE 0x1807 /**< Next Dst Change service UUID. */ 00048 #define BLE_UUID_PHONE_ALERT_STATUS_SERVICE 0x180E /**< Phone Alert Status service UUID. */ 00049 #define BLE_UUID_REFERENCE_TIME_UPDATE_SERVICE 0x1806 /**< Reference Time Update service UUID. */ 00050 #define BLE_UUID_RUNNING_SPEED_AND_CADENCE 0x1814 /**< Running Speed and Cadence service UUID. */ 00051 #define BLE_UUID_SCAN_PARAMETERS_SERVICE 0x1813 /**< Scan Parameters service UUID. */ 00052 #define BLE_UUID_TX_POWER_SERVICE 0x1804 /**< TX Power service UUID. */ 00053 #define BLE_UUID_IPSP_SERVICE 0x1820 /**< Internet Protocol Support service UUID. */ 00054 #define BLE_UUID_BMS_SERVICE 0x181E /**< BOND MANAGEMENT service UUID*/ 00055 #define BLE_UUID_CGM_SERVICE 0x181F /**< Contiunous Glucose Monitoring service UUID*/ 00056 #define BLE_UUID_PLX_SERVICE 0x1822 /**< Pulse Oximeter Service UUID*/ 00057 00058 00059 /** @} */ 00060 00061 /** @defgroup UUID_CHARACTERISTICS Characteristic UUID definitions 00062 * @{ */ 00063 #define BLE_UUID_REMOVABLE_CHAR 0x2A3A /**< Removable characteristic UUID. */ 00064 #define BLE_UUID_SERVICE_REQUIRED_CHAR 0x2A3B /**< Service Required characteristic UUID. */ 00065 #define BLE_UUID_ALERT_CATEGORY_ID_CHAR 0x2A43 /**< Alert Category Id characteristic UUID. */ 00066 #define BLE_UUID_ALERT_CATEGORY_ID_BIT_MASK_CHAR 0x2A42 /**< Alert Category Id Bit Mask characteristic UUID. */ 00067 #define BLE_UUID_ALERT_LEVEL_CHAR 0x2A06 /**< Alert Level characteristic UUID. */ 00068 #define BLE_UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR 0x2A44 /**< Alert Notification Control Point characteristic UUID. */ 00069 #define BLE_UUID_ALERT_STATUS_CHAR 0x2A3F /**< Alert Status characteristic UUID. */ 00070 #define BLE_UUID_BATTERY_LEVEL_CHAR 0x2A19 /**< Battery Level characteristic UUID. */ 00071 #define BLE_UUID_BLOOD_PRESSURE_FEATURE_CHAR 0x2A49 /**< Blood Pressure Feature characteristic UUID. */ 00072 #define BLE_UUID_BLOOD_PRESSURE_MEASUREMENT_CHAR 0x2A35 /**< Blood Pressure Measurement characteristic UUID. */ 00073 #define BLE_UUID_BODY_SENSOR_LOCATION_CHAR 0x2A38 /**< Body Sensor Location characteristic UUID. */ 00074 #define BLE_UUID_BOOT_KEYBOARD_INPUT_REPORT_CHAR 0x2A22 /**< Boot Keyboard Input Report characteristic UUID. */ 00075 #define BLE_UUID_BOOT_KEYBOARD_OUTPUT_REPORT_CHAR 0x2A32 /**< Boot Keyboard Output Report characteristic UUID. */ 00076 #define BLE_UUID_BOOT_MOUSE_INPUT_REPORT_CHAR 0x2A33 /**< Boot Mouse Input Report characteristic UUID. */ 00077 #define BLE_UUID_CURRENT_TIME_CHAR 0x2A2B /**< Current Time characteristic UUID. */ 00078 #define BLE_UUID_DATE_TIME_CHAR 0x2A08 /**< Date Time characteristic UUID. */ 00079 #define BLE_UUID_DAY_DATE_TIME_CHAR 0x2A0A /**< Day Date Time characteristic UUID. */ 00080 #define BLE_UUID_DAY_OF_WEEK_CHAR 0x2A09 /**< Day Of Week characteristic UUID. */ 00081 #define BLE_UUID_DST_OFFSET_CHAR 0x2A0D /**< Dst Offset characteristic UUID. */ 00082 #define BLE_UUID_EXACT_TIME_256_CHAR 0x2A0C /**< Exact Time 256 characteristic UUID. */ 00083 #define BLE_UUID_FIRMWARE_REVISION_STRING_CHAR 0x2A26 /**< Firmware Revision String characteristic UUID. */ 00084 #define BLE_UUID_GLUCOSE_FEATURE_CHAR 0x2A51 /**< Glucose Feature characteristic UUID. */ 00085 #define BLE_UUID_GLUCOSE_MEASUREMENT_CHAR 0x2A18 /**< Glucose Measurement characteristic UUID. */ 00086 #define BLE_UUID_GLUCOSE_MEASUREMENT_CONTEXT_CHAR 0x2A34 /**< Glucose Measurement Context characteristic UUID. */ 00087 #define BLE_UUID_HARDWARE_REVISION_STRING_CHAR 0x2A27 /**< Hardware Revision String characteristic UUID. */ 00088 #define BLE_UUID_HEART_RATE_CONTROL_POINT_CHAR 0x2A39 /**< Heart Rate Control Point characteristic UUID. */ 00089 #define BLE_UUID_HEART_RATE_MEASUREMENT_CHAR 0x2A37 /**< Heart Rate Measurement characteristic UUID. */ 00090 #define BLE_UUID_HID_CONTROL_POINT_CHAR 0x2A4C /**< Hid Control Point characteristic UUID. */ 00091 #define BLE_UUID_HID_INFORMATION_CHAR 0x2A4A /**< Hid Information characteristic UUID. */ 00092 #define BLE_UUID_IEEE_REGULATORY_CERTIFICATION_DATA_LIST_CHAR 0x2A2A /**< IEEE Regulatory Certification Data List characteristic UUID. */ 00093 #define BLE_UUID_INTERMEDIATE_CUFF_PRESSURE_CHAR 0x2A36 /**< Intermediate Cuff Pressure characteristic UUID. */ 00094 #define BLE_UUID_INTERMEDIATE_TEMPERATURE_CHAR 0x2A1E /**< Intermediate Temperature characteristic UUID. */ 00095 #define BLE_UUID_LOCAL_TIME_INFORMATION_CHAR 0x2A0F /**< Local Time Information characteristic UUID. */ 00096 #define BLE_UUID_MANUFACTURER_NAME_STRING_CHAR 0x2A29 /**< Manufacturer Name String characteristic UUID. */ 00097 #define BLE_UUID_MEASUREMENT_INTERVAL_CHAR 0x2A21 /**< Measurement Interval characteristic UUID. */ 00098 #define BLE_UUID_MODEL_NUMBER_STRING_CHAR 0x2A24 /**< Model Number String characteristic UUID. */ 00099 #define BLE_UUID_UNREAD_ALERT_CHAR 0x2A45 /**< Unread Alert characteristic UUID. */ 00100 #define BLE_UUID_NEW_ALERT_CHAR 0x2A46 /**< New Alert characteristic UUID. */ 00101 #define BLE_UUID_PNP_ID_CHAR 0x2A50 /**< PNP Id characteristic UUID. */ 00102 #define BLE_UUID_PROTOCOL_MODE_CHAR 0x2A4E /**< Protocol Mode characteristic UUID. */ 00103 #define BLE_UUID_RECORD_ACCESS_CONTROL_POINT_CHAR 0x2A52 /**< Record Access Control Point characteristic UUID. */ 00104 #define BLE_UUID_REFERENCE_TIME_INFORMATION_CHAR 0x2A14 /**< Reference Time Information characteristic UUID. */ 00105 #define BLE_UUID_REPORT_CHAR 0x2A4D /**< Report characteristic UUID. */ 00106 #define BLE_UUID_REPORT_MAP_CHAR 0x2A4B /**< Report Map characteristic UUID. */ 00107 #define BLE_UUID_RINGER_CONTROL_POINT_CHAR 0x2A40 /**< Ringer Control Point characteristic UUID. */ 00108 #define BLE_UUID_RINGER_SETTING_CHAR 0x2A41 /**< Ringer Setting characteristic UUID. */ 00109 #define BLE_UUID_SCAN_INTERVAL_WINDOW_CHAR 0x2A4F /**< Scan Interval Window characteristic UUID. */ 00110 #define BLE_UUID_SCAN_REFRESH_CHAR 0x2A31 /**< Scan Refresh characteristic UUID. */ 00111 #define BLE_UUID_SERIAL_NUMBER_STRING_CHAR 0x2A25 /**< Serial Number String characteristic UUID. */ 00112 #define BLE_UUID_SOFTWARE_REVISION_STRING_CHAR 0x2A28 /**< Software Revision String characteristic UUID. */ 00113 #define BLE_UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR 0x2A47 /**< Supported New Alert Category characteristic UUID. */ 00114 #define BLE_UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR 0x2A48 /**< Supported Unread Alert Category characteristic UUID. */ 00115 #define BLE_UUID_SYSTEM_ID_CHAR 0x2A23 /**< System Id characteristic UUID. */ 00116 #define BLE_UUID_TEMPERATURE_MEASUREMENT_CHAR 0x2A1C /**< Temperature Measurement characteristic UUID. */ 00117 #define BLE_UUID_TEMPERATURE_TYPE_CHAR 0x2A1D /**< Temperature Type characteristic UUID. */ 00118 #define BLE_UUID_TIME_ACCURACY_CHAR 0x2A12 /**< Time Accuracy characteristic UUID. */ 00119 #define BLE_UUID_TIME_SOURCE_CHAR 0x2A13 /**< Time Source characteristic UUID. */ 00120 #define BLE_UUID_TIME_UPDATE_CONTROL_POINT_CHAR 0x2A16 /**< Time Update Control Point characteristic UUID. */ 00121 #define BLE_UUID_TIME_UPDATE_STATE_CHAR 0x2A17 /**< Time Update State characteristic UUID. */ 00122 #define BLE_UUID_TIME_WITH_DST_CHAR 0x2A11 /**< Time With Dst characteristic UUID. */ 00123 #define BLE_UUID_TIME_ZONE_CHAR 0x2A0E /**< Time Zone characteristic UUID. */ 00124 #define BLE_UUID_TX_POWER_LEVEL_CHAR 0x2A07 /**< TX Power Level characteristic UUID. */ 00125 #define BLE_UUID_CSC_FEATURE_CHAR 0x2A5C /**< Cycling Speed and Cadence Feature characteristic UUID. */ 00126 #define BLE_UUID_CSC_MEASUREMENT_CHAR 0x2A5B /**< Cycling Speed and Cadence Measurement characteristic UUID. */ 00127 #define BLE_UUID_RSC_FEATURE_CHAR 0x2A54 /**< Running Speed and Cadence Feature characteristic UUID. */ 00128 #define BLE_UUID_SC_CTRLPT_CHAR 0x2A55 /**< Speed and Cadence Control Point UUID. */ 00129 #define BLE_UUID_RSC_MEASUREMENT_CHAR 0x2A53 /**< Running Speed and Cadence Measurement characteristic UUID. */ 00130 #define BLE_UUID_SENSOR_LOCATION_CHAR 0x2A5D /**< Sensor Location characteristic UUID. */ 00131 #define BLE_UUID_EXTERNAL_REPORT_REF_DESCR 0x2907 /**< External Report Reference descriptor UUID. */ 00132 #define BLE_UUID_REPORT_REF_DESCR 0x2908 /**< Report Reference descriptor UUID. */ 00133 #define BLE_UUID_LN_FEATURE_CHAR 0x2A6A /**< Location Navigation Service, Feature characteristic UUID. */ 00134 #define BLE_UUID_LN_POSITION_QUALITY_CHAR 0x2A69 /**< Location Navigation Service, Position quality UUID. */ 00135 #define BLE_UUID_LN_LOCATION_AND_SPEED_CHAR 0x2A67 /**< Location Navigation Service, Location and Speed characteristic UUID. */ 00136 #define BLE_UUID_LN_NAVIGATION_CHAR 0x2A68 /**< Location Navigation Service, Navigation characteristic UUID. */ 00137 #define BLE_UUID_LN_CONTROL_POINT_CHAR 0x2A6B /**< Location Navigation Service, Control point characteristic UUID. */ 00138 #define BLE_UUID_BMS_CTRLPT 0x2AA4 /**< BMS Control Point characteristic UUID. */ 00139 #define BLE_UUID_BMS_FEATURE 0x2AA5 /**< BMS Feature characteristic UUID. */ 00140 #define BLE_UUID_CGM_MEASUREMENT 0x2AA7 /**< CGM Service, Measurement characteristic UUID*/ 00141 #define BLE_UUID_CGM_FEATURE 0x2AA8 /**< CGM Service, Feature characteristic UUID*/ 00142 #define BLE_UUID_CGM_STATUS 0x2AA9 /**< CGM Service, Status characteristic UUID*/ 00143 #define BLE_UUID_CGM_SESSION_START_TIME 0x2AAA /**< CGM Service, session start time characteristic UUID*/ 00144 #define BLE_UUID_CGM_SESSION_RUN_TIME 0x2AAB /**< CGM Service, session run time characteristic UUID*/ 00145 #define BLE_UUID_CGM_SPECIFIC_OPS_CTRLPT 0x2AAC /**< CGM Service, specific ops ctrlpt characteristic UUID*/ 00146 #define BLE_UUID_PLX_SPOT_CHECK_MEAS 0x2A5E /**< PLX Service, spot check measurement characteristic UUID*/ 00147 #define BLE_UUID_PLX_CONTINUOUS_MEAS 0x2A5F /**< PLX Service, continuous measurement characteristic UUID*/ 00148 #define BLE_UUID_PLX_FEATURES 0x2A60 /**< PLX Service, feature characteristic UUID*/ 00149 00150 00151 00152 00153 00154 /** @} */ 00155 00156 /** @defgroup ALERT_LEVEL_VALUES Definitions for the Alert Level characteristic values 00157 * @{ */ 00158 #define BLE_CHAR_ALERT_LEVEL_NO_ALERT 0x00 /**< No Alert. */ 00159 #define BLE_CHAR_ALERT_LEVEL_MILD_ALERT 0x01 /**< Mild Alert. */ 00160 #define BLE_CHAR_ALERT_LEVEL_HIGH_ALERT 0x02 /**< High Alert. */ 00161 /** @} */ 00162 00163 #define BLE_SRV_ENCODED_REPORT_REF_LEN 2 /**< The length of an encoded Report Reference Descriptor. */ 00164 #define BLE_CCCD_VALUE_LEN 2 /**< The length of a CCCD value. */ 00165 00166 /**@brief Type definition for error handler function that will be called in case of an error in 00167 * a service or a service library module. */ 00168 typedef void (*ble_srv_error_handler_t) (uint32_t nrf_error); 00169 00170 00171 00172 /**@brief Value of a Report Reference descriptor. 00173 * 00174 * @details This is mapping information that maps the parent characteristic to the Report ID(s) and 00175 * Report Type(s) defined within a Report Map characteristic. 00176 */ 00177 typedef struct 00178 { 00179 uint8_t report_id; /**< Non-zero value if there is more than one instance of the same Report Type */ 00180 uint8_t report_type; /**< Type of Report characteristic (see @ref BLE_HIDS_REPORT_TYPE) */ 00181 } ble_srv_report_ref_t; 00182 00183 /**@brief UTF-8 string data type. 00184 * 00185 * @note The type can only hold a pointer to the string data (i.e. not the actual data). 00186 */ 00187 typedef struct 00188 { 00189 uint16_t length; /**< String length. */ 00190 uint8_t * p_str; /**< String data. */ 00191 } ble_srv_utf8_str_t; 00192 00193 00194 /**@brief Security settings structure. 00195 * @details This structure contains the security options needed during initialization of the 00196 * service. 00197 */ 00198 typedef struct 00199 { 00200 ble_gap_conn_sec_mode_t read_perm; /**< Read permissions. */ 00201 ble_gap_conn_sec_mode_t write_perm; /**< Write permissions. */ 00202 } ble_srv_security_mode_t; 00203 00204 /**@brief Security settings structure. 00205 * @details This structure contains the security options needed during initialization of the 00206 * service. It can be used when the characteristics contains a CCCD. 00207 */ 00208 typedef struct 00209 { 00210 ble_gap_conn_sec_mode_t cccd_write_perm; /**< Write permissions for Client Characteristic Configuration Descriptor. */ 00211 ble_gap_conn_sec_mode_t read_perm; /**< Read permissions. */ 00212 ble_gap_conn_sec_mode_t write_perm; /**< Write permissions. */ 00213 } ble_srv_cccd_security_mode_t; 00214 00215 /**@brief Function for decoding a CCCD value, and then testing if notification is 00216 * enabled. 00217 * 00218 * @param[in] p_encoded_data Buffer where the encoded CCCD is stored. 00219 * 00220 * @retval TRUE If notification is enabled. 00221 * @retval FALSE Otherwise. 00222 */ 00223 static __INLINE bool ble_srv_is_notification_enabled(uint8_t const * p_encoded_data) 00224 { 00225 uint16_t cccd_value = uint16_decode(p_encoded_data); 00226 return ((cccd_value & BLE_GATT_HVX_NOTIFICATION) != 0); 00227 } 00228 00229 /**@brief Function for decoding a CCCD value, and then testing if indication is 00230 * enabled. 00231 * 00232 * @param[in] p_encoded_data Buffer where the encoded CCCD is stored. 00233 * 00234 * @retval TRUE If indication is enabled. 00235 * @retval FALSE Otherwise. 00236 */ 00237 static __INLINE bool ble_srv_is_indication_enabled(uint8_t const * p_encoded_data) 00238 { 00239 uint16_t cccd_value = uint16_decode(p_encoded_data); 00240 return ((cccd_value & BLE_GATT_HVX_INDICATION) != 0); 00241 } 00242 00243 /**@brief Function for encoding a Report Reference Descriptor. 00244 * 00245 * @param[in] p_encoded_buffer The buffer of the encoded data. 00246 * @param[in] p_report_ref Report Reference value to be encoded. 00247 * 00248 * @return Length of the encoded data. 00249 */ 00250 uint8_t ble_srv_report_ref_encode(uint8_t * p_encoded_buffer, 00251 const ble_srv_report_ref_t * p_report_ref); 00252 00253 /**@brief Function for making a UTF-8 structure refer to an ASCII string. 00254 * 00255 * @param[out] p_utf8 UTF-8 structure to be set. 00256 * @param[in] p_ascii ASCII string to be referred to. 00257 */ 00258 void ble_srv_ascii_to_utf8(ble_srv_utf8_str_t * p_utf8, char * p_ascii); 00259 00260 00261 /**@brief Security Access enumeration. 00262 * @details This enumeration gives the possible requirements for accessing a characteristic value. 00263 */ 00264 typedef enum 00265 { 00266 SEC_NO_ACCESS = 0, /**< Not possible to access. */ 00267 SEC_OPEN = 1, /**< Access open. */ 00268 SEC_JUST_WORKS = 2, /**< Access possible with 'Just Works' security at least. */ 00269 SEC_MITM = 3, /**< Access possible with 'MITM' security at least. */ 00270 SEC_SIGNED = 4, /**< Access possible with 'signed' security at least. */ 00271 SEC_SIGNED_MITM = 5 /**< Access possible with 'signed and MITM' security at least. */ 00272 }security_req_t; 00273 00274 00275 /**@brief Characteristic User Descriptor parameters. 00276 * @details This structure contains the parameters for User Descriptor. 00277 */ 00278 typedef struct 00279 { 00280 uint16_t max_size; /**< Maximum size of the user descriptor*/ 00281 uint16_t size; /**< Size of the user descriptor*/ 00282 uint8_t *p_char_user_desc; /**< User descriptor content, pointer to a UTF-8 encoded string (non-NULL terminated)*/ 00283 bool is_var_len; /**< Indicates if the user descriptor has variable length.*/ 00284 ble_gatt_char_props_t char_props; /**< user descriptor properties.*/ 00285 bool is_defered_read; /**< Indicate if deferred read operations are supported.*/ 00286 bool is_defered_write; /**< Indicate if deferred write operations are supported.*/ 00287 security_req_t read_access; /**< Security requirement for reading the user descriptor.*/ 00288 security_req_t write_access; /**< Security requirement for writing the user descriptor.*/ 00289 bool is_value_user; /**< Indicate if the content of the characteristic is to be stored in the application (user) or in the stack.*/ 00290 }ble_add_char_user_desc_t; 00291 00292 00293 /**@brief Add characteristic parameters structure. 00294 * @details This structure contains the parameters needed to use the @ref characteristic_add function. 00295 */ 00296 typedef struct 00297 { 00298 uint16_t uuid; /**< Characteristic UUID (16 bits UUIDs).*/ 00299 uint8_t uuid_type; /**< Base UUID. If 0, the Bluetooth SIG UUID will be used. Otherwise, this should be a value returned by @ref sd_ble_uuid_vs_add when adding the base UUID.*/ 00300 uint16_t max_len; /**< Maximum length of the characteristic value.*/ 00301 uint16_t init_len; /**< Initial length of the characteristic value.*/ 00302 uint8_t * p_init_value; /**< Initial encoded value of the characteristic.*/ 00303 bool is_var_len; /**< Indicates if the characteristic value has variable length.*/ 00304 ble_gatt_char_props_t char_props; /**< Characteristic properties.*/ 00305 bool is_defered_read; /**< Indicate if deferred read operations are supported.*/ 00306 bool is_defered_write; /**< Indicate if deferred write operations are supported.*/ 00307 security_req_t read_access; /**< Security requirement for reading the characteristic value.*/ 00308 security_req_t write_access; /**< Security requirement for writing the characteristic value.*/ 00309 security_req_t cccd_write_access; /**< Security requirement for writing the characteristic's CCCD.*/ 00310 bool is_value_user; /**< Indicate if the content of the characteristic is to be stored in the application (user) or in the stack.*/ 00311 ble_add_char_user_desc_t *p_user_descr; /**< Pointer to user descriptor if needed*/ 00312 ble_gatts_char_pf_t *p_presentation_format; /**< Pointer to characteristic format if needed*/ 00313 } ble_add_char_params_t; 00314 00315 00316 /**@brief Add descriptor parameters structure. 00317 * @details This structure contains the parameters needed to use the @ref descriptor_add function. 00318 */ 00319 typedef struct 00320 { 00321 uint16_t uuid; /**< descriptor UUID (16 bits UUIDs).*/ 00322 uint8_t uuid_type; /**< Base UUID. If 0, the Bluetooth SIG UUID will be used. Otherwise, this should be a value returned by @ref sd_ble_uuid_vs_add when adding the base UUID.*/ 00323 bool is_defered_read; /**< Indicate if deferred read operations are supported.*/ 00324 bool is_defered_write; /**< Indicate if deferred write operations are supported.*/ 00325 bool is_var_len; /**< Indicates if the descriptor value has variable length.*/ 00326 security_req_t read_access; /**< Security requirement for reading the descriptor value.*/ 00327 security_req_t write_access; /**< Security requirement for writing the descriptor value.*/ 00328 bool is_value_user; /**< Indicate if the content of the characteristic is to be stored in the application (user) or in the stack.*/ 00329 uint16_t init_len; /**< Initial descriptor value length in bytes. */ 00330 uint16_t init_offs; /**< Initial descriptor value offset in bytes. If different from zero, the first init_offs bytes of the attribute value will be left uninitialized. */ 00331 uint16_t max_len; /**< Maximum descriptor value length in bytes, see @ref BLE_GATTS_ATTR_LENS_MAX for maximum values. */ 00332 uint8_t* p_value; /**< Pointer to the value of the descriptor*/ 00333 } ble_add_descr_params_t; 00334 00335 00336 /**@brief Function for adding a characteristic to a given service. 00337 * 00338 * If no pointer is given for the initial value, 00339 * the initial length parameter will be ignored and the initial length will be 0. 00340 * 00341 * @param[in] service_handle Handle of the service to which the characteristic is to be added. 00342 * @param[in] p_char_props Information needed to add the characteristic. 00343 * @param[out] p_char_handle Handle of the added characteristic. 00344 * 00345 * @retval NRF_SUCCESS If the characteristic was added successfully. Otherwise, an error code is returned. 00346 */ 00347 uint32_t characteristic_add(uint16_t service_handle, 00348 ble_add_char_params_t * p_char_props, 00349 ble_gatts_char_handles_t * p_char_handle); 00350 00351 00352 /**@brief Function for adding a characteristic's descriptor to a given characteristic. 00353 * 00354 * @param[in] char_handle Handle of the characteristic to which the descriptor is to be added, if @ref BLE_GATT_HANDLE_INVALID is used, it will be placed sequentially. 00355 * @param[in] p_descr_props Information needed to add the descriptor. 00356 * @param[out] p_descr_handle Handle of the added descriptor. 00357 * 00358 * @retval NRF_SUCCESS If the characteristic was added successfully. Otherwise, an error code is returned. 00359 */ 00360 uint32_t descriptor_add(uint16_t char_handle, 00361 ble_add_descr_params_t * p_descr_props, 00362 uint16_t * p_descr_handle); 00363 00364 00365 #endif // BLE_SRV_COMMON_H__ 00366 00367 /** @} */ 00368
Generated on Wed Jul 13 2022 07:07:19 by 1.7.2