jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

DigitalIn.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_DIGITALIN_H
bogdanm 65:5798e58a58b1 17 #define MBED_DIGITALIN_H
bogdanm 65:5798e58a58b1 18
bogdanm 65:5798e58a58b1 19 #include "platform.h"
bogdanm 65:5798e58a58b1 20
bogdanm 65:5798e58a58b1 21 #include "gpio_api.h"
bogdanm 65:5798e58a58b1 22
bogdanm 65:5798e58a58b1 23 namespace mbed {
bogdanm 65:5798e58a58b1 24
bogdanm 65:5798e58a58b1 25 /** A digital input, used for reading the state of a pin
bogdanm 65:5798e58a58b1 26 *
bogdanm 65:5798e58a58b1 27 * Example:
bogdanm 65:5798e58a58b1 28 * @code
bogdanm 65:5798e58a58b1 29 * // Flash an LED while a DigitalIn is true
bogdanm 65:5798e58a58b1 30 *
bogdanm 65:5798e58a58b1 31 * #include "mbed.h"
bogdanm 65:5798e58a58b1 32 *
bogdanm 65:5798e58a58b1 33 * DigitalIn enable(p5);
bogdanm 65:5798e58a58b1 34 * DigitalOut led(LED1);
bogdanm 65:5798e58a58b1 35 *
bogdanm 65:5798e58a58b1 36 * int main() {
bogdanm 65:5798e58a58b1 37 * while(1) {
bogdanm 65:5798e58a58b1 38 * if(enable) {
bogdanm 65:5798e58a58b1 39 * led = !led;
bogdanm 65:5798e58a58b1 40 * }
bogdanm 65:5798e58a58b1 41 * wait(0.25);
bogdanm 65:5798e58a58b1 42 * }
bogdanm 65:5798e58a58b1 43 * }
bogdanm 65:5798e58a58b1 44 * @endcode
bogdanm 65:5798e58a58b1 45 */
bogdanm 65:5798e58a58b1 46 class DigitalIn {
bogdanm 65:5798e58a58b1 47
bogdanm 65:5798e58a58b1 48 public:
bogdanm 65:5798e58a58b1 49 /** Create a DigitalIn connected to the specified pin
bogdanm 65:5798e58a58b1 50 *
bogdanm 65:5798e58a58b1 51 * @param pin DigitalIn pin to connect to
bogdanm 65:5798e58a58b1 52 * @param name (optional) A string to identify the object
bogdanm 65:5798e58a58b1 53 */
bogdanm 65:5798e58a58b1 54 DigitalIn(PinName pin) {
bogdanm 65:5798e58a58b1 55 gpio_init(&gpio, pin, PIN_INPUT);
bogdanm 65:5798e58a58b1 56 }
bogdanm 65:5798e58a58b1 57
bogdanm 65:5798e58a58b1 58 /** Read the input, represented as 0 or 1 (int)
bogdanm 65:5798e58a58b1 59 *
bogdanm 65:5798e58a58b1 60 * @returns
bogdanm 65:5798e58a58b1 61 * An integer representing the state of the input pin,
bogdanm 65:5798e58a58b1 62 * 0 for logical 0, 1 for logical 1
bogdanm 65:5798e58a58b1 63 */
bogdanm 65:5798e58a58b1 64 int read() {
bogdanm 65:5798e58a58b1 65 return gpio_read(&gpio);
bogdanm 65:5798e58a58b1 66 }
bogdanm 65:5798e58a58b1 67
bogdanm 65:5798e58a58b1 68 /** Set the input pin mode
bogdanm 65:5798e58a58b1 69 *
bogdanm 65:5798e58a58b1 70 * @param mode PullUp, PullDown, PullNone, OpenDrain
bogdanm 65:5798e58a58b1 71 */
bogdanm 65:5798e58a58b1 72 void mode(PinMode pull) {
bogdanm 65:5798e58a58b1 73 gpio_mode(&gpio, pull);
bogdanm 65:5798e58a58b1 74 }
bogdanm 65:5798e58a58b1 75
bogdanm 65:5798e58a58b1 76 #ifdef MBED_OPERATORS
bogdanm 65:5798e58a58b1 77 /** An operator shorthand for read()
bogdanm 65:5798e58a58b1 78 */
bogdanm 65:5798e58a58b1 79 operator int() {
bogdanm 65:5798e58a58b1 80 return read();
bogdanm 65:5798e58a58b1 81 }
bogdanm 65:5798e58a58b1 82 #endif
bogdanm 65:5798e58a58b1 83
bogdanm 65:5798e58a58b1 84 protected:
bogdanm 65:5798e58a58b1 85 gpio_t gpio;
bogdanm 65:5798e58a58b1 86 };
bogdanm 65:5798e58a58b1 87
bogdanm 65:5798e58a58b1 88 } // namespace mbed
bogdanm 65:5798e58a58b1 89
bogdanm 65:5798e58a58b1 90 #endif