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

#include <DigitalOut.h>

Public Member Functions
	DigitalOut (PinName pin)
	Create a DigitalOut connected to the specified pin. More...

	DigitalOut (PinName pin, int value)
	Create a DigitalOut connected to the specified pin. More...

void	write (int value)
	Set the output, specified as 0 or 1 (int) More...

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

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

DigitalOut &	operator= (int value)
	A shorthand for write() More...

DigitalOut &	operator= (DigitalOut &rhs)
	A shorthand for write() using the assignment operator which copies the state from the DigitalOut argument. More...

	operator int ()
	A shorthand for read() More...

Detailed Description

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

Note: Synchronization level: Interrupt safe

Example:

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

Definition at line 47 of file DigitalOut.h.

Constructor & Destructor Documentation

DigitalOut ( PinName pin )

Create a DigitalOut connected to the specified pin.

Parameters

pin	DigitalOut pin to connect to

Definition at line 54 of file DigitalOut.h.

DigitalOut	(	PinName	pin,
		int	value
	)

Create a DigitalOut connected to the specified pin.

Parameters

pin	DigitalOut pin to connect to
value	the initial pin value

Definition at line 65 of file DigitalOut.h.

Member Function Documentation

int is_connected ( )

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

Returns: Non zero value if pin is connected to uc GPIO 0 if gpio object was initialized with NC

Definition at line 100 of file DigitalOut.h.

operator int ( )

A shorthand for read()

See also: DigitalOut::read()
DigitalIn button(BUTTON1);
DigitalOut led(LED1);
led = button; // Equivalent to led.write(button.read())

Definition at line 141 of file DigitalOut.h.

DigitalOut& operator= ( int value )

A shorthand for write()

See also: DigitalOut::write()
DigitalIn button(BUTTON1);
DigitalOut led(LED1);
led = button; // Equivalent to led.write(button.read())

Definition at line 114 of file DigitalOut.h.

DigitalOut& operator= ( DigitalOut & rhs )

A shorthand for write() using the assignment operator which copies the state from the DigitalOut argument.

See also: DigitalOut::write()

Definition at line 125 of file DigitalOut.h.

int read ( )

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

Definition at line 88 of file DigitalOut.h.

void write ( int value )

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

Parameters

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

Definition at line 76 of file DigitalOut.h.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Important Information for this Arm website