wanjun chen / Mbed 2 deprecated Nucleo_BLE_Demo

IOTIO

Dependencies:   Nucleo_BLE_API_IOTIO Nucleo_BLE_BlueNRG Nucleo_BLE_DemoApp Nucleo_Sensor_Shield mbed

Dependents:   Nucleo_BLE_Demo_IOTIO

Fork of Nucleo_BLE_Demo by Cortex Challenge Team

mbed/DigitalInOut.h@2:c69117fc79da, 2017-03-08 (annotated)

Committer:
16038618
Date:
Wed Mar 08 10:24:56 2017 +0000
Revision:
2:c69117fc79da
Parent:
1:4bdfa7d7e8bf 
IOTIO

Who changed what in which revision?

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