Jhon Plantikow / DHT11

DHT11

DigitalIn.h@0:c52df770855b, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

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