kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

DigitalIn.h@0:2f388b030837, 2016-04-29 (annotated)

Committer:
kbrahmbhatt6
Date:
Fri Apr 29 06:59:59 2016 +0000
Revision:
0:2f388b030837
1

Who changed what in which revision?

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