Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

ble/GapScanningParams.h@993:4d62b7967c11, 2015-12-02 (annotated)

Committer:
rgrover1
Date:
Wed Dec 02 10:29:44 2015 +0000
Revision:
993:4d62b7967c11
Parent:
992:ca834f7ae8ed
Child:
1042:21a86ac7f5b1
Synchronized with git rev 12e27cd4

Author: Rohit Grover

Release 2.1.3

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



* Improvements to CallChainOfFunctionPointerswithContext:

  - add a `detach` function to be able to remove callbacks.

  - detach function now return true if a function has been detached and

    false otherwise.

  - add a function call operator.

  - use safe-bool idiom. see : http://www.artima.com/cppsource/safebool.html



* Add SafeBool class which allow to easily declare a safe bool operator in

  c++03.



* Improvements to FunctionPointerWithContext:

  - fix call propagation

  - use safe bool idiom



* Add config file for generating Doxygen.



* Setup for onRadioNotification callback does not call initRadioNotification

  anymore.



* GapAdvertisementData now handles replacement and appending of data fields

  based on type. Some fields can be replaced with new values, and others

  require the payload to be appended.

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 993:4d62b7967c11 22 static const unsigned SCAN_INTERVAL_MIN = 0x0004; /**< Minimum Scan interval in 625us units - 2.5ms. */
rgrover1 993:4d62b7967c11 23 static const unsigned SCAN_INTERVAL_MAX = 0x4000; /**< Maximum Scan interval in 625us units - 10.24s. */
rgrover1 993:4d62b7967c11 24 static const unsigned SCAN_WINDOW_MIN = 0x0004; /**< Minimum Scan window in 625us units - 2.5ms. */
rgrover1 993:4d62b7967c11 25 static const unsigned SCAN_WINDOW_MAX = 0x4000; /**< Maximum Scan window in 625us units - 10.24s. */
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 766:03f1a26f132f 35 static const uint16_t UNIT_0_625_MS = 625; /**< Number of microseconds in 0.625 milliseconds. */
rgrover1 766:03f1a26f132f 36 static uint16_t MSEC_TO_SCAN_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 766:03f1a26f132f 37 return (durationInMillis * 1000) / UNIT_0_625_MS;
rgrover1 766:03f1a26f132f 38 }
rgrover1 766:03f1a26f132f 39
rgrover1 710:b2e1a2660ec2 40 ble_error_t setInterval(uint16_t newIntervalInMS);
rgrover1 710:b2e1a2660ec2 41
rgrover1 710:b2e1a2660ec2 42 ble_error_t setWindow(uint16_t newWindowInMS);
rgrover1 710:b2e1a2660ec2 43
rgrover1 710:b2e1a2660ec2 44 ble_error_t setTimeout(uint16_t newTimeout);
rgrover1 710:b2e1a2660ec2 45
rgrover1 710:b2e1a2660ec2 46 void setActiveScanning(bool activeScanning);
rgrover1 710:b2e1a2660ec2 47
rgrover1 710:b2e1a2660ec2 48 public:
rgrover1 993:4d62b7967c11 49 /* @Note: The following return durations in units of 0.625ms */
rgrover1 710:b2e1a2660ec2 50 uint16_t getInterval(void) const {return _interval;}
rgrover1 710:b2e1a2660ec2 51 uint16_t getWindow(void) const {return _window; }
rgrover1 710:b2e1a2660ec2 52
rgrover1 710:b2e1a2660ec2 53 uint16_t getTimeout(void) const {return _timeout; }
rgrover1 710:b2e1a2660ec2 54 bool getActiveScanning(void) const {return _activeScanning;}
rgrover1 710:b2e1a2660ec2 55
rgrover1 710:b2e1a2660ec2 56 private:
rgrover1 993:4d62b7967c11 57 uint16_t _interval; /**< Scan interval in units of 625us (between 2.5ms and 10.24s). */
rgrover1 993:4d62b7967c11 58 uint16_t _window; /**< Scan window in units of 625us (between 2.5ms and 10.24s). */
rgrover1 993:4d62b7967c11 59 uint16_t _timeout; /**< Scan timeout between 0x0001 and 0xFFFF in seconds; 0x0000 disables timeout. */
rgrover1 993:4d62b7967c11 60 bool _activeScanning; /**< Obtain the peer device's advertising data and (if possible) scanResponse. */
rgrover1 710:b2e1a2660ec2 61
rgrover1 710:b2e1a2660ec2 62 private:
rgrover1 993:4d62b7967c11 63 /* Disallow copy constructor. */
rgrover1 710:b2e1a2660ec2 64 GapScanningParams(const GapScanningParams &);
rgrover1 710:b2e1a2660ec2 65 GapScanningParams& operator =(const GapScanningParams &in);
rgrover1 710:b2e1a2660ec2 66 };
rgrover1 710:b2e1a2660ec2 67
rgrover1 710:b2e1a2660ec2 68 #endif // ifndef __GAP_SCANNING_PARAMS_H__