xiao sun / BLE_API

fork BLE_API to add update adv payload API

Fork of BLE_API by Bluetooth Low Energy

public/GapScanningParams.h@710:b2e1a2660ec2, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:28 2015 +0100
Revision:
710:b2e1a2660ec2
Parent:
674:923c47bd1547 
Synchronized with git rev 7e8977d8

Author: Rohit Grover

Release 0.3.8

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



This is a minor set of enhancements before we yotta-ize BLE_API.



Enhancements

~~~~~~~~~~~~



* Minor rework for class UUID; added a default and copy constructor; and a != operator.



* Added copy constructor and accessors for GapAdvertisingParams.



* GapScanningParams:: remove unnecessary checks for SCAN_TIMEOUT_MAX.



* Add a comment header block to explain why BLEDevice::init() may not be safe

  to call from global static context.



* Introduce GattAttribute::INVALID_HANDLE.



* Replace some deprecated uses of Gap::address_t with Gap::Address_t.



Bugfixes

~~~~~~~~



* None.

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 710:b2e1a2660ec2 20 #include "Gap.h"
rgrover1 710:b2e1a2660ec2 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 710:b2e1a2660ec2 32 GapScanningParams(uint16_t interval = SCAN_INTERVAL_MAX,
rgrover1 710:b2e1a2660ec2 33 uint16_t window = SCAN_WINDOW_MAX,
rgrover1 710:b2e1a2660ec2 34 uint16_t timeout = 0,
rgrover1 710:b2e1a2660ec2 35 bool activeScanning = false) : _interval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(interval)),
rgrover1 710:b2e1a2660ec2 36 _window(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(window)),
rgrover1 710:b2e1a2660ec2 37 _timeout(timeout),
rgrover1 710:b2e1a2660ec2 38 _activeScanning(activeScanning) {
rgrover1 710:b2e1a2660ec2 39 /* stay within limits */
rgrover1 710:b2e1a2660ec2 40 if (_interval < SCAN_INTERVAL_MIN) {
rgrover1 710:b2e1a2660ec2 41 _interval = SCAN_INTERVAL_MIN;
rgrover1 710:b2e1a2660ec2 42 }
rgrover1 710:b2e1a2660ec2 43 if (_interval > SCAN_INTERVAL_MAX) {
rgrover1 710:b2e1a2660ec2 44 _interval = SCAN_INTERVAL_MAX;
rgrover1 710:b2e1a2660ec2 45 }
rgrover1 710:b2e1a2660ec2 46 if (_window < SCAN_WINDOW_MIN) {
rgrover1 710:b2e1a2660ec2 47 _window = SCAN_WINDOW_MIN;
rgrover1 710:b2e1a2660ec2 48 }
rgrover1 710:b2e1a2660ec2 49 if (_window > SCAN_WINDOW_MAX) {
rgrover1 710:b2e1a2660ec2 50 _window = SCAN_WINDOW_MAX;
rgrover1 710:b2e1a2660ec2 51 }
rgrover1 710:b2e1a2660ec2 52 }
rgrover1 386:d30591c3d39c 53
rgrover1 710:b2e1a2660ec2 54 ble_error_t setInterval(uint16_t newIntervalInMS) {
rgrover1 710:b2e1a2660ec2 55 uint16_t newInterval = Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(newIntervalInMS);
rgrover1 710:b2e1a2660ec2 56 if ((newInterval >= SCAN_INTERVAL_MIN) && (newInterval < SCAN_INTERVAL_MAX)) {
rgrover1 710:b2e1a2660ec2 57 _interval = newInterval;
rgrover1 710:b2e1a2660ec2 58 return BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 59 }
rgrover1 386:d30591c3d39c 60
rgrover1 710:b2e1a2660ec2 61 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 710:b2e1a2660ec2 62 }
rgrover1 567:e4b38e43de7c 63
rgrover1 710:b2e1a2660ec2 64 ble_error_t setWindow(uint16_t newWindowInMS) {
rgrover1 710:b2e1a2660ec2 65 uint16_t newWindow = Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(newWindowInMS);
rgrover1 710:b2e1a2660ec2 66 if ((newWindow >= SCAN_WINDOW_MIN) && (newWindow < SCAN_WINDOW_MAX)) {
rgrover1 710:b2e1a2660ec2 67 _window = newWindow;
rgrover1 710:b2e1a2660ec2 68 return BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 69 }
rgrover1 710:b2e1a2660ec2 70
rgrover1 710:b2e1a2660ec2 71 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 710:b2e1a2660ec2 72 }
rgrover1 567:e4b38e43de7c 73
rgrover1 710:b2e1a2660ec2 74 ble_error_t setTimeout(uint16_t newTimeout) {
rgrover1 710:b2e1a2660ec2 75 _timeout = newTimeout;
rgrover1 710:b2e1a2660ec2 76 return BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 77 }
rgrover1 710:b2e1a2660ec2 78
rgrover1 710:b2e1a2660ec2 79 void setActiveScanning(bool activeScanning) {
rgrover1 710:b2e1a2660ec2 80 _activeScanning = activeScanning;
rgrover1 710:b2e1a2660ec2 81 }
rgrover1 710:b2e1a2660ec2 82
rgrover1 710:b2e1a2660ec2 83
rgrover1 400:868801af787c 84 /* @Note: The following return durations in units of 0.625 ms */
rgrover1 379:b379d350aaab 85 uint16_t getInterval(void) const {return _interval;}
rgrover1 379:b379d350aaab 86 uint16_t getWindow(void) const {return _window; }
rgrover1 400:868801af787c 87
rgrover1 379:b379d350aaab 88 uint16_t getTimeout(void) const {return _timeout; }
rgrover1 393:77d0399da8aa 89 bool getActiveScanning(void) const {return _activeScanning;}
rgrover1 379:b379d350aaab 90
rgrover1 379:b379d350aaab 91 private:
rgrover1 400:868801af787c 92 uint16_t _interval; /**< Scan interval in units of 625us (between 2.5ms to 10.24s). */
rgrover1 400:868801af787c 93 uint16_t _window; /**< Scan window in units of 625us (between 2.5ms to 10.24s). */
rgrover1 379:b379d350aaab 94 uint16_t _timeout; /**< Scan timeout between 0x0001 and 0xFFFF in seconds, 0x0000 disables timeout. */
rgrover1 393:77d0399da8aa 95 bool _activeScanning; /**< obtain not only the advertising data from the peer device, but also their scanResponse if possible. */
rgrover1 379:b379d350aaab 96
rgrover1 379:b379d350aaab 97 private:
rgrover1 379:b379d350aaab 98 /* disallow copy constructor */
rgrover1 379:b379d350aaab 99 GapScanningParams(const GapScanningParams &);
rgrover1 379:b379d350aaab 100 GapScanningParams& operator =(const GapScanningParams &in);
rgrover1 379:b379d350aaab 101 };
rgrover1 379:b379d350aaab 102
rgrover1 379:b379d350aaab 103 #endif // ifndef __GAP_SCANNING_PARAMS_H__