erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

features/FEATURE_BLE/ble/GapAdvertisingParams.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16
elessair 0:f269e3021894 17 #ifndef __GAP_ADVERTISING_PARAMS_H__
elessair 0:f269e3021894 18 #define __GAP_ADVERTISING_PARAMS_H__
elessair 0:f269e3021894 19
elessair 0:f269e3021894 20 /**
elessair 0:f269e3021894 21 * This class provides a wrapper for the core advertising parameters,
elessair 0:f269e3021894 22 * including the advertising type (Connectable Undirected,
elessair 0:f269e3021894 23 * Non Connectable Undirected and so on), as well as the advertising and
elessair 0:f269e3021894 24 * timeout intervals.
elessair 0:f269e3021894 25 */
elessair 0:f269e3021894 26 class GapAdvertisingParams {
elessair 0:f269e3021894 27 public:
elessair 0:f269e3021894 28 /**
elessair 0:f269e3021894 29 * Minimum Advertising interval for connectable undirected and connectable
elessair 0:f269e3021894 30 * directed events in 625us units - 20ms.
elessair 0:f269e3021894 31 */
elessair 0:f269e3021894 32 static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN = 0x0020;
elessair 0:f269e3021894 33 /**
elessair 0:f269e3021894 34 * Minimum Advertising interval for scannable and non-connectable
elessair 0:f269e3021894 35 * undirected events in 625us units - 100ms.
elessair 0:f269e3021894 36 */
elessair 0:f269e3021894 37 static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN_NONCON = 0x00A0;
elessair 0:f269e3021894 38 /**
elessair 0:f269e3021894 39 * Maximum Advertising interval in 625us units - 10.24s.
elessair 0:f269e3021894 40 */
elessair 0:f269e3021894 41 static const unsigned GAP_ADV_PARAMS_INTERVAL_MAX = 0x4000;
elessair 0:f269e3021894 42 /**
elessair 0:f269e3021894 43 * Maximum advertising timeout seconds.
elessair 0:f269e3021894 44 */
elessair 0:f269e3021894 45 static const unsigned GAP_ADV_PARAMS_TIMEOUT_MAX = 0x3FFF;
elessair 0:f269e3021894 46
elessair 0:f269e3021894 47 /**
elessair 0:f269e3021894 48 * Encapsulates the peripheral advertising modes, which determine how
elessair 0:f269e3021894 49 * the device appears to other central devices in hearing range.
elessair 0:f269e3021894 50 */
elessair 0:f269e3021894 51 enum AdvertisingType_t {
elessair 0:f269e3021894 52 ADV_CONNECTABLE_UNDIRECTED, /**< Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1. */
elessair 0:f269e3021894 53 ADV_CONNECTABLE_DIRECTED, /**< Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2. */
elessair 0:f269e3021894 54 ADV_SCANNABLE_UNDIRECTED, /**< Include support for Scan Response payloads, see Vol 6, Part B, Section 2.3.1.4. */
elessair 0:f269e3021894 55 ADV_NON_CONNECTABLE_UNDIRECTED /**< Vol 3, Part C, Section 9.3.2 and Vol 6, Part B, Section 2.3.1.3. */
elessair 0:f269e3021894 56 };
elessair 0:f269e3021894 57 /**
elessair 0:f269e3021894 58 * Type alias for GapAdvertisingParams::AdvertisingType_t.
elessair 0:f269e3021894 59 *
elessair 0:f269e3021894 60 * @deprecated This type alias will be dropped in future releases.
elessair 0:f269e3021894 61 */
elessair 0:f269e3021894 62 typedef enum AdvertisingType_t AdvertisingType;
elessair 0:f269e3021894 63
elessair 0:f269e3021894 64 public:
elessair 0:f269e3021894 65 /**
elessair 0:f269e3021894 66 * Construct an instance of GapAdvertisingParams.
elessair 0:f269e3021894 67 *
elessair 0:f269e3021894 68 * @param[in] advType
elessair 0:f269e3021894 69 * Type of advertising. Default is
elessair 0:f269e3021894 70 * GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED.
elessair 0:f269e3021894 71 * @param[in] interval
elessair 0:f269e3021894 72 * Advertising interval in units of 0.625ms. Default is
elessair 0:f269e3021894 73 * GapAdvertisingParams::GAP_ADV_PARAMS_INTERVAL_MIN_NONCON.
elessair 0:f269e3021894 74 * @param[in] timeout
elessair 0:f269e3021894 75 * Advertising timeout. Default is 0.
elessair 0:f269e3021894 76 */
elessair 0:f269e3021894 77 GapAdvertisingParams(AdvertisingType_t advType = ADV_CONNECTABLE_UNDIRECTED,
elessair 0:f269e3021894 78 uint16_t interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON,
elessair 0:f269e3021894 79 uint16_t timeout = 0) : _advType(advType), _interval(interval), _timeout(timeout) {
elessair 0:f269e3021894 80 /* Interval checks. */
elessair 0:f269e3021894 81 if (_advType == ADV_CONNECTABLE_DIRECTED) {
elessair 0:f269e3021894 82 /* Interval must be 0 in directed connectable mode. */
elessair 0:f269e3021894 83 _interval = 0;
elessair 0:f269e3021894 84 } else if (_advType == ADV_NON_CONNECTABLE_UNDIRECTED) {
elessair 0:f269e3021894 85 /* Min interval is slightly larger than in other modes. */
elessair 0:f269e3021894 86 if (_interval < GAP_ADV_PARAMS_INTERVAL_MIN_NONCON) {
elessair 0:f269e3021894 87 _interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON;
elessair 0:f269e3021894 88 }
elessair 0:f269e3021894 89 if (_interval > GAP_ADV_PARAMS_INTERVAL_MAX) {
elessair 0:f269e3021894 90 _interval = GAP_ADV_PARAMS_INTERVAL_MAX;
elessair 0:f269e3021894 91 }
elessair 0:f269e3021894 92 } else {
elessair 0:f269e3021894 93 /* Stay within interval limits. */
elessair 0:f269e3021894 94 if (_interval < GAP_ADV_PARAMS_INTERVAL_MIN) {
elessair 0:f269e3021894 95 _interval = GAP_ADV_PARAMS_INTERVAL_MIN;
elessair 0:f269e3021894 96 }
elessair 0:f269e3021894 97 if (_interval > GAP_ADV_PARAMS_INTERVAL_MAX) {
elessair 0:f269e3021894 98 _interval = GAP_ADV_PARAMS_INTERVAL_MAX;
elessair 0:f269e3021894 99 }
elessair 0:f269e3021894 100 }
elessair 0:f269e3021894 101
elessair 0:f269e3021894 102 /* Timeout checks. */
elessair 0:f269e3021894 103 if (timeout) {
elessair 0:f269e3021894 104 /* Stay within timeout limits. */
elessair 0:f269e3021894 105 if (_timeout > GAP_ADV_PARAMS_TIMEOUT_MAX) {
elessair 0:f269e3021894 106 _timeout = GAP_ADV_PARAMS_TIMEOUT_MAX;
elessair 0:f269e3021894 107 }
elessair 0:f269e3021894 108 }
elessair 0:f269e3021894 109 }
elessair 0:f269e3021894 110
elessair 0:f269e3021894 111 static const uint16_t UNIT_0_625_MS = 625; /**< Number of microseconds in 0.625 milliseconds. */
elessair 0:f269e3021894 112 /**
elessair 0:f269e3021894 113 * Convert milliseconds to units of 0.625ms.
elessair 0:f269e3021894 114 *
elessair 0:f269e3021894 115 * @param[in] durationInMillis
elessair 0:f269e3021894 116 * The number of milliseconds to convert.
elessair 0:f269e3021894 117 *
elessair 0:f269e3021894 118 * @return The value of @p durationInMillis in units of 0.625ms.
elessair 0:f269e3021894 119 */
elessair 0:f269e3021894 120 static uint16_t MSEC_TO_ADVERTISEMENT_DURATION_UNITS(uint32_t durationInMillis) {
elessair 0:f269e3021894 121 return (durationInMillis * 1000) / UNIT_0_625_MS;
elessair 0:f269e3021894 122 }
elessair 0:f269e3021894 123 /**
elessair 0:f269e3021894 124 * Convert units of 0.625ms to milliseconds.
elessair 0:f269e3021894 125 *
elessair 0:f269e3021894 126 * @param[in] gapUnits
elessair 0:f269e3021894 127 * The number of units of 0.625ms to convert.
elessair 0:f269e3021894 128 *
elessair 0:f269e3021894 129 * @return The value of @p gapUnits in milliseconds.
elessair 0:f269e3021894 130 */
elessair 0:f269e3021894 131 static uint16_t ADVERTISEMENT_DURATION_UNITS_TO_MS(uint16_t gapUnits) {
elessair 0:f269e3021894 132 return (gapUnits * UNIT_0_625_MS) / 1000;
elessair 0:f269e3021894 133 }
elessair 0:f269e3021894 134
elessair 0:f269e3021894 135 /**
elessair 0:f269e3021894 136 * Get the advertising type.
elessair 0:f269e3021894 137 *
elessair 0:f269e3021894 138 * @return The advertising type.
elessair 0:f269e3021894 139 */
elessair 0:f269e3021894 140 AdvertisingType_t getAdvertisingType(void) const {
elessair 0:f269e3021894 141 return _advType;
elessair 0:f269e3021894 142 }
elessair 0:f269e3021894 143
elessair 0:f269e3021894 144 /**
elessair 0:f269e3021894 145 * Get the advertising interval in milliseconds.
elessair 0:f269e3021894 146 *
elessair 0:f269e3021894 147 * @return The advertisement interval (in milliseconds).
elessair 0:f269e3021894 148 */
elessair 0:f269e3021894 149 uint16_t getInterval(void) const {
elessair 0:f269e3021894 150 return ADVERTISEMENT_DURATION_UNITS_TO_MS(_interval);
elessair 0:f269e3021894 151 }
elessair 0:f269e3021894 152
elessair 0:f269e3021894 153 /**
elessair 0:f269e3021894 154 * Get the advertisement interval in units of 0.625ms.
elessair 0:f269e3021894 155 *
elessair 0:f269e3021894 156 * @return The advertisement interval in advertisement duration units (0.625ms units).
elessair 0:f269e3021894 157 */
elessair 0:f269e3021894 158 uint16_t getIntervalInADVUnits(void) const {
elessair 0:f269e3021894 159 return _interval;
elessair 0:f269e3021894 160 }
elessair 0:f269e3021894 161
elessair 0:f269e3021894 162 /**
elessair 0:f269e3021894 163 * Get The advertising timeout.
elessair 0:f269e3021894 164 *
elessair 0:f269e3021894 165 * @return The advertising timeout (in seconds).
elessair 0:f269e3021894 166 */
elessair 0:f269e3021894 167 uint16_t getTimeout(void) const {
elessair 0:f269e3021894 168 return _timeout;
elessair 0:f269e3021894 169 }
elessair 0:f269e3021894 170
elessair 0:f269e3021894 171 /**
elessair 0:f269e3021894 172 * Set the advertising type.
elessair 0:f269e3021894 173 *
elessair 0:f269e3021894 174 * @param[in] newAdvType
elessair 0:f269e3021894 175 * The new advertising type.
elessair 0:f269e3021894 176 */
elessair 0:f269e3021894 177 void setAdvertisingType(AdvertisingType_t newAdvType) {
elessair 0:f269e3021894 178 _advType = newAdvType;
elessair 0:f269e3021894 179 }
elessair 0:f269e3021894 180
elessair 0:f269e3021894 181 /**
elessair 0:f269e3021894 182 * Set the advertising interval in milliseconds.
elessair 0:f269e3021894 183 *
elessair 0:f269e3021894 184 * @param[in] newInterval
elessair 0:f269e3021894 185 * The new advertising interval in milliseconds.
elessair 0:f269e3021894 186 */
elessair 0:f269e3021894 187 void setInterval(uint16_t newInterval) {
elessair 0:f269e3021894 188 _interval = MSEC_TO_ADVERTISEMENT_DURATION_UNITS(newInterval);
elessair 0:f269e3021894 189 }
elessair 0:f269e3021894 190
elessair 0:f269e3021894 191 /**
elessair 0:f269e3021894 192 * Set the advertising timeout.
elessair 0:f269e3021894 193 *
elessair 0:f269e3021894 194 * @param[in] newTimeout
elessair 0:f269e3021894 195 * The new advertising timeout (in seconds).
elessair 0:f269e3021894 196 */
elessair 0:f269e3021894 197 void setTimeout(uint16_t newTimeout) {
elessair 0:f269e3021894 198 _timeout = newTimeout;
elessair 0:f269e3021894 199 }
elessair 0:f269e3021894 200
elessair 0:f269e3021894 201 private:
elessair 0:f269e3021894 202 AdvertisingType_t _advType; /**< The advertising type. */
elessair 0:f269e3021894 203 uint16_t _interval; /**< The advertising interval in ADV duration units (i.e. 0.625ms). */
elessair 0:f269e3021894 204 uint16_t _timeout; /**< The advertising timeout in seconds. */
elessair 0:f269e3021894 205 };
elessair 0:f269e3021894 206
elessair 0:f269e3021894 207 #endif /* ifndef __GAP_ADVERTISING_PARAMS_H__ */