PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/DigitalOut.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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