Jeremy Hammel / Mbed 2 deprecated ATT_Smart_Home

FRDM-K64F, Avnet M14A2A, Grove Shield, to create smart home system. In use with AT&Ts M2x & Flow.

Dependencies:   mbed FXOS8700CQ MODSERIAL

mbed/PortOut.h@85:0cf65ceb4492, 2019-04-29 (annotated)

Committer:
jwhammel
Date:
Mon Apr 29 04:24:38 2019 +0000
Revision:
85:0cf65ceb4492
Parent:
84:fc8c9b39723a 
We have added an alarm trigger that gets sent to AT&T Flow.

Who changed what in which revision?

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