David Saul / mbed-dev-bin

R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more information

Fork of mbed-dev-bin by Lancaster University

DigitalIn.h@4:98796b85dcf3, 2017-05-23 (annotated)

Committer:
DavidMS
Date:
Tue May 23 12:27:33 2017 +0000
Revision:
4:98796b85dcf3
Parent:
0:e1a608bb55e8 
basic_microbit_tx_train_controller_code: R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more details

Who changed what in which revision?

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