Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

public/GapScanningParams.h@386:d30591c3d39c, 2015-05-13 (annotated)

Committer:
rgrover1
Date:
Wed May 13 08:51:08 2015 +0100
Revision:
386:d30591c3d39c
Parent:
380:2109a08c311c
Child:
393:77d0399da8aa
Synchronized with git rev 4c6fb079

Author: Rohit Grover

add error checking for APIs for ScanningParameters.

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 379:b379d350aaab 34 uint16_t timeout = 0) : _interval(interval), _window(window), _timeout(timeout) {
rgrover1 379:b379d350aaab 35 /* stay within limits */
rgrover1 379:b379d350aaab 36 if (_interval < SCAN_INTERVAL_MIN) {
rgrover1 379:b379d350aaab 37 _interval = SCAN_INTERVAL_MIN;
rgrover1 379:b379d350aaab 38 }
rgrover1 379:b379d350aaab 39 if (_interval > SCAN_INTERVAL_MAX) {
rgrover1 379:b379d350aaab 40 _interval = SCAN_INTERVAL_MAX;
rgrover1 379:b379d350aaab 41 }
rgrover1 386:d30591c3d39c 42 if (_window < SCAN_WINDOW_MIN) {
rgrover1 386:d30591c3d39c 43 _window = SCAN_WINDOW_MIN;
rgrover1 386:d30591c3d39c 44 }
rgrover1 386:d30591c3d39c 45 if (_window > SCAN_WINDOW_MAX) {
rgrover1 386:d30591c3d39c 46 _window = SCAN_WINDOW_MAX;
rgrover1 386:d30591c3d39c 47 }
rgrover1 379:b379d350aaab 48 if (_timeout > SCAN_TIMEOUT_MAX) {
rgrover1 379:b379d350aaab 49 _timeout = SCAN_TIMEOUT_MAX;
rgrover1 379:b379d350aaab 50 }
rgrover1 379:b379d350aaab 51 }
rgrover1 379:b379d350aaab 52
rgrover1 386:d30591c3d39c 53 ble_error_t setInterval(uint16_t newInterval) {
rgrover1 386:d30591c3d39c 54 if ((newInterval >= SCAN_INTERVAL_MIN) && (newInterval < SCAN_INTERVAL_MAX)) {
rgrover1 386:d30591c3d39c 55 _interval = newInterval;
rgrover1 386:d30591c3d39c 56 return BLE_ERROR_NONE;
rgrover1 386:d30591c3d39c 57 }
rgrover1 386:d30591c3d39c 58
rgrover1 386:d30591c3d39c 59 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 386:d30591c3d39c 60 }
rgrover1 386:d30591c3d39c 61
rgrover1 386:d30591c3d39c 62 ble_error_t setWindow(uint16_t newWindow) {
rgrover1 386:d30591c3d39c 63 if ((newWindow >= SCAN_WINDOW_MIN) && (newWindow < SCAN_WINDOW_MAX)) {
rgrover1 386:d30591c3d39c 64 _window = newWindow;
rgrover1 386:d30591c3d39c 65 return BLE_ERROR_NONE;
rgrover1 386:d30591c3d39c 66 }
rgrover1 386:d30591c3d39c 67
rgrover1 386:d30591c3d39c 68 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 386:d30591c3d39c 69 }
rgrover1 386:d30591c3d39c 70
rgrover1 386:d30591c3d39c 71 ble_error_t setTimeout(uint16_t newTimeout) {
rgrover1 386:d30591c3d39c 72 if (newTimeout <= SCAN_TIMEOUT_MAX) {
rgrover1 386:d30591c3d39c 73 _timeout = newTimeout;
rgrover1 386:d30591c3d39c 74 return BLE_ERROR_NONE;
rgrover1 386:d30591c3d39c 75 }
rgrover1 386:d30591c3d39c 76
rgrover1 386:d30591c3d39c 77 return BLE_ERROR_PARAM_OUT_OF_RANGE;
rgrover1 386:d30591c3d39c 78 }
rgrover1 379:b379d350aaab 79
rgrover1 379:b379d350aaab 80 uint16_t getInterval(void) const {return _interval;}
rgrover1 379:b379d350aaab 81 uint16_t getWindow(void) const {return _window; }
rgrover1 379:b379d350aaab 82 uint16_t getTimeout(void) const {return _timeout; }
rgrover1 379:b379d350aaab 83
rgrover1 379:b379d350aaab 84 private:
rgrover1 379:b379d350aaab 85 uint16_t _interval; /**< Scan interval (between 2.5ms to 10.24s). */
rgrover1 379:b379d350aaab 86 uint16_t _window; /**< Scan window (between 2.5ms to 10.24s). */
rgrover1 379:b379d350aaab 87 uint16_t _timeout; /**< Scan timeout between 0x0001 and 0xFFFF in seconds, 0x0000 disables timeout. */
rgrover1 379:b379d350aaab 88
rgrover1 379:b379d350aaab 89 private:
rgrover1 379:b379d350aaab 90 /* disallow copy constructor */
rgrover1 379:b379d350aaab 91 GapScanningParams(const GapScanningParams &);
rgrover1 379:b379d350aaab 92 GapScanningParams& operator =(const GapScanningParams &in);
rgrover1 379:b379d350aaab 93 };
rgrover1 379:b379d350aaab 94
rgrover1 379:b379d350aaab 95 #endif // ifndef __GAP_SCANNING_PARAMS_H__