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