Mark Turner / MarksMbed

This is a repository for all my programs or modified programs.

PortIn.h@0:72480818e4a9, 2016-09-11 (annotated)

Committer:
mturner5
Date:
Sun Sep 11 23:48:09 2016 +0000
Revision:
0:72480818e4a9
Made delays for the LEDS and button presses

Who changed what in which revision?

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