Mark Turner / MarksMbed

This is a repository for all my programs or modified programs.

DigitalOut.h@0:72480818e4a9, 2016-09-11 (annotated)

Committer:
mturner5
Date:
Sun Sep 11 23:48:09 2016 +0000
Revision:
0:72480818e4a9
Made delays for the LEDS and button presses

Who changed what in which revision?

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