Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/DigitalOut.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

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