Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/DigitalIn.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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