RYUICHI NAKAYAMA / mbed-dev

OK

Fork of mbed-dev by mbed official

api/DigitalIn.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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