David Kester / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   GonioTrainer

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/softdevice/s130/include/ble_gattc.h@187:02500109ccb8, 2015-06-11 (annotated)

Committer:
dkester
Date:
Thu Jun 11 20:58:18 2015 +0000
Revision:
187:02500109ccb8
Parent:
163:65f11741e3d4 
change to goniometer;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 112:737b08b3b995 1 /*
rgrover1 112:737b08b3b995 2 * Copyright (c) Nordic Semiconductor ASA
rgrover1 112:737b08b3b995 3 * All rights reserved.
rgrover1 112:737b08b3b995 4 *
rgrover1 112:737b08b3b995 5 * Redistribution and use in source and binary forms, with or without modification,
rgrover1 112:737b08b3b995 6 * are permitted provided that the following conditions are met:
rgrover1 112:737b08b3b995 7 *
rgrover1 112:737b08b3b995 8 * 1. Redistributions of source code must retain the above copyright notice, this
rgrover1 112:737b08b3b995 9 * list of conditions and the following disclaimer.
rgrover1 112:737b08b3b995 10 *
rgrover1 112:737b08b3b995 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
rgrover1 112:737b08b3b995 12 * list of conditions and the following disclaimer in the documentation and/or
rgrover1 112:737b08b3b995 13 * other materials provided with the distribution.
rgrover1 112:737b08b3b995 14 *
rgrover1 112:737b08b3b995 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
rgrover1 112:737b08b3b995 16 * contributors to this software may be used to endorse or promote products
rgrover1 112:737b08b3b995 17 * derived from this software without specific prior written permission.
rgrover1 112:737b08b3b995 18 *
rgrover1 112:737b08b3b995 19 * 4. This software must only be used in a processor manufactured by Nordic
rgrover1 112:737b08b3b995 20 * Semiconductor ASA, or in a processor manufactured by a third party that
rgrover1 112:737b08b3b995 21 * is used in combination with a processor manufactured by Nordic Semiconductor.
rgrover1 112:737b08b3b995 22 *
rgrover1 112:737b08b3b995 23 *
rgrover1 112:737b08b3b995 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
rgrover1 112:737b08b3b995 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
rgrover1 112:737b08b3b995 26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
rgrover1 112:737b08b3b995 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
rgrover1 112:737b08b3b995 28 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
rgrover1 112:737b08b3b995 29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
rgrover1 112:737b08b3b995 30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
rgrover1 112:737b08b3b995 31 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
rgrover1 112:737b08b3b995 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
rgrover1 112:737b08b3b995 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
rgrover1 112:737b08b3b995 34 *
rgrover1 103:138bdc859cc9 35 */
rgrover1 112:737b08b3b995 36
rgrover1 103:138bdc859cc9 37 /**
rgrover1 103:138bdc859cc9 38 @addtogroup BLE_GATTC Generic Attribute Profile (GATT) Client
rgrover1 103:138bdc859cc9 39 @{
rgrover1 103:138bdc859cc9 40 @brief Definitions and prototypes for the GATT Client interface.
rgrover1 103:138bdc859cc9 41 */
rgrover1 103:138bdc859cc9 42
rgrover1 103:138bdc859cc9 43 #ifndef BLE_GATTC_H__
rgrover1 103:138bdc859cc9 44 #define BLE_GATTC_H__
rgrover1 103:138bdc859cc9 45
rgrover1 103:138bdc859cc9 46 #include "ble_gatt.h"
rgrover1 103:138bdc859cc9 47 #include "ble_types.h"
rgrover1 103:138bdc859cc9 48 #include "ble_ranges.h"
rgrover1 103:138bdc859cc9 49 #include "nrf_svc.h"
rgrover1 103:138bdc859cc9 50
rgrover1 103:138bdc859cc9 51 /** @addtogroup BLE_GATTC_ENUMERATIONS Enumerations
rgrover1 103:138bdc859cc9 52 * @{ */
rgrover1 103:138bdc859cc9 53
rgrover1 103:138bdc859cc9 54 /**@brief GATTC API SVC numbers. */
rgrover1 103:138bdc859cc9 55 enum BLE_GATTC_SVCS
rgrover1 103:138bdc859cc9 56 {
rgrover1 103:138bdc859cc9 57 SD_BLE_GATTC_PRIMARY_SERVICES_DISCOVER = BLE_GATTC_SVC_BASE, /**< Primary Service Discovery. */
rgrover1 103:138bdc859cc9 58 SD_BLE_GATTC_RELATIONSHIPS_DISCOVER, /**< Relationship Discovery. */
rgrover1 103:138bdc859cc9 59 SD_BLE_GATTC_CHARACTERISTICS_DISCOVER, /**< Characteristic Discovery. */
rgrover1 103:138bdc859cc9 60 SD_BLE_GATTC_DESCRIPTORS_DISCOVER, /**< Characteristic Descriptor Discovery. */
rgrover1 103:138bdc859cc9 61 SD_BLE_GATTC_CHAR_VALUE_BY_UUID_READ, /**< Read Characteristic Value by UUID. */
rgrover1 103:138bdc859cc9 62 SD_BLE_GATTC_READ, /**< Generic read. */
rgrover1 103:138bdc859cc9 63 SD_BLE_GATTC_CHAR_VALUES_READ, /**< Read multiple Characteristic Values. */
rgrover1 103:138bdc859cc9 64 SD_BLE_GATTC_WRITE, /**< Generic write. */
rgrover1 103:138bdc859cc9 65 SD_BLE_GATTC_HV_CONFIRM /**< Handle Value Confirmation. */
rgrover1 103:138bdc859cc9 66 };
rgrover1 103:138bdc859cc9 67
rgrover1 112:737b08b3b995 68 /**
rgrover1 112:737b08b3b995 69 * @brief GATT Client Event IDs.
rgrover1 112:737b08b3b995 70 */
rgrover1 112:737b08b3b995 71 enum BLE_GATTC_EVTS
rgrover1 112:737b08b3b995 72 {
rgrover1 112:737b08b3b995 73 BLE_GATTC_EVT_PRIM_SRVC_DISC_RSP = BLE_GATTC_EVT_BASE, /**< Primary Service Discovery Response event. @ref ble_gattc_evt_prim_srvc_disc_rsp_t */
rgrover1 112:737b08b3b995 74 BLE_GATTC_EVT_REL_DISC_RSP, /**< Relationship Discovery Response event. @ref ble_gattc_evt_rel_disc_rsp_t */
rgrover1 112:737b08b3b995 75 BLE_GATTC_EVT_CHAR_DISC_RSP, /**< Characteristic Discovery Response event. @ref ble_gattc_evt_char_disc_rsp_t */
rgrover1 112:737b08b3b995 76 BLE_GATTC_EVT_DESC_DISC_RSP, /**< Descriptor Discovery Response event. @ref ble_gattc_evt_desc_disc_rsp_t */
rgrover1 112:737b08b3b995 77 BLE_GATTC_EVT_CHAR_VAL_BY_UUID_READ_RSP, /**< Read By UUID Response event. @ref ble_gattc_evt_char_val_by_uuid_read_rsp_t */
rgrover1 112:737b08b3b995 78 BLE_GATTC_EVT_READ_RSP, /**< Read Response event. @ref ble_gattc_evt_read_rsp_t */
rgrover1 112:737b08b3b995 79 BLE_GATTC_EVT_CHAR_VALS_READ_RSP, /**< Read multiple Response event. @ref ble_gattc_evt_char_vals_read_rsp_t */
rgrover1 112:737b08b3b995 80 BLE_GATTC_EVT_WRITE_RSP, /**< Write Response event. @ref ble_gattc_evt_write_rsp_t */
rgrover1 112:737b08b3b995 81 BLE_GATTC_EVT_HVX, /**< Handle Value Notification or Indication event. @ref ble_gattc_evt_hvx_t */
rgrover1 112:737b08b3b995 82 BLE_GATTC_EVT_TIMEOUT /**< Timeout event. @ref ble_gattc_evt_timeout_t */
rgrover1 112:737b08b3b995 83 };
rgrover1 112:737b08b3b995 84
rgrover1 103:138bdc859cc9 85 /** @} */
rgrover1 103:138bdc859cc9 86
rgrover1 103:138bdc859cc9 87 /** @addtogroup BLE_GATTC_DEFINES Defines
rgrover1 103:138bdc859cc9 88 * @{ */
rgrover1 103:138bdc859cc9 89
rgrover1 103:138bdc859cc9 90 /** @defgroup BLE_ERRORS_GATTC SVC return values specific to GATTC
rgrover1 103:138bdc859cc9 91 * @{ */
rgrover1 112:737b08b3b995 92 #define BLE_ERROR_GATTC_PROC_NOT_PERMITTED (NRF_GATTC_ERR_BASE + 0x000) /**< Procedure not Permitted. */
rgrover1 103:138bdc859cc9 93 /** @} */
rgrover1 103:138bdc859cc9 94
rgrover1 103:138bdc859cc9 95 /**@brief Last Attribute Handle. */
rgrover1 103:138bdc859cc9 96 #define BLE_GATTC_HANDLE_END 0xFFFF
rgrover1 103:138bdc859cc9 97
rgrover1 103:138bdc859cc9 98 /** @} */
rgrover1 103:138bdc859cc9 99
rgrover1 103:138bdc859cc9 100 /** @addtogroup BLE_GATTC_STRUCTURES Structures
rgrover1 103:138bdc859cc9 101 * @{ */
rgrover1 103:138bdc859cc9 102
rgrover1 103:138bdc859cc9 103 /**@brief Operation Handle Range. */
rgrover1 103:138bdc859cc9 104 typedef struct
rgrover1 103:138bdc859cc9 105 {
rgrover1 103:138bdc859cc9 106 uint16_t start_handle; /**< Start Handle. */
rgrover1 103:138bdc859cc9 107 uint16_t end_handle; /**< End Handle. */
rgrover1 103:138bdc859cc9 108 } ble_gattc_handle_range_t;
rgrover1 103:138bdc859cc9 109
rgrover1 103:138bdc859cc9 110
rgrover1 103:138bdc859cc9 111 /**@brief GATT service. */
rgrover1 103:138bdc859cc9 112 typedef struct
rgrover1 103:138bdc859cc9 113 {
rgrover1 103:138bdc859cc9 114 ble_uuid_t uuid; /**< Service UUID. */
rgrover1 103:138bdc859cc9 115 ble_gattc_handle_range_t handle_range; /**< Service Handle Range. */
rgrover1 103:138bdc859cc9 116 } ble_gattc_service_t;
rgrover1 103:138bdc859cc9 117
rgrover1 103:138bdc859cc9 118
rgrover1 103:138bdc859cc9 119 /**@brief GATT include. */
rgrover1 103:138bdc859cc9 120 typedef struct
rgrover1 103:138bdc859cc9 121 {
rgrover1 103:138bdc859cc9 122 uint16_t handle; /**< Include Handle. */
rgrover1 103:138bdc859cc9 123 ble_gattc_service_t included_srvc; /**< Handle of the included service. */
rgrover1 103:138bdc859cc9 124 } ble_gattc_include_t;
rgrover1 103:138bdc859cc9 125
rgrover1 103:138bdc859cc9 126
rgrover1 103:138bdc859cc9 127 /**@brief GATT characteristic. */
rgrover1 103:138bdc859cc9 128 typedef struct
rgrover1 103:138bdc859cc9 129 {
rgrover1 103:138bdc859cc9 130 ble_uuid_t uuid; /**< Characteristic UUID. */
rgrover1 103:138bdc859cc9 131 ble_gatt_char_props_t char_props; /**< Characteristic Properties. */
rgrover1 103:138bdc859cc9 132 uint8_t char_ext_props : 1; /**< Extended properties present. */
rgrover1 103:138bdc859cc9 133 uint16_t handle_decl; /**< Handle of the Characteristic Declaration. */
rgrover1 103:138bdc859cc9 134 uint16_t handle_value; /**< Handle of the Characteristic Value. */
rgrover1 103:138bdc859cc9 135 } ble_gattc_char_t;
rgrover1 103:138bdc859cc9 136
rgrover1 103:138bdc859cc9 137
rgrover1 103:138bdc859cc9 138 /**@brief GATT descriptor. */
rgrover1 103:138bdc859cc9 139 typedef struct
rgrover1 103:138bdc859cc9 140 {
rgrover1 103:138bdc859cc9 141 uint16_t handle; /**< Descriptor Handle. */
rgrover1 103:138bdc859cc9 142 ble_uuid_t uuid; /**< Descriptor UUID. */
rgrover1 103:138bdc859cc9 143 } ble_gattc_desc_t;
rgrover1 103:138bdc859cc9 144
rgrover1 103:138bdc859cc9 145
rgrover1 103:138bdc859cc9 146 /**@brief Write Parameters. */
rgrover1 103:138bdc859cc9 147 typedef struct
rgrover1 103:138bdc859cc9 148 {
rgrover1 103:138bdc859cc9 149 uint8_t write_op; /**< Write Operation to be performed, see @ref BLE_GATT_WRITE_OPS. */
rgrover1 112:737b08b3b995 150 uint8_t flags; /**< Flags, see @ref BLE_GATT_EXEC_WRITE_FLAGS. */
rgrover1 103:138bdc859cc9 151 uint16_t handle; /**< Handle to the attribute to be written. */
rgrover1 103:138bdc859cc9 152 uint16_t offset; /**< Offset in bytes. @note For WRITE_CMD and WRITE_REQ, offset must be 0. */
rgrover1 103:138bdc859cc9 153 uint16_t len; /**< Length of data in bytes. */
rgrover1 112:737b08b3b995 154 uint8_t *p_value; /**< Pointer to the value data. */
rgrover1 103:138bdc859cc9 155 } ble_gattc_write_params_t;
rgrover1 103:138bdc859cc9 156
rgrover1 112:737b08b3b995 157 /**@brief Event structure for @ref BLE_GATTC_EVT_PRIM_SRVC_DISC_RSP. */
rgrover1 103:138bdc859cc9 158 typedef struct
rgrover1 103:138bdc859cc9 159 {
rgrover1 103:138bdc859cc9 160 uint16_t count; /**< Service count. */
rgrover1 103:138bdc859cc9 161 ble_gattc_service_t services[1]; /**< Service data, variable length. */
rgrover1 103:138bdc859cc9 162 } ble_gattc_evt_prim_srvc_disc_rsp_t;
rgrover1 103:138bdc859cc9 163
rgrover1 112:737b08b3b995 164 /**@brief Event structure for @ref BLE_GATTC_EVT_REL_DISC_RSP. */
rgrover1 103:138bdc859cc9 165 typedef struct
rgrover1 103:138bdc859cc9 166 {
rgrover1 103:138bdc859cc9 167 uint16_t count; /**< Include count. */
rgrover1 103:138bdc859cc9 168 ble_gattc_include_t includes[1]; /**< Include data, variable length. */
rgrover1 103:138bdc859cc9 169 } ble_gattc_evt_rel_disc_rsp_t;
rgrover1 103:138bdc859cc9 170
rgrover1 112:737b08b3b995 171 /**@brief Event structure for @ref BLE_GATTC_EVT_CHAR_DISC_RSP. */
rgrover1 103:138bdc859cc9 172 typedef struct
rgrover1 103:138bdc859cc9 173 {
rgrover1 103:138bdc859cc9 174 uint16_t count; /**< Characteristic count. */
rgrover1 103:138bdc859cc9 175 ble_gattc_char_t chars[1]; /**< Characteristic data, variable length. */
rgrover1 103:138bdc859cc9 176 } ble_gattc_evt_char_disc_rsp_t;
rgrover1 103:138bdc859cc9 177
rgrover1 112:737b08b3b995 178 /**@brief Event structure for @ref BLE_GATTC_EVT_DESC_DISC_RSP. */
rgrover1 103:138bdc859cc9 179 typedef struct
rgrover1 103:138bdc859cc9 180 {
rgrover1 103:138bdc859cc9 181 uint16_t count; /**< Descriptor count. */
rgrover1 103:138bdc859cc9 182 ble_gattc_desc_t descs[1]; /**< Descriptor data, variable length. */
rgrover1 103:138bdc859cc9 183 } ble_gattc_evt_desc_disc_rsp_t;
rgrover1 103:138bdc859cc9 184
rgrover1 103:138bdc859cc9 185 /**@brief GATT read by UUID handle value pair. */
rgrover1 103:138bdc859cc9 186 typedef struct
rgrover1 103:138bdc859cc9 187 {
rgrover1 103:138bdc859cc9 188 uint16_t handle; /**< Attribute Handle. */
rgrover1 112:737b08b3b995 189 uint8_t *p_value; /**< Pointer to value, variable length (length available as value_len in @ref ble_gattc_evt_char_val_by_uuid_read_rsp_t).
rgrover1 103:138bdc859cc9 190 Please note that this pointer is absolute to the memory provided by the user when retrieving the event,
rgrover1 103:138bdc859cc9 191 so it will effectively point to a location inside the handle_value array. */
rgrover1 103:138bdc859cc9 192 } ble_gattc_handle_value_t;
rgrover1 103:138bdc859cc9 193
rgrover1 112:737b08b3b995 194 /**@brief Event structure for @ref BLE_GATTC_EVT_CHAR_VAL_BY_UUID_READ_RSP. */
rgrover1 103:138bdc859cc9 195 typedef struct
rgrover1 103:138bdc859cc9 196 {
rgrover1 103:138bdc859cc9 197 uint16_t count; /**< Handle-Value Pair Count. */
rgrover1 103:138bdc859cc9 198 uint16_t value_len; /**< Length of the value in Handle-Value(s) list. */
rgrover1 103:138bdc859cc9 199 ble_gattc_handle_value_t handle_value[1]; /**< Handle-Value(s) list, variable length. */
rgrover1 103:138bdc859cc9 200 } ble_gattc_evt_char_val_by_uuid_read_rsp_t;
rgrover1 103:138bdc859cc9 201
rgrover1 112:737b08b3b995 202 /**@brief Event structure for @ref BLE_GATTC_EVT_READ_RSP. */
rgrover1 103:138bdc859cc9 203 typedef struct
rgrover1 103:138bdc859cc9 204 {
rgrover1 103:138bdc859cc9 205 uint16_t handle; /**< Attribute Handle. */
rgrover1 103:138bdc859cc9 206 uint16_t offset; /**< Offset of the attribute data. */
rgrover1 103:138bdc859cc9 207 uint16_t len; /**< Attribute data length. */
rgrover1 103:138bdc859cc9 208 uint8_t data[1]; /**< Attribute data, variable length. */
rgrover1 103:138bdc859cc9 209 } ble_gattc_evt_read_rsp_t;
rgrover1 103:138bdc859cc9 210
rgrover1 112:737b08b3b995 211 /**@brief Event structure for @ref BLE_GATTC_EVT_CHAR_VALS_READ_RSP. */
rgrover1 103:138bdc859cc9 212 typedef struct
rgrover1 103:138bdc859cc9 213 {
rgrover1 103:138bdc859cc9 214 uint16_t len; /**< Concatenated Attribute values length. */
rgrover1 103:138bdc859cc9 215 uint8_t values[1]; /**< Attribute values, variable length. */
rgrover1 103:138bdc859cc9 216 } ble_gattc_evt_char_vals_read_rsp_t;
rgrover1 103:138bdc859cc9 217
rgrover1 112:737b08b3b995 218 /**@brief Event structure for @ref BLE_GATTC_EVT_WRITE_RSP. */
rgrover1 103:138bdc859cc9 219 typedef struct
rgrover1 103:138bdc859cc9 220 {
rgrover1 103:138bdc859cc9 221 uint16_t handle; /**< Attribute Handle. */
rgrover1 103:138bdc859cc9 222 uint8_t write_op; /**< Type of write operation, see @ref BLE_GATT_WRITE_OPS. */
rgrover1 112:737b08b3b995 223 uint16_t offset; /**< Data offset. */
rgrover1 103:138bdc859cc9 224 uint16_t len; /**< Data length. */
rgrover1 103:138bdc859cc9 225 uint8_t data[1]; /**< Data, variable length. */
rgrover1 103:138bdc859cc9 226 } ble_gattc_evt_write_rsp_t;
rgrover1 103:138bdc859cc9 227
rgrover1 112:737b08b3b995 228 /**@brief Event structure for @ref BLE_GATTC_EVT_HVX. */
rgrover1 103:138bdc859cc9 229 typedef struct
rgrover1 103:138bdc859cc9 230 {
rgrover1 103:138bdc859cc9 231 uint16_t handle; /**< Handle to which the HVx operation applies. */
rgrover1 103:138bdc859cc9 232 uint8_t type; /**< Indication or Notification, see @ref BLE_GATT_HVX_TYPES. */
rgrover1 103:138bdc859cc9 233 uint16_t len; /**< Attribute data length. */
rgrover1 103:138bdc859cc9 234 uint8_t data[1]; /**< Attribute data, variable length. */
rgrover1 103:138bdc859cc9 235 } ble_gattc_evt_hvx_t;
rgrover1 103:138bdc859cc9 236
rgrover1 112:737b08b3b995 237 /**@brief Event structure for @ref BLE_GATTC_EVT_TIMEOUT. */
rgrover1 103:138bdc859cc9 238 typedef struct
rgrover1 103:138bdc859cc9 239 {
rgrover1 103:138bdc859cc9 240 uint8_t src; /**< Timeout source, see @ref BLE_GATT_TIMEOUT_SOURCES. */
rgrover1 103:138bdc859cc9 241 } ble_gattc_evt_timeout_t;
rgrover1 103:138bdc859cc9 242
rgrover1 112:737b08b3b995 243 /**@brief GATTC event structure. */
rgrover1 103:138bdc859cc9 244 typedef struct
rgrover1 103:138bdc859cc9 245 {
rgrover1 103:138bdc859cc9 246 uint16_t conn_handle; /**< Connection Handle on which event occured. */
rgrover1 103:138bdc859cc9 247 uint16_t gatt_status; /**< GATT status code for the operation, see @ref BLE_GATT_STATUS_CODES. */
rgrover1 112:737b08b3b995 248 uint16_t error_handle; /**< In case of error: The handle causing the error. In all other cases @ref BLE_GATT_HANDLE_INVALID. */
rgrover1 103:138bdc859cc9 249 union
rgrover1 103:138bdc859cc9 250 {
rgrover1 103:138bdc859cc9 251 ble_gattc_evt_prim_srvc_disc_rsp_t prim_srvc_disc_rsp; /**< Primary Service Discovery Response Event Parameters. */
rgrover1 103:138bdc859cc9 252 ble_gattc_evt_rel_disc_rsp_t rel_disc_rsp; /**< Relationship Discovery Response Event Parameters. */
rgrover1 103:138bdc859cc9 253 ble_gattc_evt_char_disc_rsp_t char_disc_rsp; /**< Characteristic Discovery Response Event Parameters. */
rgrover1 103:138bdc859cc9 254 ble_gattc_evt_desc_disc_rsp_t desc_disc_rsp; /**< Descriptor Discovery Response Event Parameters. */
rgrover1 103:138bdc859cc9 255 ble_gattc_evt_char_val_by_uuid_read_rsp_t char_val_by_uuid_read_rsp; /**< Characteristic Value Read by UUID Response Event Parameters. */
rgrover1 103:138bdc859cc9 256 ble_gattc_evt_read_rsp_t read_rsp; /**< Read Response Event Parameters. */
rgrover1 103:138bdc859cc9 257 ble_gattc_evt_char_vals_read_rsp_t char_vals_read_rsp; /**< Characteristic Values Read Response Event Parameters. */
rgrover1 103:138bdc859cc9 258 ble_gattc_evt_write_rsp_t write_rsp; /**< Write Response Event Parameters. */
rgrover1 103:138bdc859cc9 259 ble_gattc_evt_hvx_t hvx; /**< Handle Value Notification/Indication Event Parameters. */
rgrover1 103:138bdc859cc9 260 ble_gattc_evt_timeout_t timeout; /**< Timeout Event Parameters. */
rgrover1 112:737b08b3b995 261 } params; /**< Event Parameters. @note Only valid if @ref gatt_status == @ref BLE_GATT_STATUS_SUCCESS. */
rgrover1 103:138bdc859cc9 262 } ble_gattc_evt_t;
rgrover1 103:138bdc859cc9 263 /** @} */
rgrover1 103:138bdc859cc9 264
rgrover1 103:138bdc859cc9 265 /** @addtogroup BLE_GATTC_FUNCTIONS Functions
rgrover1 103:138bdc859cc9 266 * @{ */
rgrover1 103:138bdc859cc9 267
rgrover1 103:138bdc859cc9 268 /**@brief Initiate or continue a GATT Primary Service Discovery procedure.
rgrover1 103:138bdc859cc9 269 *
rgrover1 112:737b08b3b995 270 * @details This function initiates or resumes a Primary Service discovery procedure, starting from the supplied handle.
rgrover1 112:737b08b3b995 271 * If the last service has not been reached, this function must be called again with an updated start handle value to continue the search.
rgrover1 103:138bdc859cc9 272 *
rgrover1 103:138bdc859cc9 273 * @note If any of the discovered services have 128-bit UUIDs which are not present in the table provided to ble_vs_uuids_assign, a UUID structure with
rgrover1 112:737b08b3b995 274 * type @ref BLE_UUID_TYPE_UNKNOWN will be received in the corresponding event.
rgrover1 103:138bdc859cc9 275 *
rgrover1 103:138bdc859cc9 276 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 277 * @param[in] start_handle Handle to start searching from.
rgrover1 103:138bdc859cc9 278 * @param[in] p_srvc_uuid Pointer to the service UUID to be found. If it is NULL, all primary services will be returned.
rgrover1 103:138bdc859cc9 279 *
rgrover1 112:737b08b3b995 280 * @retval ::NRF_SUCCESS Successfully started or resumed the Primary Service Discovery procedure.
rgrover1 112:737b08b3b995 281 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 282 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 283 * @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied.
rgrover1 112:737b08b3b995 284 * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
rgrover1 103:138bdc859cc9 285 */
rgrover1 112:737b08b3b995 286 SVCALL(SD_BLE_GATTC_PRIMARY_SERVICES_DISCOVER, uint32_t, sd_ble_gattc_primary_services_discover(uint16_t conn_handle, uint16_t start_handle, ble_uuid_t const *p_srvc_uuid));
rgrover1 103:138bdc859cc9 287
rgrover1 103:138bdc859cc9 288
rgrover1 103:138bdc859cc9 289 /**@brief Initiate or continue a GATT Relationship Discovery procedure.
rgrover1 103:138bdc859cc9 290 *
rgrover1 112:737b08b3b995 291 * @details This function initiates or resumes the Find Included Services sub-procedure. If the last included service has not been reached,
rgrover1 103:138bdc859cc9 292 * this must be called again with an updated handle range to continue the search.
rgrover1 103:138bdc859cc9 293 *
rgrover1 103:138bdc859cc9 294 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 295 * @param[in] p_handle_range A pointer to the range of handles of the Service to perform this procedure on.
rgrover1 103:138bdc859cc9 296 *
rgrover1 112:737b08b3b995 297 * @retval ::NRF_SUCCESS Successfully started or resumed the Relationship Discovery procedure.
rgrover1 112:737b08b3b995 298 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 299 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 300 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
rgrover1 112:737b08b3b995 301 * @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied.
rgrover1 112:737b08b3b995 302 * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
rgrover1 103:138bdc859cc9 303 */
rgrover1 112:737b08b3b995 304 SVCALL(SD_BLE_GATTC_RELATIONSHIPS_DISCOVER, uint32_t, sd_ble_gattc_relationships_discover(uint16_t conn_handle, ble_gattc_handle_range_t const *p_handle_range));
rgrover1 103:138bdc859cc9 305
rgrover1 103:138bdc859cc9 306
rgrover1 103:138bdc859cc9 307 /**@brief Initiate or continue a GATT Characteristic Discovery procedure.
rgrover1 103:138bdc859cc9 308 *
rgrover1 112:737b08b3b995 309 * @details This function initiates or resumes a Characteristic discovery procedure. If the last Characteristic has not been reached,
rgrover1 103:138bdc859cc9 310 * this must be called again with an updated handle range to continue the discovery.
rgrover1 103:138bdc859cc9 311 *
rgrover1 103:138bdc859cc9 312 * @note If any of the discovered characteristics have 128-bit UUIDs which are not present in the table provided to ble_vs_uuids_assign, a UUID structure with
rgrover1 112:737b08b3b995 313 * type @ref BLE_UUID_TYPE_UNKNOWN will be received in the corresponding event.
rgrover1 103:138bdc859cc9 314 *
rgrover1 103:138bdc859cc9 315 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 316 * @param[in] p_handle_range A pointer to the range of handles of the Service to perform this procedure on.
rgrover1 103:138bdc859cc9 317 *
rgrover1 112:737b08b3b995 318 * @retval ::NRF_SUCCESS Successfully started or resumed the Characteristic Discovery procedure.
rgrover1 112:737b08b3b995 319 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 320 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 321 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
rgrover1 112:737b08b3b995 322 * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
rgrover1 103:138bdc859cc9 323 */
rgrover1 112:737b08b3b995 324 SVCALL(SD_BLE_GATTC_CHARACTERISTICS_DISCOVER, uint32_t, sd_ble_gattc_characteristics_discover(uint16_t conn_handle, ble_gattc_handle_range_t const *p_handle_range));
rgrover1 103:138bdc859cc9 325
rgrover1 103:138bdc859cc9 326
rgrover1 103:138bdc859cc9 327 /**@brief Initiate or continue a GATT Characteristic Descriptor Discovery procedure.
rgrover1 103:138bdc859cc9 328 *
rgrover1 112:737b08b3b995 329 * @details This function initiates or resumes a Characteristic Descriptor discovery procedure. If the last Descriptor has not been reached,
rgrover1 103:138bdc859cc9 330 * this must be called again with an updated handle range to continue the discovery.
rgrover1 103:138bdc859cc9 331 *
rgrover1 103:138bdc859cc9 332 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 333 * @param[in] p_handle_range A pointer to the range of handles of the Characteristic to perform this procedure on.
rgrover1 103:138bdc859cc9 334 *
rgrover1 112:737b08b3b995 335 * @retval ::NRF_SUCCESS Successfully started or resumed the Descriptor Discovery procedure.
rgrover1 112:737b08b3b995 336 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 337 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 338 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
rgrover1 112:737b08b3b995 339 * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
rgrover1 103:138bdc859cc9 340 */
rgrover1 112:737b08b3b995 341 SVCALL(SD_BLE_GATTC_DESCRIPTORS_DISCOVER, uint32_t, sd_ble_gattc_descriptors_discover(uint16_t conn_handle, ble_gattc_handle_range_t const *p_handle_range));
rgrover1 103:138bdc859cc9 342
rgrover1 103:138bdc859cc9 343
rgrover1 103:138bdc859cc9 344 /**@brief Initiate or continue a GATT Read using Characteristic UUID procedure.
rgrover1 103:138bdc859cc9 345 *
rgrover1 112:737b08b3b995 346 * @details This function initiates or resumes a Read using Characteristic UUID procedure. If the last Characteristic has not been reached,
rgrover1 103:138bdc859cc9 347 * this must be called again with an updated handle range to continue the discovery.
rgrover1 103:138bdc859cc9 348 *
rgrover1 103:138bdc859cc9 349 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 350 * @param[in] p_uuid Pointer to a Characteristic value UUID to read.
rgrover1 103:138bdc859cc9 351 * @param[in] p_handle_range A pointer to the range of handles to perform this procedure on.
rgrover1 103:138bdc859cc9 352 *
rgrover1 112:737b08b3b995 353 * @retval ::NRF_SUCCESS Successfully started or resumed the Read using Characteristic UUID procedure.
rgrover1 112:737b08b3b995 354 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 355 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 356 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
rgrover1 112:737b08b3b995 357 * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
rgrover1 103:138bdc859cc9 358 */
rgrover1 112:737b08b3b995 359 SVCALL(SD_BLE_GATTC_CHAR_VALUE_BY_UUID_READ, uint32_t, sd_ble_gattc_char_value_by_uuid_read(uint16_t conn_handle, ble_uuid_t const *p_uuid, ble_gattc_handle_range_t const *p_handle_range));
rgrover1 103:138bdc859cc9 360
rgrover1 103:138bdc859cc9 361
rgrover1 103:138bdc859cc9 362 /**@brief Initiate or continue a GATT Read (Long) Characteristic or Descriptor procedure.
rgrover1 103:138bdc859cc9 363 *
rgrover1 112:737b08b3b995 364 * @details This function initiates or resumes a GATT Read (Long) Characteristic or Descriptor procedure. If the Characteristic or Descriptor
rgrover1 112:737b08b3b995 365 * to be read is longer than ATT_MTU - 1, this function must be called multiple times with appropriate offset to read the
rgrover1 103:138bdc859cc9 366 * complete value.
rgrover1 103:138bdc859cc9 367 *
rgrover1 103:138bdc859cc9 368 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 369 * @param[in] handle The handle of the attribute to be read.
rgrover1 103:138bdc859cc9 370 * @param[in] offset Offset into the attribute value to be read.
rgrover1 103:138bdc859cc9 371 *
rgrover1 112:737b08b3b995 372 * @retval ::NRF_SUCCESS Successfully started or resumed the Read (Long) procedure.
rgrover1 112:737b08b3b995 373 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 374 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 375 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
rgrover1 112:737b08b3b995 376 * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
rgrover1 103:138bdc859cc9 377 */
rgrover1 103:138bdc859cc9 378 SVCALL(SD_BLE_GATTC_READ, uint32_t, sd_ble_gattc_read(uint16_t conn_handle, uint16_t handle, uint16_t offset));
rgrover1 103:138bdc859cc9 379
rgrover1 103:138bdc859cc9 380
rgrover1 103:138bdc859cc9 381 /**@brief Initiate a GATT Read Multiple Characteristic Values procedure.
rgrover1 103:138bdc859cc9 382 *
rgrover1 103:138bdc859cc9 383 * @details This function initiates a GATT Read Multiple Characteristic Values procedure.
rgrover1 103:138bdc859cc9 384 *
rgrover1 103:138bdc859cc9 385 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 386 * @param[in] p_handles A pointer to the handle(s) of the attribute(s) to be read.
rgrover1 103:138bdc859cc9 387 * @param[in] handle_count The number of handles in p_handles.
rgrover1 103:138bdc859cc9 388 *
rgrover1 112:737b08b3b995 389 * @retval ::NRF_SUCCESS Successfully started the Read Multiple Characteristic Values procedure.
rgrover1 112:737b08b3b995 390 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 391 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 392 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
rgrover1 112:737b08b3b995 393 * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
rgrover1 103:138bdc859cc9 394 */
rgrover1 112:737b08b3b995 395 SVCALL(SD_BLE_GATTC_CHAR_VALUES_READ, uint32_t, sd_ble_gattc_char_values_read(uint16_t conn_handle, uint16_t const *p_handles, uint16_t handle_count));
rgrover1 103:138bdc859cc9 396
rgrover1 103:138bdc859cc9 397
rgrover1 103:138bdc859cc9 398 /**@brief Perform a Write (Characteristic Value or Descriptor, with or without response, signed or not, long or reliable) procedure.
rgrover1 103:138bdc859cc9 399 *
rgrover1 103:138bdc859cc9 400 * @details This function can perform all write procedures described in GATT.
rgrover1 103:138bdc859cc9 401 *
rgrover1 103:138bdc859cc9 402 * @note It is important to note that a write without response will <b>consume an application buffer</b>, and will therefore
rgrover1 112:737b08b3b995 403 * generate a @ref BLE_EVT_TX_COMPLETE event when the packet has been transmitted. A write (with response) on the other hand will use the
rgrover1 103:138bdc859cc9 404 * standard client internal buffer and thus will only generate a @ref BLE_GATTC_EVT_WRITE_RSP event as soon as the write response
rgrover1 103:138bdc859cc9 405 * has been received from the peer. Please see the documentation of @ref sd_ble_tx_buffer_count_get for more details.
rgrover1 103:138bdc859cc9 406 *
rgrover1 103:138bdc859cc9 407 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 408 * @param[in] p_write_params A pointer to a write parameters structure.
rgrover1 103:138bdc859cc9 409 *
rgrover1 112:737b08b3b995 410 * @retval ::NRF_SUCCESS Successfully started the Write procedure.
rgrover1 112:737b08b3b995 411 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 412 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
rgrover1 112:737b08b3b995 413 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
rgrover1 112:737b08b3b995 414 * @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied.
rgrover1 112:737b08b3b995 415 * @retval ::NRF_ERROR_DATA_SIZE Invalid data size(s) supplied.
rgrover1 112:737b08b3b995 416 * @retval ::NRF_ERROR_BUSY Procedure already in progress.
rgrover1 112:737b08b3b995 417 * @retval ::BLE_ERROR_NO_TX_BUFFERS There are no available buffers left.
rgrover1 103:138bdc859cc9 418 */
rgrover1 112:737b08b3b995 419 SVCALL(SD_BLE_GATTC_WRITE, uint32_t, sd_ble_gattc_write(uint16_t conn_handle, ble_gattc_write_params_t const *p_write_params));
rgrover1 103:138bdc859cc9 420
rgrover1 103:138bdc859cc9 421
rgrover1 103:138bdc859cc9 422 /**@brief Send a Handle Value Confirmation to the GATT Server.
rgrover1 103:138bdc859cc9 423 *
rgrover1 103:138bdc859cc9 424 * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
rgrover1 103:138bdc859cc9 425 * @param[in] handle The handle of the attribute in the indication.
rgrover1 103:138bdc859cc9 426 *
rgrover1 112:737b08b3b995 427 * @retval ::NRF_SUCCESS Successfully queued the Handle Value Confirmation for transmission.
rgrover1 112:737b08b3b995 428 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
rgrover1 112:737b08b3b995 429 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State or no Indication pending to be confirmed.
rgrover1 112:737b08b3b995 430 * @retval ::BLE_ERROR_INVALID_ATTR_HANDLE Invalid attribute handle.
rgrover1 103:138bdc859cc9 431 */
rgrover1 103:138bdc859cc9 432 SVCALL(SD_BLE_GATTC_HV_CONFIRM, uint32_t, sd_ble_gattc_hv_confirm(uint16_t conn_handle, uint16_t handle));
rgrover1 103:138bdc859cc9 433
rgrover1 103:138bdc859cc9 434 /** @} */
rgrover1 103:138bdc859cc9 435
rgrover1 103:138bdc859cc9 436 #endif /* BLE_GATTC_H__ */
rgrover1 103:138bdc859cc9 437
rgrover1 103:138bdc859cc9 438 /**
rgrover1 103:138bdc859cc9 439 @}
rgrover1 103:138bdc859cc9 440 @}
rgrover1 103:138bdc859cc9 441 */