Thor Hall / mbed-dev_mbed_lib_v125

This fork captures the mbed lib v125 for ease of integration into older projects.

Fork of mbed-dev by mbed official

Embed: (wiki syntax)

« Back to documentation index

PortIn Class Reference
Public Member Functions

PortIn Class Reference

A multiple pin digital input. More...

#include <PortIn.h>

Public Member Functions

 PortIn (PortName port, int mask=0xFFFFFFFF)
 Create an PortIn, connected to the specified port.
int read ()
 Read the value currently output on the port.
void mode (PinMode mode)
 Set the input pin mode.
 operator int ()
 A shorthand for read()

Detailed Description

A multiple pin digital input.

Synchronization level: Interrupt safe

Example: 

 // Switch on an LED if any of mbed pins 21-26 is high

 #include "mbed.h"

 PortIn     p(Port2, 0x0000003F);   // p21-p26
 DigitalOut ind(LED4);

 int main() {
     while(1) {
         int pins = p.read();
         if(pins) {
             ind = 1;
         } else {
             ind = 0;
         }
     }
 }

Definition at line 53 of file PortIn.h.

Constructor & Destructor Documentation

PortIn ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create an PortIn, connected to the specified port.

Parameters:
portPort to connect to (Port0-Port5)
maskA bitmask to identify which bits in the port should be included (0 - ignore)

Definition at line 61 of file PortIn.h.

Member Function Documentation

void mode ( PinMode  mode )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 80 of file PortIn.h.

operator int (  )

A shorthand for read()

Definition at line 88 of file PortIn.h.

int read ( void   )

Read the value currently output on the port.

Returns:
An integer with each bit corresponding to associated port pin setting

Definition at line 72 of file PortIn.h.

Generated on Tue Jul 12 2022 19:06:18 by  doxygen 1.7.2