Jhon Plantikow / Dataloger

Dataloger

DigitalIn.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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