jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

DigitalOut.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

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 65:5798e58a58b1 48 DigitalOut(PinName pin) {
bogdanm 65:5798e58a58b1 49 gpio_init(&gpio, pin, PIN_OUTPUT);
bogdanm 65:5798e58a58b1 50 }
bogdanm 65:5798e58a58b1 51
bogdanm 65:5798e58a58b1 52 /** Set the output, specified as 0 or 1 (int)
bogdanm 65:5798e58a58b1 53 *
bogdanm 65:5798e58a58b1 54 * @param value An integer specifying the pin output value,
bogdanm 65:5798e58a58b1 55 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
bogdanm 65:5798e58a58b1 56 */
bogdanm 65:5798e58a58b1 57 void write(int value) {
bogdanm 65:5798e58a58b1 58 gpio_write(&gpio, value);
bogdanm 65:5798e58a58b1 59 }
bogdanm 65:5798e58a58b1 60
bogdanm 65:5798e58a58b1 61 /** Return the output setting, represented as 0 or 1 (int)
bogdanm 65:5798e58a58b1 62 *
bogdanm 65:5798e58a58b1 63 * @returns
bogdanm 65:5798e58a58b1 64 * an integer representing the output setting of the pin,
bogdanm 65:5798e58a58b1 65 * 0 for logical 0, 1 for logical 1
bogdanm 65:5798e58a58b1 66 */
bogdanm 65:5798e58a58b1 67 int read() {
bogdanm 65:5798e58a58b1 68 return gpio_read(&gpio);
bogdanm 65:5798e58a58b1 69 }
bogdanm 65:5798e58a58b1 70
bogdanm 65:5798e58a58b1 71 #ifdef MBED_OPERATORS
bogdanm 65:5798e58a58b1 72 /** A shorthand for write()
bogdanm 65:5798e58a58b1 73 */
bogdanm 65:5798e58a58b1 74 DigitalOut& operator= (int value) {
bogdanm 65:5798e58a58b1 75 write(value);
bogdanm 65:5798e58a58b1 76 return *this;
bogdanm 65:5798e58a58b1 77 }
bogdanm 65:5798e58a58b1 78
bogdanm 65:5798e58a58b1 79 DigitalOut& operator= (DigitalOut& rhs) {
bogdanm 65:5798e58a58b1 80 write(rhs.read());
bogdanm 65:5798e58a58b1 81 return *this;
bogdanm 65:5798e58a58b1 82 }
bogdanm 65:5798e58a58b1 83
bogdanm 65:5798e58a58b1 84 /** A shorthand for read()
bogdanm 65:5798e58a58b1 85 */
bogdanm 65:5798e58a58b1 86 operator int() {
bogdanm 65:5798e58a58b1 87 return read();
bogdanm 65:5798e58a58b1 88 }
bogdanm 65:5798e58a58b1 89 #endif
bogdanm 65:5798e58a58b1 90
bogdanm 65:5798e58a58b1 91 protected:
bogdanm 65:5798e58a58b1 92 gpio_t gpio;
bogdanm 65:5798e58a58b1 93 };
bogdanm 65:5798e58a58b1 94
bogdanm 65:5798e58a58b1 95 } // namespace mbed
bogdanm 65:5798e58a58b1 96
bogdanm 65:5798e58a58b1 97 #endif