Micah B / mbed

mbed

Dependents:   DHTSensor_Test K64F_eCompass_OneNET_JW

DigitalIn.h@0:2cc6bb4d7fea, 2015-02-25 (annotated)

Committer:
mbotkinl
Date:
Wed Feb 25 20:22:22 2015 +0000
Revision:
0:2cc6bb4d7fea
Working code to read Temperature and Humidity readings

Who changed what in which revision?

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