AlternatorController Class Reference

#include <alternator_controller.h>

Inheritance diagram for AlternatorController:

Collaboration diagram for AlternatorController:

Public Member Functions
	AlternatorController ()
void	onFastCallback () override
void	onConfigurationChange (engine_configuration_s const *previousConfiguration) override
expected< float >	getSetpoint () override
expected< float >	observePlant () override
expected< percent_t >	getOpenLoop (float target) override
expected< percent_t >	getClosedLoop (float setpoint, float observation) override
void	setOutput (expected< percent_t > outputValue) override
Public Member Functions inherited from EngineModule
virtual void	initNoConfiguration ()
virtual void	setDefaultConfiguration ()
virtual void	onSlowCallback ()
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 ClosedLoopController< float, percent_t >
void	update ()

Private Attributes
Pid	alternatorPid

Detailed Description

Definition at line 19 of file alternator_controller.h.

Constructor & Destructor Documentation

AlternatorController()

AlternatorController::AlternatorController

(

)

Definition at line 24 of file alternator_controller.cpp.

                                           {
    alternatorPid.initPidClass(&engineConfiguration->alternatorControl);
}

Here is the call graph for this function:

Member Function Documentation

getClosedLoop()

expected< percent_t > AlternatorController::getClosedLoop ( float  setpoint, float  observation  )

overridevirtual

Implements ClosedLoopController< float, percent_t >.

Definition at line 67 of file alternator_controller.cpp.

                                                                                         {
        alternatorPid.iTermMin = engineConfiguration->alternator_iTermMin;
        alternatorPid.iTermMax = engineConfiguration->alternator_iTermMax;
    return alternatorPid.getOutput(setpoint, observation, FAST_CALLBACK_PERIOD_MS / 1000.0f);
}

Here is the call graph for this function:

getOpenLoop()

expected< percent_t > AlternatorController::getOpenLoop ( float  target )

overridevirtual

Implements ClosedLoopController< float, percent_t >.

Definition at line 62 of file alternator_controller.cpp.

                                                             {
    // see "idle air Bump for AC" comment
    return engine->module<AcController>().unmock().acButtonState ? engineConfiguration->acRelayAlternatorDutyAdder : 0;
}

Here is the call graph for this function:

getSetpoint()

expected< float > AlternatorController::getSetpoint ( )

overridevirtual

Implements ClosedLoopController< float, percent_t >.

Definition at line 42 of file alternator_controller.cpp.

                                                  {
    const float rpm = Sensor::getOrZero(SensorType::Rpm);
    bool alternatorShouldBeEnabledAtCurrentRpm = rpm > engineConfiguration->cranking.rpm;
 
    if (!engineConfiguration->isAlternatorControlEnabled || !alternatorShouldBeEnabledAtCurrentRpm) {
        return unexpected;
    }
 
    const float load = getEngineState()->fuelingLoad;
    return interpolate3d(
        config->alternatorVoltageTargetTable,
        config->alternatorVoltageTargetLoadBins, load,
        config->alternatorVoltageTargetRpmBins, rpm
    );
}

Here is the call graph for this function:

observePlant()

expected< float > AlternatorController::observePlant ( )

overridevirtual

Implements ClosedLoopController< float, percent_t >.

Definition at line 58 of file alternator_controller.cpp.

                                                   {
    return Sensor::get(SensorType::BatteryVoltage);
}

Here is the call graph for this function:

onConfigurationChange()

void AlternatorController::onConfigurationChange ( engine_configuration_s const *  previousConfiguration )

overridevirtual

Reimplemented from EngineModule.

Definition at line 83 of file alternator_controller.cpp.

                                                                                                     {
    if(!alternatorPid.isSame(&previousConfiguration->alternatorControl)) {
        alternatorPid.reset();
    }
}

Here is the call graph for this function:

onFastCallback()

void AlternatorController::onFastCallback ( )

overridevirtual

Reimplemented from EngineModule.

Definition at line 28 of file alternator_controller.cpp.

                                          {
    if (!isBrainPinValid(engineConfiguration->alternatorControlPin)) {
        return;
    }
 
    // this block could be executed even in on/off alternator control mode
    // but at least we would reflect latest state
#if EFI_TUNER_STUDIO
    alternatorPid.postState(engine->outputChannels.alternatorStatus);
#endif /* EFI_TUNER_STUDIO */
 
    update();
}

Here is the call graph for this function:

setOutput()

void AlternatorController::setOutput ( expected< percent_t >  outputValue )

overridevirtual

Implements ClosedLoopController< float, percent_t >.

Definition at line 73 of file alternator_controller.cpp.

                                                                    {
    if (outputValue) {
        alternatorControl.setSimplePwmDutyCycle(PERCENT_TO_DUTY(outputValue.Value));
    } else {
        // Shut off output if not needed
        alternatorPid.reset();
        alternatorControl.setSimplePwmDutyCycle(0);
    }
}

Here is the call graph for this function:

Field Documentation

alternatorPid

Pid AlternatorController::alternatorPid

private

Definition at line 33 of file alternator_controller.h.

Referenced by AlternatorController(), getClosedLoop(), onConfigurationChange(), onFastCallback(), and setOutput().

---

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

• controllers/actuators/alternator_controller.h
• controllers/actuators/alternator_controller.cpp