Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/DigitalOut.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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