Mistake on this page?
Report an issue in GitHub or email us
Functions
wait_api functions

Functions

void wait (float s)
 Generic wait functions. More...
 
void wait_ms (int ms)
 Waits a number of milliseconds. More...
 
void wait_us (int us)
 Waits a number of microseconds. More...
 

Detailed Description

Function Documentation

void wait ( float  s)

Generic wait functions.

These provide simple NOP type wait capabilities.

Example:

1 #include "mbed.h"
2 
3 DigitalOut heartbeat(LED1);
4 
5 int main() {
6  while (1) {
7  heartbeat = 1;
8  wait(0.5);
9  heartbeat = 0;
10  wait(0.5);
11  }
12 }

Waits for a number of seconds, with microsecond resolution (within the accuracy of single precision floating point).

Parameters
snumber of seconds to wait
Note
If the RTOS is present, this function spins to get the exact number of microseconds for microsecond precision up to 10 milliseconds. If delay is larger than 10 milliseconds and not in ISR, it is the same as wait_ms. We recommend wait_us and wait_ms over wait.
void wait_ms ( int  ms)

Waits a number of milliseconds.

Parameters
msthe whole number of milliseconds to wait
Note
If the RTOS is present, it calls ThisThread::sleep_for(), which is same as CMSIS osDelay(). You can't call this from interrupts, and it doesn't lock hardware sleep.
void wait_us ( int  us)

Waits a number of microseconds.

Parameters
usthe whole number of microseconds to wait
Note
This function always spins to get the exact number of microseconds. If RTOS is present, this will affect power (by preventing deep sleep) and multithread performance. Therefore, spinning for millisecond wait is not recommended.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.