Microbug / BLE_API

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: hw/BLEDevice.h

Revision:
79:b6284f5928bb
Parent:
78:5d356ef94347
--- a/hw/BLEDevice.h	Tue Jun 10 08:55:33 2014 +0100
+++ b/hw/BLEDevice.h	Tue Jun 10 09:26:32 2014 +0100
@@ -145,7 +145,11 @@
     ble_error_t     updateCharacteristicValue(uint16_t handle, const uint8_t* value, uint16_t size, bool localOnly = false);
 
     /**
-     * Yield control to the BLE stack or to other tasks waiting for events.
+     * Yield control to the BLE stack or to other tasks waiting for events. This
+     * is a sleep function which will return when there is an application
+     * specific interrupt, but the MCU might wake up several times before
+     * returning (to service the stack). Note: The use of this API is not always
+     * interchangeable with the MCU's WFE() instruction.
      */
     void waitForEvent(void);