kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

DigitalOut.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_DIGITALOUT_H
kbrahmbhatt6 0:2f388b030837 17 #define MBED_DIGITALOUT_H
kbrahmbhatt6 0:2f388b030837 18
kbrahmbhatt6 0:2f388b030837 19 #include "platform.h"
kbrahmbhatt6 0:2f388b030837 20 #include "gpio_api.h"
kbrahmbhatt6 0:2f388b030837 21
kbrahmbhatt6 0:2f388b030837 22 namespace mbed {
kbrahmbhatt6 0:2f388b030837 23
kbrahmbhatt6 0:2f388b030837 24 /** A digital output, used for setting the state of a pin
kbrahmbhatt6 0:2f388b030837 25 *
kbrahmbhatt6 0:2f388b030837 26 * Example:
kbrahmbhatt6 0:2f388b030837 27 * @code
kbrahmbhatt6 0:2f388b030837 28 * // Toggle a LED
kbrahmbhatt6 0:2f388b030837 29 * #include "mbed.h"
kbrahmbhatt6 0:2f388b030837 30 *
kbrahmbhatt6 0:2f388b030837 31 * DigitalOut led(LED1);
kbrahmbhatt6 0:2f388b030837 32 *
kbrahmbhatt6 0:2f388b030837 33 * int main() {
kbrahmbhatt6 0:2f388b030837 34 * while(1) {
kbrahmbhatt6 0:2f388b030837 35 * led = !led;
kbrahmbhatt6 0:2f388b030837 36 * wait(0.2);
kbrahmbhatt6 0:2f388b030837 37 * }
kbrahmbhatt6 0:2f388b030837 38 * }
kbrahmbhatt6 0:2f388b030837 39 * @endcode
kbrahmbhatt6 0:2f388b030837 40 */
kbrahmbhatt6 0:2f388b030837 41 class DigitalOut {
kbrahmbhatt6 0:2f388b030837 42
kbrahmbhatt6 0:2f388b030837 43 public:
kbrahmbhatt6 0:2f388b030837 44 /** Create a DigitalOut connected to the specified pin
kbrahmbhatt6 0:2f388b030837 45 *
kbrahmbhatt6 0:2f388b030837 46 * @param pin DigitalOut pin to connect to
kbrahmbhatt6 0:2f388b030837 47 */
kbrahmbhatt6 0:2f388b030837 48 DigitalOut(PinName pin) {
kbrahmbhatt6 0:2f388b030837 49 gpio_init_out(&gpio, pin);
kbrahmbhatt6 0:2f388b030837 50 }
kbrahmbhatt6 0:2f388b030837 51
kbrahmbhatt6 0:2f388b030837 52 /** Create a DigitalOut connected to the specified pin
kbrahmbhatt6 0:2f388b030837 53 *
kbrahmbhatt6 0:2f388b030837 54 * @param pin DigitalOut pin to connect to
kbrahmbhatt6 0:2f388b030837 55 * @param value the initial pin value
kbrahmbhatt6 0:2f388b030837 56 */
kbrahmbhatt6 0:2f388b030837 57 DigitalOut(PinName pin, int value){
kbrahmbhatt6 0:2f388b030837 58 gpio_init_out_ex(&gpio, pin, value);
kbrahmbhatt6 0:2f388b030837 59 }
kbrahmbhatt6 0:2f388b030837 60
kbrahmbhatt6 0:2f388b030837 61 /** Set the output, specified as 0 or 1 (int)
kbrahmbhatt6 0:2f388b030837 62 *
kbrahmbhatt6 0:2f388b030837 63 * @param value An integer specifying the pin output value,
kbrahmbhatt6 0:2f388b030837 64 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
kbrahmbhatt6 0:2f388b030837 65 */
kbrahmbhatt6 0:2f388b030837 66 void write(int value) {
kbrahmbhatt6 0:2f388b030837 67 gpio_write(&gpio, value);
kbrahmbhatt6 0:2f388b030837 68 }
kbrahmbhatt6 0:2f388b030837 69
kbrahmbhatt6 0:2f388b030837 70 /** Return the output setting, represented as 0 or 1 (int)
kbrahmbhatt6 0:2f388b030837 71 *
kbrahmbhatt6 0:2f388b030837 72 * @returns
kbrahmbhatt6 0:2f388b030837 73 * an integer representing the output setting of the pin,
kbrahmbhatt6 0:2f388b030837 74 * 0 for logical 0, 1 for logical 1
kbrahmbhatt6 0:2f388b030837 75 */
kbrahmbhatt6 0:2f388b030837 76 int read() {
kbrahmbhatt6 0:2f388b030837 77 return gpio_read(&gpio);
kbrahmbhatt6 0:2f388b030837 78 }
kbrahmbhatt6 0:2f388b030837 79
kbrahmbhatt6 0:2f388b030837 80 #ifdef MBED_OPERATORS
kbrahmbhatt6 0:2f388b030837 81 /** A shorthand for write()
kbrahmbhatt6 0:2f388b030837 82 */
kbrahmbhatt6 0:2f388b030837 83 DigitalOut& operator= (int value) {
kbrahmbhatt6 0:2f388b030837 84 write(value);
kbrahmbhatt6 0:2f388b030837 85 return *this;
kbrahmbhatt6 0:2f388b030837 86 }
kbrahmbhatt6 0:2f388b030837 87
kbrahmbhatt6 0:2f388b030837 88 DigitalOut& operator= (DigitalOut& rhs) {
kbrahmbhatt6 0:2f388b030837 89 write(rhs.read());
kbrahmbhatt6 0:2f388b030837 90 return *this;
kbrahmbhatt6 0:2f388b030837 91 }
kbrahmbhatt6 0:2f388b030837 92
kbrahmbhatt6 0:2f388b030837 93 /** A shorthand for read()
kbrahmbhatt6 0:2f388b030837 94 */
kbrahmbhatt6 0:2f388b030837 95 operator int() {
kbrahmbhatt6 0:2f388b030837 96 return read();
kbrahmbhatt6 0:2f388b030837 97 }
kbrahmbhatt6 0:2f388b030837 98 #endif
kbrahmbhatt6 0:2f388b030837 99
kbrahmbhatt6 0:2f388b030837 100 protected:
kbrahmbhatt6 0:2f388b030837 101 gpio_t gpio;
kbrahmbhatt6 0:2f388b030837 102 };
kbrahmbhatt6 0:2f388b030837 103
kbrahmbhatt6 0:2f388b030837 104 } // namespace mbed
kbrahmbhatt6 0:2f388b030837 105
kbrahmbhatt6 0:2f388b030837 106 #endif