Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

DigitalIn.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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