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@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
138:093f2bd7b9eb
Child:
145:64910690c574
Release 143 of the mbed library.

Who changed what in which revision?

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