Vladimir Vana / mbed

pro vyuku PSS v Jecne

DigitalOut.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_DIGITALOUT_H
vladvana 0:23d1f73bf130 17 #define MBED_DIGITALOUT_H
vladvana 0:23d1f73bf130 18
vladvana 0:23d1f73bf130 19 #include "platform.h"
vladvana 0:23d1f73bf130 20 #include "gpio_api.h"
vladvana 0:23d1f73bf130 21
vladvana 0:23d1f73bf130 22 namespace mbed {
vladvana 0:23d1f73bf130 23
vladvana 0:23d1f73bf130 24 /** A digital output, used for setting the state of a pin
vladvana 0:23d1f73bf130 25 *
vladvana 0:23d1f73bf130 26 * Example:
vladvana 0:23d1f73bf130 27 * @code
vladvana 0:23d1f73bf130 28 * // Toggle a LED
vladvana 0:23d1f73bf130 29 * #include "mbed.h"
vladvana 0:23d1f73bf130 30 *
vladvana 0:23d1f73bf130 31 * DigitalOut led(LED1);
vladvana 0:23d1f73bf130 32 *
vladvana 0:23d1f73bf130 33 * int main() {
vladvana 0:23d1f73bf130 34 * while(1) {
vladvana 0:23d1f73bf130 35 * led = !led;
vladvana 0:23d1f73bf130 36 * wait(0.2);
vladvana 0:23d1f73bf130 37 * }
vladvana 0:23d1f73bf130 38 * }
vladvana 0:23d1f73bf130 39 * @endcode
vladvana 0:23d1f73bf130 40 */
vladvana 0:23d1f73bf130 41 class DigitalOut {
vladvana 0:23d1f73bf130 42
vladvana 0:23d1f73bf130 43 public:
vladvana 0:23d1f73bf130 44 /** Create a DigitalOut connected to the specified pin
vladvana 0:23d1f73bf130 45 *
vladvana 0:23d1f73bf130 46 * @param pin DigitalOut pin to connect to
vladvana 0:23d1f73bf130 47 */
vladvana 0:23d1f73bf130 48 DigitalOut(PinName pin) : gpio() {
vladvana 0:23d1f73bf130 49 gpio_init_out(&gpio, pin);
vladvana 0:23d1f73bf130 50 }
vladvana 0:23d1f73bf130 51
vladvana 0:23d1f73bf130 52 /** Create a DigitalOut connected to the specified pin
vladvana 0:23d1f73bf130 53 *
vladvana 0:23d1f73bf130 54 * @param pin DigitalOut pin to connect to
vladvana 0:23d1f73bf130 55 * @param value the initial pin value
vladvana 0:23d1f73bf130 56 */
vladvana 0:23d1f73bf130 57 DigitalOut(PinName pin, int value) : gpio() {
vladvana 0:23d1f73bf130 58 gpio_init_out_ex(&gpio, pin, value);
vladvana 0:23d1f73bf130 59 }
vladvana 0:23d1f73bf130 60
vladvana 0:23d1f73bf130 61 /** Set the output, specified as 0 or 1 (int)
vladvana 0:23d1f73bf130 62 *
vladvana 0:23d1f73bf130 63 * @param value An integer specifying the pin output value,
vladvana 0:23d1f73bf130 64 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
vladvana 0:23d1f73bf130 65 */
vladvana 0:23d1f73bf130 66 void write(int value) {
vladvana 0:23d1f73bf130 67 gpio_write(&gpio, value);
vladvana 0:23d1f73bf130 68 }
vladvana 0:23d1f73bf130 69
vladvana 0:23d1f73bf130 70 /** Return the output setting, represented as 0 or 1 (int)
vladvana 0:23d1f73bf130 71 *
vladvana 0:23d1f73bf130 72 * @returns
vladvana 0:23d1f73bf130 73 * an integer representing the output setting of the pin,
vladvana 0:23d1f73bf130 74 * 0 for logical 0, 1 for logical 1
vladvana 0:23d1f73bf130 75 */
vladvana 0:23d1f73bf130 76 int read() {
vladvana 0:23d1f73bf130 77 return gpio_read(&gpio);
vladvana 0:23d1f73bf130 78 }
vladvana 0:23d1f73bf130 79
vladvana 0:23d1f73bf130 80 /** Return the output setting, represented as 0 or 1 (int)
vladvana 0:23d1f73bf130 81 *
vladvana 0:23d1f73bf130 82 * @returns
vladvana 0:23d1f73bf130 83 * Non zero value if pin is connected to uc GPIO
vladvana 0:23d1f73bf130 84 * 0 if gpio object was initialized with NC
vladvana 0:23d1f73bf130 85 */
vladvana 0:23d1f73bf130 86 int is_connected() {
vladvana 0:23d1f73bf130 87 return gpio_is_connected(&gpio);
vladvana 0:23d1f73bf130 88 }
vladvana 0:23d1f73bf130 89
vladvana 0:23d1f73bf130 90 #ifdef MBED_OPERATORS
vladvana 0:23d1f73bf130 91 /** A shorthand for write()
vladvana 0:23d1f73bf130 92 */
vladvana 0:23d1f73bf130 93 DigitalOut& operator= (int value) {
vladvana 0:23d1f73bf130 94 write(value);
vladvana 0:23d1f73bf130 95 return *this;
vladvana 0:23d1f73bf130 96 }
vladvana 0:23d1f73bf130 97
vladvana 0:23d1f73bf130 98 DigitalOut& operator= (DigitalOut& rhs) {
vladvana 0:23d1f73bf130 99 write(rhs.read());
vladvana 0:23d1f73bf130 100 return *this;
vladvana 0:23d1f73bf130 101 }
vladvana 0:23d1f73bf130 102
vladvana 0:23d1f73bf130 103 /** A shorthand for read()
vladvana 0:23d1f73bf130 104 */
vladvana 0:23d1f73bf130 105 operator int() {
vladvana 0:23d1f73bf130 106 return read();
vladvana 0:23d1f73bf130 107 }
vladvana 0:23d1f73bf130 108 #endif
vladvana 0:23d1f73bf130 109
vladvana 0:23d1f73bf130 110 protected:
vladvana 0:23d1f73bf130 111 gpio_t gpio;
vladvana 0:23d1f73bf130 112 };
vladvana 0:23d1f73bf130 113
vladvana 0:23d1f73bf130 114 } // namespace mbed
vladvana 0:23d1f73bf130 115
vladvana 0:23d1f73bf130 116 #endif