mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_wait_api.h@156:ff21514d8981, 2017-11-08 (annotated)

Committer:
AnnaBridge
Date:
Wed Nov 08 17:18:06 2017 +0000
Revision:
156:ff21514d8981
Child:
158:1c57384330a6
Reverting back to release 154 of the mbed library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 156:ff21514d8981 4 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 5 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 156:ff21514d8981 6 *
AnnaBridge 156:ff21514d8981 7 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 8 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 9 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 12 *
AnnaBridge 156:ff21514d8981 13 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 14 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 16 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 17 * limitations under the License.
AnnaBridge 156:ff21514d8981 18 */
AnnaBridge 156:ff21514d8981 19 #ifndef MBED_WAIT_API_H
AnnaBridge 156:ff21514d8981 20 #define MBED_WAIT_API_H
AnnaBridge 156:ff21514d8981 21
AnnaBridge 156:ff21514d8981 22 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 23 extern "C" {
AnnaBridge 156:ff21514d8981 24 #endif
AnnaBridge 156:ff21514d8981 25
AnnaBridge 156:ff21514d8981 26 /** Generic wait functions.
AnnaBridge 156:ff21514d8981 27 *
AnnaBridge 156:ff21514d8981 28 * These provide simple NOP type wait capabilities.
AnnaBridge 156:ff21514d8981 29 *
AnnaBridge 156:ff21514d8981 30 * Example:
AnnaBridge 156:ff21514d8981 31 * @code
AnnaBridge 156:ff21514d8981 32 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 33 *
AnnaBridge 156:ff21514d8981 34 * DigitalOut heartbeat(LED1);
AnnaBridge 156:ff21514d8981 35 *
AnnaBridge 156:ff21514d8981 36 * int main() {
AnnaBridge 156:ff21514d8981 37 * while (1) {
AnnaBridge 156:ff21514d8981 38 * heartbeat = 1;
AnnaBridge 156:ff21514d8981 39 * wait(0.5);
AnnaBridge 156:ff21514d8981 40 * heartbeat = 0;
AnnaBridge 156:ff21514d8981 41 * wait(0.5);
AnnaBridge 156:ff21514d8981 42 * }
AnnaBridge 156:ff21514d8981 43 * }
AnnaBridge 156:ff21514d8981 44 * @endcode
AnnaBridge 156:ff21514d8981 45 */
AnnaBridge 156:ff21514d8981 46
AnnaBridge 156:ff21514d8981 47 /** Waits for a number of seconds, with microsecond resolution (within
AnnaBridge 156:ff21514d8981 48 * the accuracy of single precision floating point).
AnnaBridge 156:ff21514d8981 49 *
AnnaBridge 156:ff21514d8981 50 * @param s number of seconds to wait
AnnaBridge 156:ff21514d8981 51 */
AnnaBridge 156:ff21514d8981 52 void wait(float s);
AnnaBridge 156:ff21514d8981 53
AnnaBridge 156:ff21514d8981 54 /** Waits a number of milliseconds.
AnnaBridge 156:ff21514d8981 55 *
AnnaBridge 156:ff21514d8981 56 * @param ms the whole number of milliseconds to wait
AnnaBridge 156:ff21514d8981 57 */
AnnaBridge 156:ff21514d8981 58 void wait_ms(int ms);
AnnaBridge 156:ff21514d8981 59
AnnaBridge 156:ff21514d8981 60 /** Waits a number of microseconds.
AnnaBridge 156:ff21514d8981 61 *
AnnaBridge 156:ff21514d8981 62 * @param us the whole number of microseconds to wait
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 156:ff21514d8981 64 void wait_us(int us);
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 67 }
AnnaBridge 156:ff21514d8981 68 #endif
AnnaBridge 156:ff21514d8981 69
AnnaBridge 156:ff21514d8981 70 #endif
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 /** @}*/