Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/wait_api.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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