First Last / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/DigitalIn.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 10:3bc89ef62ce7 1 /* mbed Microcontroller Library
emilmont 10:3bc89ef62ce7 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 10:3bc89ef62ce7 3 *
emilmont 10:3bc89ef62ce7 4 * Licensed under the Apache License, Version 2.0 (the "License");
emilmont 10:3bc89ef62ce7 5 * you may not use this file except in compliance with the License.
emilmont 10:3bc89ef62ce7 6 * You may obtain a copy of the License at
emilmont 10:3bc89ef62ce7 7 *
emilmont 10:3bc89ef62ce7 8 * http://www.apache.org/licenses/LICENSE-2.0
emilmont 10:3bc89ef62ce7 9 *
emilmont 10:3bc89ef62ce7 10 * Unless required by applicable law or agreed to in writing, software
emilmont 10:3bc89ef62ce7 11 * distributed under the License is distributed on an "AS IS" BASIS,
emilmont 10:3bc89ef62ce7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
emilmont 10:3bc89ef62ce7 13 * See the License for the specific language governing permissions and
emilmont 10:3bc89ef62ce7 14 * limitations under the License.
emilmont 10:3bc89ef62ce7 15 */
emilmont 10:3bc89ef62ce7 16 #ifndef MBED_DIGITALIN_H
emilmont 10:3bc89ef62ce7 17 #define MBED_DIGITALIN_H
emilmont 10:3bc89ef62ce7 18
emilmont 10:3bc89ef62ce7 19 #include "platform.h"
emilmont 10:3bc89ef62ce7 20
emilmont 10:3bc89ef62ce7 21 #include "gpio_api.h"
emilmont 10:3bc89ef62ce7 22
emilmont 10:3bc89ef62ce7 23 namespace mbed {
emilmont 10:3bc89ef62ce7 24
emilmont 10:3bc89ef62ce7 25 /** A digital input, used for reading the state of a pin
emilmont 10:3bc89ef62ce7 26 *
emilmont 10:3bc89ef62ce7 27 * Example:
emilmont 10:3bc89ef62ce7 28 * @code
emilmont 10:3bc89ef62ce7 29 * // Flash an LED while a DigitalIn is true
emilmont 10:3bc89ef62ce7 30 *
emilmont 10:3bc89ef62ce7 31 * #include "mbed.h"
emilmont 10:3bc89ef62ce7 32 *
emilmont 10:3bc89ef62ce7 33 * DigitalIn enable(p5);
emilmont 10:3bc89ef62ce7 34 * DigitalOut led(LED1);
emilmont 10:3bc89ef62ce7 35 *
emilmont 10:3bc89ef62ce7 36 * int main() {
emilmont 10:3bc89ef62ce7 37 * while(1) {
emilmont 10:3bc89ef62ce7 38 * if(enable) {
emilmont 10:3bc89ef62ce7 39 * led = !led;
emilmont 10:3bc89ef62ce7 40 * }
emilmont 10:3bc89ef62ce7 41 * wait(0.25);
emilmont 10:3bc89ef62ce7 42 * }
emilmont 10:3bc89ef62ce7 43 * }
emilmont 10:3bc89ef62ce7 44 * @endcode
emilmont 10:3bc89ef62ce7 45 */
emilmont 10:3bc89ef62ce7 46 class DigitalIn {
emilmont 10:3bc89ef62ce7 47
emilmont 10:3bc89ef62ce7 48 public:
emilmont 10:3bc89ef62ce7 49 /** Create a DigitalIn connected to the specified pin
emilmont 10:3bc89ef62ce7 50 *
emilmont 10:3bc89ef62ce7 51 * @param pin DigitalIn pin to connect to
emilmont 10:3bc89ef62ce7 52 * @param name (optional) A string to identify the object
emilmont 10:3bc89ef62ce7 53 */
emilmont 10:3bc89ef62ce7 54 DigitalIn(PinName pin) {
emilmont 10:3bc89ef62ce7 55 gpio_init(&gpio, pin, PIN_INPUT);
emilmont 10:3bc89ef62ce7 56 }
emilmont 10:3bc89ef62ce7 57
emilmont 10:3bc89ef62ce7 58 /** Read the input, represented as 0 or 1 (int)
emilmont 10:3bc89ef62ce7 59 *
emilmont 10:3bc89ef62ce7 60 * @returns
emilmont 10:3bc89ef62ce7 61 * An integer representing the state of the input pin,
emilmont 10:3bc89ef62ce7 62 * 0 for logical 0, 1 for logical 1
emilmont 10:3bc89ef62ce7 63 */
emilmont 10:3bc89ef62ce7 64 int read() {
emilmont 10:3bc89ef62ce7 65 return gpio_read(&gpio);
emilmont 10:3bc89ef62ce7 66 }
emilmont 10:3bc89ef62ce7 67
emilmont 10:3bc89ef62ce7 68 /** Set the input pin mode
emilmont 10:3bc89ef62ce7 69 *
emilmont 10:3bc89ef62ce7 70 * @param mode PullUp, PullDown, PullNone, OpenDrain
emilmont 10:3bc89ef62ce7 71 */
emilmont 10:3bc89ef62ce7 72 void mode(PinMode pull) {
emilmont 10:3bc89ef62ce7 73 gpio_mode(&gpio, pull);
emilmont 10:3bc89ef62ce7 74 }
emilmont 10:3bc89ef62ce7 75
emilmont 10:3bc89ef62ce7 76 #ifdef MBED_OPERATORS
emilmont 10:3bc89ef62ce7 77 /** An operator shorthand for read()
emilmont 10:3bc89ef62ce7 78 */
emilmont 10:3bc89ef62ce7 79 operator int() {
emilmont 10:3bc89ef62ce7 80 return read();
emilmont 10:3bc89ef62ce7 81 }
emilmont 10:3bc89ef62ce7 82 #endif
emilmont 10:3bc89ef62ce7 83
emilmont 10:3bc89ef62ce7 84 protected:
emilmont 10:3bc89ef62ce7 85 gpio_t gpio;
emilmont 10:3bc89ef62ce7 86 };
emilmont 10:3bc89ef62ce7 87
emilmont 10:3bc89ef62ce7 88 } // namespace mbed
emilmont 10:3bc89ef62ce7 89
emilmont 10:3bc89ef62ce7 90 #endif