Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/hal/api/wait_api.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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