meh
Fork of mbed by
Embed:
(wiki syntax)
Show/hide line numbers
wait_api.h
00001 /* mbed Microcontroller Library 00002 * Copyright (c) 2006-2013 ARM Limited 00003 * 00004 * Licensed under the Apache License, Version 2.0 (the "License"); 00005 * you may not use this file except in compliance with the License. 00006 * You may obtain a copy of the License at 00007 * 00008 * http://www.apache.org/licenses/LICENSE-2.0 00009 * 00010 * Unless required by applicable law or agreed to in writing, software 00011 * distributed under the License is distributed on an "AS IS" BASIS, 00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 * See the License for the specific language governing permissions and 00014 * limitations under the License. 00015 */ 00016 #ifndef MBED_WAIT_API_H 00017 #define MBED_WAIT_API_H 00018 00019 #ifdef __cplusplus 00020 extern "C" { 00021 #endif 00022 00023 /** Generic wait functions. 00024 * 00025 * These provide simple NOP type wait capabilities. 00026 * 00027 * Example: 00028 * @code 00029 * #include "mbed.h" 00030 * 00031 * DigitalOut heartbeat(LED1); 00032 * 00033 * int main() { 00034 * while (1) { 00035 * heartbeat = 1; 00036 * wait(0.5); 00037 * heartbeat = 0; 00038 * wait(0.5); 00039 * } 00040 * } 00041 */ 00042 00043 /** Waits for a number of seconds, with microsecond resolution (within 00044 * the accuracy of single precision floating point). 00045 * 00046 * @param s number of seconds to wait 00047 */ 00048 void wait(float s); 00049 00050 /** Waits a number of milliseconds. 00051 * 00052 * @param ms the whole number of milliseconds to wait 00053 */ 00054 void wait_ms(int ms); 00055 00056 /** Waits a number of microseconds. 00057 * 00058 * @param us the whole number of microseconds to wait 00059 */ 00060 void wait_us(int us); 00061 00062 #ifdef __cplusplus 00063 } 00064 #endif 00065 00066 #endif
Generated on Wed Jul 13 2022 07:02:15 by 1.7.2