Einstein Filho / Mbed 2 deprecated MANGUEBAJA2019_BOX

Mangue Baja Box

Dependencies:   mbed

mbed/DigitalIn.h@0:0dee8840a1c0, 2019-07-29 (annotated)

Committer:
einsteingustavo
Date:
Mon Jul 29 20:38:00 2019 +0000
Revision:
0:0dee8840a1c0
Mangue Baja Box

Who changed what in which revision?

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