ActivationController Class Reference

Controls breathing activation ON/OFF state. More...

#include <activation.h>

Public Member Functions
	ActivationController ()
void	refreshState ()
	Refresh the current state. More...
bool	isRunning () const
	Return if breathing is activated or not. More...
void	changeState (uint16_t state)
	Change the current state. More...
void	onStartButton ()
	Callback to call each time the start button is pushed. More...
void	onStopButton ()
	Callback to call each time the stop button is pushed. More...

Private Types
enum	State { STOPPED = 0 , RUNNING , RUNNING_READY_TO_STOP }

Private Attributes
State	m_state
	Activation status. More...
uint32_t	m_timeOfLastStopPushed
	Last time stop button was pushed. More...

Detailed Description

Controls breathing activation ON/OFF state.

Definition at line 18 of file activation.h.

Member Enumeration Documentation

State

enum ActivationController::State

private

Enumerator
STOPPED	Breathing is OFF.
RUNNING	Breathing is ON.
RUNNING_READY_TO_STOP	Breathing is ON, waiting for a second push to stop.

Definition at line 52 of file activation.h.

               {
        STOPPED = 0,
 
        RUNNING,
 
        RUNNING_READY_TO_STOP,
    };

Constructor & Destructor Documentation

ActivationController()

ActivationController::ActivationController

(

)

Definition at line 25 of file activation.cpp.

: m_state(STOPPED), m_timeOfLastStopPushed(0) {}

Member Function Documentation

changeState()

void ActivationController::changeState

(

uint16_t

state

)

Change the current state.

Parameters

state

New state: 0 = STOPPED, 1 = RUNNING

Definition at line 29 of file activation.cpp.

                                                     {
    if (state == 0u) {
        m_state = STOPPED;
    } else {
        m_state = RUNNING;
    }
}

isRunning()

bool ActivationController::isRunning ( ) const

inline

Return if breathing is activated or not.

Definition at line 32 of file activation.h.

{ return m_state != STOPPED; }

onStartButton()

void ActivationController::onStartButton

(

)

Callback to call each time the start button is pushed.

Definition at line 27 of file activation.cpp.

{ m_state = RUNNING; }

onStopButton()

void ActivationController::onStopButton

(

)

Callback to call each time the stop button is pushed.

Definition at line 37 of file activation.cpp.

                                        {
    if ((m_state == RUNNING_READY_TO_STOP)
        && ((millis() - m_timeOfLastStopPushed) < SECOND_STOP_MAX_DELAY_MS)) {
        m_state = STOPPED;
    } else if ((m_state == RUNNING_READY_TO_STOP) || (m_state == RUNNING)) {
        m_timeOfLastStopPushed = millis();
        m_state = RUNNING_READY_TO_STOP;
    } else {
        // Stay in STOPPED state
    }
}

refreshState()

void ActivationController::refreshState

(

)

Refresh the current state.

Warning

It must be called regularly to protect against time counter overflow

Definition at line 49 of file activation.cpp.

                                        {
    // If the 2nd STOP deadline is exceeded, switch back
    // to running state. This is needed to make sure millis() counter
    // overflow does not make the test invalid
    if ((m_state == RUNNING_READY_TO_STOP)
        && ((millis() - m_timeOfLastStopPushed) >= SECOND_STOP_MAX_DELAY_MS)) {
        m_state = RUNNING;
    }
}

Member Data Documentation

m_state

State ActivationController::m_state

private

Activation status.

Definition at line 64 of file activation.h.

m_timeOfLastStopPushed

uint32_t ActivationController::m_timeOfLastStopPushed

private

Last time stop button was pushed.

Definition at line 67 of file activation.h.

---

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

• includes/activation.h
• srcs/activation.cpp