Jhon Plantikow / Dataloger

Dataloger

DigitalOut.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:666850d06c9f 1 /* mbed Microcontroller Library
jhon309 0:666850d06c9f 2 * Copyright (c) 2006-2013 ARM Limited
jhon309 0:666850d06c9f 3 *
jhon309 0:666850d06c9f 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:666850d06c9f 5 * you may not use this file except in compliance with the License.
jhon309 0:666850d06c9f 6 * You may obtain a copy of the License at
jhon309 0:666850d06c9f 7 *
jhon309 0:666850d06c9f 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:666850d06c9f 9 *
jhon309 0:666850d06c9f 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:666850d06c9f 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:666850d06c9f 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:666850d06c9f 13 * See the License for the specific language governing permissions and
jhon309 0:666850d06c9f 14 * limitations under the License.
jhon309 0:666850d06c9f 15 */
jhon309 0:666850d06c9f 16 #ifndef MBED_DIGITALOUT_H
jhon309 0:666850d06c9f 17 #define MBED_DIGITALOUT_H
jhon309 0:666850d06c9f 18
jhon309 0:666850d06c9f 19 #include "platform.h"
jhon309 0:666850d06c9f 20 #include "gpio_api.h"
jhon309 0:666850d06c9f 21
jhon309 0:666850d06c9f 22 namespace mbed {
jhon309 0:666850d06c9f 23
jhon309 0:666850d06c9f 24 /** A digital output, used for setting the state of a pin
jhon309 0:666850d06c9f 25 *
jhon309 0:666850d06c9f 26 * Example:
jhon309 0:666850d06c9f 27 * @code
jhon309 0:666850d06c9f 28 * // Toggle a LED
jhon309 0:666850d06c9f 29 * #include "mbed.h"
jhon309 0:666850d06c9f 30 *
jhon309 0:666850d06c9f 31 * DigitalOut led(LED1);
jhon309 0:666850d06c9f 32 *
jhon309 0:666850d06c9f 33 * int main() {
jhon309 0:666850d06c9f 34 * while(1) {
jhon309 0:666850d06c9f 35 * led = !led;
jhon309 0:666850d06c9f 36 * wait(0.2);
jhon309 0:666850d06c9f 37 * }
jhon309 0:666850d06c9f 38 * }
jhon309 0:666850d06c9f 39 * @endcode
jhon309 0:666850d06c9f 40 */
jhon309 0:666850d06c9f 41 class DigitalOut {
jhon309 0:666850d06c9f 42
jhon309 0:666850d06c9f 43 public:
jhon309 0:666850d06c9f 44 /** Create a DigitalOut connected to the specified pin
jhon309 0:666850d06c9f 45 *
jhon309 0:666850d06c9f 46 * @param pin DigitalOut pin to connect to
jhon309 0:666850d06c9f 47 */
jhon309 0:666850d06c9f 48 DigitalOut(PinName pin) : gpio() {
jhon309 0:666850d06c9f 49 gpio_init_out(&gpio, pin);
jhon309 0:666850d06c9f 50 }
jhon309 0:666850d06c9f 51
jhon309 0:666850d06c9f 52 /** Create a DigitalOut connected to the specified pin
jhon309 0:666850d06c9f 53 *
jhon309 0:666850d06c9f 54 * @param pin DigitalOut pin to connect to
jhon309 0:666850d06c9f 55 * @param value the initial pin value
jhon309 0:666850d06c9f 56 */
jhon309 0:666850d06c9f 57 DigitalOut(PinName pin, int value) : gpio() {
jhon309 0:666850d06c9f 58 gpio_init_out_ex(&gpio, pin, value);
jhon309 0:666850d06c9f 59 }
jhon309 0:666850d06c9f 60
jhon309 0:666850d06c9f 61 /** Set the output, specified as 0 or 1 (int)
jhon309 0:666850d06c9f 62 *
jhon309 0:666850d06c9f 63 * @param value An integer specifying the pin output value,
jhon309 0:666850d06c9f 64 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
jhon309 0:666850d06c9f 65 */
jhon309 0:666850d06c9f 66 void write(int value) {
jhon309 0:666850d06c9f 67 gpio_write(&gpio, value);
jhon309 0:666850d06c9f 68 }
jhon309 0:666850d06c9f 69
jhon309 0:666850d06c9f 70 /** Return the output setting, represented as 0 or 1 (int)
jhon309 0:666850d06c9f 71 *
jhon309 0:666850d06c9f 72 * @returns
jhon309 0:666850d06c9f 73 * an integer representing the output setting of the pin,
jhon309 0:666850d06c9f 74 * 0 for logical 0, 1 for logical 1
jhon309 0:666850d06c9f 75 */
jhon309 0:666850d06c9f 76 int read() {
jhon309 0:666850d06c9f 77 return gpio_read(&gpio);
jhon309 0:666850d06c9f 78 }
jhon309 0:666850d06c9f 79
jhon309 0:666850d06c9f 80 /** Return the output setting, represented as 0 or 1 (int)
jhon309 0:666850d06c9f 81 *
jhon309 0:666850d06c9f 82 * @returns
jhon309 0:666850d06c9f 83 * Non zero value if pin is connected to uc GPIO
jhon309 0:666850d06c9f 84 * 0 if gpio object was initialized with NC
jhon309 0:666850d06c9f 85 */
jhon309 0:666850d06c9f 86 int is_connected() {
jhon309 0:666850d06c9f 87 return gpio_is_connected(&gpio);
jhon309 0:666850d06c9f 88 }
jhon309 0:666850d06c9f 89
jhon309 0:666850d06c9f 90 #ifdef MBED_OPERATORS
jhon309 0:666850d06c9f 91 /** A shorthand for write()
jhon309 0:666850d06c9f 92 */
jhon309 0:666850d06c9f 93 DigitalOut& operator= (int value) {
jhon309 0:666850d06c9f 94 write(value);
jhon309 0:666850d06c9f 95 return *this;
jhon309 0:666850d06c9f 96 }
jhon309 0:666850d06c9f 97
jhon309 0:666850d06c9f 98 DigitalOut& operator= (DigitalOut& rhs) {
jhon309 0:666850d06c9f 99 write(rhs.read());
jhon309 0:666850d06c9f 100 return *this;
jhon309 0:666850d06c9f 101 }
jhon309 0:666850d06c9f 102
jhon309 0:666850d06c9f 103 /** A shorthand for read()
jhon309 0:666850d06c9f 104 */
jhon309 0:666850d06c9f 105 operator int() {
jhon309 0:666850d06c9f 106 return read();
jhon309 0:666850d06c9f 107 }
jhon309 0:666850d06c9f 108 #endif
jhon309 0:666850d06c9f 109
jhon309 0:666850d06c9f 110 protected:
jhon309 0:666850d06c9f 111 gpio_t gpio;
jhon309 0:666850d06c9f 112 };
jhon309 0:666850d06c9f 113
jhon309 0:666850d06c9f 114 } // namespace mbed
jhon309 0:666850d06c9f 115
jhon309 0:666850d06c9f 116 #endif