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/GapScanningParams.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_GAP_SCANNING_PARAMS_H__
be_bryan 0:b74591d5ab33 18 #define MBED_GAP_SCANNING_PARAMS_H__
be_bryan 0:b74591d5ab33 19
be_bryan 0:b74591d5ab33 20 /**
be_bryan 0:b74591d5ab33 21 * @addtogroup ble
be_bryan 0:b74591d5ab33 22 * @{
be_bryan 0:b74591d5ab33 23 * @addtogroup gap
be_bryan 0:b74591d5ab33 24 * @{
be_bryan 0:b74591d5ab33 25 */
be_bryan 0:b74591d5ab33 26
be_bryan 0:b74591d5ab33 27 /**
be_bryan 0:b74591d5ab33 28 * Parameters defining the scan process.
be_bryan 0:b74591d5ab33 29 *
be_bryan 0:b74591d5ab33 30 * Four distinct parameters define the scan procedure:
be_bryan 0:b74591d5ab33 31 * - Scan window: Period during which the scanner listens to advertising
be_bryan 0:b74591d5ab33 32 * channels. That value is in the range of 2.5ms to 10.24s. This value
be_bryan 0:b74591d5ab33 33 * can be set at construction time, updated by calling setWindow() and
be_bryan 0:b74591d5ab33 34 * retrieved by invoking getWindow().
be_bryan 0:b74591d5ab33 35 *
be_bryan 0:b74591d5ab33 36 * - Scan interval: Interval between the start of two consecutive scan windows.
be_bryan 0:b74591d5ab33 37 * That value shall be greater or equal to the scan window value. The
be_bryan 0:b74591d5ab33 38 * maximum allowed value is 10.24ms. The scan interval value can be set at
be_bryan 0:b74591d5ab33 39 * construction time, updated with a call to setInterval() and queried by a
be_bryan 0:b74591d5ab33 40 * call to getInterval().
be_bryan 0:b74591d5ab33 41 *
be_bryan 0:b74591d5ab33 42 * - Timeout: The duration of the scan procedure if any. It can be set at
be_bryan 0:b74591d5ab33 43 * construction time, updated with setTimeout() and obtained from
be_bryan 0:b74591d5ab33 44 * getTimeout().
be_bryan 0:b74591d5ab33 45 *
be_bryan 0:b74591d5ab33 46 * - Active scanning: If set, then the scanner sends scan requests to a scannable
be_bryan 0:b74591d5ab33 47 * or connectable advertiser. Advertisers may respond to the scan request
be_bryan 0:b74591d5ab33 48 * by a scan response containing the scan response payload. If not set, then
be_bryan 0:b74591d5ab33 49 * the scanner does not send any request. This flag is set at construction
be_bryan 0:b74591d5ab33 50 * time, may be updated with the help of setActiveScanning() and retrieved
be_bryan 0:b74591d5ab33 51 * by getActiveScanning().
be_bryan 0:b74591d5ab33 52 *
be_bryan 0:b74591d5ab33 53 * @note If the scan window's duration is equal to the scan interval, then the
be_bryan 0:b74591d5ab33 54 * device listens continuously during the scan procedure.
be_bryan 0:b74591d5ab33 55 */
be_bryan 0:b74591d5ab33 56 class GapScanningParams {
be_bryan 0:b74591d5ab33 57 public:
be_bryan 0:b74591d5ab33 58 /**
be_bryan 0:b74591d5ab33 59 * Minimum Scan interval in 625us units - 2.5ms.
be_bryan 0:b74591d5ab33 60 */
be_bryan 0:b74591d5ab33 61 static const unsigned SCAN_INTERVAL_MIN = 0x0004;
be_bryan 0:b74591d5ab33 62
be_bryan 0:b74591d5ab33 63 /**
be_bryan 0:b74591d5ab33 64 * Maximum Scan interval in 625us units - 10.24s.
be_bryan 0:b74591d5ab33 65 */
be_bryan 0:b74591d5ab33 66 static const unsigned SCAN_INTERVAL_MAX = 0x4000;
be_bryan 0:b74591d5ab33 67
be_bryan 0:b74591d5ab33 68 /**
be_bryan 0:b74591d5ab33 69 * Minimum Scan window in 625us units - 2.5ms.
be_bryan 0:b74591d5ab33 70 */
be_bryan 0:b74591d5ab33 71 static const unsigned SCAN_WINDOW_MIN = 0x0004;
be_bryan 0:b74591d5ab33 72
be_bryan 0:b74591d5ab33 73 /**
be_bryan 0:b74591d5ab33 74 * Maximum Scan window in 625us units - 10.24s.
be_bryan 0:b74591d5ab33 75 */
be_bryan 0:b74591d5ab33 76 static const unsigned SCAN_WINDOW_MAX = 0x4000;
be_bryan 0:b74591d5ab33 77
be_bryan 0:b74591d5ab33 78 /**
be_bryan 0:b74591d5ab33 79 * Minimum Scan duration in seconds.
be_bryan 0:b74591d5ab33 80 */
be_bryan 0:b74591d5ab33 81 static const unsigned SCAN_TIMEOUT_MIN = 0x0001;
be_bryan 0:b74591d5ab33 82
be_bryan 0:b74591d5ab33 83 /**
be_bryan 0:b74591d5ab33 84 * Maximum Scan duration in seconds.
be_bryan 0:b74591d5ab33 85 */
be_bryan 0:b74591d5ab33 86 static const unsigned SCAN_TIMEOUT_MAX = 0xFFFF;
be_bryan 0:b74591d5ab33 87
be_bryan 0:b74591d5ab33 88 public:
be_bryan 0:b74591d5ab33 89 /**
be_bryan 0:b74591d5ab33 90 * Construct an instance of GapScanningParams.
be_bryan 0:b74591d5ab33 91 *
be_bryan 0:b74591d5ab33 92 * @param[in] interval Milliseconds interval between the start of two
be_bryan 0:b74591d5ab33 93 * consecutive scan windows. The value passed is between the scan
be_bryan 0:b74591d5ab33 94 * window value and 10.24 seconds.
be_bryan 0:b74591d5ab33 95 *
be_bryan 0:b74591d5ab33 96 * @param[in] window Milliseconds period during which the device
be_bryan 0:b74591d5ab33 97 * listens to advertising channels. The value of the scan window is in
be_bryan 0:b74591d5ab33 98 * the range of 2.5ms to 10.24s.
be_bryan 0:b74591d5ab33 99 *
be_bryan 0:b74591d5ab33 100 * @param[in] timeout Duration in seconds of the scan procedure. The special
be_bryan 0:b74591d5ab33 101 * value 0 may be used when the scan procedure is not time bounded.
be_bryan 0:b74591d5ab33 102 *
be_bryan 0:b74591d5ab33 103 * @param[in] activeScanning If true, then the scanner sends scan requests to
be_bryan 0:b74591d5ab33 104 * to scannable or connectable advertiser. Advertisers may respond to the
be_bryan 0:b74591d5ab33 105 * scan request by a scan response containing the scan response payload. If
be_bryan 0:b74591d5ab33 106 * false, the scanner does not send any request.
be_bryan 0:b74591d5ab33 107 *
be_bryan 0:b74591d5ab33 108 * @note If interval is equal to window
be_bryan 0:b74591d5ab33 109 */
be_bryan 0:b74591d5ab33 110 GapScanningParams(
be_bryan 0:b74591d5ab33 111 uint16_t interval = SCAN_INTERVAL_MAX,
be_bryan 0:b74591d5ab33 112 uint16_t window = SCAN_WINDOW_MAX,
be_bryan 0:b74591d5ab33 113 uint16_t timeout = 0,
be_bryan 0:b74591d5ab33 114 bool activeScanning = false
be_bryan 0:b74591d5ab33 115 );
be_bryan 0:b74591d5ab33 116
be_bryan 0:b74591d5ab33 117 /**
be_bryan 0:b74591d5ab33 118 * Number of microseconds in 0.625 milliseconds.
be_bryan 0:b74591d5ab33 119 */
be_bryan 0:b74591d5ab33 120 static const uint16_t UNIT_0_625_MS = 625;
be_bryan 0:b74591d5ab33 121
be_bryan 0:b74591d5ab33 122 /**
be_bryan 0:b74591d5ab33 123 * Convert milliseconds to units of 0.625ms.
be_bryan 0:b74591d5ab33 124 *
be_bryan 0:b74591d5ab33 125 * @param[in] durationInMillis Milliseconds to convert.
be_bryan 0:b74591d5ab33 126 *
be_bryan 0:b74591d5ab33 127 * @return The value of @p durationInMillis in units of 0.625ms.
be_bryan 0:b74591d5ab33 128 */
be_bryan 0:b74591d5ab33 129 static uint16_t MSEC_TO_SCAN_DURATION_UNITS(uint32_t durationInMillis)
be_bryan 0:b74591d5ab33 130 {
be_bryan 0:b74591d5ab33 131 return (durationInMillis * 1000) / UNIT_0_625_MS;
be_bryan 0:b74591d5ab33 132 }
be_bryan 0:b74591d5ab33 133
be_bryan 0:b74591d5ab33 134 /**
be_bryan 0:b74591d5ab33 135 * Update the scan interval.
be_bryan 0:b74591d5ab33 136 *
be_bryan 0:b74591d5ab33 137 * @param[in] newIntervalInMS New scan interval in milliseconds.
be_bryan 0:b74591d5ab33 138 *
be_bryan 0:b74591d5ab33 139 * @return BLE_ERROR_NONE if the new scan interval was set successfully.
be_bryan 0:b74591d5ab33 140 */
be_bryan 0:b74591d5ab33 141 ble_error_t setInterval(uint16_t newIntervalInMS);
be_bryan 0:b74591d5ab33 142
be_bryan 0:b74591d5ab33 143 /**
be_bryan 0:b74591d5ab33 144 * Update the scan window.
be_bryan 0:b74591d5ab33 145 *
be_bryan 0:b74591d5ab33 146 * @param[in] newWindowInMS New scan window in milliseconds.
be_bryan 0:b74591d5ab33 147 *
be_bryan 0:b74591d5ab33 148 * @return BLE_ERROR_NONE if the new scan window was set successfully.
be_bryan 0:b74591d5ab33 149 */
be_bryan 0:b74591d5ab33 150 ble_error_t setWindow(uint16_t newWindowInMS);
be_bryan 0:b74591d5ab33 151
be_bryan 0:b74591d5ab33 152 /**
be_bryan 0:b74591d5ab33 153 * Update the scan timeout.
be_bryan 0:b74591d5ab33 154 *
be_bryan 0:b74591d5ab33 155 * @param[in] newTimeout New scan timeout in seconds.
be_bryan 0:b74591d5ab33 156 *
be_bryan 0:b74591d5ab33 157 * @return BLE_ERROR_NONE if the new scan window was set successfully.
be_bryan 0:b74591d5ab33 158 */
be_bryan 0:b74591d5ab33 159 ble_error_t setTimeout(uint16_t newTimeout);
be_bryan 0:b74591d5ab33 160
be_bryan 0:b74591d5ab33 161 /**
be_bryan 0:b74591d5ab33 162 * Update the active scanning flag.
be_bryan 0:b74591d5ab33 163 *
be_bryan 0:b74591d5ab33 164 * @param[in] activeScanning New boolean value of active scanning.
be_bryan 0:b74591d5ab33 165 */
be_bryan 0:b74591d5ab33 166 void setActiveScanning(bool activeScanning);
be_bryan 0:b74591d5ab33 167
be_bryan 0:b74591d5ab33 168 public:
be_bryan 0:b74591d5ab33 169 /**
be_bryan 0:b74591d5ab33 170 * Get the scan interval.
be_bryan 0:b74591d5ab33 171 *
be_bryan 0:b74591d5ab33 172 * @return the scan interval in units of 0.625ms.
be_bryan 0:b74591d5ab33 173 */
be_bryan 0:b74591d5ab33 174 uint16_t getInterval(void) const
be_bryan 0:b74591d5ab33 175 {
be_bryan 0:b74591d5ab33 176 return _interval;
be_bryan 0:b74591d5ab33 177 }
be_bryan 0:b74591d5ab33 178
be_bryan 0:b74591d5ab33 179 /**
be_bryan 0:b74591d5ab33 180 * Get the scan window.
be_bryan 0:b74591d5ab33 181 *
be_bryan 0:b74591d5ab33 182 * @return the scan window in units of 0.625ms.
be_bryan 0:b74591d5ab33 183 */
be_bryan 0:b74591d5ab33 184 uint16_t getWindow(void) const
be_bryan 0:b74591d5ab33 185 {
be_bryan 0:b74591d5ab33 186 return _window;
be_bryan 0:b74591d5ab33 187 }
be_bryan 0:b74591d5ab33 188
be_bryan 0:b74591d5ab33 189 /**
be_bryan 0:b74591d5ab33 190 * Get the scan timeout.
be_bryan 0:b74591d5ab33 191 *
be_bryan 0:b74591d5ab33 192 * @return The scan timeout in seconds.
be_bryan 0:b74591d5ab33 193 */
be_bryan 0:b74591d5ab33 194 uint16_t getTimeout(void) const
be_bryan 0:b74591d5ab33 195 {
be_bryan 0:b74591d5ab33 196 return _timeout;
be_bryan 0:b74591d5ab33 197 }
be_bryan 0:b74591d5ab33 198
be_bryan 0:b74591d5ab33 199 /**
be_bryan 0:b74591d5ab33 200 * Check whether active scanning is set.
be_bryan 0:b74591d5ab33 201 *
be_bryan 0:b74591d5ab33 202 * @return True if active scanning is set, false otherwise.
be_bryan 0:b74591d5ab33 203 */
be_bryan 0:b74591d5ab33 204 bool getActiveScanning(void) const
be_bryan 0:b74591d5ab33 205 {
be_bryan 0:b74591d5ab33 206 return _activeScanning;
be_bryan 0:b74591d5ab33 207 }
be_bryan 0:b74591d5ab33 208
be_bryan 0:b74591d5ab33 209 private:
be_bryan 0:b74591d5ab33 210 /**
be_bryan 0:b74591d5ab33 211 * Scan interval in units of 625us (between 2.5ms and 10.24s).
be_bryan 0:b74591d5ab33 212 */
be_bryan 0:b74591d5ab33 213 uint16_t _interval;
be_bryan 0:b74591d5ab33 214
be_bryan 0:b74591d5ab33 215 /**
be_bryan 0:b74591d5ab33 216 * Scan window in units of 625us (between 2.5ms and 10.24s).
be_bryan 0:b74591d5ab33 217 */
be_bryan 0:b74591d5ab33 218 uint16_t _window;
be_bryan 0:b74591d5ab33 219
be_bryan 0:b74591d5ab33 220 /**
be_bryan 0:b74591d5ab33 221 * Scan timeout between 0x0001 and 0xFFFF in seconds; 0x0000 disables timeout.
be_bryan 0:b74591d5ab33 222 */
be_bryan 0:b74591d5ab33 223 uint16_t _timeout;
be_bryan 0:b74591d5ab33 224
be_bryan 0:b74591d5ab33 225 /**
be_bryan 0:b74591d5ab33 226 * Obtain the peer device's advertising data and (if possible) scanResponse.
be_bryan 0:b74591d5ab33 227 */
be_bryan 0:b74591d5ab33 228 bool _activeScanning;
be_bryan 0:b74591d5ab33 229
be_bryan 0:b74591d5ab33 230 private:
be_bryan 0:b74591d5ab33 231 /* Disallow copy constructor. */
be_bryan 0:b74591d5ab33 232 GapScanningParams(const GapScanningParams &);
be_bryan 0:b74591d5ab33 233 GapScanningParams& operator =(const GapScanningParams &in);
be_bryan 0:b74591d5ab33 234 };
be_bryan 0:b74591d5ab33 235
be_bryan 0:b74591d5ab33 236 /**
be_bryan 0:b74591d5ab33 237 * @}
be_bryan 0:b74591d5ab33 238 * @}
be_bryan 0:b74591d5ab33 239 */
be_bryan 0:b74591d5ab33 240
be_bryan 0:b74591d5ab33 241 #endif /* ifndef MBED_GAP_SCANNING_PARAMS_H__ */