Blame view

mbed/wait_api.h 1.54 KB
f7c9a8e1   jdenecha   Feat : Firt dump
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
  /* mbed Microcontroller Library

   * Copyright (c) 2006-2013 ARM Limited

   *

   * Licensed under the Apache License, Version 2.0 (the "License");

   * you may not use this file except in compliance with the License.

   * You may obtain a copy of the License at

   *

   *     http://www.apache.org/licenses/LICENSE-2.0

   *

   * Unless required by applicable law or agreed to in writing, software

   * distributed under the License is distributed on an "AS IS" BASIS,

   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   * See the License for the specific language governing permissions and

   * limitations under the License.

   */

  #ifndef MBED_WAIT_API_H

  #define MBED_WAIT_API_H

  

  #ifdef __cplusplus

  extern "C" {

  #endif

  

  /** Generic wait functions.

   *

   * These provide simple NOP type wait capabilities.

   *

   * Example:

   * @code

   * #include "mbed.h"

   *

   * DigitalOut heartbeat(LED1);

   *

   * int main() {

   *     while (1) {

   *         heartbeat = 1;

   *         wait(0.5);

   *         heartbeat = 0;

   *         wait(0.5);

   *     }

   * }

   */

  

  /** Waits for a number of seconds, with microsecond resolution (within

   *  the accuracy of single precision floating point).

   *

   *  @param s number of seconds to wait

   */

  void wait(float s);

  

  /** Waits a number of milliseconds.

   *

   *  @param ms the whole number of milliseconds to wait

   */

  void wait_ms(int ms);

  

  /** Waits a number of microseconds.

   *

   *  @param us the whole number of microseconds to wait

   */

  void wait_us(int us);

  

  #ifdef __cplusplus

  }

  #endif

  

  #endif