Lancaster University / BLE_API

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:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

public/GapScanningParams.h@715:6d415ac147aa, 2015-07-02 (annotated)

Committer:
rgrover1
Date:
Thu Jul 02 09:06:11 2015 +0100
Revision:
715:6d415ac147aa
Parent:
714:a6130aaa0fd9 
Synchronized with git rev 69726547

Author: Rohit Grover

Release 0.3.9

=============



A minor patch to fix a build error introduced by the previous

release. This has to do with certain declarations being made members

of class UUID.

Who changed what in which revision?

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