mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

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()
 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 56 of file cmsis/BUILD/mbed/drivers/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 64 of file cmsis/BUILD/mbed/drivers/PortIn.h.

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 64 of file drivers/PortIn.h.

Member Function Documentation

void mode ( PinMode  mode )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 85 of file cmsis/BUILD/mbed/drivers/PortIn.h.

void mode ( PinMode  mode )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 85 of file drivers/PortIn.h.

operator int (  )

A shorthand for read()

Definition at line 94 of file drivers/PortIn.h.

operator int (  )

A shorthand for read()

Definition at line 94 of file cmsis/BUILD/mbed/drivers/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 76 of file drivers/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 76 of file cmsis/BUILD/mbed/drivers/PortIn.h.

Generated on Tue Jul 12 2022 20:41:17 by  doxygen 1.7.2