Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

DigitalOut.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
85:024bf7f99721
Child:
93:e188a91d3eaa
dgdgr

Who changed what in which revision?

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