kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

BusOut.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_BUSOUT_H
kbrahmbhatt6 0:2f388b030837 17 #define MBED_BUSOUT_H
kbrahmbhatt6 0:2f388b030837 18
kbrahmbhatt6 0:2f388b030837 19 #include "DigitalOut.h"
kbrahmbhatt6 0:2f388b030837 20
kbrahmbhatt6 0:2f388b030837 21 namespace mbed {
kbrahmbhatt6 0:2f388b030837 22
kbrahmbhatt6 0:2f388b030837 23 /** A digital output bus, used for setting the state of a collection of pins
kbrahmbhatt6 0:2f388b030837 24 */
kbrahmbhatt6 0:2f388b030837 25 class BusOut {
kbrahmbhatt6 0:2f388b030837 26
kbrahmbhatt6 0:2f388b030837 27 public:
kbrahmbhatt6 0:2f388b030837 28
kbrahmbhatt6 0:2f388b030837 29 /** Create an BusOut, connected to the specified pins
kbrahmbhatt6 0:2f388b030837 30 *
kbrahmbhatt6 0:2f388b030837 31 * @param p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
kbrahmbhatt6 0:2f388b030837 32 *
kbrahmbhatt6 0:2f388b030837 33 * @note
kbrahmbhatt6 0:2f388b030837 34 * It is only required to specify as many pin variables as is required
kbrahmbhatt6 0:2f388b030837 35 * for the bus; the rest will default to NC (not connected)
kbrahmbhatt6 0:2f388b030837 36 */
kbrahmbhatt6 0:2f388b030837 37 BusOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
kbrahmbhatt6 0:2f388b030837 38 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
kbrahmbhatt6 0:2f388b030837 39 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
kbrahmbhatt6 0:2f388b030837 40 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
kbrahmbhatt6 0:2f388b030837 41
kbrahmbhatt6 0:2f388b030837 42 BusOut(PinName pins[16]);
kbrahmbhatt6 0:2f388b030837 43
kbrahmbhatt6 0:2f388b030837 44 virtual ~BusOut();
kbrahmbhatt6 0:2f388b030837 45
kbrahmbhatt6 0:2f388b030837 46 /** Write the value to the output bus
kbrahmbhatt6 0:2f388b030837 47 *
kbrahmbhatt6 0:2f388b030837 48 * @param value An integer specifying a bit to write for every corresponding DigitalOut pin
kbrahmbhatt6 0:2f388b030837 49 */
kbrahmbhatt6 0:2f388b030837 50 void write(int value);
kbrahmbhatt6 0:2f388b030837 51
kbrahmbhatt6 0:2f388b030837 52 /** Read the value currently output on the bus
kbrahmbhatt6 0:2f388b030837 53 *
kbrahmbhatt6 0:2f388b030837 54 * @returns
kbrahmbhatt6 0:2f388b030837 55 * An integer with each bit corresponding to associated DigitalOut pin setting
kbrahmbhatt6 0:2f388b030837 56 */
kbrahmbhatt6 0:2f388b030837 57 int read();
kbrahmbhatt6 0:2f388b030837 58
kbrahmbhatt6 0:2f388b030837 59 #ifdef MBED_OPERATORS
kbrahmbhatt6 0:2f388b030837 60 /** A shorthand for write()
kbrahmbhatt6 0:2f388b030837 61 */
kbrahmbhatt6 0:2f388b030837 62 BusOut& operator= (int v);
kbrahmbhatt6 0:2f388b030837 63 BusOut& operator= (BusOut& rhs);
kbrahmbhatt6 0:2f388b030837 64
kbrahmbhatt6 0:2f388b030837 65 /** A shorthand for read()
kbrahmbhatt6 0:2f388b030837 66 */
kbrahmbhatt6 0:2f388b030837 67 operator int();
kbrahmbhatt6 0:2f388b030837 68 #endif
kbrahmbhatt6 0:2f388b030837 69
kbrahmbhatt6 0:2f388b030837 70 protected:
kbrahmbhatt6 0:2f388b030837 71 DigitalOut* _pin[16];
kbrahmbhatt6 0:2f388b030837 72 };
kbrahmbhatt6 0:2f388b030837 73
kbrahmbhatt6 0:2f388b030837 74 } // namespace mbed
kbrahmbhatt6 0:2f388b030837 75
kbrahmbhatt6 0:2f388b030837 76 #endif