Alex Cordonnier / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Fork of BLE_API by Bluetooth Low Energy

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

Committer:
rgrover1
Date:
Fri Jun 19 15:53:28 2015 +0100
Revision:
710:b2e1a2660ec2
Child:
766:03f1a26f132f
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 710:b2e1a2660ec2 1 /* mbed Microcontroller Library
rgrover1 710:b2e1a2660ec2 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 710:b2e1a2660ec2 3 *
rgrover1 710:b2e1a2660ec2 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 710:b2e1a2660ec2 5 * you may not use this file except in compliance with the License.
rgrover1 710:b2e1a2660ec2 6 * You may obtain a copy of the License at
rgrover1 710:b2e1a2660ec2 7 *
rgrover1 710:b2e1a2660ec2 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 710:b2e1a2660ec2 9 *
rgrover1 710:b2e1a2660ec2 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 710:b2e1a2660ec2 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 710:b2e1a2660ec2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 710:b2e1a2660ec2 13 * See the License for the specific language governing permissions and
rgrover1 710:b2e1a2660ec2 14 * limitations under the License.
rgrover1 710:b2e1a2660ec2 15 */
rgrover1 710:b2e1a2660ec2 16
rgrover1 710:b2e1a2660ec2 17 #ifndef __GAP_SCANNING_PARAMS_H__
rgrover1 710:b2e1a2660ec2 18 #define __GAP_SCANNING_PARAMS_H__
rgrover1 710:b2e1a2660ec2 19
rgrover1 710:b2e1a2660ec2 20 class GapScanningParams {
rgrover1 710:b2e1a2660ec2 21 public:
rgrover1 710:b2e1a2660ec2 22 static const unsigned SCAN_INTERVAL_MIN = 0x0004; /**< Minimum Scan interval in 625 us units, i.e. 2.5 ms. */
rgrover1 710:b2e1a2660ec2 23 static const unsigned SCAN_INTERVAL_MAX = 0x4000; /**< Maximum Scan interval in 625 us units, i.e. 10.24 s. */
rgrover1 710:b2e1a2660ec2 24 static const unsigned SCAN_WINDOW_MIN = 0x0004; /**< Minimum Scan window in 625 us units, i.e. 2.5 ms. */
rgrover1 710:b2e1a2660ec2 25 static const unsigned SCAN_WINDOW_MAX = 0x4000; /**< Maximum Scan window in 625 us units, i.e. 10.24 s. */
rgrover1 710:b2e1a2660ec2 26 static const unsigned SCAN_TIMEOUT_MIN = 0x0001; /**< Minimum Scan timeout in seconds. */
rgrover1 710:b2e1a2660ec2 27 static const unsigned SCAN_TIMEOUT_MAX = 0xFFFF; /**< Maximum Scan timeout in seconds. */
rgrover1 710:b2e1a2660ec2 28
rgrover1 710:b2e1a2660ec2 29 public:
rgrover1 710:b2e1a2660ec2 30 GapScanningParams(uint16_t interval = SCAN_INTERVAL_MAX,
rgrover1 710:b2e1a2660ec2 31 uint16_t window = SCAN_WINDOW_MAX,
rgrover1 710:b2e1a2660ec2 32 uint16_t timeout = 0,
rgrover1 710:b2e1a2660ec2 33 bool activeScanning = false);
rgrover1 710:b2e1a2660ec2 34
rgrover1 710:b2e1a2660ec2 35 ble_error_t setInterval(uint16_t newIntervalInMS);
rgrover1 710:b2e1a2660ec2 36
rgrover1 710:b2e1a2660ec2 37 ble_error_t setWindow(uint16_t newWindowInMS);
rgrover1 710:b2e1a2660ec2 38
rgrover1 710:b2e1a2660ec2 39 ble_error_t setTimeout(uint16_t newTimeout);
rgrover1 710:b2e1a2660ec2 40
rgrover1 710:b2e1a2660ec2 41 void setActiveScanning(bool activeScanning);
rgrover1 710:b2e1a2660ec2 42
rgrover1 710:b2e1a2660ec2 43 public:
rgrover1 710:b2e1a2660ec2 44 /* @Note: The following return durations in units of 0.625 ms */
rgrover1 710:b2e1a2660ec2 45 uint16_t getInterval(void) const {return _interval;}
rgrover1 710:b2e1a2660ec2 46 uint16_t getWindow(void) const {return _window; }
rgrover1 710:b2e1a2660ec2 47
rgrover1 710:b2e1a2660ec2 48 uint16_t getTimeout(void) const {return _timeout; }
rgrover1 710:b2e1a2660ec2 49 bool getActiveScanning(void) const {return _activeScanning;}
rgrover1 710:b2e1a2660ec2 50
rgrover1 710:b2e1a2660ec2 51 private:
rgrover1 710:b2e1a2660ec2 52 uint16_t _interval; /**< Scan interval in units of 625us (between 2.5ms to 10.24s). */
rgrover1 710:b2e1a2660ec2 53 uint16_t _window; /**< Scan window in units of 625us (between 2.5ms to 10.24s). */
rgrover1 710:b2e1a2660ec2 54 uint16_t _timeout; /**< Scan timeout between 0x0001 and 0xFFFF in seconds, 0x0000 disables timeout. */
rgrover1 710:b2e1a2660ec2 55 bool _activeScanning; /**< obtain not only the advertising data from the peer device, but also their scanResponse if possible. */
rgrover1 710:b2e1a2660ec2 56
rgrover1 710:b2e1a2660ec2 57 private:
rgrover1 710:b2e1a2660ec2 58 /* disallow copy constructor */
rgrover1 710:b2e1a2660ec2 59 GapScanningParams(const GapScanningParams &);
rgrover1 710:b2e1a2660ec2 60 GapScanningParams& operator =(const GapScanningParams &in);
rgrover1 710:b2e1a2660ec2 61 };
rgrover1 710:b2e1a2660ec2 62
rgrover1 710:b2e1a2660ec2 63 #endif // ifndef __GAP_SCANNING_PARAMS_H__