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/DigitalIn.h@1:4bdfa7d7e8bf, 2016-10-29 (annotated)

Committer:
16038618
Date:
Sat Oct 29 15:11:28 2016 +0000
Revision:
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_DIGITALIN_H
16038618 1:4bdfa7d7e8bf 17 #define MBED_DIGITALIN_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, used for reading the state of a pin
16038618 1:4bdfa7d7e8bf 26 *
16038618 1:4bdfa7d7e8bf 27 * Example:
16038618 1:4bdfa7d7e8bf 28 * @code
16038618 1:4bdfa7d7e8bf 29 * // Flash an LED while a DigitalIn is true
16038618 1:4bdfa7d7e8bf 30 *
16038618 1:4bdfa7d7e8bf 31 * #include "mbed.h"
16038618 1:4bdfa7d7e8bf 32 *
16038618 1:4bdfa7d7e8bf 33 * DigitalIn enable(p5);
16038618 1:4bdfa7d7e8bf 34 * DigitalOut led(LED1);
16038618 1:4bdfa7d7e8bf 35 *
16038618 1:4bdfa7d7e8bf 36 * int main() {
16038618 1:4bdfa7d7e8bf 37 * while(1) {
16038618 1:4bdfa7d7e8bf 38 * if(enable) {
16038618 1:4bdfa7d7e8bf 39 * led = !led;
16038618 1:4bdfa7d7e8bf 40 * }
16038618 1:4bdfa7d7e8bf 41 * wait(0.25);
16038618 1:4bdfa7d7e8bf 42 * }
16038618 1:4bdfa7d7e8bf 43 * }
16038618 1:4bdfa7d7e8bf 44 * @endcode
16038618 1:4bdfa7d7e8bf 45 */
16038618 1:4bdfa7d7e8bf 46 class DigitalIn {
16038618 1:4bdfa7d7e8bf 47
16038618 1:4bdfa7d7e8bf 48 public:
16038618 1:4bdfa7d7e8bf 49 /** Create a DigitalIn connected to the specified pin
16038618 1:4bdfa7d7e8bf 50 *
16038618 1:4bdfa7d7e8bf 51 * @param pin DigitalIn pin to connect to
16038618 1:4bdfa7d7e8bf 52 */
16038618 1:4bdfa7d7e8bf 53 DigitalIn(PinName pin) : gpio() {
16038618 1:4bdfa7d7e8bf 54 gpio_init_in(&gpio, pin);
16038618 1:4bdfa7d7e8bf 55 }
16038618 1:4bdfa7d7e8bf 56
16038618 1:4bdfa7d7e8bf 57 /** Create a DigitalIn connected to the specified pin
16038618 1:4bdfa7d7e8bf 58 *
16038618 1:4bdfa7d7e8bf 59 * @param pin DigitalIn pin to connect to
16038618 1:4bdfa7d7e8bf 60 * @param mode the initial mode of the pin
16038618 1:4bdfa7d7e8bf 61 */
16038618 1:4bdfa7d7e8bf 62 DigitalIn(PinName pin, PinMode mode) : gpio() {
16038618 1:4bdfa7d7e8bf 63 gpio_init_in_ex(&gpio, pin, mode);
16038618 1:4bdfa7d7e8bf 64 }
16038618 1:4bdfa7d7e8bf 65 /** Read the input, represented as 0 or 1 (int)
16038618 1:4bdfa7d7e8bf 66 *
16038618 1:4bdfa7d7e8bf 67 * @returns
16038618 1:4bdfa7d7e8bf 68 * An integer representing the state of the input pin,
16038618 1:4bdfa7d7e8bf 69 * 0 for logical 0, 1 for logical 1
16038618 1:4bdfa7d7e8bf 70 */
16038618 1:4bdfa7d7e8bf 71 int read() {
16038618 1:4bdfa7d7e8bf 72 return gpio_read(&gpio);
16038618 1:4bdfa7d7e8bf 73 }
16038618 1:4bdfa7d7e8bf 74
16038618 1:4bdfa7d7e8bf 75 /** Set the input pin mode
16038618 1:4bdfa7d7e8bf 76 *
16038618 1:4bdfa7d7e8bf 77 * @param mode PullUp, PullDown, PullNone, OpenDrain
16038618 1:4bdfa7d7e8bf 78 */
16038618 1:4bdfa7d7e8bf 79 void mode(PinMode pull) {
16038618 1:4bdfa7d7e8bf 80 gpio_mode(&gpio, pull);
16038618 1:4bdfa7d7e8bf 81 }
16038618 1:4bdfa7d7e8bf 82
16038618 1:4bdfa7d7e8bf 83 /** Return the output setting, represented as 0 or 1 (int)
16038618 1:4bdfa7d7e8bf 84 *
16038618 1:4bdfa7d7e8bf 85 * @returns
16038618 1:4bdfa7d7e8bf 86 * Non zero value if pin is connected to uc GPIO
16038618 1:4bdfa7d7e8bf 87 * 0 if gpio object was initialized with NC
16038618 1:4bdfa7d7e8bf 88 */
16038618 1:4bdfa7d7e8bf 89 int is_connected() {
16038618 1:4bdfa7d7e8bf 90 return gpio_is_connected(&gpio);
16038618 1:4bdfa7d7e8bf 91 }
16038618 1:4bdfa7d7e8bf 92
16038618 1:4bdfa7d7e8bf 93 #ifdef MBED_OPERATORS
16038618 1:4bdfa7d7e8bf 94 /** An operator shorthand for read()
16038618 1:4bdfa7d7e8bf 95 */
16038618 1:4bdfa7d7e8bf 96 operator int() {
16038618 1:4bdfa7d7e8bf 97 return read();
16038618 1:4bdfa7d7e8bf 98 }
16038618 1:4bdfa7d7e8bf 99 #endif
16038618 1:4bdfa7d7e8bf 100
16038618 1:4bdfa7d7e8bf 101 protected:
16038618 1:4bdfa7d7e8bf 102 gpio_t gpio;
16038618 1:4bdfa7d7e8bf 103 };
16038618 1:4bdfa7d7e8bf 104
16038618 1:4bdfa7d7e8bf 105 } // namespace mbed
16038618 1:4bdfa7d7e8bf 106
16038618 1:4bdfa7d7e8bf 107 #endif