Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/DigitalIn.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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