Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

PortIn.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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