NitrousController Class Reference

#include <nitrous_controller.h>

Inheritance diagram for NitrousController:

Collaboration diagram for NitrousController:

Public Types
using	interface_t = NitrousController

Public Member Functions
void	onSlowCallback () override
float	getFuelCoefficient () 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 Member Functions
void	updateArmingState ()
void	updateSpeedConditionSatisfied ()
void	updateTpsConditionSatisfied ()
void	updateCltConditionSatisfied ()
void	updateMapConditionSatisfied ()
void	updateAfrConditionSatisfied ()
void	updateRpmConditionSatisfied ()
bool	checkTriggerPinState () const
bool	checkLuaGauge () const
SensorType	getLuaGauge () const

Additional Inherited Members
Data Fields inherited from nitrous_control_state_s
bool	isNitrousArmed: 1 {}
bool	isNitrousSpeedCondition: 1 {}
bool	isNitrousTpsCondition: 1 {}
bool	isNitrousCltCondition: 1 {}
bool	isNitrousMapCondition: 1 {}
bool	isNitrousAfrCondition: 1 {}
bool	isNitrousRpmCondition: 1 {}
bool	isNitrousCondition: 1 {}
bool	unusedBit_8_8: 1 {}
bool	unusedBit_8_9: 1 {}
bool	unusedBit_8_10: 1 {}
bool	unusedBit_8_11: 1 {}
bool	unusedBit_8_12: 1 {}
bool	unusedBit_8_13: 1 {}
bool	unusedBit_8_14: 1 {}
bool	unusedBit_8_15: 1 {}
bool	unusedBit_8_16: 1 {}
bool	unusedBit_8_17: 1 {}
bool	unusedBit_8_18: 1 {}
bool	unusedBit_8_19: 1 {}
bool	unusedBit_8_20: 1 {}
bool	unusedBit_8_21: 1 {}
bool	unusedBit_8_22: 1 {}
bool	unusedBit_8_23: 1 {}
bool	unusedBit_8_24: 1 {}
bool	unusedBit_8_25: 1 {}
bool	unusedBit_8_26: 1 {}
bool	unusedBit_8_27: 1 {}
bool	unusedBit_8_28: 1 {}
bool	unusedBit_8_29: 1 {}
bool	unusedBit_8_30: 1 {}
bool	unusedBit_8_31: 1 {}

Detailed Description

Definition at line 9 of file nitrous_controller.h.

Member Typedef Documentation

interface_t

using NitrousController::interface_t = NitrousController

Definition at line 11 of file nitrous_controller.h.

Member Function Documentation

checkLuaGauge()

bool NitrousController::checkLuaGauge ( ) const

private

Definition at line 138 of file nitrous_controller.cpp.

                                            {
    bool result = false;
    const SensorResult currentSensorResult = Sensor::get(getLuaGauge());
    if (currentSensorResult.Valid) {
        const float currentValue = currentSensorResult.Value;
        const float armingValue = engineConfiguration->nitrousLuaGaugeArmingValue;
        switch (engineConfiguration->nitrousLuaGaugeMeaning) {
            case LUA_GAUGE_LOWER_BOUND: {
                result = (armingValue <= currentValue);
                break;
            }
            case LUA_GAUGE_UPPER_BOUND: {
                result = (currentValue <= armingValue);
                break;
            }
        }
    }
    return result;
}

Referenced by updateArmingState().

Here is the call graph for this function:

Here is the caller graph for this function:

checkTriggerPinState()

bool NitrousController::checkTriggerPinState ( ) const

private

Definition at line 126 of file nitrous_controller.cpp.

                                                   {
    bool result = false;
#if !EFI_SIMULATOR
    const switch_input_pin_e triggerPin = engineConfiguration->nitrousControlTriggerPin;
    const pin_input_mode_e triggerPinMode = engineConfiguration->nitrousControlTriggerPinMode;
    if (isBrainPinValid(triggerPin)) {
        result = efiReadPin(triggerPin, triggerPinMode);
    }
#endif // !EFI_SIMULATOR
    return result;
}

Referenced by updateArmingState().

Here is the call graph for this function:

Here is the caller graph for this function:

getFuelCoefficient()

float NitrousController::getFuelCoefficient

(

)

const

Definition at line 29 of file nitrous_controller.cpp.

                                                  {
    float result = 1.0f;
    if (engineConfiguration->nitrousControlEnabled && isNitrousCondition) {
        result += engineConfiguration->nitrousFuelAdderPercent / 100.0f;
    }
    return result;
}

Referenced by getRunningFuel().

Here is the caller graph for this function:

getLuaGauge()

SensorType NitrousController::getLuaGauge ( ) const

private

Definition at line 158 of file nitrous_controller.cpp.

                                                {
    SensorType result = SensorType::LuaGauge1;
    switch (engineConfiguration->nitrousLuaGauge) {
        case LUA_GAUGE_1: {
            break;
        }
        case LUA_GAUGE_2: {
            result = SensorType::LuaGauge2;
            break;
        }
        case LUA_GAUGE_3: {
            result = SensorType::LuaGauge3;
            break;
        }
        case LUA_GAUGE_4: {
            result = SensorType::LuaGauge4;
            break;
        }
        case LUA_GAUGE_5: {
            result = SensorType::LuaGauge5;
            break;
        }
        case LUA_GAUGE_6: {
            result = SensorType::LuaGauge6;
            break;
        }
        case LUA_GAUGE_7: {
            result = SensorType::LuaGauge7;
            break;
        }
        case LUA_GAUGE_8: {
            result = SensorType::LuaGauge8;
            break;
        }
    }
    return result;
}

Referenced by checkLuaGauge().

Here is the caller graph for this function:

onSlowCallback()

void NitrousController::onSlowCallback ( )

overridevirtual

Reimplemented from EngineModule.

Definition at line 10 of file nitrous_controller.cpp.

                                       {
    if (engineConfiguration->nitrousControlEnabled) {
        updateArmingState();
        updateSpeedConditionSatisfied();
        updateTpsConditionSatisfied();
        updateCltConditionSatisfied();
        updateMapConditionSatisfied();
        updateAfrConditionSatisfied();
        updateRpmConditionSatisfied();
        isNitrousCondition = (
            isNitrousArmed && isNitrousSpeedCondition && isNitrousTpsCondition && isNitrousCltCondition
                && isNitrousMapCondition && isNitrousAfrCondition && isNitrousRpmCondition
        );
    } else {
        isNitrousCondition = false;
    }
    enginePins.nitrousRelay.setValue(isNitrousCondition);
}

Here is the call graph for this function:

updateAfrConditionSatisfied()

void NitrousController::updateAfrConditionSatisfied ( )

private

Definition at line 90 of file nitrous_controller.cpp.

                                                    {
    if (static_cast<float>(engineConfiguration->nitrousMaximumAfr) != 0.0f) {
        const expected<float> lambda1 = Sensor::get(SensorType::Lambda1);
        if (lambda1.Valid) {
            const float afr = lambda1.Value * STOICH_RATIO;
            isNitrousAfrCondition = (afr <= static_cast<float>(engineConfiguration->nitrousMaximumAfr));
        } else {
            isNitrousAfrCondition = false;
        }
    } else {
        isNitrousAfrCondition = true;
    }
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

updateArmingState()

void NitrousController::updateArmingState ( )

private

Definition at line 37 of file nitrous_controller.cpp.

                                          {
    switch (engineConfiguration->nitrousControlArmingMethod) {
        case DIGITAL_SWITCH_INPUT: {
            isNitrousArmed = checkTriggerPinState();
            break;
        }
        case LUA_GAUGE: {
            isNitrousArmed = checkLuaGauge();
            break;
        }
        default: { // Unexpected value!!!
            isNitrousArmed = false;
            break;
        }
    }
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

updateCltConditionSatisfied()

void NitrousController::updateCltConditionSatisfied ( )

private

Definition at line 72 of file nitrous_controller.cpp.

                                                    {
    if (engineConfiguration->nitrousMinimumClt != 0) {
        const expected<float> clt = Sensor::get(SensorType::Clt);
        isNitrousCltCondition = clt.Valid && (engineConfiguration->nitrousMinimumClt <= clt.Value);
    } else {
        isNitrousCltCondition = true;
    }
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

updateMapConditionSatisfied()

void NitrousController::updateMapConditionSatisfied ( )

private

Definition at line 81 of file nitrous_controller.cpp.

                                                    {
    if (engineConfiguration->nitrousMaximumMap != 0) {
        const expected<float> map = Sensor::get(SensorType::Map);
        isNitrousMapCondition = map.Valid && (map.Value <= engineConfiguration->nitrousMaximumMap);
    } else {
        isNitrousMapCondition = true;
    }
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

updateRpmConditionSatisfied()

void NitrousController::updateRpmConditionSatisfied ( )

private

Definition at line 108 of file nitrous_controller.cpp.

                                                    {
    const expected<float> rpmSensorReading = Sensor::get(SensorType::Rpm);
    if (rpmSensorReading.Valid) {
        const float rpm = rpmSensorReading.Value;
        if (rpmHysteresis.checkIfLimitIsExceeded(
                rpm,
                engineConfiguration->nitrousDeactivationRpm,
                engineConfiguration->nitrousDeactivationRpmWindow
        )) {
            isNitrousRpmCondition = false;
        } else {
            isNitrousRpmCondition = (engineConfiguration->nitrousActivationRpm <= rpm);
        }
    } else {
        isNitrousRpmCondition = false;
    }
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

updateSpeedConditionSatisfied()

void NitrousController::updateSpeedConditionSatisfied ( )

private

Definition at line 54 of file nitrous_controller.cpp.

                                                      {
    if (engineConfiguration->nitrousMinimumVehicleSpeed != 0) {
        const expected<float> speed = Sensor::get(SensorType::VehicleSpeed);
        isNitrousSpeedCondition = speed.Valid && (engineConfiguration->nitrousMinimumVehicleSpeed <= speed.Value);
    } else {
        isNitrousSpeedCondition = true;
    }
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

updateTpsConditionSatisfied()

void NitrousController::updateTpsConditionSatisfied ( )

private

Definition at line 63 of file nitrous_controller.cpp.

                                                    {
    if (engineConfiguration->nitrousMinimumTps != 0) {
        const expected<float> tps = Sensor::get(SensorType::DriverThrottleIntent);
        isNitrousTpsCondition = tps.Valid && (engineConfiguration->nitrousMinimumTps <= tps.Value);
    } else {
        isNitrousTpsCondition = true;
    }
}

Referenced by onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• controllers/algo/nitrous_controller.h
• controllers/algo/nitrous_controller.cpp