kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

wait_api.h@0:2f388b030837, 2016-04-29 (annotated)

Committer:
kbrahmbhatt6
Date:
Fri Apr 29 06:59:59 2016 +0000
Revision:
0:2f388b030837
1

Who changed what in which revision?

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