Bei Chen Liu / mbed-src

mbed library sources

Fork of mbed-src by mbed official

cpp/DigitalIn.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_DIGITALIN_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_DIGITALIN_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "platform.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #include "gpio_api.h"
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 30
mbed_official 0:fd0d7bdfcdc2 31 /** A digital input, used for reading the state of a pin
mbed_official 0:fd0d7bdfcdc2 32 *
mbed_official 0:fd0d7bdfcdc2 33 * Example:
mbed_official 0:fd0d7bdfcdc2 34 * @code
mbed_official 0:fd0d7bdfcdc2 35 * // Flash an LED while a DigitalIn is true
mbed_official 0:fd0d7bdfcdc2 36 *
mbed_official 0:fd0d7bdfcdc2 37 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 38 *
mbed_official 0:fd0d7bdfcdc2 39 * DigitalIn enable(p5);
mbed_official 0:fd0d7bdfcdc2 40 * DigitalOut led(LED1);
mbed_official 0:fd0d7bdfcdc2 41 *
mbed_official 0:fd0d7bdfcdc2 42 * int main() {
mbed_official 0:fd0d7bdfcdc2 43 * while(1) {
mbed_official 0:fd0d7bdfcdc2 44 * if(enable) {
mbed_official 0:fd0d7bdfcdc2 45 * led = !led;
mbed_official 0:fd0d7bdfcdc2 46 * }
mbed_official 0:fd0d7bdfcdc2 47 * wait(0.25);
mbed_official 0:fd0d7bdfcdc2 48 * }
mbed_official 0:fd0d7bdfcdc2 49 * }
mbed_official 0:fd0d7bdfcdc2 50 * @endcode
mbed_official 0:fd0d7bdfcdc2 51 */
mbed_official 0:fd0d7bdfcdc2 52 class DigitalIn {
mbed_official 0:fd0d7bdfcdc2 53
mbed_official 0:fd0d7bdfcdc2 54 public:
mbed_official 0:fd0d7bdfcdc2 55 /** Create a DigitalIn connected to the specified pin
mbed_official 0:fd0d7bdfcdc2 56 *
mbed_official 0:fd0d7bdfcdc2 57 * @param pin DigitalIn pin to connect to
mbed_official 0:fd0d7bdfcdc2 58 * @param name (optional) A string to identify the object
mbed_official 0:fd0d7bdfcdc2 59 */
mbed_official 0:fd0d7bdfcdc2 60 DigitalIn(PinName pin) {
mbed_official 0:fd0d7bdfcdc2 61 gpio_init(&gpio, pin, PIN_INPUT);
mbed_official 0:fd0d7bdfcdc2 62 }
mbed_official 0:fd0d7bdfcdc2 63
mbed_official 0:fd0d7bdfcdc2 64 /** Read the input, represented as 0 or 1 (int)
mbed_official 0:fd0d7bdfcdc2 65 *
mbed_official 0:fd0d7bdfcdc2 66 * @returns
mbed_official 0:fd0d7bdfcdc2 67 * An integer representing the state of the input pin,
mbed_official 0:fd0d7bdfcdc2 68 * 0 for logical 0, 1 for logical 1
mbed_official 0:fd0d7bdfcdc2 69 */
mbed_official 0:fd0d7bdfcdc2 70 int read() {
mbed_official 0:fd0d7bdfcdc2 71 return gpio_read(&gpio);
mbed_official 0:fd0d7bdfcdc2 72 }
mbed_official 0:fd0d7bdfcdc2 73
mbed_official 0:fd0d7bdfcdc2 74 /** Set the input pin mode
mbed_official 0:fd0d7bdfcdc2 75 *
mbed_official 0:fd0d7bdfcdc2 76 * @param mode PullUp, PullDown, PullNone, OpenDrain
mbed_official 0:fd0d7bdfcdc2 77 */
mbed_official 0:fd0d7bdfcdc2 78 void mode(PinMode pull) {
mbed_official 0:fd0d7bdfcdc2 79 gpio_mode(&gpio, pull);
mbed_official 0:fd0d7bdfcdc2 80 }
mbed_official 0:fd0d7bdfcdc2 81
mbed_official 0:fd0d7bdfcdc2 82 #ifdef MBED_OPERATORS
mbed_official 0:fd0d7bdfcdc2 83 /** An operator shorthand for read()
mbed_official 0:fd0d7bdfcdc2 84 */
mbed_official 0:fd0d7bdfcdc2 85 operator int() {
mbed_official 0:fd0d7bdfcdc2 86 return read();
mbed_official 0:fd0d7bdfcdc2 87 }
mbed_official 0:fd0d7bdfcdc2 88 #endif
mbed_official 0:fd0d7bdfcdc2 89
mbed_official 0:fd0d7bdfcdc2 90 protected:
mbed_official 0:fd0d7bdfcdc2 91 gpio_t gpio;
mbed_official 0:fd0d7bdfcdc2 92 };
mbed_official 0:fd0d7bdfcdc2 93
mbed_official 0:fd0d7bdfcdc2 94 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 95
mbed_official 0:fd0d7bdfcdc2 96 #endif