kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

DigitalInOut.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_DIGITALINOUT_H
kbrahmbhatt6 0:2f388b030837 17 #define MBED_DIGITALINOUT_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/output, used for setting or reading a bi-directional pin
kbrahmbhatt6 0:2f388b030837 26 */
kbrahmbhatt6 0:2f388b030837 27 class DigitalInOut {
kbrahmbhatt6 0:2f388b030837 28
kbrahmbhatt6 0:2f388b030837 29 public:
kbrahmbhatt6 0:2f388b030837 30 /** Create a DigitalInOut connected to the specified pin
kbrahmbhatt6 0:2f388b030837 31 *
kbrahmbhatt6 0:2f388b030837 32 * @param pin DigitalInOut pin to connect to
kbrahmbhatt6 0:2f388b030837 33 */
kbrahmbhatt6 0:2f388b030837 34 DigitalInOut(PinName pin) {
kbrahmbhatt6 0:2f388b030837 35 gpio_init_in(&gpio, pin);
kbrahmbhatt6 0:2f388b030837 36 }
kbrahmbhatt6 0:2f388b030837 37
kbrahmbhatt6 0:2f388b030837 38 /** Create a DigitalInOut connected to the specified pin
kbrahmbhatt6 0:2f388b030837 39 *
kbrahmbhatt6 0:2f388b030837 40 * @param pin DigitalInOut pin to connect to
kbrahmbhatt6 0:2f388b030837 41 * @param direction the initial direction of the pin
kbrahmbhatt6 0:2f388b030837 42 * @param mode the initial mode of the pin
kbrahmbhatt6 0:2f388b030837 43 * @param value the initial value of the pin if is an output
kbrahmbhatt6 0:2f388b030837 44 */
kbrahmbhatt6 0:2f388b030837 45 DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) {
kbrahmbhatt6 0:2f388b030837 46 gpio_init_inout(&gpio, pin, direction, mode, value);
kbrahmbhatt6 0:2f388b030837 47 }
kbrahmbhatt6 0:2f388b030837 48
kbrahmbhatt6 0:2f388b030837 49 /** Set the output, specified as 0 or 1 (int)
kbrahmbhatt6 0:2f388b030837 50 *
kbrahmbhatt6 0:2f388b030837 51 * @param value An integer specifying the pin output value,
kbrahmbhatt6 0:2f388b030837 52 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
kbrahmbhatt6 0:2f388b030837 53 */
kbrahmbhatt6 0:2f388b030837 54 void write(int value) {
kbrahmbhatt6 0:2f388b030837 55 gpio_write(&gpio, value);
kbrahmbhatt6 0:2f388b030837 56 }
kbrahmbhatt6 0:2f388b030837 57
kbrahmbhatt6 0:2f388b030837 58 /** Return the output setting, represented as 0 or 1 (int)
kbrahmbhatt6 0:2f388b030837 59 *
kbrahmbhatt6 0:2f388b030837 60 * @returns
kbrahmbhatt6 0:2f388b030837 61 * an integer representing the output setting of the pin if it is an output,
kbrahmbhatt6 0:2f388b030837 62 * or read the input if set as an input
kbrahmbhatt6 0:2f388b030837 63 */
kbrahmbhatt6 0:2f388b030837 64 int read() {
kbrahmbhatt6 0:2f388b030837 65 return gpio_read(&gpio);
kbrahmbhatt6 0:2f388b030837 66 }
kbrahmbhatt6 0:2f388b030837 67
kbrahmbhatt6 0:2f388b030837 68 /** Set as an output
kbrahmbhatt6 0:2f388b030837 69 */
kbrahmbhatt6 0:2f388b030837 70 void output() {
kbrahmbhatt6 0:2f388b030837 71 gpio_dir(&gpio, PIN_OUTPUT);
kbrahmbhatt6 0:2f388b030837 72 }
kbrahmbhatt6 0:2f388b030837 73
kbrahmbhatt6 0:2f388b030837 74 /** Set as an input
kbrahmbhatt6 0:2f388b030837 75 */
kbrahmbhatt6 0:2f388b030837 76 void input() {
kbrahmbhatt6 0:2f388b030837 77 gpio_dir(&gpio, PIN_INPUT);
kbrahmbhatt6 0:2f388b030837 78 }
kbrahmbhatt6 0:2f388b030837 79
kbrahmbhatt6 0:2f388b030837 80 /** Set the input pin mode
kbrahmbhatt6 0:2f388b030837 81 *
kbrahmbhatt6 0:2f388b030837 82 * @param mode PullUp, PullDown, PullNone, OpenDrain
kbrahmbhatt6 0:2f388b030837 83 */
kbrahmbhatt6 0:2f388b030837 84 void mode(PinMode pull) {
kbrahmbhatt6 0:2f388b030837 85 gpio_mode(&gpio, pull);
kbrahmbhatt6 0:2f388b030837 86 }
kbrahmbhatt6 0:2f388b030837 87
kbrahmbhatt6 0:2f388b030837 88 #ifdef MBED_OPERATORS
kbrahmbhatt6 0:2f388b030837 89 /** A shorthand for write()
kbrahmbhatt6 0:2f388b030837 90 */
kbrahmbhatt6 0:2f388b030837 91 DigitalInOut& operator= (int value) {
kbrahmbhatt6 0:2f388b030837 92 write(value);
kbrahmbhatt6 0:2f388b030837 93 return *this;
kbrahmbhatt6 0:2f388b030837 94 }
kbrahmbhatt6 0:2f388b030837 95
kbrahmbhatt6 0:2f388b030837 96 DigitalInOut& operator= (DigitalInOut& rhs) {
kbrahmbhatt6 0:2f388b030837 97 write(rhs.read());
kbrahmbhatt6 0:2f388b030837 98 return *this;
kbrahmbhatt6 0:2f388b030837 99 }
kbrahmbhatt6 0:2f388b030837 100
kbrahmbhatt6 0:2f388b030837 101 /** A shorthand for read()
kbrahmbhatt6 0:2f388b030837 102 */
kbrahmbhatt6 0:2f388b030837 103 operator int() {
kbrahmbhatt6 0:2f388b030837 104 return read();
kbrahmbhatt6 0:2f388b030837 105 }
kbrahmbhatt6 0:2f388b030837 106 #endif
kbrahmbhatt6 0:2f388b030837 107
kbrahmbhatt6 0:2f388b030837 108 protected:
kbrahmbhatt6 0:2f388b030837 109 gpio_t gpio;
kbrahmbhatt6 0:2f388b030837 110 };
kbrahmbhatt6 0:2f388b030837 111
kbrahmbhatt6 0:2f388b030837 112 } // namespace mbed
kbrahmbhatt6 0:2f388b030837 113
kbrahmbhatt6 0:2f388b030837 114 #endif