Sergey Solodunov / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/DigitalOut.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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