Jhon Plantikow / DHT11

DHT11

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