EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/FEATURE_BLE/ble/GattService.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

UserRevisionLine numberNew contents of line
be_bryan 0:b74591d5ab33 1 /* mbed Microcontroller Library
be_bryan 0:b74591d5ab33 2 * Copyright (c) 2006-2013 ARM Limited
be_bryan 0:b74591d5ab33 3 *
be_bryan 0:b74591d5ab33 4 * Licensed under the Apache License, Version 2.0 (the "License");
be_bryan 0:b74591d5ab33 5 * you may not use this file except in compliance with the License.
be_bryan 0:b74591d5ab33 6 * You may obtain a copy of the License at
be_bryan 0:b74591d5ab33 7 *
be_bryan 0:b74591d5ab33 8 * http://www.apache.org/licenses/LICENSE-2.0
be_bryan 0:b74591d5ab33 9 *
be_bryan 0:b74591d5ab33 10 * Unless required by applicable law or agreed to in writing, software
be_bryan 0:b74591d5ab33 11 * distributed under the License is distributed on an "AS IS" BASIS,
be_bryan 0:b74591d5ab33 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
be_bryan 0:b74591d5ab33 13 * See the License for the specific language governing permissions and
be_bryan 0:b74591d5ab33 14 * limitations under the License.
be_bryan 0:b74591d5ab33 15 */
be_bryan 0:b74591d5ab33 16
be_bryan 0:b74591d5ab33 17 #ifndef MBED_GATT_SERVICE_H__
be_bryan 0:b74591d5ab33 18 #define MBED_GATT_SERVICE_H__
be_bryan 0:b74591d5ab33 19
be_bryan 0:b74591d5ab33 20 #include "UUID.h"
be_bryan 0:b74591d5ab33 21 #include "GattCharacteristic.h"
be_bryan 0:b74591d5ab33 22
be_bryan 0:b74591d5ab33 23 /**
be_bryan 0:b74591d5ab33 24 * @addtogroup ble
be_bryan 0:b74591d5ab33 25 * @{
be_bryan 0:b74591d5ab33 26 * @addtogroup gatt
be_bryan 0:b74591d5ab33 27 * @{
be_bryan 0:b74591d5ab33 28 * @addtogroup server
be_bryan 0:b74591d5ab33 29 * @{
be_bryan 0:b74591d5ab33 30 */
be_bryan 0:b74591d5ab33 31
be_bryan 0:b74591d5ab33 32 /**
be_bryan 0:b74591d5ab33 33 * Representation of a GattServer service.
be_bryan 0:b74591d5ab33 34 *
be_bryan 0:b74591d5ab33 35 * A service is a cohesive collection of characteristics. It is identified by a
be_bryan 0:b74591d5ab33 36 * UUID and starts at a specific handle of its GattServer.
be_bryan 0:b74591d5ab33 37 */
be_bryan 0:b74591d5ab33 38 class GattService {
be_bryan 0:b74591d5ab33 39 public:
be_bryan 0:b74591d5ab33 40 enum {
be_bryan 0:b74591d5ab33 41 /**
be_bryan 0:b74591d5ab33 42 * UUID of the Alert Notification service.
be_bryan 0:b74591d5ab33 43 */
be_bryan 0:b74591d5ab33 44 UUID_ALERT_NOTIFICATION_SERVICE = 0x1811,
be_bryan 0:b74591d5ab33 45
be_bryan 0:b74591d5ab33 46 /**
be_bryan 0:b74591d5ab33 47 * UUID of the Battery service.
be_bryan 0:b74591d5ab33 48 */
be_bryan 0:b74591d5ab33 49 UUID_BATTERY_SERVICE = 0x180F,
be_bryan 0:b74591d5ab33 50
be_bryan 0:b74591d5ab33 51 /**
be_bryan 0:b74591d5ab33 52 * UUID of the Blood Pressure service.
be_bryan 0:b74591d5ab33 53 */
be_bryan 0:b74591d5ab33 54 UUID_BLOOD_PRESSURE_SERVICE = 0x1810,
be_bryan 0:b74591d5ab33 55
be_bryan 0:b74591d5ab33 56 /**
be_bryan 0:b74591d5ab33 57 * UUID of the Current Time service.
be_bryan 0:b74591d5ab33 58 */
be_bryan 0:b74591d5ab33 59 UUID_CURRENT_TIME_SERVICE = 0x1805,
be_bryan 0:b74591d5ab33 60
be_bryan 0:b74591d5ab33 61 /**
be_bryan 0:b74591d5ab33 62 * UUID of the Cycling Speed and Cadence (CSC) service.
be_bryan 0:b74591d5ab33 63 */
be_bryan 0:b74591d5ab33 64 UUID_CYCLING_SPEED_AND_CADENCE = 0x1816,
be_bryan 0:b74591d5ab33 65
be_bryan 0:b74591d5ab33 66 /**
be_bryan 0:b74591d5ab33 67 * UUID of the Device Information Service (DIS).
be_bryan 0:b74591d5ab33 68 */
be_bryan 0:b74591d5ab33 69 UUID_DEVICE_INFORMATION_SERVICE = 0x180A,
be_bryan 0:b74591d5ab33 70
be_bryan 0:b74591d5ab33 71 /**
be_bryan 0:b74591d5ab33 72 * UUID of the environmental service.
be_bryan 0:b74591d5ab33 73 */
be_bryan 0:b74591d5ab33 74 UUID_ENVIRONMENTAL_SERVICE = 0x181A,
be_bryan 0:b74591d5ab33 75
be_bryan 0:b74591d5ab33 76 /**
be_bryan 0:b74591d5ab33 77 * UUID of the Glucose service.
be_bryan 0:b74591d5ab33 78 */
be_bryan 0:b74591d5ab33 79 UUID_GLUCOSE_SERVICE = 0x1808,
be_bryan 0:b74591d5ab33 80
be_bryan 0:b74591d5ab33 81 /**
be_bryan 0:b74591d5ab33 82 * UUID of the health thermometer.
be_bryan 0:b74591d5ab33 83 */
be_bryan 0:b74591d5ab33 84 UUID_HEALTH_THERMOMETER_SERVICE = 0x1809,
be_bryan 0:b74591d5ab33 85
be_bryan 0:b74591d5ab33 86 /**
be_bryan 0:b74591d5ab33 87 * UUID of the Heart Rate service.
be_bryan 0:b74591d5ab33 88 */
be_bryan 0:b74591d5ab33 89 UUID_HEART_RATE_SERVICE = 0x180D,
be_bryan 0:b74591d5ab33 90
be_bryan 0:b74591d5ab33 91 /**
be_bryan 0:b74591d5ab33 92 * UUID of the Human Interface Device (HID) service.
be_bryan 0:b74591d5ab33 93 */
be_bryan 0:b74591d5ab33 94 UUID_HUMAN_INTERFACE_DEVICE_SERVICE = 0x1812,
be_bryan 0:b74591d5ab33 95
be_bryan 0:b74591d5ab33 96 /**
be_bryan 0:b74591d5ab33 97 * UUID of the Immediate Alert service.
be_bryan 0:b74591d5ab33 98 */
be_bryan 0:b74591d5ab33 99 UUID_IMMEDIATE_ALERT_SERVICE = 0x1802,
be_bryan 0:b74591d5ab33 100
be_bryan 0:b74591d5ab33 101 /**
be_bryan 0:b74591d5ab33 102 * UUID of the Link Loss service.
be_bryan 0:b74591d5ab33 103 */
be_bryan 0:b74591d5ab33 104 UUID_LINK_LOSS_SERVICE = 0x1803,
be_bryan 0:b74591d5ab33 105
be_bryan 0:b74591d5ab33 106 /**
be_bryan 0:b74591d5ab33 107 * UUID of the Next DST change service.
be_bryan 0:b74591d5ab33 108 */
be_bryan 0:b74591d5ab33 109 UUID_NEXT_DST_CHANGE_SERVICE = 0x1807,
be_bryan 0:b74591d5ab33 110
be_bryan 0:b74591d5ab33 111 /**
be_bryan 0:b74591d5ab33 112 * UUID of the Phone Alert Status service.
be_bryan 0:b74591d5ab33 113 */
be_bryan 0:b74591d5ab33 114 UUID_PHONE_ALERT_STATUS_SERVICE = 0x180E,
be_bryan 0:b74591d5ab33 115
be_bryan 0:b74591d5ab33 116 /**
be_bryan 0:b74591d5ab33 117 * UUID of the Reference Time Update service.
be_bryan 0:b74591d5ab33 118 */
be_bryan 0:b74591d5ab33 119 UUID_REFERENCE_TIME_UPDATE_SERVICE = 0x1806,
be_bryan 0:b74591d5ab33 120
be_bryan 0:b74591d5ab33 121 /**
be_bryan 0:b74591d5ab33 122 * UUID of the Running Speed and Cadence (RSC) service.
be_bryan 0:b74591d5ab33 123 */
be_bryan 0:b74591d5ab33 124 UUID_RUNNING_SPEED_AND_CADENCE = 0x1814,
be_bryan 0:b74591d5ab33 125
be_bryan 0:b74591d5ab33 126 /**
be_bryan 0:b74591d5ab33 127 * UUID of the Scan Parameter service.
be_bryan 0:b74591d5ab33 128 */
be_bryan 0:b74591d5ab33 129 UUID_SCAN_PARAMETERS_SERVICE = 0x1813,
be_bryan 0:b74591d5ab33 130
be_bryan 0:b74591d5ab33 131 /**
be_bryan 0:b74591d5ab33 132 * UUID of the TX power service.
be_bryan 0:b74591d5ab33 133 */
be_bryan 0:b74591d5ab33 134 UUID_TX_POWER_SERVICE = 0x1804
be_bryan 0:b74591d5ab33 135 };
be_bryan 0:b74591d5ab33 136
be_bryan 0:b74591d5ab33 137 public:
be_bryan 0:b74591d5ab33 138 /**
be_bryan 0:b74591d5ab33 139 * Construct a GattService.
be_bryan 0:b74591d5ab33 140 *
be_bryan 0:b74591d5ab33 141 * @param[in] uuid The UUID assigned to this service.
be_bryan 0:b74591d5ab33 142 * @param[in] characteristics A pointer to the array of characteristics that
be_bryan 0:b74591d5ab33 143 * belongs to the service.
be_bryan 0:b74591d5ab33 144 * @param[in] numCharacteristics The number of characteristics.
be_bryan 0:b74591d5ab33 145 *
be_bryan 0:b74591d5ab33 146 * @important The characteristics of the service must remain valid while the
be_bryan 0:b74591d5ab33 147 * GattServer uses the service.
be_bryan 0:b74591d5ab33 148 */
be_bryan 0:b74591d5ab33 149 GattService(
be_bryan 0:b74591d5ab33 150 const UUID &uuid,
be_bryan 0:b74591d5ab33 151 GattCharacteristic *characteristics[],
be_bryan 0:b74591d5ab33 152 unsigned numCharacteristics
be_bryan 0:b74591d5ab33 153 ) :
be_bryan 0:b74591d5ab33 154 _primaryServiceID(uuid),
be_bryan 0:b74591d5ab33 155 _characteristicCount(numCharacteristics),
be_bryan 0:b74591d5ab33 156 _characteristics(characteristics),
be_bryan 0:b74591d5ab33 157 _handle(0) {
be_bryan 0:b74591d5ab33 158 }
be_bryan 0:b74591d5ab33 159
be_bryan 0:b74591d5ab33 160 /**
be_bryan 0:b74591d5ab33 161 * Get this service's UUID.
be_bryan 0:b74591d5ab33 162 *
be_bryan 0:b74591d5ab33 163 * @return A reference to the service's UUID.
be_bryan 0:b74591d5ab33 164 */
be_bryan 0:b74591d5ab33 165 const UUID &getUUID(void) const
be_bryan 0:b74591d5ab33 166 {
be_bryan 0:b74591d5ab33 167 return _primaryServiceID;
be_bryan 0:b74591d5ab33 168 }
be_bryan 0:b74591d5ab33 169
be_bryan 0:b74591d5ab33 170 /**
be_bryan 0:b74591d5ab33 171 * Get the handle of the service declaration attribute in the ATT table.
be_bryan 0:b74591d5ab33 172 *
be_bryan 0:b74591d5ab33 173 * @return The service's handle.
be_bryan 0:b74591d5ab33 174 */
be_bryan 0:b74591d5ab33 175 uint16_t getHandle(void) const
be_bryan 0:b74591d5ab33 176 {
be_bryan 0:b74591d5ab33 177 return _handle;
be_bryan 0:b74591d5ab33 178 }
be_bryan 0:b74591d5ab33 179
be_bryan 0:b74591d5ab33 180 /**
be_bryan 0:b74591d5ab33 181 * Get the total number of characteristics within this service.
be_bryan 0:b74591d5ab33 182 *
be_bryan 0:b74591d5ab33 183 * @return The total number of characteristics within this service.
be_bryan 0:b74591d5ab33 184 */
be_bryan 0:b74591d5ab33 185 uint8_t getCharacteristicCount(void) const
be_bryan 0:b74591d5ab33 186 {
be_bryan 0:b74591d5ab33 187 return _characteristicCount;
be_bryan 0:b74591d5ab33 188 }
be_bryan 0:b74591d5ab33 189
be_bryan 0:b74591d5ab33 190 /**
be_bryan 0:b74591d5ab33 191 * Set the handle of the service declaration attribute in the ATT table.
be_bryan 0:b74591d5ab33 192 *
be_bryan 0:b74591d5ab33 193 * @important Application code must not use this API.
be_bryan 0:b74591d5ab33 194 *
be_bryan 0:b74591d5ab33 195 * @param[in] handle The service's handle.
be_bryan 0:b74591d5ab33 196 */
be_bryan 0:b74591d5ab33 197 void setHandle(uint16_t handle)
be_bryan 0:b74591d5ab33 198 {
be_bryan 0:b74591d5ab33 199 _handle = handle;
be_bryan 0:b74591d5ab33 200 }
be_bryan 0:b74591d5ab33 201
be_bryan 0:b74591d5ab33 202 /**
be_bryan 0:b74591d5ab33 203 * Get this service's characteristic at a specific index.
be_bryan 0:b74591d5ab33 204 *
be_bryan 0:b74591d5ab33 205 * @param[in] index The index of the characteristic.
be_bryan 0:b74591d5ab33 206 *
be_bryan 0:b74591d5ab33 207 * @return A pointer to the characteristic at index @p index.
be_bryan 0:b74591d5ab33 208 */
be_bryan 0:b74591d5ab33 209 GattCharacteristic *getCharacteristic(uint8_t index)
be_bryan 0:b74591d5ab33 210 {
be_bryan 0:b74591d5ab33 211 if (index >= _characteristicCount) {
be_bryan 0:b74591d5ab33 212 return NULL;
be_bryan 0:b74591d5ab33 213 }
be_bryan 0:b74591d5ab33 214
be_bryan 0:b74591d5ab33 215 return _characteristics[index];
be_bryan 0:b74591d5ab33 216 }
be_bryan 0:b74591d5ab33 217
be_bryan 0:b74591d5ab33 218 private:
be_bryan 0:b74591d5ab33 219 /**
be_bryan 0:b74591d5ab33 220 * This service's UUID.
be_bryan 0:b74591d5ab33 221 */
be_bryan 0:b74591d5ab33 222 UUID _primaryServiceID;
be_bryan 0:b74591d5ab33 223
be_bryan 0:b74591d5ab33 224 /**
be_bryan 0:b74591d5ab33 225 * Total number of characteristics within this service.
be_bryan 0:b74591d5ab33 226 */
be_bryan 0:b74591d5ab33 227 uint8_t _characteristicCount;
be_bryan 0:b74591d5ab33 228
be_bryan 0:b74591d5ab33 229 /**
be_bryan 0:b74591d5ab33 230 * An array with pointers to the characteristics added to this service.
be_bryan 0:b74591d5ab33 231 */
be_bryan 0:b74591d5ab33 232 GattCharacteristic **_characteristics;
be_bryan 0:b74591d5ab33 233
be_bryan 0:b74591d5ab33 234 /**
be_bryan 0:b74591d5ab33 235 * Handle of the service declaration attribute in the ATT table.
be_bryan 0:b74591d5ab33 236 *
be_bryan 0:b74591d5ab33 237 * @note The underlying BLE stack generally assigns this handle when the
be_bryan 0:b74591d5ab33 238 * service is added to the ATT table.
be_bryan 0:b74591d5ab33 239 */
be_bryan 0:b74591d5ab33 240 uint16_t _handle;
be_bryan 0:b74591d5ab33 241 };
be_bryan 0:b74591d5ab33 242
be_bryan 0:b74591d5ab33 243 /**
be_bryan 0:b74591d5ab33 244 * @}
be_bryan 0:b74591d5ab33 245 * @}
be_bryan 0:b74591d5ab33 246 * @}
be_bryan 0:b74591d5ab33 247 */
be_bryan 0:b74591d5ab33 248
be_bryan 0:b74591d5ab33 249 #endif /* ifndef MBED_GATT_SERVICE_H__ */