kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

PortIn.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_PORTIN_H
kbrahmbhatt6 0:2f388b030837 17 #define MBED_PORTIN_H
kbrahmbhatt6 0:2f388b030837 18
kbrahmbhatt6 0:2f388b030837 19 #include "platform.h"
kbrahmbhatt6 0:2f388b030837 20
kbrahmbhatt6 0:2f388b030837 21 #if DEVICE_PORTIN
kbrahmbhatt6 0:2f388b030837 22
kbrahmbhatt6 0:2f388b030837 23 #include "port_api.h"
kbrahmbhatt6 0:2f388b030837 24
kbrahmbhatt6 0:2f388b030837 25 namespace mbed {
kbrahmbhatt6 0:2f388b030837 26
kbrahmbhatt6 0:2f388b030837 27 /** A multiple pin digital input
kbrahmbhatt6 0:2f388b030837 28 *
kbrahmbhatt6 0:2f388b030837 29 * Example:
kbrahmbhatt6 0:2f388b030837 30 * @code
kbrahmbhatt6 0:2f388b030837 31 * // Switch on an LED if any of mbed pins 21-26 is high
kbrahmbhatt6 0:2f388b030837 32 *
kbrahmbhatt6 0:2f388b030837 33 * #include "mbed.h"
kbrahmbhatt6 0:2f388b030837 34 *
kbrahmbhatt6 0:2f388b030837 35 * PortIn p(Port2, 0x0000003F); // p21-p26
kbrahmbhatt6 0:2f388b030837 36 * DigitalOut ind(LED4);
kbrahmbhatt6 0:2f388b030837 37 *
kbrahmbhatt6 0:2f388b030837 38 * int main() {
kbrahmbhatt6 0:2f388b030837 39 * while(1) {
kbrahmbhatt6 0:2f388b030837 40 * int pins = p.read();
kbrahmbhatt6 0:2f388b030837 41 * if(pins) {
kbrahmbhatt6 0:2f388b030837 42 * ind = 1;
kbrahmbhatt6 0:2f388b030837 43 * } else {
kbrahmbhatt6 0:2f388b030837 44 * ind = 0;
kbrahmbhatt6 0:2f388b030837 45 * }
kbrahmbhatt6 0:2f388b030837 46 * }
kbrahmbhatt6 0:2f388b030837 47 * }
kbrahmbhatt6 0:2f388b030837 48 * @endcode
kbrahmbhatt6 0:2f388b030837 49 */
kbrahmbhatt6 0:2f388b030837 50 class PortIn {
kbrahmbhatt6 0:2f388b030837 51 public:
kbrahmbhatt6 0:2f388b030837 52
kbrahmbhatt6 0:2f388b030837 53 /** Create an PortIn, connected to the specified port
kbrahmbhatt6 0:2f388b030837 54 *
kbrahmbhatt6 0:2f388b030837 55 * @param port Port to connect to (Port0-Port5)
kbrahmbhatt6 0:2f388b030837 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
kbrahmbhatt6 0:2f388b030837 57 */
kbrahmbhatt6 0:2f388b030837 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
kbrahmbhatt6 0:2f388b030837 59 port_init(&_port, port, mask, PIN_INPUT);
kbrahmbhatt6 0:2f388b030837 60 }
kbrahmbhatt6 0:2f388b030837 61
kbrahmbhatt6 0:2f388b030837 62 /** Read the value currently output on the port
kbrahmbhatt6 0:2f388b030837 63 *
kbrahmbhatt6 0:2f388b030837 64 * @returns
kbrahmbhatt6 0:2f388b030837 65 * An integer with each bit corresponding to associated port pin setting
kbrahmbhatt6 0:2f388b030837 66 */
kbrahmbhatt6 0:2f388b030837 67 int read() {
kbrahmbhatt6 0:2f388b030837 68 return port_read(&_port);
kbrahmbhatt6 0:2f388b030837 69 }
kbrahmbhatt6 0:2f388b030837 70
kbrahmbhatt6 0:2f388b030837 71 /** Set the input pin mode
kbrahmbhatt6 0:2f388b030837 72 *
kbrahmbhatt6 0:2f388b030837 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
kbrahmbhatt6 0:2f388b030837 74 */
kbrahmbhatt6 0:2f388b030837 75 void mode(PinMode mode) {
kbrahmbhatt6 0:2f388b030837 76 port_mode(&_port, mode);
kbrahmbhatt6 0:2f388b030837 77 }
kbrahmbhatt6 0:2f388b030837 78
kbrahmbhatt6 0:2f388b030837 79 /** A shorthand for read()
kbrahmbhatt6 0:2f388b030837 80 */
kbrahmbhatt6 0:2f388b030837 81 operator int() {
kbrahmbhatt6 0:2f388b030837 82 return read();
kbrahmbhatt6 0:2f388b030837 83 }
kbrahmbhatt6 0:2f388b030837 84
kbrahmbhatt6 0:2f388b030837 85 private:
kbrahmbhatt6 0:2f388b030837 86 port_t _port;
kbrahmbhatt6 0:2f388b030837 87 };
kbrahmbhatt6 0:2f388b030837 88
kbrahmbhatt6 0:2f388b030837 89 } // namespace mbed
kbrahmbhatt6 0:2f388b030837 90
kbrahmbhatt6 0:2f388b030837 91 #endif
kbrahmbhatt6 0:2f388b030837 92
kbrahmbhatt6 0:2f388b030837 93 #endif