Jhon Plantikow / mbed

.

Dependents:   RTC

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

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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