Micah B / mbed

mbed

Dependents:   DHTSensor_Test K64F_eCompass_OneNET_JW

DigitalOut.h@0:2cc6bb4d7fea, 2015-02-25 (annotated)

Committer:
mbotkinl
Date:
Wed Feb 25 20:22:22 2015 +0000
Revision:
0:2cc6bb4d7fea
Working code to read Temperature and Humidity readings

Who changed what in which revision?

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