Blame view

mbed/DigitalOut.h 2.78 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
  /* 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_DIGITALOUT_H

  #define MBED_DIGITALOUT_H

  

  #include "platform.h"

  #include "gpio_api.h"

  

  namespace mbed {

  

  /** A digital output, used for setting the state of a pin

   *

   * Example:

   * @code

   * // Toggle a LED

   * #include "mbed.h"

   *

   * DigitalOut led(LED1);

   *

   * int main() {

   *     while(1) {

   *         led = !led;

   *         wait(0.2);

   *     }

   * }

   * @endcode

   */

  class DigitalOut {

  

  public:

      /** Create a DigitalOut connected to the specified pin

       *

       *  @param pin DigitalOut pin to connect to

       */

      DigitalOut(PinName pin) : gpio() {

          gpio_init_out(&gpio, pin);

      }

  

      /** Create a DigitalOut connected to the specified pin

       *

       *  @param pin DigitalOut pin to connect to

       *  @param value the initial pin value

       */

      DigitalOut(PinName pin, int value) : gpio() {

          gpio_init_out_ex(&gpio, pin, value);

      }

  

      /** Set the output, specified as 0 or 1 (int)

       *

       *  @param value An integer specifying the pin output value,

       *      0 for logical 0, 1 (or any other non-zero value) for logical 1

       */

      void write(int value) {

          gpio_write(&gpio, value);

      }

  

      /** Return the output setting, represented as 0 or 1 (int)

       *

       *  @returns

       *    an integer representing the output setting of the pin,

       *    0 for logical 0, 1 for logical 1

       */

      int read() {

          return gpio_read(&gpio);

      }

  

      /** Return the output setting, represented as 0 or 1 (int)

       *

       *  @returns

       *    Non zero value if pin is connected to uc GPIO

       *    0 if gpio object was initialized with NC

       */

      int is_connected() {

          return gpio_is_connected(&gpio);

      }

  

  #ifdef MBED_OPERATORS

      /** A shorthand for write()

       */

      DigitalOut& operator= (int value) {

          write(value);

          return *this;

      }

  

      DigitalOut& operator= (DigitalOut& rhs) {

          write(rhs.read());

          return *this;

      }

  

      /** A shorthand for read()

       */

      operator int() {

          return read();

      }

  #endif

  

  protected:

      gpio_t gpio;

  };

  

  } // namespace mbed

  

  #endif