Steve Kim / mbed-src

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.

Dependents:   AsyncPrint

Fork of mbed-src by mbed official

Embed: (wiki syntax)

« Back to documentation index

PortOut Class Reference
Public Member Functions

PortOut Class Reference

A multiple pin digital out. More...

#include <PortOut.h>

Public Member Functions

 PortOut (PortName port, int mask=0xFFFFFFFF)
 Create an PortOut, connected to the specified port.
void write (int value)
 Write the value to the output port.
int read ()
 Read the value currently output on the port.
PortOut & operator= (int value)
 A shorthand for write()
 operator int ()
 A shorthand for read()

Detailed Description

A multiple pin digital out.

Example: 

 // Toggle all four LEDs

 #include "mbed.h"

 // LED1 = P1.18  LED2 = P1.20  LED3 = P1.21  LED4 = P1.23
 #define LED_MASK 0x00B40000

 PortOut ledport(Port1, LED_MASK);

 int main() {
     while(1) {
         ledport = LED_MASK;
         wait(1);
         ledport = 0;
         wait(1);
     }
 }

Definition at line 49 of file PortOut.h.

Constructor & Destructor Documentation

PortOut ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create an PortOut, 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 57 of file PortOut.h.

Member Function Documentation

operator int (  )

A shorthand for read()

Definition at line 92 of file PortOut.h.

PortOut& operator= ( int  value )

A shorthand for write()

Definition at line 80 of file PortOut.h.

int read ( void   )

Read the value currently output on the port.

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

Definition at line 74 of file PortOut.h.

void write ( int  value )

Write the value to the output port.

Parameters:
valueAn integer specifying a bit to write for every corresponding PortOut pin

Definition at line 65 of file PortOut.h.

Generated on Tue Jul 12 2022 16:30:33 by  doxygen 1.7.2