Micah B / mbed

mbed

Dependents:   DHTSensor_Test K64F_eCompass_OneNET_JW

PortOut.h@0:2cc6bb4d7fea, 2015-02-25 (annotated)

Committer:
mbotkinl
Date:
Wed Feb 25 20:22:22 2015 +0000
Revision:
0:2cc6bb4d7fea
Working code to read Temperature and Humidity readings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbotkinl 0:2cc6bb4d7fea 1 /* mbed Microcontroller Library
mbotkinl 0:2cc6bb4d7fea 2 * Copyright (c) 2006-2013 ARM Limited
mbotkinl 0:2cc6bb4d7fea 3 *
mbotkinl 0:2cc6bb4d7fea 4 * Licensed under the Apache License, Version 2.0 (the "License");
mbotkinl 0:2cc6bb4d7fea 5 * you may not use this file except in compliance with the License.
mbotkinl 0:2cc6bb4d7fea 6 * You may obtain a copy of the License at
mbotkinl 0:2cc6bb4d7fea 7 *
mbotkinl 0:2cc6bb4d7fea 8 * http://www.apache.org/licenses/LICENSE-2.0
mbotkinl 0:2cc6bb4d7fea 9 *
mbotkinl 0:2cc6bb4d7fea 10 * Unless required by applicable law or agreed to in writing, software
mbotkinl 0:2cc6bb4d7fea 11 * distributed under the License is distributed on an "AS IS" BASIS,
mbotkinl 0:2cc6bb4d7fea 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbotkinl 0:2cc6bb4d7fea 13 * See the License for the specific language governing permissions and
mbotkinl 0:2cc6bb4d7fea 14 * limitations under the License.
mbotkinl 0:2cc6bb4d7fea 15 */
mbotkinl 0:2cc6bb4d7fea 16 #ifndef MBED_PORTOUT_H
mbotkinl 0:2cc6bb4d7fea 17 #define MBED_PORTOUT_H
mbotkinl 0:2cc6bb4d7fea 18
mbotkinl 0:2cc6bb4d7fea 19 #include "platform.h"
mbotkinl 0:2cc6bb4d7fea 20
mbotkinl 0:2cc6bb4d7fea 21 #if DEVICE_PORTOUT
mbotkinl 0:2cc6bb4d7fea 22
mbotkinl 0:2cc6bb4d7fea 23 #include "port_api.h"
mbotkinl 0:2cc6bb4d7fea 24
mbotkinl 0:2cc6bb4d7fea 25 namespace mbed {
mbotkinl 0:2cc6bb4d7fea 26 /** A multiple pin digital out
mbotkinl 0:2cc6bb4d7fea 27 *
mbotkinl 0:2cc6bb4d7fea 28 * Example:
mbotkinl 0:2cc6bb4d7fea 29 * @code
mbotkinl 0:2cc6bb4d7fea 30 * // Toggle all four LEDs
mbotkinl 0:2cc6bb4d7fea 31 *
mbotkinl 0:2cc6bb4d7fea 32 * #include "mbed.h"
mbotkinl 0:2cc6bb4d7fea 33 *
mbotkinl 0:2cc6bb4d7fea 34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
mbotkinl 0:2cc6bb4d7fea 35 * #define LED_MASK 0x00B40000
mbotkinl 0:2cc6bb4d7fea 36 *
mbotkinl 0:2cc6bb4d7fea 37 * PortOut ledport(Port1, LED_MASK);
mbotkinl 0:2cc6bb4d7fea 38 *
mbotkinl 0:2cc6bb4d7fea 39 * int main() {
mbotkinl 0:2cc6bb4d7fea 40 * while(1) {
mbotkinl 0:2cc6bb4d7fea 41 * ledport = LED_MASK;
mbotkinl 0:2cc6bb4d7fea 42 * wait(1);
mbotkinl 0:2cc6bb4d7fea 43 * ledport = 0;
mbotkinl 0:2cc6bb4d7fea 44 * wait(1);
mbotkinl 0:2cc6bb4d7fea 45 * }
mbotkinl 0:2cc6bb4d7fea 46 * }
mbotkinl 0:2cc6bb4d7fea 47 * @endcode
mbotkinl 0:2cc6bb4d7fea 48 */
mbotkinl 0:2cc6bb4d7fea 49 class PortOut {
mbotkinl 0:2cc6bb4d7fea 50 public:
mbotkinl 0:2cc6bb4d7fea 51
mbotkinl 0:2cc6bb4d7fea 52 /** Create an PortOut, connected to the specified port
mbotkinl 0:2cc6bb4d7fea 53 *
mbotkinl 0:2cc6bb4d7fea 54 * @param port Port to connect to (Port0-Port5)
mbotkinl 0:2cc6bb4d7fea 55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
mbotkinl 0:2cc6bb4d7fea 56 */
mbotkinl 0:2cc6bb4d7fea 57 PortOut(PortName port, int mask = 0xFFFFFFFF) {
mbotkinl 0:2cc6bb4d7fea 58 port_init(&_port, port, mask, PIN_OUTPUT);
mbotkinl 0:2cc6bb4d7fea 59 }
mbotkinl 0:2cc6bb4d7fea 60
mbotkinl 0:2cc6bb4d7fea 61 /** Write the value to the output port
mbotkinl 0:2cc6bb4d7fea 62 *
mbotkinl 0:2cc6bb4d7fea 63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
mbotkinl 0:2cc6bb4d7fea 64 */
mbotkinl 0:2cc6bb4d7fea 65 void write(int value) {
mbotkinl 0:2cc6bb4d7fea 66 port_write(&_port, value);
mbotkinl 0:2cc6bb4d7fea 67 }
mbotkinl 0:2cc6bb4d7fea 68
mbotkinl 0:2cc6bb4d7fea 69 /** Read the value currently output on the port
mbotkinl 0:2cc6bb4d7fea 70 *
mbotkinl 0:2cc6bb4d7fea 71 * @returns
mbotkinl 0:2cc6bb4d7fea 72 * An integer with each bit corresponding to associated PortOut pin setting
mbotkinl 0:2cc6bb4d7fea 73 */
mbotkinl 0:2cc6bb4d7fea 74 int read() {
mbotkinl 0:2cc6bb4d7fea 75 return port_read(&_port);
mbotkinl 0:2cc6bb4d7fea 76 }
mbotkinl 0:2cc6bb4d7fea 77
mbotkinl 0:2cc6bb4d7fea 78 /** A shorthand for write()
mbotkinl 0:2cc6bb4d7fea 79 */
mbotkinl 0:2cc6bb4d7fea 80 PortOut& operator= (int value) {
mbotkinl 0:2cc6bb4d7fea 81 write(value);
mbotkinl 0:2cc6bb4d7fea 82 return *this;
mbotkinl 0:2cc6bb4d7fea 83 }
mbotkinl 0:2cc6bb4d7fea 84
mbotkinl 0:2cc6bb4d7fea 85 PortOut& operator= (PortOut& rhs) {
mbotkinl 0:2cc6bb4d7fea 86 write(rhs.read());
mbotkinl 0:2cc6bb4d7fea 87 return *this;
mbotkinl 0:2cc6bb4d7fea 88 }
mbotkinl 0:2cc6bb4d7fea 89
mbotkinl 0:2cc6bb4d7fea 90 /** A shorthand for read()
mbotkinl 0:2cc6bb4d7fea 91 */
mbotkinl 0:2cc6bb4d7fea 92 operator int() {
mbotkinl 0:2cc6bb4d7fea 93 return read();
mbotkinl 0:2cc6bb4d7fea 94 }
mbotkinl 0:2cc6bb4d7fea 95
mbotkinl 0:2cc6bb4d7fea 96 private:
mbotkinl 0:2cc6bb4d7fea 97 port_t _port;
mbotkinl 0:2cc6bb4d7fea 98 };
mbotkinl 0:2cc6bb4d7fea 99
mbotkinl 0:2cc6bb4d7fea 100 } // namespace mbed
mbotkinl 0:2cc6bb4d7fea 101
mbotkinl 0:2cc6bb4d7fea 102 #endif
mbotkinl 0:2cc6bb4d7fea 103
mbotkinl 0:2cc6bb4d7fea 104 #endif