digitalPin_t Class Reference

A class for input pin operations. More...

#include <digitalPin.h>

Public Member Functions
void	setPin (uint8_t pin, uint8_t mode) noexcept
	Set the input pin.
bool	isValid (void) const
	Is the pin set?
bool	isPinHigh (void) const noexcept
	Check if the pin is set high.
bool	isPinLow (void) const noexcept
	Check if the pin is set low.
void	setPinHigh (void) noexcept
	Set the pin high.
void	setPinLow (void) noexcept
	Set the pin low.

Detailed Description

A class for input pin operations.

Call setPin() to initialize the pin, then call isPinHigh() to check if the pin is set high.

Note

Must have same signature as fastInputPin_t to allow for interchangeable use.

Member Function Documentation

isPinHigh()

bool digitalPin_t::isPinHigh ( void  ) const

noexcept

Check if the pin is set high.

Here is the caller graph for this function:

isPinLow()

bool digitalPin_t::isPinLow ( void  ) const

inlinenoexcept

Check if the pin is set low.

Here is the call graph for this function:

Here is the caller graph for this function:

isValid()

bool digitalPin_t::isValid ( void  ) const

inline

Is the pin set?

Here is the caller graph for this function:

setPin()

void digitalPin_t::setPin ( uint8_t  pin, uint8_t  mode  )

noexcept

Set the input pin.

Here is the caller graph for this function:

setPinHigh()

void digitalPin_t::setPinHigh ( void  )

noexcept

Set the pin high.

Here is the caller graph for this function:

setPinLow()

void digitalPin_t::setPinLow ( void  )

noexcept

Set the pin low.

Here is the caller graph for this function:

---

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

• speeduino/src/pins/digitalPin.h
• speeduino/src/pins/digitalPin.cpp