George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/BusInOut.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:e8fdba0ed044 1 /* mbed Microcontroller Library
gkroussos 0:e8fdba0ed044 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:e8fdba0ed044 3 *
gkroussos 0:e8fdba0ed044 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:e8fdba0ed044 5 * you may not use this file except in compliance with the License.
gkroussos 0:e8fdba0ed044 6 * You may obtain a copy of the License at
gkroussos 0:e8fdba0ed044 7 *
gkroussos 0:e8fdba0ed044 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:e8fdba0ed044 9 *
gkroussos 0:e8fdba0ed044 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:e8fdba0ed044 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:e8fdba0ed044 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:e8fdba0ed044 13 * See the License for the specific language governing permissions and
gkroussos 0:e8fdba0ed044 14 * limitations under the License.
gkroussos 0:e8fdba0ed044 15 */
gkroussos 0:e8fdba0ed044 16 #ifndef MBED_BUSINOUT_H
gkroussos 0:e8fdba0ed044 17 #define MBED_BUSINOUT_H
gkroussos 0:e8fdba0ed044 18
gkroussos 0:e8fdba0ed044 19 #include "DigitalInOut.h"
gkroussos 0:e8fdba0ed044 20
gkroussos 0:e8fdba0ed044 21 namespace mbed {
gkroussos 0:e8fdba0ed044 22
gkroussos 0:e8fdba0ed044 23 /** A digital input output bus, used for setting the state of a collection of pins
gkroussos 0:e8fdba0ed044 24 */
gkroussos 0:e8fdba0ed044 25 class BusInOut {
gkroussos 0:e8fdba0ed044 26
gkroussos 0:e8fdba0ed044 27 public:
gkroussos 0:e8fdba0ed044 28
gkroussos 0:e8fdba0ed044 29 /** Create an BusInOut, connected to the specified pins
gkroussos 0:e8fdba0ed044 30 *
gkroussos 0:e8fdba0ed044 31 * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
gkroussos 0:e8fdba0ed044 32 *
gkroussos 0:e8fdba0ed044 33 * @note
gkroussos 0:e8fdba0ed044 34 * It is only required to specify as many pin variables as is required
gkroussos 0:e8fdba0ed044 35 * for the bus; the rest will default to NC (not connected)
gkroussos 0:e8fdba0ed044 36 */
gkroussos 0:e8fdba0ed044 37 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
gkroussos 0:e8fdba0ed044 38 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
gkroussos 0:e8fdba0ed044 39 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
gkroussos 0:e8fdba0ed044 40 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
gkroussos 0:e8fdba0ed044 41
gkroussos 0:e8fdba0ed044 42 BusInOut(PinName pins[16]);
gkroussos 0:e8fdba0ed044 43
gkroussos 0:e8fdba0ed044 44 virtual ~BusInOut();
gkroussos 0:e8fdba0ed044 45
gkroussos 0:e8fdba0ed044 46 /* Group: Access Methods */
gkroussos 0:e8fdba0ed044 47
gkroussos 0:e8fdba0ed044 48 /** Write the value to the output bus
gkroussos 0:e8fdba0ed044 49 *
gkroussos 0:e8fdba0ed044 50 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
gkroussos 0:e8fdba0ed044 51 */
gkroussos 0:e8fdba0ed044 52 void write(int value);
gkroussos 0:e8fdba0ed044 53
gkroussos 0:e8fdba0ed044 54
gkroussos 0:e8fdba0ed044 55 /** Read the value currently output on the bus
gkroussos 0:e8fdba0ed044 56 *
gkroussos 0:e8fdba0ed044 57 * @returns
gkroussos 0:e8fdba0ed044 58 * An integer with each bit corresponding to associated DigitalInOut pin setting
gkroussos 0:e8fdba0ed044 59 */
gkroussos 0:e8fdba0ed044 60 int read();
gkroussos 0:e8fdba0ed044 61
gkroussos 0:e8fdba0ed044 62 /** Set as an output
gkroussos 0:e8fdba0ed044 63 */
gkroussos 0:e8fdba0ed044 64 void output();
gkroussos 0:e8fdba0ed044 65
gkroussos 0:e8fdba0ed044 66 /** Set as an input
gkroussos 0:e8fdba0ed044 67 */
gkroussos 0:e8fdba0ed044 68 void input();
gkroussos 0:e8fdba0ed044 69
gkroussos 0:e8fdba0ed044 70 /** Set the input pin mode
gkroussos 0:e8fdba0ed044 71 *
gkroussos 0:e8fdba0ed044 72 * @param mode PullUp, PullDown, PullNone
gkroussos 0:e8fdba0ed044 73 */
gkroussos 0:e8fdba0ed044 74 void mode(PinMode pull);
gkroussos 0:e8fdba0ed044 75
gkroussos 0:e8fdba0ed044 76 #ifdef MBED_OPERATORS
gkroussos 0:e8fdba0ed044 77 /** A shorthand for write()
gkroussos 0:e8fdba0ed044 78 */
gkroussos 0:e8fdba0ed044 79 BusInOut& operator= (int v);
gkroussos 0:e8fdba0ed044 80 BusInOut& operator= (BusInOut& rhs);
gkroussos 0:e8fdba0ed044 81
gkroussos 0:e8fdba0ed044 82 /** A shorthand for read()
gkroussos 0:e8fdba0ed044 83 */
gkroussos 0:e8fdba0ed044 84 operator int();
gkroussos 0:e8fdba0ed044 85 #endif
gkroussos 0:e8fdba0ed044 86
gkroussos 0:e8fdba0ed044 87 protected:
gkroussos 0:e8fdba0ed044 88 DigitalInOut* _pin[16];
gkroussos 0:e8fdba0ed044 89 };
gkroussos 0:e8fdba0ed044 90
gkroussos 0:e8fdba0ed044 91 } // namespace mbed
gkroussos 0:e8fdba0ed044 92
gkroussos 0:e8fdba0ed044 93 #endif