M J / mbed-src

logi loader fork from jpiat

Fork of mbed-src by Jonathan Piat

api/DigitalIn.h@13:0645d8841f51, 2013-08-05 (annotated)

Committer:
bogdanm
Date:
Mon Aug 05 14:12:34 2013 +0300
Revision:
13:0645d8841f51
Parent:
10:3bc89ef62ce7
Child:
113:65a335a675de
Update mbed sources to revision 64

Who changed what in which revision?

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