modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

api/DigitalOut.h@17:639ed60ce759, 2016-08-19 (annotated)

Committer:
modtronix-com
Date:
Fri Aug 19 15:46:42 2016 +1000
Revision:
17:639ed60ce759
Parent:
1:71204b8406f2 
Added tag v1.1 for changeset 076cbe3e55be

Who changed what in which revision?

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