Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

wait_api.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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