Microbug / BLE_API

Minor temporary patch to allow DFU packet callback

Fork of BLE_API by Bluetooth Low Energy

public/GapScanningParams.h@400:868801af787c, 2015-05-13 (annotated)

Committer:
rgrover1
Date:
Wed May 13 08:51:09 2015 +0100
Revision:
400:868801af787c
Parent:
393:77d0399da8aa 
Synchronized with git rev c577e02e

Author: Rohit Grover

GapScanningParams takes in interval and window args in units of ms.

But then translates them internally to units of 0.625ms.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 379:b379d350aaab 1 /* mbed Microcontroller Library
rgrover1 379:b379d350aaab 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 379:b379d350aaab 3 *
rgrover1 379:b379d350aaab 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 379:b379d350aaab 5 * you may not use this file except in compliance with the License.
rgrover1 379:b379d350aaab 6 * You may obtain a copy of the License at
rgrover1 379:b379d350aaab 7 *
rgrover1 379:b379d350aaab 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 379:b379d350aaab 9 *
rgrover1 379:b379d350aaab 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 379:b379d350aaab 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 379:b379d350aaab 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 379:b379d350aaab 13 * See the License for the specific language governing permissions and
rgrover1 379:b379d350aaab 14 * limitations under the License.
rgrover1 379:b379d350aaab 15 */
rgrover1 379:b379d350aaab 16
rgrover1 379:b379d350aaab 17 #ifndef __GAP_SCANNING_PARAMS_H__
rgrover1 379:b379d350aaab 18 #define __GAP_SCANNING_PARAMS_H__
rgrover1 379:b379d350aaab 19
rgrover1 379:b379d350aaab 20 #include "Gap.h"
rgrover1 379:b379d350aaab 21
rgrover1 379:b379d350aaab 22 class GapScanningParams {
rgrover1 379:b379d350aaab 23 public:
rgrover1 379:b379d350aaab 24 static const unsigned SCAN_INTERVAL_MIN = 0x0004; /**< Minimum Scan interval in 625 us units, i.e. 2.5 ms. */
rgrover1 379:b379d350aaab 25 static const unsigned SCAN_INTERVAL_MAX = 0x4000; /**< Maximum Scan interval in 625 us units, i.e. 10.24 s. */
rgrover1 379:b379d350aaab 26 static const unsigned SCAN_WINDOW_MIN = 0x0004; /**< Minimum Scan window in 625 us units, i.e. 2.5 ms. */
rgrover1 379:b379d350aaab 27 static const unsigned SCAN_WINDOW_MAX = 0x4000; /**< Maximum Scan window in 625 us units, i.e. 10.24 s. */
rgrover1 379:b379d350aaab 28 static const unsigned SCAN_TIMEOUT_MIN = 0x0001; /**< Minimum Scan timeout in seconds. */
rgrover1 379:b379d350aaab 29 static const unsigned SCAN_TIMEOUT_MAX = 0xFFFF; /**< Maximum Scan timeout in seconds. */
rgrover1 379:b379d350aaab 30
rgrover1 379:b379d350aaab 31 public:
rgrover1 379:b379d350aaab 32 GapScanningParams(uint16_t interval = SCAN_INTERVAL_MAX,
rgrover1 379:b379d350aaab 33 uint16_t window = SCAN_WINDOW_MAX,
rgrover1 393:77d0399da8aa 34 uint16_t timeout = 0,
rgrover1 400:868801af787c 35 bool activeScanning = false) : _interval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(interval)),
rgrover1 400:868801af787c 36 _window(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(window)),
rgrover1 400:868801af787c 37 _timeout(timeout),
rgrover1 400:868801af787c 38 _activeScanning(activeScanning) {
rgrover1 379:b379d350aaab 39 /* stay within limits */
rgrover1 379:b379d350aaab 40 if (_interval < SCAN_INTERVAL_MIN) {
rgrover1 379:b379d350aaab 41 _interval = SCAN_INTERVAL_MIN;
rgrover1 379:b379d350aaab 42 }
rgrover1 379:b379d350aaab 43 if (_interval > SCAN_INTERVAL_MAX) {
rgrover1 379:b379d350aaab 44 _interval = SCAN_INTERVAL_MAX;
rgrover1 379:b379d350aaab 45 }
rgrover1 386:d30591c3d39c 46 if (_window < SCAN_WINDOW_MIN) {
rgrover1 386:d30591c3d39c 47 _window = SCAN_WINDOW_MIN;
rgrover1 386:d30591c3d39c 48 }
rgrover1 386:d30591c3d39c 49 if (_window > SCAN_WINDOW_MAX) {
rgrover1 386:d30591c3d39c 50 _window = SCAN_WINDOW_MAX;
rgrover1 386:d30591c3d39c 51 }
rgrover1 379:b379d350aaab 52 if (_timeout > SCAN_TIMEOUT_MAX) {
rgrover1 379:b379d350aaab 53 _timeout = SCAN_TIMEOUT_MAX;
rgrover1 379:b379d350aaab 54 }
rgrover1 379:b379d350aaab 55 }
rgrover1 379:b379d350aaab 56
rgrover1 400:868801af787c 57 ble_error_t setInterval(uint16_t newIntervalInMS) {
rgrover1 400:868801af787c 58 uint16_t newInterval = Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(newIntervalInMS);
rgrover1 386:d30591c3d39c 59 if ((newInterval >= SCAN_INTERVAL_MIN) && (newInterval < SCAN_INTERVAL_MAX)) {
rgrover1 386:d30591c3d39c 60 _interval = newInterval;
rgrover1 386:d30591c3d39c 61 return BLE_ERROR_NONE;
rgrover1 386:d30591c3d39c 62 }
rgrover1 386:d30591c3d39c 63
rgrover1 386:d30591c3d39c 64 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 386:d30591c3d39c 65 }
rgrover1 386:d30591c3d39c 66
rgrover1 400:868801af787c 67 ble_error_t setWindow(uint16_t newWindowInMS) {
rgrover1 400:868801af787c 68 uint16_t newWindow = Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(newWindowInMS);
rgrover1 386:d30591c3d39c 69 if ((newWindow >= SCAN_WINDOW_MIN) && (newWindow < SCAN_WINDOW_MAX)) {
rgrover1 386:d30591c3d39c 70 _window = newWindow;
rgrover1 386:d30591c3d39c 71 return BLE_ERROR_NONE;
rgrover1 386:d30591c3d39c 72 }
rgrover1 386:d30591c3d39c 73
rgrover1 386:d30591c3d39c 74 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 386:d30591c3d39c 75 }
rgrover1 386:d30591c3d39c 76
rgrover1 386:d30591c3d39c 77 ble_error_t setTimeout(uint16_t newTimeout) {
rgrover1 386:d30591c3d39c 78 if (newTimeout <= SCAN_TIMEOUT_MAX) {
rgrover1 386:d30591c3d39c 79 _timeout = newTimeout;
rgrover1 386:d30591c3d39c 80 return BLE_ERROR_NONE;
rgrover1 386:d30591c3d39c 81 }
rgrover1 386:d30591c3d39c 82
rgrover1 386:d30591c3d39c 83 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 386:d30591c3d39c 84 }
rgrover1 379:b379d350aaab 85
rgrover1 393:77d0399da8aa 86 void setActiveScanning(bool activeScanning) {
rgrover1 393:77d0399da8aa 87 _activeScanning = activeScanning;
rgrover1 393:77d0399da8aa 88 }
rgrover1 393:77d0399da8aa 89
rgrover1 400:868801af787c 90
rgrover1 400:868801af787c 91 /* @Note: The following return durations in units of 0.625 ms */
rgrover1 379:b379d350aaab 92 uint16_t getInterval(void) const {return _interval;}
rgrover1 379:b379d350aaab 93 uint16_t getWindow(void) const {return _window; }
rgrover1 400:868801af787c 94
rgrover1 379:b379d350aaab 95 uint16_t getTimeout(void) const {return _timeout; }
rgrover1 393:77d0399da8aa 96 bool getActiveScanning(void) const {return _activeScanning;}
rgrover1 379:b379d350aaab 97
rgrover1 379:b379d350aaab 98 private:
rgrover1 400:868801af787c 99 uint16_t _interval; /**< Scan interval in units of 625us (between 2.5ms to 10.24s). */
rgrover1 400:868801af787c 100 uint16_t _window; /**< Scan window in units of 625us (between 2.5ms to 10.24s). */
rgrover1 379:b379d350aaab 101 uint16_t _timeout; /**< Scan timeout between 0x0001 and 0xFFFF in seconds, 0x0000 disables timeout. */
rgrover1 393:77d0399da8aa 102 bool _activeScanning; /**< obtain not only the advertising data from the peer device, but also their scanResponse if possible. */
rgrover1 379:b379d350aaab 103
rgrover1 379:b379d350aaab 104 private:
rgrover1 379:b379d350aaab 105 /* disallow copy constructor */
rgrover1 379:b379d350aaab 106 GapScanningParams(const GapScanningParams &);
rgrover1 379:b379d350aaab 107 GapScanningParams& operator =(const GapScanningParams &in);
rgrover1 379:b379d350aaab 108 };
rgrover1 379:b379d350aaab 109
rgrover1 379:b379d350aaab 110 #endif // ifndef __GAP_SCANNING_PARAMS_H__