#include <engine_parts.h>

Collaboration diagram for WarningCodeState:

[legend]

Public Member Functions
	WarningCodeState ()

void	addWarningCode (ObdCode code, const char *text=nullptr)

bool	isWarningNow () const

bool	isWarningNow (ObdCode code) const

bool	hasWarningMessage ()

const char *	getWarningMessage ()

void	refreshTs ()

void	clear ()

Data Fields
int	warningCounter

ObdCode	lastErrorCode = ObdCode::None

const char *	description

Timer	timeSinceLastWarning

critical_msg_t	m_msg

warning_t *	m_msgWarning = nullptr

warningBuffer_t	recentWarnings

Detailed Description

Definition at line 55 of file engine_parts.h.

Constructor & Destructor Documentation

◆ WarningCodeState()

WarningCodeState::WarningCodeState ( )

Definition at line 28 of file engine2.cpp.

                                   {
    clear();
}

Here is the call graph for this function:

Member Function Documentation

◆ addWarningCode()

void WarningCodeState::addWarningCode	(	ObdCode	code,
		const char *	text = `nullptr`
	)

Definition at line 38 of file engine2.cpp.

                                                                    {
    warningCounter++;
    lastErrorCode = code;
 
    warning_t* existing = recentWarnings.find(code);
    if (!existing) {
        chibios_rt::CriticalSectionLocker csl;
 
        // Add the code to the list
        existing = recentWarnings.add(warning_t(code));
    }
 
    if (existing) {
        // Reset the timer on the code to now
        existing->LastTriggered.reset();
 
        // no pending message? lets try to add this
        if ((m_msgWarning == nullptr) && (text)) {
            strlncpy(m_msg, text, sizeof(m_msg));
            m_msgWarning = existing;
        }
    }
 
    // Reset the "any warning" timer too
    timeSinceLastWarning.reset();
}

Referenced by firmwareErrorV(), and warningVA().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void WarningCodeState::clear ( )

Definition at line 32 of file engine2.cpp.

                             {
    warningCounter = 0;
    lastErrorCode = ObdCode::None;
    recentWarnings.clear();
}

Referenced by WarningCodeState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWarningMessage()

const char * WarningCodeState::getWarningMessage ( )

Definition at line 107 of file engine2.cpp.

                                                {
    return m_msg;
}

Referenced by handleGetConfigErorr().

Here is the caller graph for this function:

◆ hasWarningMessage()

bool WarningCodeState::hasWarningMessage ( )

Definition at line 102 of file engine2.cpp.

                                         {
    // Do we have any error code to show as text?
    return (m_msgWarning != nullptr);
}

Referenced by updateTunerStudioState().

Here is the caller graph for this function:

◆ isWarningNow() [1/2]

bool WarningCodeState::isWarningNow ( ) const

Parameters

forIndicator if we want to retrieving value for TS indicator, this case a minimal period is applued

Definition at line 114 of file engine2.cpp.

                                          {
    int period = maxI(3, engineConfiguration->warningPeriod);
 
    return !timeSinceLastWarning.hasElapsedSec(period);
}

Referenced by updateTunerStudioState(), and warningVA().

Here is the caller graph for this function:

◆ isWarningNow() [2/2]

bool WarningCodeState::isWarningNow ( ObdCode code ) const

Definition at line 121 of file engine2.cpp.

                                                      {
    warning_t* warn = recentWarnings.find(code);
 
    // No warning found at all
    if (!warn) {
        return false;
    }
 
    // If the warning is old, it is not active
    return !warn->LastTriggered.hasElapsedSec(maxI(3, engineConfiguration->warningPeriod));
}

Here is the call graph for this function:

◆ refreshTs()

void WarningCodeState::refreshTs ( )

Definition at line 65 of file engine2.cpp.

                                 {
    TunerStudioOutputChannels *tsOutputChannels = &engine->outputChannels;
    const int period = maxI(3, engineConfiguration->warningPeriod);
 
    // TODO: do we neet this sticky warning code?
    tsOutputChannels->warningCounter = engine->engineState.warnings.warningCounter;
    tsOutputChannels->lastErrorCode = static_cast<uint16_t>(engine->engineState.warnings.lastErrorCode);
 
    // TODO: fix OBD codes "jumping" between positions when one of codes disapears
 
    size_t i = 0;
    for (size_t j = 0; j < recentWarnings.getCount(); j++) {
        warning_t& warn = recentWarnings.get(j);
        if (warn.Code != ObdCode::None) {
            if (!warn.LastTriggered.hasElapsedSec(period)) {
                if (i < efi::size(tsOutputChannels->recentErrorCode)) {
                    tsOutputChannels->recentErrorCode[i] = static_cast<uint16_t>(warn.Code);
                    i++;
                }
            } else {
                // warning message is outdated, stop showing to TS
                if (m_msgWarning == &warn) {
                    m_msg[0] = 0;
                    m_msgWarning = nullptr;
                }
                // TODO:
                // reset warning as it is outdated
            }
        }
    }
 
    // reset rest
    for ( ; i < efi::size(tsOutputChannels->recentErrorCode); i++) {
        tsOutputChannels->recentErrorCode[i] = 0;
    }
}