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:
334:6bc1223306b9
Parent:
333:098598ba075d
Child:
335:dea9e14b7ddc
--- a/public/BLEDevice.h	Wed Apr 15 09:05:10 2015 +0100
+++ b/public/BLEDevice.h	Wed Apr 15 09:05:10 2015 +0100
@@ -100,6 +100,12 @@
      *              \par
      *              See Bluetooth Core Specification, Vol 3., Part C,
      *              Appendix A for suggested advertising intervals.
+     *
+     * @Note: [WARNING] This API previously used 0.625ms as the unit for its
+     * 'interval' argument. That required an explicit conversion from
+     * milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
+     * no longer required as the new units are milliseconds. Any application
+     * code depending on the old semantics would need to be updated accordingly.
      */
     void        setAdvertisingInterval(uint16_t interval);