Jhon Plantikow / DHT11

DHT11

BusInOut.h@0:c52df770855b, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

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