First Last / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/DigitalOut.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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