mbed-drivers
Public Member Functions | List of all members
mbed::PortOut Class Reference

#include <PortOut.h>

Public Member Functions

 PortOut (PortName port, int mask=0xFFFFFFFF)
 
void write (int value)
 
int read ()
 
PortOutoperator= (int value)
 
PortOutoperator= (PortOut &rhs)
 
 operator int ()
 

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);
}
}

Constructor & Destructor Documentation

mbed::PortOut::PortOut ( PortName  port,
int  mask = 0xFFFFFFFF 
)
inline

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)

Member Function Documentation

mbed::PortOut::operator int ( )
inline

A shorthand for read()

PortOut& mbed::PortOut::operator= ( int  value)
inline

A shorthand for write()

int mbed::PortOut::read ( )
inline

Read the value currently output on the port

Returns
An integer with each bit corresponding to associated PortOut pin setting
void mbed::PortOut::write ( int  value)
inline

Write the value to the output port

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

The documentation for this class was generated from the following file: