Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

DigitalIn.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_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 */
bogdanm 85:024bf7f99721 53 DigitalIn(PinName pin) : gpio() {
bogdanm 81:7d30d6019079 54 gpio_init_in(&gpio, pin);
bogdanm 65:5798e58a58b1 55 }
bogdanm 65:5798e58a58b1 56
bogdanm 81:7d30d6019079 57 /** Create a DigitalIn connected to the specified pin
bogdanm 81:7d30d6019079 58 *
bogdanm 81:7d30d6019079 59 * @param pin DigitalIn pin to connect to
bogdanm 81:7d30d6019079 60 * @param mode the initial mode of the pin
bogdanm 81:7d30d6019079 61 */
bogdanm 85:024bf7f99721 62 DigitalIn(PinName pin, PinMode mode) : gpio() {
bogdanm 81:7d30d6019079 63 gpio_init_in_ex(&gpio, pin, mode);
bogdanm 81:7d30d6019079 64 }
bogdanm 65:5798e58a58b1 65 /** Read the input, represented as 0 or 1 (int)
bogdanm 65:5798e58a58b1 66 *
bogdanm 65:5798e58a58b1 67 * @returns
bogdanm 65:5798e58a58b1 68 * An integer representing the state of the input pin,
bogdanm 65:5798e58a58b1 69 * 0 for logical 0, 1 for logical 1
bogdanm 65:5798e58a58b1 70 */
bogdanm 65:5798e58a58b1 71 int read() {
bogdanm 65:5798e58a58b1 72 return gpio_read(&gpio);
bogdanm 65:5798e58a58b1 73 }
bogdanm 65:5798e58a58b1 74
bogdanm 65:5798e58a58b1 75 /** Set the input pin mode
bogdanm 65:5798e58a58b1 76 *
bogdanm 65:5798e58a58b1 77 * @param mode PullUp, PullDown, PullNone, OpenDrain
bogdanm 65:5798e58a58b1 78 */
bogdanm 65:5798e58a58b1 79 void mode(PinMode pull) {
bogdanm 65:5798e58a58b1 80 gpio_mode(&gpio, pull);
bogdanm 65:5798e58a58b1 81 }
bogdanm 65:5798e58a58b1 82
bogdanm 65:5798e58a58b1 83 #ifdef MBED_OPERATORS
bogdanm 65:5798e58a58b1 84 /** An operator 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