#include <debounce.h>

Collaboration diagram for ButtonDebounce:

[legend]

Public Member Functions
	ButtonDebounce (const char *name)

void	init (efitimems_t threshold, brain_pin_e &pin, pin_input_mode_e &mode, bool inverted=false)

void	stopConfiguration ()

void	startConfiguration ()

bool	readPinEvent ()

bool	readPinState ()

bool	readPinState2 (bool valueWithinThreshold)

bool	getPhysicalState ()

Static Public Member Functions
static void	stopConfigurationList ()

static void	startConfigurationList ()

static void	debug ()

static void	resetForUnitTests ()

Private Attributes
const char *const	m_name

efidur_t	m_threshold

Timer	timeLast

brain_pin_e *	m_pin

brain_pin_e	active_pin = Gpio::Unassigned

pin_input_mode_e *	m_mode

pin_input_mode_e	active_mode = PI_DEFAULT

bool	storedValue = false

bool	m_inverted = false

bool	isInstanceRegisteredInGlobalList = false

bool	needsPinInitialization = true

ButtonDebounce *	nextDebounce = nullptr

Static Private Attributes
static ButtonDebounce *	s_firstDebounce = nullptr

Detailed Description

Definition at line 16 of file debounce.h.

Constructor & Destructor Documentation

◆ ButtonDebounce()

ButtonDebounce::ButtonDebounce ( const char * name )

explicit

Definition at line 15 of file debounce.cpp.

    : m_name(name)
{
}

Member Function Documentation

◆ debug()

static void ButtonDebounce::debug ( )

static

Referenced by stopConfiguration().

Here is the caller graph for this function:

◆ getPhysicalState()

bool ButtonDebounce::getPhysicalState ( )

Referenced by slowStartStopButtonCallback(), and stopConfiguration().

Here is the caller graph for this function:

◆ init()

void ButtonDebounce::init	(	efitimems_t	threshold,
		brain_pin_e &	pin,
		pin_input_mode_e &	mode,
		bool	inverted = `false`
	)

We need to have a separate init function because we do not have the pin or mode in the context in which the class is originally created

Definition at line 23 of file debounce.cpp.

                                                                                                         {
   // we need to keep track of whether we have already been initialized due to the way unit tests run.
    if (!isInstanceRegisteredInGlobalList) {
    // Link us to the list that is used to track ButtonDebounce instances, so that when the configuration changes,
    //  they can be looped through and updated.
        nextDebounce = s_firstDebounce;
        s_firstDebounce = this;
    }
    m_threshold = MS2NT(threshold);
    m_pin = &pin;
    m_mode = &mode;
    m_inverted = inverted;
    startConfiguration();
    isInstanceRegisteredInGlobalList = true;
}

Referenced by ButtonShiftController::init(), initSensors(), and initStartStopButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readPinEvent()

bool ButtonDebounce::readPinEvent ( )

Referenced by slowStartStopButtonCallback(), stopConfiguration(), and ButtonShiftController::update().

Here is the caller graph for this function:

◆ readPinState()

bool ButtonDebounce::readPinState ( )

Referenced by getAcToggle(), and stopConfiguration().

Here is the caller graph for this function:

◆ readPinState2()

bool ButtonDebounce::readPinState2 ( bool valueWithinThreshold )

Referenced by stopConfiguration().

Here is the caller graph for this function:

◆ resetForUnitTests()

static void ButtonDebounce::resetForUnitTests ( )

inlinestatic

Definition at line 30 of file debounce.h.

                                    {
      s_firstDebounce = nullptr;
    }

◆ startConfiguration()

void ButtonDebounce::startConfiguration ( )

Referenced by init(), startConfigurationList(), and stopConfiguration().

Here is the caller graph for this function:

◆ startConfigurationList()

void ButtonDebounce::startConfigurationList ( )

static

Definition at line 49 of file debounce.cpp.

                                            {
    ButtonDebounce *listItem = s_firstDebounce;
    int loopLimitCounter = 0;
    while (listItem != nullptr) {
        criticalAssertVoid(loopLimitCounter++ < 10000, "dead startConfigurationList?");
        listItem->startConfiguration();
        listItem = listItem->nextDebounce;
    }
}

Referenced by applyNewHardwareSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stopConfiguration()

void ButtonDebounce::stopConfiguration ( )

Returns: true if the button is pressed, and will not return true again within the set timeout

Definition at line 59 of file debounce.cpp.

Referenced by stopConfigurationList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stopConfigurationList()

void ButtonDebounce::stopConfigurationList ( )

static

Definition at line 39 of file debounce.cpp.

                                           {
    ButtonDebounce *listItem = s_firstDebounce;
    int loopLimitCounter = 0;
    while (listItem != nullptr) {
        criticalAssertVoid(loopLimitCounter++ < 10000, "dead stopConfigurationList?");
        listItem->stopConfiguration();
        listItem = listItem->nextDebounce;
    }
}