GearDetector Class Reference

#include <gear_detector.h>

Inheritance diagram for GearDetector:

Collaboration diagram for GearDetector:

Public Member Functions
	GearDetector ()
	~GearDetector ()
void	onSlowCallback () override
void	onConfigurationChange (engine_configuration_s const *) override
float	getGearboxRatio () const
size_t	determineGearFromRatio (float ratio) const
float	getRpmInGear (size_t gear) const
SensorResult	get () const override
void	showInfo (const char *sensorName) const override
Public Member Functions inherited from EngineModule
virtual void	initNoConfiguration ()
virtual void	setDefaultConfiguration ()
virtual void	onFastCallback ()
virtual void	onEngineStop ()
virtual void	onIgnitionStateChanged (bool)
virtual bool	needsDelayedShutoff ()
virtual void	onEnginePhase (float, efitick_t, angle_t, angle_t)
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 Member Functions
float	computeGearboxRatio () const
float	getDriveshaftRpm () const
void	initGearDetector ()

Private Attributes
bool	isInitialized = false
float	m_gearboxRatio = 0
size_t	m_currentGear = 0
float	m_gearThresholds [TCU_GEAR_COUNT - 1]

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 4 of file gear_detector.h.

Constructor & Destructor Documentation

GearDetector()

GearDetector::GearDetector

(

)

Definition at line 8 of file gear_detector.cpp.

    : Sensor(SensorType::DetectedGear)
{
}

~GearDetector()

GearDetector::~GearDetector

(

)

Definition at line 13 of file gear_detector.cpp.

                            {
    unregister();
}

Here is the call graph for this function:

Member Function Documentation

computeGearboxRatio()

float GearDetector::computeGearboxRatio ( ) const

private

Definition at line 119 of file gear_detector.cpp.

                                              {
    float driveshaftRpm = getDriveshaftRpm();
 
    if (driveshaftRpm == 0) {
        return 0;
    }
 
    float engineRpm;
    if (Sensor::hasSensor(SensorType::InputShaftSpeed)) {
        engineRpm = Sensor::getOrZero(SensorType::InputShaftSpeed);
    } else {
        engineRpm = Sensor::getOrZero(SensorType::Rpm);
    }
 
    return engineRpm / driveshaftRpm;
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

determineGearFromRatio()

size_t GearDetector::determineGearFromRatio

(

float

ratio

)

const

Definition at line 71 of file gear_detector.cpp.

                                                             {
    auto gearCount = engineConfiguration->totalGearsCount;
    if (gearCount == 0) {
        // No gears, we only have neutral.
        return 0;
    }
 
    // 1.5x first gear is neutral or clutch slip or something
    if (ratio > engineConfiguration->gearRatio[0] * 1.5f) {
        return 0;
    }
 
    // 0.66x top gear is coasting with engine off or something
    if (ratio < engineConfiguration->gearRatio[gearCount - 1] * 0.66f) {
        return 0;
    }
 
    size_t currentGear = gearCount;
 
    while (currentGear > 1) {
        if (ratio < m_gearThresholds[currentGear - 2]) {
            break;
        }
 
        currentGear--;
    }
 
    return currentGear;
}

Referenced by onSlowCallback().

Here is the caller graph for this function:

get()

SensorResult GearDetector::get ( ) const

overridevirtual

Implements Sensor.

Definition at line 149 of file gear_detector.cpp.

                                     {
    return m_currentGear;
}

getDriveshaftRpm()

float GearDetector::getDriveshaftRpm ( ) const

private

Definition at line 101 of file gear_detector.cpp.

                                           {
    auto vssKph = Sensor::getOrZero(SensorType::VehicleSpeed);
 
    if (vssKph < 3) {
        // Vehicle too slow to determine gearbox ratio, avoid div/0
        return 0;
    }
 
    // Convert to wheel RPM
    //                 km                        rev                        1 hr
    //               ------ *               ------------              *  __________
    //                 hr                        km                        60 min
    float wheelRpm = vssKph * engineConfiguration->driveWheelRevPerKm * (1 / 60.0f);
 
    // Convert to driveshaft RPM
    return wheelRpm * engineConfiguration->finalGearRatio;
}

Referenced by computeGearboxRatio(), and getRpmInGear().

Here is the call graph for this function:

Here is the caller graph for this function:

getGearboxRatio()

float GearDetector::getGearboxRatio

(

)

const

Definition at line 145 of file gear_detector.cpp.

                                          {
    return m_gearboxRatio;
}

getRpmInGear()

float GearDetector::getRpmInGear

(

size_t

gear

)

const

Definition at line 136 of file gear_detector.cpp.

                                                  {
    if (gear <= 0 || gear > engineConfiguration->totalGearsCount) {
        return 0;
    }
 
    // Ideal engine RPM is driveshaft speed times gear
    return getDriveshaftRpm() * engineConfiguration->gearRatio[gear - 1];
}

Here is the call graph for this function:

initGearDetector()

void GearDetector::initGearDetector ( )

private

Definition at line 17 of file gear_detector.cpp.

                                    {
    // Compute gear thresholds between gears
 
    uint8_t gearCount = engineConfiguration->totalGearsCount;
 
    if (gearCount == 0) {
        // No gears, nothing to do here.
        return;
    }
 
    if (gearCount > TCU_GEAR_COUNT) {
        criticalError("too many gears");
        return;
    }
 
    // validate gears
    for (size_t i = 0; i < gearCount; i++) {
        if (engineConfiguration->gearRatio[i] <= 0) {
            criticalError("Expecting positive gear ratio for #%d", i + 1);
            return;
        }
    }
 
    for (int i = 0; i < gearCount - 1; i++) {
        // Threshold i is the threshold between gears i and i+1
        float gearI        = engineConfiguration->gearRatio[i];
        float gearIplusOne = engineConfiguration->gearRatio[i + 1];
 
        if (gearI <= gearIplusOne) {
            criticalError("Invalid gear ordering near gear #%d", i + 1);
        }
 
        m_gearThresholds[i] = geometricMean(gearI, gearIplusOne);
    }
 
    Register();
}

Referenced by onConfigurationChange(), and onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

onConfigurationChange()

void GearDetector::onConfigurationChange ( engine_configuration_s const *  )

overridevirtual

Reimplemented from EngineModule.

Definition at line 55 of file gear_detector.cpp.

                                                                         {
    initGearDetector();
}

Here is the call graph for this function:

onSlowCallback()

void GearDetector::onSlowCallback ( )

overridevirtual

Reimplemented from EngineModule.

Definition at line 59 of file gear_detector.cpp.

                                  {
    if (!isInitialized) {
        initGearDetector();
        isInitialized = true;
    }
 
    float ratio = computeGearboxRatio();
    m_gearboxRatio = ratio;
 
    m_currentGear = determineGearFromRatio(ratio);
}

Here is the call graph for this function:

showInfo()

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

overridevirtual

Implements Sensor.

Definition at line 153 of file gear_detector.cpp.

                                                        {
    efiPrintf("Sensor \"%s\" is gear detector.", sensorName);
    efiPrintf("    Gearbox ratio: %.3f", m_gearboxRatio);
    efiPrintf("    Detected gear: %d", m_currentGear);
}

Field Documentation

isInitialized

bool GearDetector::isInitialized = false

private

Definition at line 26 of file gear_detector.h.

Referenced by onSlowCallback().

m_currentGear

size_t GearDetector::m_currentGear = 0

private

Definition at line 29 of file gear_detector.h.

Referenced by get(), onSlowCallback(), and showInfo().

m_gearboxRatio

float GearDetector::m_gearboxRatio = 0

private

Definition at line 28 of file gear_detector.h.

Referenced by getGearboxRatio(), onSlowCallback(), and showInfo().

m_gearThresholds

float GearDetector::m_gearThresholds[TCU_GEAR_COUNT - 1]

private

Definition at line 31 of file gear_detector.h.

Referenced by determineGearFromRatio(), and initGearDetector().

---

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

• controllers/modules/gear_detector/gear_detector.h
• controllers/modules/gear_detector/gear_detector.cpp