Jacob McEntire / BLE_API_mod2

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

Diff: public/BLEDevice.h

Revision:
390:4bf41689c7f9
Parent:
387:7faa54079669
Child:
391:6f42075be548
--- a/public/BLEDevice.h	Wed May 13 08:51:08 2015 +0100
+++ b/public/BLEDevice.h	Wed May 13 08:51:08 2015 +0100
@@ -237,6 +237,18 @@
      * @param  interval Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
      * @param  window   Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
      * @param  timeout  Scan timeout (in seconds) between 0x0001 and 0xFFFF, 0x0000 disables timeout.
+     *
+     * The scanning window divided by the interval determines the duty cycle for
+     * scanning. For example, if the interval is 100ms and the window is 10ms,
+     * then the controller will scan for 10 percent of the time. It is possible
+     * to have the interval and window set to the same value. In this case,
+     * scanning is continuous, with a change of scanning frequency once every
+     * interval.
+     *
+     * Once the scanning parameters have been configured, scanning can be
+     * enabled by using startScan().
+     *
+     * @Note: The scan interval and window are recommendations to the BLE stack.
      */
     ble_error_t setScanningParams(uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
                                   uint16_t window   = GapScanningParams::SCAN_WINDOW_MAX,