Kev Mann / mbed-dev-OS5_10_4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

PortIn Class Reference
Public Member Functions

PortIn Class Reference
[Drivers]

A multiple pin digital input. More...

#include <PortIn.h>

Public Member Functions

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

Detailed Description

A multiple pin digital input.

Note:
Synchronization level: Interrupt safe

Example: 

 // Turn on an LED if any pins of Port2[0:5] are high

 #include "mbed.h"

 PortIn     p(Port2, 0x0000003F);  // Port2 pins [0:5] only
 DigitalOut led(LED4);

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

Definition at line 55 of file PortIn.h.

Constructor & Destructor Documentation

PortIn ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create a PortIn, connected to the specified port.

Parameters:
portPort to connect to (as defined in target's PortNames.h)
maskBitmask defines which port pins should be an input (0 - ignore, 1 - include)

Definition at line 63 of file PortIn.h.

Member Function Documentation

void mode ( PinMode  mode )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 84 of file PortIn.h.

operator int (  )

A shorthand for read()

Definition at line 93 of file PortIn.h.

int read ( void   )

Read the value input to the port.

Returns:
An integer with each bit corresponding to the associated pin value

Definition at line 75 of file PortIn.h.

Generated on Tue Jul 12 2022 20:53:14 by  doxygen 1.7.2