Jhon Plantikow / DHT11

DHT11

DigitalOut.h@0:c52df770855b, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

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