FrequencySensor Class Reference

#include <frequency_sensor.h>

Inheritance diagram for FrequencySensor:

Collaboration diagram for FrequencySensor:

Public Member Functions
	FrequencySensor (SensorType type, efidur_t timeoutPeriod)
void	initIfValid (brain_pin_e pin, SensorConverter &converter, float filterParameter)
void	deInit ()
void	showInfo (const char *sensorName) const override
void	onEdge (efitick_t nowNt)
Public Member Functions inherited from FunctionalSensor
	FunctionalSensor (SensorType type, efidur_t timeoutPeriod)
void	showInfo (const char *sensorName) const override
Public Member Functions inherited from FunctionalSensorImpl< SensorConverter >
	FunctionalSensorImpl (SensorType type, efidur_t timeoutPeriod)
void	postRawValue (float inputValue, efitick_t timestamp) override
void	setFunction (SensorConverter &func)
SensorConverter *	getFunction () const
float	getRaw () const override final
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 bool	isRedundant () const
void	unregister ()
SensorType	type () const

Data Fields
bool	useBiQuad = true
int	eventCounter = 0

Private Attributes
Timer	m_edgeTimer
brain_pin_e	m_pin = Gpio::Unassigned
Biquad	m_filter

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 FunctionalSensorBase
	FunctionalSensorBase (SensorType type, efidur_t timeoutPeriod)
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 8 of file frequency_sensor.h.

Constructor & Destructor Documentation

FrequencySensor()

FrequencySensor::FrequencySensor ( SensorType  type, efidur_t  timeoutPeriod  )

inline

Definition at line 10 of file frequency_sensor.h.

        : FunctionalSensor(type, timeoutPeriod)
    { }

Member Function Documentation

deInit()

void FrequencySensor::deInit

(

)

Definition at line 45 of file frequency_sensor.cpp.

                             {
    if (!isBrainPinValid(m_pin)) {
        return;
    }
 
#if EFI_PROD_CODE
    efiExtiDisablePin(m_pin);
#endif
 
    m_pin = Gpio::Unassigned;
}

Referenced by deinitAuxSpeedSensors(), deinitInputShaftSpeedSensor(), deinitTurbochargerSpeedSensor(), and deInitVehicleSpeedSensor().

Here is the call graph for this function:

Here is the caller graph for this function:

initIfValid()

void FrequencySensor::initIfValid	(	brain_pin_e	pin,
		SensorConverter &	converter,
		float	filterParameter
	)

Definition at line 18 of file frequency_sensor.cpp.

                                                                                                    {
    if (!isBrainPinValid(pin)) {
        return;
    }
 
    // Filter parameter greater than or equal to 0.5 impossible as it causes filter instability, clamp
    // far under that value.
    if (filterParameter > 0.35f) {
        filterParameter = 0.35f;
    }
 
    m_filter.configureLowpass(1, filterParameter);
 
    setFunction(converter);
 
#if EFI_PROD_CODE
    if (efiExtiEnablePin(getSensorName(), pin, PAL_EVENT_MODE_FALLING_EDGE,
            freqSensorExtiCallback, reinterpret_cast<void*>(this)) < 0) {
        return;
    }
#endif // EFI_PROD_CODE
 
    m_pin = pin;
 
    Register();
}

Referenced by initAuxSpeedSensors(), initInputShaftSpeedSensor(), initTurbochargerSpeedSensor(), and initVehicleSpeedSensor().

Here is the call graph for this function:

Here is the caller graph for this function:

onEdge()

void FrequencySensor::onEdge

(

efitick_t

nowNt

)

Definition at line 57 of file frequency_sensor.cpp.

                                            {
    // diagnostics
    eventCounter++;
    float frequency = 1 / m_edgeTimer.getElapsedSecondsAndReset(nowNt);
 
    if (useBiQuad) {
        frequency = m_filter.filter(frequency);
    }
 
    postRawValue(frequency, nowNt);
}

Here is the call graph for this function:

showInfo()

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

overridevirtual

Implements Sensor.

Definition at line 54 of file sensor_info_printing.cpp.

                                                           {
    efiPrintf("FrequencySensor \"%s\" counter %d", sensorName, eventCounter);
}

Field Documentation

eventCounter

int FrequencySensor::eventCounter = 0

Definition at line 24 of file frequency_sensor.h.

Referenced by onEdge(), sendQcBenchEventCounters(), showInfo(), and updateTunerStudioState().

m_edgeTimer

Timer FrequencySensor::m_edgeTimer

private

Definition at line 26 of file frequency_sensor.h.

Referenced by onEdge().

m_filter

Biquad FrequencySensor::m_filter

private

Definition at line 29 of file frequency_sensor.h.

Referenced by initIfValid(), and onEdge().

m_pin

brain_pin_e FrequencySensor::m_pin = Gpio::Unassigned

private

Definition at line 27 of file frequency_sensor.h.

Referenced by deInit(), and initIfValid().

useBiQuad

bool FrequencySensor::useBiQuad = true

Definition at line 18 of file frequency_sensor.h.

Referenced by initAuxSpeedSensors(), and onEdge().

---

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

• controllers/sensors/frequency_sensor.h
• controllers/sensors/frequency_sensor.cpp
• controllers/sensors/sensor_info_printing.cpp