TripOdometer Class Reference

#include <trip_odometer.h>

Inheritance diagram for TripOdometer:

Collaboration diagram for TripOdometer:

Public Member Functions
void	onSlowCallback () override
void	reset ()
void	consumeFuel (float grams, efitick_t nowNt)
uint32_t	getConsumedGrams () const
float	getConsumedGramsRemainder () const
float	getConsumptionGramPerSecond () const
uint32_t	getDistanceMeters () const
uint32_t	getIgnitionOnTime () const
uint32_t	getEngineRunTime () const
Public Member Functions inherited from EngineModule
virtual void	initNoConfiguration ()
virtual void	setDefaultConfiguration ()
virtual void	onConfigurationChange (engine_configuration_s const *)
virtual void	onFastCallback ()
virtual void	onEngineStop ()
virtual void	onIgnitionStateChanged (bool)
virtual bool	needsDelayedShutoff ()
virtual void	onEnginePhase (float, efitick_t, angle_t, angle_t)

Private Attributes
uint32_t	m_consumedGrams = 0
float	m_consumedRemainder = 0
float	m_rate = 0
uint32_t	m_distanceMeters = 0
float	m_distanceRemainder = 0
uint32_t	m_slowCallbackCounter = 0
uint32_t	m_ignitionOnSeconds = 0
uint32_t	m_engineRunningSeconds = 0
Timer	m_timer

Detailed Description

Definition at line 3 of file trip_odometer.h.

Member Function Documentation

consumeFuel()

void TripOdometer::consumeFuel	(	float	grams,
		efitick_t	nowNt
	)

Definition at line 15 of file trip_odometer.cpp.

                                                           {
// we have some drama with simulator busy loop in reality :(
#if EFI_PROD_CODE || EFI_UNIT_TEST
    m_consumedRemainder += grams;
 
  // 1000grams of fuel between invocations of TripOdometer logic means something very wrong, we do not control cruise ship engines yet!
  if (m_consumedRemainder > 1000) {
    firmwareError(ObdCode::OBD_PCM_Processor_Fault, "m_consumedRemainder busy loop %f %f", m_consumedRemainder, grams);
    return;
  }
    // A racecar with a very large fuel tank might consume 60kg of fuel on a single run of the ECU
    // we use integers to gain dynamic range of about 10^9 which is more than float would give us
    // optimized for lots of small pulses
    while (m_consumedRemainder >= 1) {
        m_consumedRemainder--;
        m_consumedGrams++;
    }
 
    float elapsedSecond = m_timer.getElapsedSecondsAndReset(nowNt);
 
    // If it's been a long time since last injection, ignore this pulse
    if (elapsedSecond > 0.2f) {
        m_rate = 0;
    } else {
        m_rate = grams / elapsedSecond;
    }
#endif // EFI_PROD_CODE || EFI_UNIT_TEST
}

Here is the call graph for this function:

getConsumedGrams()

uint32_t TripOdometer::getConsumedGrams

(

)

const

Definition at line 44 of file trip_odometer.cpp.

                                              {
    return m_consumedGrams;
}

Referenced by configureRusefiLuaHooks().

Here is the caller graph for this function:

getConsumedGramsRemainder()

float TripOdometer::getConsumedGramsRemainder ( ) const

inline

Definition at line 12 of file trip_odometer.h.

                                            {
      return m_consumedRemainder;
    }

Referenced by configureRusefiLuaHooks().

Here is the caller graph for this function:

getConsumptionGramPerSecond()

float TripOdometer::getConsumptionGramPerSecond

(

)

const

Definition at line 48 of file trip_odometer.cpp.

                                                      {
    return m_rate;
}

Referenced by configureRusefiLuaHooks().

Here is the caller graph for this function:

getDistanceMeters()

uint32_t TripOdometer::getDistanceMeters

(

)

const

Definition at line 77 of file trip_odometer.cpp.

                                               {
    return m_distanceMeters;
}

getEngineRunTime()

uint32_t TripOdometer::getEngineRunTime

(

)

const

Definition at line 85 of file trip_odometer.cpp.

                                              {
    return m_engineRunningSeconds;
}

getIgnitionOnTime()

uint32_t TripOdometer::getIgnitionOnTime

(

)

const

Definition at line 81 of file trip_odometer.cpp.

                                               {
    return m_ignitionOnSeconds;
}

onSlowCallback()

void TripOdometer::onSlowCallback ( )

overridevirtual

Reimplemented from EngineModule.

Definition at line 52 of file trip_odometer.cpp.

                                  {
    float meterPerSecond = Sensor::getOrZero(SensorType::VehicleSpeed) / 3.6f;
    float metersThisTick = meterPerSecond * (SLOW_CALLBACK_PERIOD_MS / 1000.0f);
 
    m_distanceRemainder += metersThisTick;
    while (m_distanceRemainder > 1.0f) {
        m_distanceMeters++;
        m_distanceRemainder--;
    }
 
    constexpr float slowCallbackPerSecond = 1000 / SLOW_CALLBACK_PERIOD_MS;
    m_slowCallbackCounter++;
    if (m_slowCallbackCounter == slowCallbackPerSecond) {
        m_slowCallbackCounter = 0;
 
        m_ignitionOnSeconds++;
 
#if EFI_SHAFT_POSITION_INPUT
        if (engine->rpmCalculator.isRunning()) {
            m_engineRunningSeconds++;
        }
#endif // EFI_SHAFT_POSITION_INPUT
    }
}

Here is the call graph for this function:

reset()

void TripOdometer::reset

(

)

Definition at line 3 of file trip_odometer.cpp.

                         {
    m_consumedGrams = 0;
    m_consumedRemainder = 0;
 
    m_distanceMeters = 0;
    m_distanceRemainder = 0;
 
    m_slowCallbackCounter = 0;
    m_engineRunningSeconds = 0;
    m_ignitionOnSeconds = 0;
}

Field Documentation

m_consumedGrams

uint32_t TripOdometer::m_consumedGrams = 0

private

Definition at line 22 of file trip_odometer.h.

Referenced by consumeFuel(), getConsumedGrams(), and reset().

m_consumedRemainder

float TripOdometer::m_consumedRemainder = 0

private

Definition at line 23 of file trip_odometer.h.

Referenced by consumeFuel(), getConsumedGramsRemainder(), and reset().

m_distanceMeters

uint32_t TripOdometer::m_distanceMeters = 0

private

Definition at line 27 of file trip_odometer.h.

Referenced by getDistanceMeters(), onSlowCallback(), and reset().

m_distanceRemainder

float TripOdometer::m_distanceRemainder = 0

private

Definition at line 28 of file trip_odometer.h.

Referenced by onSlowCallback(), and reset().

m_engineRunningSeconds

uint32_t TripOdometer::m_engineRunningSeconds = 0

private

Definition at line 33 of file trip_odometer.h.

Referenced by getEngineRunTime(), onSlowCallback(), and reset().

m_ignitionOnSeconds

uint32_t TripOdometer::m_ignitionOnSeconds = 0

private

Definition at line 32 of file trip_odometer.h.

Referenced by getIgnitionOnTime(), onSlowCallback(), and reset().

m_rate

float TripOdometer::m_rate = 0

private

Definition at line 24 of file trip_odometer.h.

Referenced by consumeFuel(), and getConsumptionGramPerSecond().

m_slowCallbackCounter

uint32_t TripOdometer::m_slowCallbackCounter = 0

private

Definition at line 31 of file trip_odometer.h.

Referenced by onSlowCallback(), and reset().

m_timer

Timer TripOdometer::m_timer

private

Definition at line 35 of file trip_odometer.h.

Referenced by consumeFuel().

---

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

• controllers/modules/trip_odometer/trip_odometer.h
• controllers/modules/trip_odometer/trip_odometer.cpp