#include <AbstractDebouncedButton.h>

Inheritance diagram for AbstractDebouncedButton:

Public Member Functions
	AbstractDebouncedButton ()

void	begin (uint8_t threshold=DefaultThreshold, uint8_t delay=DefaultButtonDelay)

virtual void	update ()=0

bool	pushed (bool peek=false)

uint32_t	tapped (bool peek=false)

bool	held (uint16_t ms=DefaultHeldMs)

bool	repeat (uint16_t initialMs=DefaultButtonRepeatInitialMs, uint16_t repeatMs=DefaultButtonRepeatMs)

void	setState (bool newState)

Public Member Functions inherited from AbstractButton
	AbstractButton ()

virtual void	begin ()

virtual bool	on ()=0

Static Public Attributes
static const uint8_t	DefaultThreshold = 5

static const uint8_t	DefaultButtonDelay = 5

static const uint16_t	DefaultHeldMs = 800

static const uint16_t	DefaultButtonRepeatInitialMs = 700

static const uint16_t	DefaultButtonRepeatMs = 350

Protected Attributes
uint8_t	_threshold

uint8_t	_delay

uint32_t	_lastUpdate

uint8_t	_counter

bool	_state

uint32_t	_lastStateChange

bool	_pushed

uint16_t	_repeatCount

uint32_t	_lastRepeat

uint32_t	_lastOnDuration

Detailed Description

Timeslice-based button with debouncing.

AbstractDebouncedButton reduces / eliminates bouncing (multiple press events registing close together with only one physical press).

Definition at line 11 of file AbstractDebouncedButton.h.

Constructor & Destructor Documentation

◆ AbstractDebouncedButton()

AbstractDebouncedButton::AbstractDebouncedButton ( )

Constructor.

Definition at line 6 of file AbstractDebouncedButton.cpp.

Member Function Documentation

◆ begin()

void AbstractDebouncedButton::begin	(	uint8_t	threshold = `DefaultThreshold`,
		uint8_t	delay = `DefaultButtonDelay`
	)

Initialization.

Parameters

threshold	how many tests of the pin must match for a state change.
delay	number of ms between tests of pin state.

Should be called from setup(), or at any rate, before other members are called. This will set the pinMode. The minimum time it takes for button presses / released to register is threshold * delay.

Definition at line 10 of file AbstractDebouncedButton.cpp.

Here is the call graph for this function:

◆ held()

bool AbstractDebouncedButton::held ( uint16_t ms = DefaultHeldMs )

Test if held on for extended period.

Parameters

ms	time in ms the button has to have been on for to be considered held

Returns: true if the button is pushed and has been for longer than specified time.

Definition at line 34 of file AbstractDebouncedButton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pushed()

bool AbstractDebouncedButton::pushed ( bool peek = false )

Test if the button has been pushed since the last time it was off.

This function returns true once, as soon as the button is pushed - even if it has not been released yet. If the peek parameter is false then subsequent calls to pushed will not return true until the button has been released and pushed again. The idea is to allow frequent tests in a tight loop, and only get one positive result (unlike on(), which returns true any time the button is depressed).

Parameters