Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/DigitalIn.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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