MapAverager Class Reference

#include <map_averaging.h>

Inheritance diagram for MapAverager:

Collaboration diagram for MapAverager:

Public Member Functions
	MapAverager (SensorType type, efidur_t timeout)
void	start (uint8_t cylinderNumber)
void	stop ()
SensorResult	submit (float sensorVolts)
void	setFunction (SensorConverter &func)
void	showInfo (const char *sensorName) const override
Public Member Functions inherited from StoredValueSensor
SensorResult	get () const final override
	StoredValueSensor (SensorType type, efidur_t timeoutNt)
void	invalidate ()
void	invalidate (UnexpectedCode why)
void	setValidValue (float value, efitick_t timestamp)
void	showInfo (const char *sensorName) const override
virtual void	setTimeout (int timeoutMs)
Public Member Functions inherited from Sensor
bool	Register ()
const char *	getSensorName () const
virtual bool	hasSensor () const
virtual float	getRaw () const
virtual bool	isRedundant () const
void	unregister ()
SensorType	type () const

Private Attributes
SensorConverter *	m_function = nullptr
bool	m_isAveraging = false
size_t	m_counter = 0
size_t	m_lastCounter = 0
float	m_sum = 0
uint8_t	m_cylinderNumber = 0

Additional Inherited Members
Static Public Member Functions inherited from Sensor
static void	showAllSensorInfo ()
static void	showInfo (SensorType type)
static void	resetRegistry ()
static const Sensor *	getSensorOfType (SensorType type)
static SensorResult	get (SensorType type)
static float	getOrZero (SensorType type)
static float	getRaw (SensorType type)
static bool	isRedundant (SensorType type)
static bool	hasSensor (SensorType type)
static void	setMockValue (SensorType type, float value, bool mockRedundant=false)
static void	setInvalidMockValue (SensorType type)
static void	resetMockValue (SensorType type)
static void	resetAllMocks ()
static void	inhibitTimeouts (bool inhibit)
static const char *	getSensorName (SensorType type)
Protected Member Functions inherited from Sensor
	Sensor (SensorType type)
Static Protected Attributes inherited from Sensor
static bool	s_inhibitSensorTimeouts = false

Detailed Description

Definition at line 35 of file map_averaging.h.

Constructor & Destructor Documentation

MapAverager()

MapAverager::MapAverager ( SensorType  type, efidur_t  timeout  )

inline

Definition at line 37 of file map_averaging.h.

        : StoredValueSensor(type, timeout)
    {
    }

Member Function Documentation

setFunction()

void MapAverager::setFunction ( SensorConverter &  func )

inline

Definition at line 47 of file map_averaging.h.

                                            {
        m_function = &func;
    }

Referenced by initMap().

Here is the caller graph for this function:

showInfo()

void MapAverager::showInfo ( const char *  sensorName ) const

overridevirtual

Implements Sensor.

Definition at line 82 of file sensor_info_printing.cpp.

                                                       {
    const auto value = get();
    efiPrintf("Sensor \"%s\" is MAP averager: valid: %s value: %.2f averaged sample count: %d", sensorName, boolToString(value.Valid), value.Value, m_lastCounter);
}

Here is the call graph for this function:

start()

void MapAverager::start

(

uint8_t

cylinderNumber

)

Definition at line 74 of file map_averaging.cpp.

                                              {
    chibios_rt::CriticalSectionLocker csl;
 
    m_counter = 0;
    m_sum = 0;
    m_isAveraging = true;
    m_cylinderNumber = cylinderNumber;
}

stop()

void MapAverager::stop

(

)

Definition at line 104 of file map_averaging.cpp.

                       {
    chibios_rt::CriticalSectionLocker csl;
 
    m_isAveraging = false;
 
    if (m_counter > 0) {
        float averageMap = m_sum / m_counter;
        m_lastCounter = m_counter;
 
        // TODO: this should be per-sensor, not one for all MAP sensors
        averagedMapRunningBuffer[averagedMapBufIdx] = averageMap;
        // increment circular running buffer index
        averagedMapBufIdx = (averagedMapBufIdx + 1) % mapMinBufferLength;
        // find min. value (only works for pressure values, not raw voltages!)
        float minPressure = averagedMapRunningBuffer[0];
        for (int i = 1; i < mapMinBufferLength; i++) {
            if (averagedMapRunningBuffer[i] < minPressure)
                minPressure = averagedMapRunningBuffer[i];
        }
 
    engine->outputChannels.mapPerCylinder[m_cylinderNumber] = minPressure;
        setValidValue(filterMapValue(minPressure), getTimeNowNt());
    } else {
#if EFI_PROD_CODE
        warning(ObdCode::CUSTOM_UNEXPECTED_MAP_VALUE, "No MAP values to average");
#endif
    }
}

Referenced by endAveraging().

Here is the call graph for this function:

Here is the caller graph for this function:

submit()

SensorResult MapAverager::submit

(

float

sensorVolts

)

Definition at line 83 of file map_averaging.cpp.

                                            {
    auto result = m_function ? m_function->convert(volts) : unexpected;
 
    if (m_isAveraging && result) {
        chibios_rt::CriticalSectionLocker csl;
 
        m_counter++;
        m_sum += result.Value;
    }
 
    return result;
}

Referenced by mapAveragingAdcCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

m_counter

size_t MapAverager::m_counter = 0

private

Definition at line 57 of file map_averaging.h.

Referenced by start(), stop(), and submit().

m_cylinderNumber

uint8_t MapAverager::m_cylinderNumber = 0

private

Definition at line 60 of file map_averaging.h.

Referenced by start(), and stop().

m_function

SensorConverter* MapAverager::m_function = nullptr

private

Definition at line 54 of file map_averaging.h.

Referenced by setFunction(), and submit().

m_isAveraging

bool MapAverager::m_isAveraging = false

private

Definition at line 56 of file map_averaging.h.

Referenced by start(), stop(), and submit().

m_lastCounter

size_t MapAverager::m_lastCounter = 0

private

Definition at line 58 of file map_averaging.h.

Referenced by showInfo(), and stop().

m_sum

float MapAverager::m_sum = 0

private

Definition at line 59 of file map_averaging.h.

Referenced by start(), stop(), and submit().

---

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

• controllers/modules/map_averaging/map_averaging.h
• controllers/modules/map_averaging/map_averaging.cpp
• controllers/sensors/sensor_info_printing.cpp