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