From b90cb8766eab411685d89c5b895dbcd722433d42 Mon Sep 17 00:00:00 2001 From: Rohit Grover Date: Thu, 9 Apr 2015 09:43:09 +0100 Subject: [PATCH] Add a note to the documentation for setAdvertisingInterval() to warn users about the new units for 'interval'. --- public/BLEDevice.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/public/BLEDevice.h b/public/BLEDevice.h index 89f0d23..0f945ee 100644 --- a/public/BLEDevice.h +++ b/public/BLEDevice.h @@ -100,6 +100,12 @@ public: * \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);