Damian Gabino / picoGW_mcu

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.

Embed: (wiki syntax)

« Back to documentation index

DigitalInOut Class Reference
Public Member Functions

DigitalInOut Class Reference

A digital input/output, used for setting or reading a bi-directional pin. More...

#include <DigitalInOut.h>

Public Member Functions

 DigitalInOut (PinName pin)
 Create a DigitalInOut connected to the specified pin.
 DigitalInOut (PinName pin, PinDirection direction, PinMode mode, int value)
 Create a DigitalInOut connected to the specified pin.
void write (int value)
 Set the output, specified as 0 or 1 (int)
int read ()
 Return the output setting, represented as 0 or 1 (int)
void output ()
 Set as an output.
void input ()
 Set as an input.
void mode (PinMode pull)
 Set the input pin mode.
int is_connected ()
 Return the output setting, represented as 0 or 1 (int)
DigitalInOut & operator= (int value)
 A shorthand for write()
 operator int ()
 A shorthand for read()
 DigitalInOut (PinName pin)
 Create a DigitalInOut connected to the specified pin.
 DigitalInOut (PinName pin, PinDirection direction, PinMode mode, int value)
 Create a DigitalInOut connected to the specified pin.
void write (int value)
 Set the output, specified as 0 or 1 (int)
int read ()
 Return the output setting, represented as 0 or 1 (int)
void output ()
 Set as an output.
void input ()
 Set as an input.
void mode (PinMode pull)
 Set the input pin mode.
int is_connected ()
 Return the output setting, represented as 0 or 1 (int)
DigitalInOut & operator= (int value)
 A shorthand for write()
 operator int ()
 A shorthand for read()

Detailed Description

A digital input/output, used for setting or reading a bi-directional pin.

Synchronization level: Interrupt safe

Definition at line 30 of file mbed-dev/api/DigitalInOut.h.

Constructor & Destructor Documentation

DigitalInOut ( PinName  pin )

Create a DigitalInOut connected to the specified pin.

Parameters:
pinDigitalInOut pin to connect to

Definition at line 37 of file mbed-dev/api/DigitalInOut.h.

DigitalInOut ( PinName  pin,
PinDirection  direction,
PinMode  mode,
int  value 
)

Create a DigitalInOut connected to the specified pin.

Parameters:
pinDigitalInOut pin to connect to
directionthe initial direction of the pin
modethe initial mode of the pin
valuethe initial value of the pin if is an output

Definition at line 49 of file mbed-dev/api/DigitalInOut.h.

DigitalInOut ( PinName  pin )

Create a DigitalInOut connected to the specified pin.

Parameters:
pinDigitalInOut pin to connect to

Definition at line 37 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

DigitalInOut ( PinName  pin,
PinDirection  direction,
PinMode  mode,
int  value 
)

Create a DigitalInOut connected to the specified pin.

Parameters:
pinDigitalInOut pin to connect to
directionthe initial direction of the pin
modethe initial mode of the pin
valuethe initial value of the pin if is an output

Definition at line 49 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

Member Function Documentation

void input (  )

Set as an input.

Definition at line 85 of file mbed-dev/api/DigitalInOut.h.

void input (  )

Set as an input.

Definition at line 85 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

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 107 of file mbed-dev/api/DigitalInOut.h.

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 107 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 95 of file mbed-dev/api/DigitalInOut.h.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 95 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

operator int (  )

A shorthand for read()

Definition at line 129 of file mbed-dev/api/DigitalInOut.h.

operator int (  )

A shorthand for read()

Definition at line 129 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

DigitalInOut& operator= ( int  value )

A shorthand for write()

Definition at line 114 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

DigitalInOut& operator= ( int  value )

A shorthand for write()

Definition at line 114 of file mbed-dev/api/DigitalInOut.h.

void output (  )

Set as an output.

Definition at line 77 of file mbed-dev/api/DigitalInOut.h.

void output (  )

Set as an output.

Definition at line 77 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

int read (  )

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

Returns:
an integer representing the output setting of the pin if it is an output, or read the input if set as an input

Definition at line 70 of file mbed-dev/api/DigitalInOut.h.

int read ( void   )

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

Returns:
an integer representing the output setting of the pin if it is an output, or read the input if set as an input

Definition at line 70 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

void write ( int  value )

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

Definition at line 59 of file mbed-dev/api/DigitalInOut.h.

void write ( int  value )

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

Definition at line 59 of file usb_cdc/mbed-dev/api/DigitalInOut.h.

Generated on Tue Jul 12 2022 22:19:22 by  doxygen 1.7.2