Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

DigitalOut.h@0:8024c367e29f, 2012-10-05 (annotated)

Committer:
emilmont
Date:
Fri Oct 05 09:16:41 2012 +0000
Revision:
0:8024c367e29f
Child:
8:c14af7958ef5
First release of the mbed libraries for KL25Z

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 0:8024c367e29f 1 /* mbed Microcontroller Library - DigitalOut
emilmont 0:8024c367e29f 2 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
emilmont 0:8024c367e29f 3 */
emilmont 0:8024c367e29f 4 #ifndef MBED_DIGITALOUT_H
emilmont 0:8024c367e29f 5 #define MBED_DIGITALOUT_H
emilmont 0:8024c367e29f 6
emilmont 0:8024c367e29f 7 #include "platform.h"
emilmont 0:8024c367e29f 8 #include "Base.h"
emilmont 0:8024c367e29f 9
emilmont 0:8024c367e29f 10 #include "gpio_api.h"
emilmont 0:8024c367e29f 11
emilmont 0:8024c367e29f 12 namespace mbed {
emilmont 0:8024c367e29f 13
emilmont 0:8024c367e29f 14 /* Class: DigitalOut
emilmont 0:8024c367e29f 15 * A digital output, used for setting the state of a pin
emilmont 0:8024c367e29f 16 *
emilmont 0:8024c367e29f 17 * Example:
emilmont 0:8024c367e29f 18 * > // Toggle a LED
emilmont 0:8024c367e29f 19 * > #include "mbed.h"
emilmont 0:8024c367e29f 20 * >
emilmont 0:8024c367e29f 21 * > DigitalOut led(LED1);
emilmont 0:8024c367e29f 22 * >
emilmont 0:8024c367e29f 23 * > int main() {
emilmont 0:8024c367e29f 24 * > while(1) {
emilmont 0:8024c367e29f 25 * > led = !led;
emilmont 0:8024c367e29f 26 * > wait(0.2);
emilmont 0:8024c367e29f 27 * > }
emilmont 0:8024c367e29f 28 * > }
emilmont 0:8024c367e29f 29 */
emilmont 0:8024c367e29f 30 class DigitalOut : public Base {
emilmont 0:8024c367e29f 31
emilmont 0:8024c367e29f 32 public:
emilmont 0:8024c367e29f 33 /* Constructor: DigitalOut
emilmont 0:8024c367e29f 34 * Create a DigitalOut connected to the specified pin
emilmont 0:8024c367e29f 35 *
emilmont 0:8024c367e29f 36 * Variables:
emilmont 0:8024c367e29f 37 * pin - DigitalOut pin to connect to
emilmont 0:8024c367e29f 38 */
emilmont 0:8024c367e29f 39 DigitalOut(PinName pin, const char* name = NULL);
emilmont 0:8024c367e29f 40
emilmont 0:8024c367e29f 41 /* Function: write
emilmont 0:8024c367e29f 42 * Set the output, specified as 0 or 1 (int)
emilmont 0:8024c367e29f 43 *
emilmont 0:8024c367e29f 44 * Variables:
emilmont 0:8024c367e29f 45 * value - An integer specifying the pin output value,
emilmont 0:8024c367e29f 46 * 0 for logical 0 and 1 (or any other non-zero value) for logical 1
emilmont 0:8024c367e29f 47 */
emilmont 0:8024c367e29f 48 void write(int value);
emilmont 0:8024c367e29f 49
emilmont 0:8024c367e29f 50 /* Function: read
emilmont 0:8024c367e29f 51 * Return the output setting, represented as 0 or 1 (int)
emilmont 0:8024c367e29f 52 *
emilmont 0:8024c367e29f 53 * Variables:
emilmont 0:8024c367e29f 54 * returns - An integer representing the output setting of the pin,
emilmont 0:8024c367e29f 55 * 0 for logical 0 and 1 for logical 1
emilmont 0:8024c367e29f 56 */
emilmont 0:8024c367e29f 57 int read();
emilmont 0:8024c367e29f 58
emilmont 0:8024c367e29f 59 #ifdef MBED_OPERATORS
emilmont 0:8024c367e29f 60 /* Function: operator=
emilmont 0:8024c367e29f 61 * A shorthand for <write>
emilmont 0:8024c367e29f 62 */
emilmont 0:8024c367e29f 63 DigitalOut& operator= (int value) {
emilmont 0:8024c367e29f 64 write(value);
emilmont 0:8024c367e29f 65 return *this;
emilmont 0:8024c367e29f 66 }
emilmont 0:8024c367e29f 67
emilmont 0:8024c367e29f 68 DigitalOut& operator= (DigitalOut& rhs) {
emilmont 0:8024c367e29f 69 write(rhs.read());
emilmont 0:8024c367e29f 70 return *this;
emilmont 0:8024c367e29f 71 }
emilmont 0:8024c367e29f 72
emilmont 0:8024c367e29f 73 /* Function: operator int()
emilmont 0:8024c367e29f 74 * A shorthand for <read>
emilmont 0:8024c367e29f 75 */
emilmont 0:8024c367e29f 76 operator int() {
emilmont 0:8024c367e29f 77 return read();
emilmont 0:8024c367e29f 78 }
emilmont 0:8024c367e29f 79 #endif
emilmont 0:8024c367e29f 80
emilmont 0:8024c367e29f 81 #ifdef MBED_RPC
emilmont 0:8024c367e29f 82 virtual const struct rpc_method *get_rpc_methods();
emilmont 0:8024c367e29f 83 static struct rpc_class *get_rpc_class();
emilmont 0:8024c367e29f 84 #endif
emilmont 0:8024c367e29f 85
emilmont 0:8024c367e29f 86 protected:
emilmont 0:8024c367e29f 87 gpio_object gpio;
emilmont 0:8024c367e29f 88 };
emilmont 0:8024c367e29f 89
emilmont 0:8024c367e29f 90 } // namespace mbed
emilmont 0:8024c367e29f 91
emilmont 0:8024c367e29f 92 #endif