HeishaMon Rules

Some introduction

Here you find a collection of different rules to use with the HeishaMon.

Special thanks to @CurlyMoo and @blb4github. Most of the rules are inspired by their work.

Warning

Usage of the rules is at your own risk.

Instructions

You can pick and mix the functions you like. To start you always need the System#Boot section, this is where the basics are configured.

on System#Boot

This is the first section of the ruleset. Here you can confiugre some settings and are global variables defined. Default all functions are disabled (the #allow* variables), you can enable them by setting 0 to 1.

The second part of the global variables are mostly helpers. Where possible the are defaulted to -1 so you can monitor the results of the functions easily.

At the end the first timer, 1, is set to run after 10 seconds. This timer is also set in this block. This is our global timer that recurs every 30 seconds to hendle all the main functions.

System#Boot

on System#Boot then
    #allowSyncOT = 0;
    #allowCalcHeatCurve = 0;
    #allowSetQuietMode = 0;
    #allowshiftOnOpenTherm = 0;
    #allowSetMaxPumpDuty = 0;

    #chEnable = -1;
    #maxTa = -1;
    #quietModeHelper = 1;
    #quietModePrevious = -1;
    #chEnableCntr = -1;
    #chDisableCntr = -1;
    #chShiftHelper = 2;
    #pumpDutyHelper = -1;
    #maxPumpDuty = 85;
    setTimer(1,10);
end

on timer=1 then
    calcHeatCurve();
    syncOpenTherm();
    setQuietMode();
    shiftOnOpenTherm();
    setMaxPumpDuty();
    setTimer(1,30);
end

syncOpenTherm

This function synchronizes the heatpump values with your OpenTherm thermostat.

syncOpenTherm

on syncOpenTherm then
    if #allowSyncOT == 1 then
        ?outletTemp = @Main_Outlet_Temp;
        ?inletTemp = @Main_Inlet_Temp;
        ?outsideTemp = @Outside_Temp;
        ?dhwTemp = @DHW_Temp;
        ?dhwSetpoint = @DHW_Target_Temp;
        if ?chEnable == 1 then
            #chEnable = 1;
        else
            #chEnable = 0;
        end
    end
    #dhwEnable = ?dhwEnable;
    if #maxTa != -1 then
        ?maxTSet = #maxTa;
    end
    if @Compressor_Freq == 0 then
        ?flameState = 0;
        ?chState = 0;
        ?dhwState = 0;
    else
        ?flameState = 1;
        if @ThreeWay_Valve_State == 0 then
            ?chState = 1;
            ?dhwState = 0;
        else
            ?chState = 0;
            ?dhwState = 1;
        end
    end
end

calcHeatCurve

This function calculates the target temperature based on the configured Heat Curve

When using syncOpenTherm the #maxTa value will be synced to the thermostat as ?maxTSet.

calcHeatCurve

on calcHeatCurve then
    if #allowCalcHeatCurve == 1 then
        if isset(@Z1_Heat_Curve_Target_Low_Temp) && isset(@Z1_Heat_Curve_Outside_High_Temp) && isset(@Z1_Heat_Curve_Target_High_Temp) && isset(@Z1_Heat_Curve_Outside_Low_Temp) && isset(@Outside_Temp) then
            $Ta1 = @Z1_Heat_Curve_Target_Low_Temp;
            $Tb1 = @Z1_Heat_Curve_Outside_High_Temp;
            $Ta2 = @Z1_Heat_Curve_Target_High_Temp;
            $Tb2 = @Z1_Heat_Curve_Outside_Low_Temp;
            $Tb3 = @Outside_Temp;
            if $Tb3 >= $Tb1 then
                #maxTa = $Ta1;
            else
                if $Tb3 <= $Tb2 then
                    #maxTa = $Ta2;
                else
                    #maxTa = 1 + floor(0.9 + $Ta1 + (($Tb1 - $Tb3) * ($Ta2 - $Ta1) / ($Tb1 - $Tb2)));
                end
            end
        end
    end
end

setQuietMode

This function sets the quiet mode based on a combination of the current time and the value of @Outside_Temp. It will help the heatpump running more stable and in low frequencies.

Important

Using this function will enable quiet mode which might impact your power usage and the performance of your heatpump.

setQuietMode

on timer=2 then
    #quietModeHelper = 1;
    #quietMode = 0;
end

on setQuietMode then
    if #allowSetQuietMode == 1 then
        if isset(@Outside_Temp) && isset(@Heatpump_State) then
            if #quietModeHelper == 1 then
                if @Outside_Temp < 13 then
                    #quietMode = 1;
                else
                    #quietMode = 2;
                end
                if @Outside_Temp < 8 then
                    #quietMode = 0;
                end
                if @Outside_Temp < 2 then
                    if %hour > 22 || %hour < 7 then
                        #quietMode = 1;
                    else
                        #quietMode = 0;
                    end
                end
                if #quietModePrevious != #quietMode && @Heatpump_State == 1 then
                    setTimer(2, 900);
                    #quietModeHelper = 0;
                    #quietModePrevious = #quietMode;
                    @SetQuietMode = #quietMode;
                end
            end
        end
    end
end

setMaxPumpDuty

This function adjust the pump duty based on the state of the heatpump and the outside temperature.

setMaxPumpDuty

on setMaxPumpDuty then
    if #allowSetMaxPumpDuty == 1 then
        #pumpDutyHelper = #pumpDutyHelper + 1;
        if #pumpDutyHelper == 6 then
            #pumpDutyHelper = 0;
            if @ThreeWay_Valve_State == 1 && @Max_Pump_Duty != 220 then
                @SetMaxPumpDuty = 220;
            end
            if @ThreeWay_Valve_State == 0 && @Heatpump_State == 1 then
                if @Outside_Temp < 10 then
                    $MPF = 11;
                else
                    $MPF = 10;
                end
                if @Outside_Temp < 5 then
                    $MPF = 12;
                end
                if @Outside_Temp < 2 then
                    $MPF = 13;
                end
                if @Compressor_Freq == 0 then
                    $MPF = 8;
                end
                if @Pump_Flow < $MPF then
                    #maxPumpDuty = #maxPumpDuty + 5;
                else
                    if @Pump_Flow > $MPF + 1 then
                        #maxPumpDuty = #maxPumpDuty - 1;
                    end
                end
                if #maxPumpDuty > 140 then
                    #maxPumpDuty = 140;
                end
                if @Max_Pump_Duty != #maxPumpDuty then
                    @SetMaxPumpDuty = #maxPumpDuty;
                end
            end
        end
    end
end

shiftOnOpenTherm

Warning

This function is still in experimental phase.

This function shifts the request temperature up based on the chEnable status of the thermostat. If the thermostat is requesting heat for longer then 30 minutes, the @SetZ1HeatRequestTemperature is shifted to the value set in #chShiftHelper (see the System#Boot section) to speed up your warm up process. If the thermostat doesn't request any heat for longer then 30 minutes, the @SetZ1HeatRequestTemperature is set back to 0.

shiftOnOpenTherm

on shiftOnOpenTherm then
    if #allowshiftOnOpenTherm == 1 then
        if ?chEnable == 0 && ?chSetpoint == 10 then
            #chDisableCntr = #chDisableCntr + 1;
        end
        if ?chEnable == 1 && ?chSetpoint != 10 then
            #chEnableCntr = #chEnableCntr + 1;
        end
        if #chEnableCntr == 60 then
            if #chShiftHelper != 2 then
                #chShiftHelper = 2;
                @SetZ1HeatRequestTemperature = 2;
            end
            #chEnableCntr = 0;
        end
        if #chDisableCntr == 60 then
            if #chShiftHelper != 0 then
                #chShiftHelper = 0;
                @SetZ1HeatRequestTemperature = 0;
            end
            #chDisableCntr = 0;
        end
    end
end