Vladimir Vana / mbed

pro vyuku PSS v Jecne

DigitalIn.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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