Pokitto Community Team / Pokitto_

PokittoLib with changes to lcd refresh etc.

Dependents:   Pokittris

Fork of Pokitto by Pokitto Community Team

This is a fork by user @Spinal, and is used in Pokittris for testing. Do not import this to your own program.

mbed-pokitto/api/DigitalOut.h@5:7e5c566b1760, 2017-10-07 (annotated)

Committer:
Pokitto
Date:
Sat Oct 07 21:31:12 2017 +0000
Revision:
5:7e5c566b1760
mbed-pokitto integrated

Who changed what in which revision?

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