PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

mbed_src_STM32F7/api/DigitalIn.h@0:aa3fc5ad02f7, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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