Jhon Plantikow / mbed

.

Dependents:   RTC

wait_api.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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