port_pin_t Struct Reference

A structure to support direct port manipulation. More...

#include <port_pin.h>

Public Member Functions
	port_pin_t ()=default
	port_pin_t (uint8_t pinNum, uint8_t mode)
	Construct from a pin number.
bool	isValid (void) const
	Is the port register initialised?
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 structure to support direct port manipulation.

See also

https://docs.arduino.cc/retired/hacking/software/PortManipulation/

Constructor & Destructor Documentation

port_pin_t() [1/2]

port_pin_t::port_pin_t ( )

default

port_pin_t() [2/2]

port_pin_t::port_pin_t	(	uint8_t	pinNum,
		uint8_t	mode
	)

Construct from a pin number.

Member Function Documentation

isPinHigh()

bool port_pin_t::isPinHigh ( void  ) const

inlinenoexcept

Check if the pin is set high.

isPinLow()

bool port_pin_t::isPinLow ( void  ) const

inlinenoexcept

Check if the pin is set low.

isValid()

bool port_pin_t::isValid ( void  ) const

inline

Is the port register initialised?

setPinHigh()

void port_pin_t::setPinHigh ( void  )

noexcept

Set the pin high.

setPinLow()

void port_pin_t::setPinLow ( void  )

noexcept

Set the pin low.

---

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

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