modm API documentation
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
modm::GpioIO Class Reference
Architecture Interfaces » General Purpose Input/Output

#include <modm/architecture/interface/gpio.hpp>

Inheritance diagram for modm::GpioIO:
modm::GpioOutput modm::GpioInput modm::Gpio modm::Gpio modm::GpioExpanderPin< GpioExpander, expander, pin > modm::platform::GpioStatic< detail::DataUnused >

Public Types

enum  Direction { In = 0, Out = 1, InOut = 2, Special = 3 }
 Declares the direction of a GPIO.
 
enum  Direction { In = 0, Out = 1, InOut = 2, Special = 3 }
 Declares the direction of a GPIO.
 

Static Public Member Functions

static Direction getDirection ()
 returns the pin direction at run-time
 
static bool isSet ()
 
static void reset ()
 set output to low level
 
static void set ()
 set output to high level
 
static void set (bool value)
 set output to high or low level
 
static void setOutput ()
 configure pin as output
 
static void setOutput (bool value)
 configure pin as output and set high or low
 
static void toggle ()
 toggle output level
 
static bool read ()
 read input
 
static void setInput ()
 configure pin as input
 

Static Public Attributes

static constexpr Direction direction = Direction::InOut
 Declares the Pin direction.
 
static constexpr bool High = true
 
static constexpr bool Low = false
 
static constexpr Direction direction = Direction::Out
 Declares the Pin direction.
 
static constexpr bool High = true
 
static constexpr bool Low = false
 

Detailed Description

Input/Output interface of an I/O pin.

Member Function Documentation

static bool modm::GpioOutput::isSet ( )
inheritedstatic

Returns the set logical output state of the pin. This may be different from the physical state!

Member Data Documentation

constexpr bool modm::Gpio::Low = false
inheritedstaticconstexpr

These constants refer to the logical state of the GPIO. The physical state is determined by the configuration and external connection.

constexpr bool modm::Gpio::Low = false
inheritedstaticconstexpr

These constants refer to the logical state of the GPIO. The physical state is determined by the configuration and external connection.

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