Pokitto Community Team / Pokitto_

PokittoLib with changes to lcd refresh etc.

Dependents:   Pokittris

Fork of Pokitto by Pokitto Community Team

This is a fork by user @Spinal, and is used in Pokittris for testing. Do not import this to your own program.

mbed-pokitto/api/PortIn.h@5:7e5c566b1760, 2017-10-07 (annotated)

Committer:
Pokitto
Date:
Sat Oct 07 21:31:12 2017 +0000
Revision:
5:7e5c566b1760
mbed-pokitto integrated

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Pokitto 5:7e5c566b1760 1 /* mbed Microcontroller Library
Pokitto 5:7e5c566b1760 2 * Copyright (c) 2006-2013 ARM Limited
Pokitto 5:7e5c566b1760 3 *
Pokitto 5:7e5c566b1760 4 * Licensed under the Apache License, Version 2.0 (the "License");
Pokitto 5:7e5c566b1760 5 * you may not use this file except in compliance with the License.
Pokitto 5:7e5c566b1760 6 * You may obtain a copy of the License at
Pokitto 5:7e5c566b1760 7 *
Pokitto 5:7e5c566b1760 8 * http://www.apache.org/licenses/LICENSE-2.0
Pokitto 5:7e5c566b1760 9 *
Pokitto 5:7e5c566b1760 10 * Unless required by applicable law or agreed to in writing, software
Pokitto 5:7e5c566b1760 11 * distributed under the License is distributed on an "AS IS" BASIS,
Pokitto 5:7e5c566b1760 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Pokitto 5:7e5c566b1760 13 * See the License for the specific language governing permissions and
Pokitto 5:7e5c566b1760 14 * limitations under the License.
Pokitto 5:7e5c566b1760 15 */
Pokitto 5:7e5c566b1760 16 #ifndef MBED_PORTIN_H
Pokitto 5:7e5c566b1760 17 #define MBED_PORTIN_H
Pokitto 5:7e5c566b1760 18
Pokitto 5:7e5c566b1760 19 #include "platform.h"
Pokitto 5:7e5c566b1760 20
Pokitto 5:7e5c566b1760 21 #if DEVICE_PORTIN
Pokitto 5:7e5c566b1760 22
Pokitto 5:7e5c566b1760 23 #include "port_api.h"
Pokitto 5:7e5c566b1760 24
Pokitto 5:7e5c566b1760 25 namespace mbed {
Pokitto 5:7e5c566b1760 26
Pokitto 5:7e5c566b1760 27 /** A multiple pin digital input
Pokitto 5:7e5c566b1760 28 *
Pokitto 5:7e5c566b1760 29 * Example:
Pokitto 5:7e5c566b1760 30 * @code
Pokitto 5:7e5c566b1760 31 * // Switch on an LED if any of mbed pins 21-26 is high
Pokitto 5:7e5c566b1760 32 *
Pokitto 5:7e5c566b1760 33 * #include "mbed.h"
Pokitto 5:7e5c566b1760 34 *
Pokitto 5:7e5c566b1760 35 * PortIn p(Port2, 0x0000003F); // p21-p26
Pokitto 5:7e5c566b1760 36 * DigitalOut ind(LED4);
Pokitto 5:7e5c566b1760 37 *
Pokitto 5:7e5c566b1760 38 * int main() {
Pokitto 5:7e5c566b1760 39 * while(1) {
Pokitto 5:7e5c566b1760 40 * int pins = p.read();
Pokitto 5:7e5c566b1760 41 * if(pins) {
Pokitto 5:7e5c566b1760 42 * ind = 1;
Pokitto 5:7e5c566b1760 43 * } else {
Pokitto 5:7e5c566b1760 44 * ind = 0;
Pokitto 5:7e5c566b1760 45 * }
Pokitto 5:7e5c566b1760 46 * }
Pokitto 5:7e5c566b1760 47 * }
Pokitto 5:7e5c566b1760 48 * @endcode
Pokitto 5:7e5c566b1760 49 */
Pokitto 5:7e5c566b1760 50 class PortIn {
Pokitto 5:7e5c566b1760 51 public:
Pokitto 5:7e5c566b1760 52
Pokitto 5:7e5c566b1760 53 /** Create an PortIn, connected to the specified port
Pokitto 5:7e5c566b1760 54 *
Pokitto 5:7e5c566b1760 55 * @param port Port to connect to (Port0-Port5)
Pokitto 5:7e5c566b1760 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
Pokitto 5:7e5c566b1760 57 */
Pokitto 5:7e5c566b1760 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
Pokitto 5:7e5c566b1760 59 port_init(&_port, port, mask, PIN_INPUT);
Pokitto 5:7e5c566b1760 60 }
Pokitto 5:7e5c566b1760 61
Pokitto 5:7e5c566b1760 62 /** Read the value currently output on the port
Pokitto 5:7e5c566b1760 63 *
Pokitto 5:7e5c566b1760 64 * @returns
Pokitto 5:7e5c566b1760 65 * An integer with each bit corresponding to associated port pin setting
Pokitto 5:7e5c566b1760 66 */
Pokitto 5:7e5c566b1760 67 int read() {
Pokitto 5:7e5c566b1760 68 return port_read(&_port);
Pokitto 5:7e5c566b1760 69 }
Pokitto 5:7e5c566b1760 70
Pokitto 5:7e5c566b1760 71 /** Set the input pin mode
Pokitto 5:7e5c566b1760 72 *
Pokitto 5:7e5c566b1760 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
Pokitto 5:7e5c566b1760 74 */
Pokitto 5:7e5c566b1760 75 void mode(PinMode mode) {
Pokitto 5:7e5c566b1760 76 port_mode(&_port, mode);
Pokitto 5:7e5c566b1760 77 }
Pokitto 5:7e5c566b1760 78
Pokitto 5:7e5c566b1760 79 /** A shorthand for read()
Pokitto 5:7e5c566b1760 80 */
Pokitto 5:7e5c566b1760 81 operator int() {
Pokitto 5:7e5c566b1760 82 return read();
Pokitto 5:7e5c566b1760 83 }
Pokitto 5:7e5c566b1760 84
Pokitto 5:7e5c566b1760 85 private:
Pokitto 5:7e5c566b1760 86 port_t _port;
Pokitto 5:7e5c566b1760 87 };
Pokitto 5:7e5c566b1760 88
Pokitto 5:7e5c566b1760 89 } // namespace mbed
Pokitto 5:7e5c566b1760 90
Pokitto 5:7e5c566b1760 91 #endif
Pokitto 5:7e5c566b1760 92
Pokitto 5:7e5c566b1760 93 #endif