DigitalPin< PinNumber > Class Template Reference

Fast digital port I/O. More...

#include <softspi.h>

Public Member Functions
	DigitalPin ()
	DigitalPin (bool pinMode)
	DigitalPin (bool mode, bool level)
FORCE_INLINE DigitalPin &	operator= (bool value)
FORCE_INLINE	operator bool () const
FORCE_INLINE void	config (bool mode, bool level)
FORCE_INLINE void	high ()
FORCE_INLINE void	low ()
FORCE_INLINE void	mode (bool pinMode)
FORCE_INLINE bool	read () const
FORCE_INLINE void	toggle ()
FORCE_INLINE void	write (bool value)

Detailed Description

template<uint8_t PinNumber>
class DigitalPin< PinNumber >

Fast digital port I/O.

Constructor & Destructor Documentation

DigitalPin() [1/3]

template<uint8_t PinNumber>

DigitalPin< PinNumber >::DigitalPin

(

)

Constructor

{}

DigitalPin() [2/3]

template<uint8_t PinNumber>

DigitalPin< PinNumber >::DigitalPin ( bool  pinMode )

explicit

Constructor

Parameters

[in]

pinMode

if true set output mode else input mode.

{ mode(pinMode); }

Here is the call graph for this function:

DigitalPin() [3/3]

template<uint8_t PinNumber>

DigitalPin< PinNumber >::DigitalPin	(	bool	mode,
		bool	level
	)

Constructor

Parameters

[in]	mode	If true set output mode else input mode
[in]	level	If mode is output, set level high/low. If mode is input, enable or disable the pin's 20K pullup.

{ config(mode, level); }

Here is the call graph for this function:

Member Function Documentation

operator=()

template<uint8_t PinNumber>

FORCE_INLINE DigitalPin& DigitalPin< PinNumber >::operator=

(

bool

value

)

Assignment operator

Parameters

[in]

value

If true set the pin's level high else set the pin's level low.

Returns

This DigitalPin instance.

{ write(value); return *this; }

Here is the call graph for this function:

operator bool()

template<uint8_t PinNumber>

FORCE_INLINE DigitalPin< PinNumber >::operator bool

(

)

const

Parentheses operator

Returns

Pin's level

{ return read(); }

Here is the call graph for this function:

config()

template<uint8_t PinNumber>

FORCE_INLINE void DigitalPin< PinNumber >::config	(	bool	mode,
		bool	level
	)

Set pin configuration

Parameters

[in]	mode	If true set output mode else input mode
[in]	level	If mode is output, set level high/low. If mode is input, enable or disable the pin's 20K pullup.

{ fastPinConfig(PinNumber, mode, level); }

Here is the call graph for this function:

Here is the caller graph for this function:

high()

template<uint8_t PinNumber>

FORCE_INLINE void DigitalPin< PinNumber >::high

(

)

Set pin level high if output mode or enable 20K pullup if input mode.

{ write(true); }

Here is the call graph for this function:

low()

template<uint8_t PinNumber>

FORCE_INLINE void DigitalPin< PinNumber >::low

(

)

Set pin level low if output mode or disable 20K pullup if input mode.

{ write(false); }

Here is the call graph for this function:

mode()

template<uint8_t PinNumber>

FORCE_INLINE void DigitalPin< PinNumber >::mode

(

bool

pinMode

)

Set pin mode

Parameters

[in]

pinMode

if true set output mode else input mode.

mode() does not enable or disable the 20K pullup for input mode.

{ fastPinMode(PinNumber, pinMode); }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

template<uint8_t PinNumber>

FORCE_INLINE bool DigitalPin< PinNumber >::read

(

void

)

const

Returns

Pin's level

{ return fastDigitalRead(PinNumber); }

Here is the call graph for this function:

Here is the caller graph for this function:

toggle()

template<uint8_t PinNumber>

FORCE_INLINE void DigitalPin< PinNumber >::toggle

(

)

Toggle a pin If the pin is in output mode toggle the pin's level. If the pin is in input mode toggle the state of the 20K pullup.

{ fastDigitalToggle(PinNumber); }

Here is the call graph for this function:

write()

template<uint8_t PinNumber>

FORCE_INLINE void DigitalPin< PinNumber >::write

(

bool

value

)

Write the pin's level.

Parameters

[in]

value

If true set the pin's level high else set the pin's level low.

{ fastDigitalWrite(PinNumber, value); }

Here is the call graph for this function:

Here is the caller graph for this function: