Sensor Class Reference

#include <sensor.h>

Inheritance diagram for Sensor:

Collaboration diagram for Sensor:

Public Member Functions
bool	Register ()
virtual void	showInfo (const char *sensorName) const =0
const char *	getSensorName () const
virtual SensorResult	get () const =0
virtual bool	hasSensor () const
virtual float	getRaw () const
virtual bool	isRedundant () const
void	unregister ()
SensorType	type () const

Static Public Member Functions
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	setMockValue (int type, float value)
static void	resetMockValue (SensorType type)
static void	resetAllMocks ()
static void	inhibitTimeouts (bool inhibit)
static const char *	getSensorName (SensorType type)

Protected Member Functions
	Sensor (SensorType type)

Static Protected Attributes
static bool	s_inhibitSensorTimeouts = false

Private Member Functions
constexpr size_t	getIndex ()

Static Private Member Functions
static constexpr size_t	getIndex (SensorType type)
static SensorRegistryEntry *	getEntryForType (SensorType type)

Private Attributes
const SensorType	m_type

Detailed Description

Definition at line 60 of file sensor.h.

Constructor & Destructor Documentation

Sensor()

Sensor::Sensor ( SensorType  type )

inlineexplicitprotected

Definition at line 182 of file sensor.h.

        : m_type(type) {}

Member Function Documentation

get() [1/2]

virtual SensorResult Sensor::get ( ) const

pure virtual

Implemented in RedundantSensor, RedundantFordTps, ProxySensor, FallbackSensor, GearDetector, StoredValueSensor, LuaOverrideSensor, and FunctionPointerSensor.

Referenced by HpfpQuantity::calcPI(), canDashboardHaltech(), canMazdaRX8(), check(), EtbController::checkStatus(), WallFuelController::computeBeta(), WallFuelController::computeTau(), ThrottleModelBase::estimateThrottleFlow(), SensorReader< TSensorType >::get(), LuaOverrideSensor::get(), FallbackSensor::get(), ProxySensor::get(), RedundantFordTps::get(), RedundantSensor::get(), AcController::getAcState(), getAdvanceCorrections(), AlphaNAirmass::getAirmass(), getBaroCorrection(), getCltFuelCorrection(), getCltTimingCorrection(), getCrankingFuel3(), InjectorModelWithConfig::getDeadtime(), InjectorModelWithConfig::getFuelDifferentialPressure(), getIatFuelCorrection(), IdleController::getIdlePosition(), ClosedLoopFuelCellImpl::getLambdaError(), IFuelComputer::getLoadOverride(), MafAirmass::getMaf(), SpeedDensityAirmass::getMap(), BoostController::getOpenLoop(), getOrZero(), PrimeController::getPrimeDuration(), getRunningAdvance(), getSensor(), BoostController::getSetpoint(), EtbController::getSetpointEtb(), DfcoController::getState(), FanController::getState(), FuelComputer::getStoichiometricRatio(), IFuelComputer::getTCharge(), AirmassVeModelBase::getVe(), initMapDecoder(), LambdaMonitorBase::isCurrentlyGood(), Engine::isInShutdownMode(), LaunchControlBase::isInsideTpsCondition(), isPedalError(), TransmissionControllerBase::isShiftCompleted(), isTps1Error(), isTps2Error(), kLineThread(), AlternatorController::observePlant(), BoostController::observePlant(), EtbController::observePlant(), HpfpController::onFastCallback(), EngineState::periodicFastCallback(), Engine::periodicSlowCallback(), populateFrame(), TransmissionControllerBase::postState(), printMAPInfo(), printTPSInfo(), printTpsSenser(), readGppwmChannel(), recalculateAuxValveTiming(), TwoPinDcMotor::set(), Gm4l6xTransmissionController::set32State(), Generic4TransmissionController::setTccState(), shouldCorrect(), AutomaticGearController::update(), LimpManager::updateState(), updateTempSensors(), updateThrottles(), and updateTunerStudioState().

get() [2/2]

SensorResult Sensor::get ( SensorType  type )

static

Returns

NotNull: sensor result or UnexpectedCode::Configuration if sensor is not registered

Definition at line 166 of file sensor.cpp.

                                          {
    const auto entry = getEntryForType(type);
 
    // Check if this is a valid sensor entry
    if (!entry) {
        return UnexpectedCode::Configuration;
    }
 
    return entry->get();
}

Here is the call graph for this function:

getEntryForType()

SensorRegistryEntry * Sensor::getEntryForType ( SensorType  type )

staticprivate

Definition at line 148 of file sensor.cpp.

                                                              {
    size_t index = getIndex(type);
    // Check that we didn't get garbage
    if (index >= getIndex(SensorType::PlaceholderLast)) {
        return nullptr;
    }
 
    return &s_sensorRegistry[index];
}

Referenced by get(), getRaw(), getSensorOfType(), hasSensor(), isRedundant(), resetMockValue(), setInvalidMockValue(), setMockValue(), and showInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

getIndex() [1/2]

constexpr size_t Sensor::getIndex ( )

inlineconstexprprivate

Definition at line 191 of file sensor.h.

                                {
        return getIndex(m_type);
    }

Referenced by getEntryForType(), Register(), and unregister().

Here is the caller graph for this function:

getIndex() [2/2]

static constexpr size_t Sensor::getIndex ( SensorType  type )

inlinestaticconstexprprivate

Definition at line 196 of file sensor.h.

                                                      {
        return static_cast<size_t>(type);
    }

Here is the call graph for this function:

getOrZero()

static float Sensor::getOrZero ( SensorType  type )

inlinestatic

Definition at line 92 of file sensor.h.

                                            {
        return Sensor::get(type).value_or(0);
    }

Referenced by adjustCrankPhase(), canDashboardBmwE46(), canDashboardBmwE90(), canDashboardFiat(), canDashboardGenesisCoupe(), canDashboardHaltech(), canDashboardNissanVQ(), canDashboardVAG(), canDashboardVagMqb(), canDashboardW202(), canMazdaRX8(), EtbController::checkStatus(), GearDetector::computeGearboxRatio(), configureRusefiLuaHooks(), TriggerCentral::decodeMapCam(), TriggerDecoderBase::decodeTriggerEvent(), fuelClosedLoopCorrection(), AcController::getAcState(), getBaroCorrection(), BoostController::getClosedLoopImpl(), GearDetector::getDriveshaftRpm(), getFuelALSCorrection(), IdleController::getIdlePosition(), KnockController::getKnockThreshold(), getLoad(), SpeedDensityAirmass::getMap(), getMaxAirflowAtMap(), KnockController::getMaximumRetard(), BoostController::getOpenLoop(), getRunningAdvance(), AlternatorController::getSetpoint(), BoostController::getSetpoint(), VvtController::getSetpoint(), EtbController::getSetpointEtb(), IgnitionState::getSparkDwell(), DfcoController::getState(), TpsAccelEnrichment::getTpsEnrichment(), getVeLoadAxis(), handleGetDataRequest(), hipThread(), initElectronicThrottle(), initNewSensors(), AntilagSystemBase::isALSMaxCLTCondition(), AntilagSystemBase::isALSMaxThrottleIntentCondition(), AntilagSystemBase::isALSMinCLTCondition(), LambdaMonitorBase::isCurrentlyGood(), isIgnVoltage(), LaunchControlBase::isInsideSpeedCondition(), LaunchControlBase::isLaunchRpmRetardCondition(), isPrimeInjectionPulseSkipped(), TriggerCentral::isToothExpectedNow(), lua_getAirmass(), mapAveragingTriggerCallback(), HpfpController::onFastCallback(), BoostController::onFastCallback(), WallFuelController::onFastCallback(), LimpManager::onFastCallback(), MainRelayController::onSlowCallback(), TripOdometer::onSlowCallback(), ThrottleModelBase::onSlowCallback(), onTdcCallback(), InjectionEvent::onTriggerTooth(), EngineState::periodicFastCallback(), Engine::periodicSlowCallback(), populateFrame(), printMAPInfo(), refreshMapAveragingPreCalc(), reportWave(), LambdaMonitorBase::restoreConditionsMet(), sendWidebandInfo(), StepperMotorBase::setInitialPosition(), shouldUpdateCorrection(), showAltInfo(), speedoUpdate(), startDwellByTurningSparkPinHigh(), tachUpdate(), tdcMarkCallback(), AntilagSystemBase::update(), LaunchControlBase::update(), GenericGearController::update(), DynoView::update(), updateEgtSensors(), updateFuelSensors(), DynoView::updateHP(), updateLambda(), updateMiscSensors(), updatePressures(), updateRawSensors(), LimpManager::updateRevLimit(), Engine::updateSlowSensors(), LimpManager::updateState(), updateThrottles(), updateTunerStudioState(), updateVehicleSpeed(), and updateVrThresholdPwm().

Here is the call graph for this function:

getRaw() [1/2]

virtual float Sensor::getRaw ( ) const

inlinevirtual

Reimplemented in FunctionalSensor.

Definition at line 162 of file sensor.h.

                                 {
        return 0;
    }

Referenced by grabPedalIsUp(), grabPedalIsWideOpen(), grabTPSIsClosed(), grabTPSIsWideOpen(), lua_getSensorRaw(), Engine::periodicSlowCallback(), printTpsSenser(), sendQcBenchRawAnalogValues(), updateRawSensors(), and updateThrottles().

Here is the caller graph for this function:

getRaw() [2/2]

float Sensor::getRaw ( SensorType  type )

static

Definition at line 177 of file sensor.cpp.

                                      {
    const auto entry = getEntryForType(type);
 
    return entry ? entry->getRaw() : 0;
}

Here is the call graph for this function:

getSensorName() [1/2]

const char* Sensor::getSensorName ( ) const

inline

Definition at line 144 of file sensor.h.

{ return getSensorName(m_type); }

Referenced by check(), getSensorName(), HellaOilLevelSensor::init(), EtbController::init(), FrequencySensor::initIfValid(), AdcSubscription::PrintInfo(), FallbackSensor::showInfo(), ProxySensor::showInfo(), RedundantFordTps::showInfo(), RedundantSensor::showInfo(), and showInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

getSensorName() [2/2]

const char * Sensor::getSensorName ( SensorType  type )

static

Definition at line 235 of file sensor.cpp.

                                                   {
    return getSensorType(type);
}

Here is the call graph for this function:

getSensorOfType()

const Sensor * Sensor::getSensorOfType ( SensorType  type )

static

Definition at line 158 of file sensor.cpp.

                                                       {
    auto entry = getEntryForType(type);
    return entry ? entry->getSensor() : nullptr;
}

Referenced by ProxySensor::isRedundant().

Here is the call graph for this function:

Here is the caller graph for this function:

hasSensor() [1/2]

virtual bool Sensor::hasSensor ( ) const

inlinevirtual

Reimplemented in ProxySensor.

Definition at line 155 of file sensor.h.

                                   {
        return true;
    }

Referenced by check(), WallFuelController::computeBeta(), GearDetector::computeGearboxRatio(), WallFuelController::computeTau(), doInitElectronicThrottle(), ThrottleModelBase::estimateThrottleFlow(), getBaroCorrection(), getCrankingFuel3(), InjectorModelWithConfig::getFuelDifferentialPressure(), MafAirmass::getMaf(), FuelComputer::getStoichiometricRatio(), ProxySensor::hasSensor(), EtbController::init(), initAuxValves(), initBaro(), isPedalError(), isTps2Error(), lua_hasSensor(), printMAPInfo(), and LimpManager::updateState().

Here is the caller graph for this function:

hasSensor() [2/2]

bool Sensor::hasSensor ( SensorType  type )

static

Definition at line 189 of file sensor.cpp.

                                        {
    const auto entry = getEntryForType(type);
 
    return entry ? entry->hasSensor() : false;
}

Here is the call graph for this function:

inhibitTimeouts()

void Sensor::inhibitTimeouts ( bool  inhibit )

static

Definition at line 241 of file sensor.cpp.

                                           {
    Sensor::s_inhibitSensorTimeouts = inhibit;
}

Referenced by writeToFlashIfPending().

Here is the caller graph for this function:

isRedundant() [1/2]

virtual bool Sensor::isRedundant ( ) const

inlinevirtual

Reimplemented in SentTps, RedundantSensor, RedundantFordTps, and ProxySensor.

Definition at line 169 of file sensor.h.

                                     {
        // By default sensors are not redundant
        return false;
    }

Referenced by EtbController::init().

Here is the caller graph for this function:

isRedundant() [2/2]

bool Sensor::isRedundant ( SensorType  type )

static

Definition at line 183 of file sensor.cpp.

                                          {
    const auto entry = getEntryForType(type);
 
    return entry ? entry->isRedundant() : false;
}

Referenced by ProxySensor::isRedundant().

Here is the call graph for this function:

Here is the caller graph for this function:

Register()

bool Sensor::Register

(

)

Definition at line 131 of file sensor.cpp.

                      {
    return s_sensorRegistry[getIndex()].Register(this);
}

Referenced by commonInitEngineController(), configureTempSensor(), enableTriggerStimulator(), HellaOilLevelSensor::init(), initAuxSensors(), initBaro(), initCanVssSupport(), initFlexSensor(), initFluidPressure(), initFuelLevel(), GearDetector::initGearDetector(), FrequencySensor::initIfValid(), initLambda(), initMaf(), initMap(), initOverrideSensors(), initRangeSensors(), initTps(), initVbatt(), onEcuStartDoSomethingTriggerInputPins(), and registerCanSensor().

Here is the call graph for this function:

Here is the caller graph for this function:

resetAllMocks()

void Sensor::resetAllMocks ( )

static

Definition at line 228 of file sensor.cpp.

                             {
    // Reset all mocks
    for (size_t i = 0; i < efi::size(s_sensorRegistry); i++) {
        s_sensorRegistry[i].resetMock();
    }
}

Referenced by initSensorCli().

Here is the caller graph for this function:

resetMockValue()

void Sensor::resetMockValue ( SensorType  type )

static

Definition at line 220 of file sensor.cpp.

                                             {
    auto entry = getEntryForType(type);
 
    if (entry) {
        entry->resetMock();
    }
}

Here is the call graph for this function:

resetRegistry()

void Sensor::resetRegistry ( )

static

Definition at line 139 of file sensor.cpp.

                             {
    // Clear all entries
    for (size_t i = 0; i < efi::size(s_sensorRegistry); i++) {
        auto &entry = s_sensorRegistry[i];
 
        entry.reset();
    }
}

setInvalidMockValue()

void Sensor::setInvalidMockValue ( SensorType  type )

static

Definition at line 195 of file sensor.cpp.

                                                {
    auto entry = getEntryForType(type);
 
    if (entry) {
        entry->setInvalidMockValue();
    }
}

Here is the call graph for this function:

setMockValue() [1/2]

void Sensor::setMockValue ( int  type, float  value  )

static

Definition at line 211 of file sensor.cpp.

                                                 {
    // bounds check
    if (type <= 0 || type >= static_cast<int>(SensorType::PlaceholderLast)) {
        return;
    }
 
    setMockValue(static_cast<SensorType>(type), value);
}

Here is the call graph for this function:

setMockValue() [2/2]

void Sensor::setMockValue ( SensorType  type, float  value, bool  mockRedundant = false  )

static

Definition at line 203 of file sensor.cpp.

                                                                            {
    auto entry = getEntryForType(type);
 
    if (entry) {
        entry->setMockValue(value, mockRedundant);
    }
}

Referenced by initMapDecoder(), initNewSensors(), initSensorCli(), and setMockValue().

Here is the call graph for this function:

Here is the caller graph for this function:

showAllSensorInfo()

void Sensor::showAllSensorInfo ( )

static

Definition at line 246 of file sensor.cpp.

                                 {
    for (size_t i = 1; i < efi::size(s_sensorRegistry); i++) {
        auto& entry = s_sensorRegistry[i];
        const char* name = getSensorType((SensorType)i);
 
        entry.showInfo(name);
    }
}

Referenced by initSensorCli(), and printSensorInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

showInfo() [1/2]

virtual void Sensor::showInfo ( const char *  sensorName ) const

pure virtual

Implemented in RedundantSensor, RedundantFordTps, Lps25Sensor, FrequencySensor, StoredValueSensor, ProxySensor, FunctionalSensor, FallbackSensor, CanSensorBase, LuaOverrideSensor, RpmCalculator, MapAverager, GearDetector, and FunctionPointerSensor.

Referenced by initSensorCli().

Here is the caller graph for this function:

showInfo() [2/2]

void Sensor::showInfo ( SensorType  type )

static

Definition at line 256 of file sensor.cpp.

                                       {
    auto entry = getEntryForType(type);
 
    if (entry) {
        entry->showInfo(getSensorName(type));
    }
}

Here is the call graph for this function:

type()

SensorType Sensor::type ( ) const

inline

Definition at line 176 of file sensor.h.

                            {
        return m_type;
    }

Referenced by get(), getEntryForType(), getIndex(), getOrZero(), getRaw(), getSensorName(), getSensorOfType(), hasSensor(), isRedundant(), resetMockValue(), setInvalidMockValue(), setMockValue(), and showInfo().

Here is the caller graph for this function:

unregister()

void Sensor::unregister

(

)

Definition at line 135 of file sensor.cpp.

                        {
    s_sensorRegistry[getIndex()].unregister();
}

Referenced by deinitAuxSensors(), deInitFlexSensor(), deinitTps(), onEcuStartDoSomethingTriggerInputPins(), and GearDetector::~GearDetector().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

m_type

const SensorType Sensor::m_type

private

Definition at line 188 of file sensor.h.

Referenced by getIndex(), getSensorName(), and type().

s_inhibitSensorTimeouts

bool Sensor::s_inhibitSensorTimeouts = false

staticprotected

Definition at line 185 of file sensor.h.

Referenced by StoredValueSensor::get(), and inhibitTimeouts().

---

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

• controllers/sensors/core/sensor.h
• controllers/sensors/core/sensor.cpp