Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

DigitalIn.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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