Refactoring PowerLimiter

[helgeerbe]

Hi @berni2288,

the actual implementation seems to be a bit messy. What do you think, if we use a lightwise state pattern?

Does this diagram match to your ideas?

[berni2288]

@helgeerbe I think so, what are "noOtherTrigger" and "inTargetRange"?

I wonder if that covers the needs for ever possible use case.
Is there a library for lightwise state patterns?

[helgeerbe]

• "noOtherTrigger" means just there is no condition and stay in current state.
• "inTargetRange" means you can set a target power import (e. g. 75W). If the target power import fluctuate around this value (hysteresis), no adjustment will be triggered.

I wouldn't use a library. Just a simple enum and a switch statement.

enum PowerLimiterStates {STATE_DISCOVER = 0, STATE_OFF, STATE_CONSUME_SOLAR_POWER_ONLY, STATE_NORMAL_OPERATION, STATE_IDLE};
    u_int8_t plState = STATE_DISCOVER; // States might be manipulated externally, so we have to discover it first

    while(true) {
        switch(plState) {
            case STATE_DISCOVER:
                if (!inverter->isProducing() || isStopThresholdReached(inverter))
                    plState = STATE_OFF;
                else if (canUseDirectSolarPower())
                    plState = STATE_CONSUME_SOLAR_POWER_ONLY;
                else 
                    plState = STATE_NORMAL_OPERATION;
                break;
            case STATE_OFF:
                // if on turn off
                if (inverter->isProducing()) {
                    MessageOutput.printf("[PowerLimiterClass::loop] DC voltage: %.2f Corrected DC voltage: %.2f...\r\n",
                        dcVoltage, correctedDcVoltage);
                    MessageOutput.println("[PowerLimiterClass::loop] Stopping inverter...");
                    inverter->sendPowerControlRequest(Hoymiles.getRadio(), false);

                    uint16_t newPowerLimit = (uint16_t)config.PowerLimiter_LowerPowerLimit;
                    inverter->sendActivePowerControlRequest(Hoymiles.getRadio(), newPowerLimit, PowerLimitControlType::AbsolutNonPersistent);
                    _lastRequestedPowerLimit = newPowerLimit;
                    _lastCommandSent = millis();
                }
                // do nothing if battery is empty
                if (isStopThresholdReached(inverter)) 
                    return;
                // check for possible state changes
                else {
                    if (isStartThresholdReached(inverter) && calcPowerLimit(false) >= config.PowerLimiter_LowerPowerLimit)
                        plState = STATE_NORMAL_OPERATION;
                    else if (canUseDirectSolarPower() && calcPowerLimit(true) >= config.PowerLimiter_LowerPowerLimit)
                        plState = STATE_CONSUME_SOLAR_POWER_ONLY;

                    // inverter on on state change
                    if (plState != STATE_OFF) {
                        // DC voltage high enough, start the inverter
                        MessageOutput.println("[PowerLimiterClass::loop] Starting up inverter...");
                        inverter->sendPowerControlRequest(Hoymiles.getRadio(), true);
                        _lastCommandSent = millis();
                    }
                    else
                        return;
                break;
            case STATE_CONSUME_SOLAR_POWER_ONLY:
                if (isStopThresholdReached(inverter)) {
                    plState = STATE_OFF;
                    break;
                }
                else if (!canUseDirectSolarPower() || isStartThresholdReached(inverter)) {
                    plState = STATE_NORMAL_OPERATION;
                    break;
                }
                int32_t newPowerLimit = calcPowerLimit(true);
                if (newPowerLimit < config.PowerLimiter_LowerPowerLimit) {
                    plState = STATE_OFF;
                    break;
                }
                setNewPowerLimit(newPowerLimit);
                return;
                break;
            case STATE_NORMAL_OPERATION:
                 if (isStopThresholdReached(inverter)) {
                    plState = STATE_OFF;
                    break;
                }
                int32_t newPowerLimit = calcPowerLimit(false);
                if (newPowerLimit < config.PowerLimiter_LowerPowerLimit) {
                    plState = STATE_OFF;
                    break;
                }
                setNewPowerLimit(newPowerLimit);
                return;
                break;
        } 
    }

[helgeerbe]

Hier noch mal das State Diagramm

und hier der code:

while(true) {
        switch(_plState) {
            case STATE_DISCOVER:
                if (!inverter->isProducing() || isStopThresholdReached(inverter)) {
                    _plState = STATE_OFF;
                }
                else if (canUseDirectSolarPower()) {
                    _plState = STATE_CONSUME_SOLAR_POWER_ONLY;
                }
                else {
                    _plState = STATE_NORMAL_OPERATION;
                }
                break;
            case STATE_OFF:
                // if on turn off
                if (inverter->isProducing()) {
                    MessageOutput.printf("[PowerLimiterClass::loop] DC voltage: %.2f Corrected DC voltage: %.2f...\r\n",
                        dcVoltage, correctedDcVoltage);
                    MessageOutput.println("[PowerLimiterClass::loop] Stopping inverter...");
                    inverter->sendPowerControlRequest(Hoymiles.getRadio(), false);

                    uint16_t newPowerLimit = (uint16_t)config.PowerLimiter_LowerPowerLimit;
                    inverter->sendActivePowerControlRequest(Hoymiles.getRadio(), newPowerLimit, PowerLimitControlType::AbsolutNonPersistent);
                    _lastRequestedPowerLimit = newPowerLimit;
                    _lastCommandSent = millis();
                }

                // do nothing if battery is empty
                if (isStopThresholdReached(inverter)) 
                    return;
                // check for possible state changes
                if (isStartThresholdReached(inverter) && calcPowerLimit(inverter, false) >= config.PowerLimiter_LowerPowerLimit) {
                    _plState = STATE_NORMAL_OPERATION;
                }
                else if (canUseDirectSolarPower() && calcPowerLimit(inverter, true) >= config.PowerLimiter_LowerPowerLimit) {
                    _plState = STATE_CONSUME_SOLAR_POWER_ONLY;
                }

                // inverter on on state change
                if (_plState != STATE_OFF) {
                    // DC voltage high enough, start the inverter
                    MessageOutput.println("[PowerLimiterClass::loop] Starting up inverter...");
                    inverter->sendPowerControlRequest(Hoymiles.getRadio(), true);
                    _lastCommandSent = millis();
                }
                else
                    return;
                break;
            case STATE_CONSUME_SOLAR_POWER_ONLY: {
                int32_t newPowerLimit = calcPowerLimit(inverter, true);
                if (!inverter->isProducing() 
                        || isStopThresholdReached(inverter)
                        || newPowerLimit < config.PowerLimiter_LowerPowerLimit) {
                    _plState = STATE_OFF;
                    break;
                }
                else if (!canUseDirectSolarPower() || isStartThresholdReached(inverter)) {
                    _plState = STATE_NORMAL_OPERATION;
                    break;
                }
                setNewPowerLimit(inverter, newPowerLimit);
                return;
                break;
            }
            case STATE_NORMAL_OPERATION: {
                int32_t newPowerLimit = calcPowerLimit(inverter, false);
                if (!inverter->isProducing() 
                        || isStopThresholdReached(inverter)
                        || newPowerLimit < config.PowerLimiter_LowerPowerLimit) {
                    _plState = STATE_OFF;
                    break;
                }
                // check if grid power consumption is within the upper an lower threshold of the target consumption
                else if (newPowerLimit >= (config.PowerLimiter_TargetPowerConsumption - config.PowerLimiter_TargetPowerConsumptionHysteresis) &&
                    newPowerLimit <= (config.PowerLimiter_TargetPowerConsumption + config.PowerLimiter_TargetPowerConsumptionHysteresis)) {
                        return;
                }
                setNewPowerLimit(inverter, newPowerLimit);
                return;
                break;
            } 
        }
    }