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.
DigitalInOut Class Reference
[Drivers]
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() | |
| DigitalInOut & | operator= (DigitalInOut &rhs) |
| 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.
- Note:
- Synchronization level: Interrupt safe
Definition at line 32 of file DigitalInOut.h.
Constructor & Destructor Documentation
| DigitalInOut | ( | PinName | pin ) |
Create a DigitalInOut connected to the specified pin.
- Parameters:
-
pin DigitalInOut pin to connect to
Definition at line 39 of file DigitalInOut.h.
| DigitalInOut | ( | PinName | pin, |
| PinDirection | direction, | ||
| PinMode | mode, | ||
| int | value | ||
| ) |
Create a DigitalInOut connected to the specified pin.
- Parameters:
-
pin DigitalInOut pin to connect to direction the initial direction of the pin mode the initial mode of the pin value the initial value of the pin if is an output
Definition at line 52 of file DigitalInOut.h.
Member Function Documentation
| void input | ( | ) |
Set as an input.
Definition at line 92 of file 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 116 of file DigitalInOut.h.
| void mode | ( | PinMode | pull ) |
Set the input pin mode.
- Parameters:
-
pull PullUp, PullDown, PullNone, OpenDrain
Definition at line 103 of file DigitalInOut.h.
| operator int | ( | ) |
| DigitalInOut& operator= | ( | int | value ) |
A shorthand for write()
- See also:
- DigitalInOut::write()
Definition at line 125 of file DigitalInOut.h.
| DigitalInOut& operator= | ( | DigitalInOut & | rhs ) |
A shorthand for write()
- See also:
- DigitalInOut::write()
Definition at line 135 of file DigitalInOut.h.
| void output | ( | ) |
Set as an output.
Definition at line 83 of file 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 75 of file DigitalInOut.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 63 of file DigitalInOut.h.
Generated on Tue Aug 9 2022 00:37:38 by
1.7.2