Add a note to the documentation for setAdvertisingInterval() to warn users about the new units for 'interval'.
This commit is contained in:
parent
721fc94b8f
commit
b90cb8766e
1 changed files with 6 additions and 0 deletions
|
@ -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);
|
||||
|
||||
|
|
Loading…
Reference in a new issue