ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

DigitalOut.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

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