erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

features/FEATURE_BLE/ble/GapScanningParams.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16
elessair 0:f269e3021894 17 #ifndef __GAP_SCANNING_PARAMS_H__
elessair 0:f269e3021894 18 #define __GAP_SCANNING_PARAMS_H__
elessair 0:f269e3021894 19
elessair 0:f269e3021894 20 class GapScanningParams {
elessair 0:f269e3021894 21 public:
elessair 0:f269e3021894 22 static const unsigned SCAN_INTERVAL_MIN = 0x0004; /**< Minimum Scan interval in 625us units - 2.5ms. */
elessair 0:f269e3021894 23 static const unsigned SCAN_INTERVAL_MAX = 0x4000; /**< Maximum Scan interval in 625us units - 10.24s. */
elessair 0:f269e3021894 24 static const unsigned SCAN_WINDOW_MIN = 0x0004; /**< Minimum Scan window in 625us units - 2.5ms. */
elessair 0:f269e3021894 25 static const unsigned SCAN_WINDOW_MAX = 0x4000; /**< Maximum Scan window in 625us units - 10.24s. */
elessair 0:f269e3021894 26 static const unsigned SCAN_TIMEOUT_MIN = 0x0001; /**< Minimum Scan timeout in seconds. */
elessair 0:f269e3021894 27 static const unsigned SCAN_TIMEOUT_MAX = 0xFFFF; /**< Maximum Scan timeout in seconds. */
elessair 0:f269e3021894 28
elessair 0:f269e3021894 29 public:
elessair 0:f269e3021894 30 /**
elessair 0:f269e3021894 31 * Construct an instance of GapScanningParams.
elessair 0:f269e3021894 32 *
elessair 0:f269e3021894 33 * @param[in] interval
elessair 0:f269e3021894 34 * The scan interval in milliseconds. Default is
elessair 0:f269e3021894 35 * GapScanningParams::SCAN_INTERVAL_MIN.
elessair 0:f269e3021894 36 * @param[in] window
elessair 0:f269e3021894 37 * The scan window in milliseconds. Default is
elessair 0:f269e3021894 38 * GapScanningParams::SCAN_WINDOW_MAX.
elessair 0:f269e3021894 39 * @param[in] timeout
elessair 0:f269e3021894 40 * The scan timeout in seconds. Default is 0.
elessair 0:f269e3021894 41 * @param[in] activeScanning
elessair 0:f269e3021894 42 * Set to True if active-scanning is required. This is used to
elessair 0:f269e3021894 43 * fetch the scan response from a peer if possible. Default is
elessair 0:f269e3021894 44 * false.
elessair 0:f269e3021894 45 */
elessair 0:f269e3021894 46 GapScanningParams(uint16_t interval = SCAN_INTERVAL_MAX,
elessair 0:f269e3021894 47 uint16_t window = SCAN_WINDOW_MAX,
elessair 0:f269e3021894 48 uint16_t timeout = 0,
elessair 0:f269e3021894 49 bool activeScanning = false);
elessair 0:f269e3021894 50
elessair 0:f269e3021894 51 static const uint16_t UNIT_0_625_MS = 625; /**< Number of microseconds in 0.625 milliseconds. */
elessair 0:f269e3021894 52 /**
elessair 0:f269e3021894 53 * Convert milliseconds to units of 0.625ms.
elessair 0:f269e3021894 54 *
elessair 0:f269e3021894 55 * @param[in] durationInMillis
elessair 0:f269e3021894 56 * The number of milliseconds to convert.
elessair 0:f269e3021894 57 *
elessair 0:f269e3021894 58 * @return The value of @p durationInMillis in units of 0.625ms.
elessair 0:f269e3021894 59 */
elessair 0:f269e3021894 60 static uint16_t MSEC_TO_SCAN_DURATION_UNITS(uint32_t durationInMillis) {
elessair 0:f269e3021894 61 return (durationInMillis * 1000) / UNIT_0_625_MS;
elessair 0:f269e3021894 62 }
elessair 0:f269e3021894 63
elessair 0:f269e3021894 64 /**
elessair 0:f269e3021894 65 * Set the scan interval.
elessair 0:f269e3021894 66 *
elessair 0:f269e3021894 67 * @param[in] newIntervalInMS
elessair 0:f269e3021894 68 * New scan interval in milliseconds.
elessair 0:f269e3021894 69 *
elessair 0:f269e3021894 70 * @return BLE_ERROR_NONE if the new scan interval was set successfully.
elessair 0:f269e3021894 71 */
elessair 0:f269e3021894 72 ble_error_t setInterval(uint16_t newIntervalInMS);
elessair 0:f269e3021894 73
elessair 0:f269e3021894 74 /**
elessair 0:f269e3021894 75 * Set the scan window.
elessair 0:f269e3021894 76 *
elessair 0:f269e3021894 77 * @param[in] newWindowInMS
elessair 0:f269e3021894 78 * New scan window in milliseconds.
elessair 0:f269e3021894 79 *
elessair 0:f269e3021894 80 * @return BLE_ERROR_NONE if the new scan window was set successfully.
elessair 0:f269e3021894 81 */
elessair 0:f269e3021894 82 ble_error_t setWindow(uint16_t newWindowInMS);
elessair 0:f269e3021894 83
elessair 0:f269e3021894 84 /**
elessair 0:f269e3021894 85 * Set the scan timeout.
elessair 0:f269e3021894 86 *
elessair 0:f269e3021894 87 * @param[in] newTimeout
elessair 0:f269e3021894 88 * New scan timeout in seconds.
elessair 0:f269e3021894 89 *
elessair 0:f269e3021894 90 * @return BLE_ERROR_NONE if the new scan window was set successfully.
elessair 0:f269e3021894 91 */
elessair 0:f269e3021894 92 ble_error_t setTimeout(uint16_t newTimeout);
elessair 0:f269e3021894 93
elessair 0:f269e3021894 94 /**
elessair 0:f269e3021894 95 * Set active scanning. This is used to fetch the scan response from a peer
elessair 0:f269e3021894 96 * if possible.
elessair 0:f269e3021894 97 *
elessair 0:f269e3021894 98 * @param[in] activeScanning
elessair 0:f269e3021894 99 * The new boolean value of active scanning.
elessair 0:f269e3021894 100 */
elessair 0:f269e3021894 101 void setActiveScanning(bool activeScanning);
elessair 0:f269e3021894 102
elessair 0:f269e3021894 103 public:
elessair 0:f269e3021894 104 /**
elessair 0:f269e3021894 105 * Get the scan interval.
elessair 0:f269e3021894 106 *
elessair 0:f269e3021894 107 * @return the scan interval in units of 0.625ms.
elessair 0:f269e3021894 108 */
elessair 0:f269e3021894 109 uint16_t getInterval(void) const {
elessair 0:f269e3021894 110 return _interval;
elessair 0:f269e3021894 111 }
elessair 0:f269e3021894 112
elessair 0:f269e3021894 113 /**
elessair 0:f269e3021894 114 * Get the scan window.
elessair 0:f269e3021894 115 *
elessair 0:f269e3021894 116 * @return the scan window in units of 0.625ms.
elessair 0:f269e3021894 117 */
elessair 0:f269e3021894 118 uint16_t getWindow(void) const {
elessair 0:f269e3021894 119 return _window;
elessair 0:f269e3021894 120 }
elessair 0:f269e3021894 121
elessair 0:f269e3021894 122 /**
elessair 0:f269e3021894 123 * Get the scan timeout.
elessair 0:f269e3021894 124 *
elessair 0:f269e3021894 125 * @return The scan timeout in seconds.
elessair 0:f269e3021894 126 */
elessair 0:f269e3021894 127 uint16_t getTimeout(void) const {
elessair 0:f269e3021894 128 return _timeout;
elessair 0:f269e3021894 129 }
elessair 0:f269e3021894 130
elessair 0:f269e3021894 131 /**
elessair 0:f269e3021894 132 * Check whether active scanning is set.
elessair 0:f269e3021894 133 *
elessair 0:f269e3021894 134 * @return True if active scanning is set, false otherwise.
elessair 0:f269e3021894 135 */
elessair 0:f269e3021894 136 bool getActiveScanning(void) const {
elessair 0:f269e3021894 137 return _activeScanning;
elessair 0:f269e3021894 138 }
elessair 0:f269e3021894 139
elessair 0:f269e3021894 140 private:
elessair 0:f269e3021894 141 uint16_t _interval; /**< Scan interval in units of 625us (between 2.5ms and 10.24s). */
elessair 0:f269e3021894 142 uint16_t _window; /**< Scan window in units of 625us (between 2.5ms and 10.24s). */
elessair 0:f269e3021894 143 uint16_t _timeout; /**< Scan timeout between 0x0001 and 0xFFFF in seconds; 0x0000 disables timeout. */
elessair 0:f269e3021894 144 bool _activeScanning; /**< Obtain the peer device's advertising data and (if possible) scanResponse. */
elessair 0:f269e3021894 145
elessair 0:f269e3021894 146 private:
elessair 0:f269e3021894 147 /* Disallow copy constructor. */
elessair 0:f269e3021894 148 GapScanningParams(const GapScanningParams &);
elessair 0:f269e3021894 149 GapScanningParams& operator =(const GapScanningParams &in);
elessair 0:f269e3021894 150 };
elessair 0:f269e3021894 151
elessair 0:f269e3021894 152 #endif /* ifndef __GAP_SCANNING_PARAMS_H__ */