Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/DigitalOut.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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