mbed-drivers
Public Member Functions | Protected Attributes | List of all members
mbed::DigitalOut Class Reference

#include <DigitalOut.h>

Public Member Functions

 DigitalOut (PinName pin)
 
 DigitalOut (PinName pin, int value)
 
void write (int value)
 
int read ()
 
DigitalOutoperator= (int value)
 
DigitalOutoperator= (DigitalOut &rhs)
 
 operator int ()
 

Protected Attributes

gpio_t gpio
 

Detailed Description

A digital output, used for setting the state of a pin

Example:

// Toggle a LED
#include "mbed.h"
DigitalOut led(LED1);
int main() {
while(1) {
led = !led;
wait(0.2);
}
}

Constructor & Destructor Documentation

mbed::DigitalOut::DigitalOut ( PinName  pin)
inline

Create a DigitalOut connected to the specified pin

Parameters
pinDigitalOut pin to connect to
mbed::DigitalOut::DigitalOut ( PinName  pin,
int  value 
)
inline

Create a DigitalOut connected to the specified pin

Parameters
pinDigitalOut pin to connect to
valuethe initial pin value

Member Function Documentation

mbed::DigitalOut::operator int ( )
inline

A shorthand for read()

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

A shorthand for write()

int mbed::DigitalOut::read ( )
inline

Return the output setting, represented as 0 or 1 (int)

Returns
an integer representing the output setting of the pin, 0 for logical 0, 1 for logical 1
void mbed::DigitalOut::write ( int  value)
inline

Set the output, specified as 0 or 1 (int)

Parameters
valueAn integer specifying the pin output value, 0 for logical 0, 1 (or any other non-zero value) for logical 1

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