Jhon Plantikow / Dataloger

Dataloger

wait_api.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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