The purpose of this site is to publish the rules I use on my HeishaMon to control my Panasonic Heat Pump in combination with an Opentherm thermostat. I try to keep it as univeral as possible but it is at the end taylored to my situation and needs. You can just copy it and start using it (at your own risk) or, better, you can use is as inspiration for your own rules set.
My setup:
a) Panasonic Heat Pump WH-MDC07J3E5 used for central heating and DHW (external tank);
b) Heishamon Opentherm version, firmware 3.2.4-beta;
c) Central heating system build out of radiators and convectors;
d) Evohome zone thermostat with opentherm boiler module.
- Max Pump Speed based on HP status 1) DHW, 2) HEAT/COOL (and the outside temp as well), IDLE flow;
- QuiteMode based on time (e.g. at night) & for Heat/Cool at start Compressor until Compressor Frequency < 30 Hz.;
- DHW production if DHWTemp <37, every day at fixed time if DHWTemp < DHWTargetTemp + DHWDelta and 1 x per week (at LegionellaRunDay) a legionellarun;
- WAR calcuation based on WAR Temperature settings from HP;
- Result of WAR calculation used for OT maxTSet (which is used by OT Thermostat as Maximum ?chSetpoint);
- Sync OT values with HP values to have correct (status) values from HP communicated to OT Thermostat;
- OT Thermostat HP control: 1) sync Main_Target_Temp with ?chSetpoint and 2) switch off HP (wapter pump) when ?chEnable is 0 (for a mimumum time);
- ExtendRunTime function which increases Main_Target_Temp to extend the run time if Heat loss is less than minimum HP Power.
Here you find a collection of different rules to use with the HeishaMon.
Special thanks to @CurlyMoo for all rules functionality and @fbloemhof for the inspiration how to document on Github.
Warning
Usage of these rules is at your own risk.
It should be possible to pick and choose the functions you like. To start you always need the System#Boot section, this is where the basics are configured. Also timer 1 and timer 2 are part of the basic setup although timer 1 and timer 2 are placed at the end of the rules set.
Purpose: 1) define which functions are active (#allow variables), 2) initial values of global variables used in the ruleset and 3) start 2 main timers, 1 for time & day references, the other one to trigger all acitve functions.
Explanation: By default all functions are enabled (the #allow* variables), you can disable them by setting 1 to 0. 3 Variables have to be set according needs; #legionellaRunDay = [1..7] defines the day a legionellarun will be performed (1 is Sunday, 7 is Saturday), #maxPDuty = xx defines the maxPumpDuty to be used as start during Heat run and #maxTa = xx sets the default maxTa if WAR function isn't used (#allowWAR = 0). All other global variables are default set to -1 so you can monitor the results of the functions easily. In the System#Boot loop timer 1 is triggered after only 60 seconds to give time to fill all variables from HP, OT and 1W.
Called by: system Boot
Purpose: to call all functions.
Explanation: this function will run first time 1 minute after system Boot to allow all HP & OT variables to sync with HP/OT Thermostat. First Run (#firstBoot = 1) is different to set some values correct and to run some functions in the right order.
Called by: System#Boot, timer=1
Purpose: time refference
Explanation: #chEnableOffTime and #compRunTime are based on #timeRef. As HeishaMon doesn't have time function #timeRef is set to minutes after sunday 00:00u.
Called by: 10 seconds after System#Boot, timer=2 (every minute)
System#Boot, timer=1, timer=2
on System#Boot then
#allowDHW = 1;
#allowOTT = 1;
#allowExtRunTime = 1;
#allowPumpSpeed = 1;
#allowSilentMode = 1;
#allowSyncOT = 1;
#allowWAR = 1;
#legionellaRunDay = 7;
#maxPDuty = 85;
#maxTa = 40;
#chE = -1;
#chEOffTime = -1;
#chETimeOff = -1;
#compRunTime = -1;
#compStartTime = -1;
#compState = -1;
#dayTime = -1;
#DHWRun = -1;
#firstBoot = 1;
#operatingMode = -1;
#prevHPS = -1;
#prevOM = -1;
#roomTDelta = -1;
#silentMode = -1;
#timeRef = -1;
setTimer(1,60);
setTimer(2,10);
end
on timer=1 then
#3WVS = @ThreeWay_Valve_State;
if #firstBoot == 1 then
if @Compressor_Freq > 18 then
#compStartTime = #timeRef;
#compState = 1;
end
if #3WVS == 1 && #allowDHW == 1 then
#DHWRun = 2;
end
compFreq();
WAR();
syncOT();
#firstBoot = 2;
else
WAR();
silentMode();
syncOT();
pumpDuty();
DHW();
OTT();
eXtRunTime();
end
setTimer(1,15);
end
on timer=2 then
#timeRef = %day * 1440 + %hour * 60 + %minute;
if %hour > 9 && %hour < 17 then
#dayTime = 1;
else
#dayTime = 0;
end
setTimer(2,60);
endPurpose: extend compressor runtime by shifting Target Temp up if TOutlet is higher than Target temp
Explanation: at a certain (high) outside Temperature the minimum power of the HP is higher than the heat lost and as a result the compressor will switch off if TOutlet > Target temp + 2 degrees. This can lead to short compressor run times and the purpose of this function is to extend the runtime by shifting the Target Temp up.
Result: @SetZ1HeatRequestTemperature set to required value
Called by: timer=1
eXtRunTime
on eXtRunTime then
if #allowExtRunTime == 1 then
#allowExtRunTime = 2;
$hM = @Heating_Mode;
$oST = @Outside_Temp;
$hRT = @Z1_Heat_Request_Temp;
if $hM == 1 then
$hRT = $hRT - #maxTA;
end
$mOT = @Main_Outlet_Temp;
$mTT = @Main_Target_Temp;
if #compState == 1 then
if $oST > 7 && #compRunTime > 10 then
if $mOT > (1.6 + $mTT) then
$hRT = 1 + $hRT;
else
if $mOT < (0.5 + $mTT) && $hRT > 0 then
$hRT = -1 + $hRT;
end
end
if $hRT > 2 then
$hRT = 2;
end
if $hRT < -1 then
$hRT = -1;
end
end
else
$hRT = 0;
end
if $hM == 1 then
$hRT = #maxTA + $hRT;
end
if $hRT != @Z1_Heat_Request_Temp then
@SetZ1HeatRequestTemperature = $hRT;
end
setTimer(8,60);
end
endPurpose: to control the HP Heat prodcution by the Opentherm Thermostat.
Explanation: The main control is ?chEnable; chEnable does have similar function as an ON/OFF thermostat (as my Evohome Opentherm thermostat doesn't provide a stable chSetpoint value I'm not using chSetpoint anymore).
The compressor will be forced OFF if rooomtemperature is 0.5 degrees above setpoint, chEnable is 15 minutes off and the compressor did run for at least 30 minutes. The 0.5 above (room)setpoint is added because evohome could keep chEnable ON if other zones are not yet on targettemperature but is nessesary because not all rooms have TRV's mounted.
The HP will be switched ON if #chEnable == 1 and OFF if chEnable is 30 minutes off except if outside temperature is below 2 degrees (waterpump will continue to run in that situation). By default this function is checked every 30 seconds except when heatpump is switched off if will run only after 10 minutes.
Called by: timer=1
Purpose: 1) determine if Compressor is running (#compState will be set to 1, otherwise 0), 2) set #compRunTime (time the compressor is running).
Result: #compState, #CompRunTime
Called by: Timer=1 (firstBoot = 1), @Compressor_Freq
OTThermostat/compFreq
on OTT then
if #allowOTT == 1 && #DHWRun < 1 && #3WVS == 0 && @Defrosting_State == 0 then
if @Heatpump_State != 1 && #chE == 1 then
@SetHeatpump = 1;
end
if #chEOffTime > 30 && #3WVS == 0 && (#compRunTime > 30 || #compState == 0) && @Outside_Temp > 2 then
@SetHeatpump = 0;
if @Operating_Mode_State != 0 then
@SetOperationMode = 0;
end
#allowOTT = 0;
setTimer(7,600);
end
if #chE == 0 then
#allowOTT = 0;
setTimer(7,25);
end
end
end
on compFreq then
if @Compressor_Freq > 18 then
if #compState < 1 then
#compStartTime = #timeRef;
#compState = 1;
end
#compRunTime = #timeRef - #compStartTime;
if #compRunTime < 0 then
#compRunTime = #timeRef - #compStartTime + 10080;
end
else
#compState = 0;
#compStartTime = -1;
#compRunTime = -1;
end
end
on @Compressor_Freq then
compFreq();
end
on timer=7 then
#allowOTThermostat = 1;
endPurpose: 1) to have hot water available & 2) to do weekly legionella run.
Explanation: Every day between 13 and 14 hour (efficient time of day) a check is performed if DHW temp is below threshold. In that case a DHW run is performed and a legionella run if day is legionellaRunDay. As a safeguard a DHW run will be performed as well if DHW temp drops below 37 degrees. OM 4 is used to give the HP the option to produce heat during legionella run on external element.
After the DHW run the previous OM and HPState will be restored. Defrost state is checked to prevent returning back from DHW run to previous OM if Defrost is performed during DHW run. This function runs every 15 minutes
Called by: timer=1
DHW
on DHW then
if #allowDHW == 1 then
#allowDHW = 0;
if #3WVS == 0 && (@DHW_Temp < 37 || (%hour == 13 && (%day == #legionellaRunDay || @DHW_Temp < (@DHW_Target_Temp + @DHW_Heat_Delta)))) then
#DHWRun = 1;
#prevOM = @Operating_Mode_State;
#prevHPS = @Heatpump_State;
@SetOperationMode = 4;
if @Heatpump_State != 1 then
@SetHeatpump = 1;
end
end
if #DHWRun > 0 then
if %day == #legionellaRunDay && %hour >= 13 && @DHW_Temp > 47 && @Sterilization_State != 1 then
@SetForceSterilization = 1;
end
if #3WVS == 0 && @DHW_Temp >= @DHW_Target_Temp && @Defrosting_State == 0 && @Sterilization_State == 0 then
@SetOperationMode = #prevOM;
if @Heatpump_State != #prevHPS then
@SetHeatpump = #prevHPS;
end
#prevOM = 4;
#prevHPS = 1;
#DHWRun = 0;
end
end
#operatingMode = @Operating_Mode_State;
setTimer(6,900);
end
end
on timer=6 then
#allowDHW = 1;
endPurpose: to set the (max)PumpSpeed depening in the Operation Mode (Heat/Cool, DHW or Idle) and for Heat/Cool the speed will depend on the outside temperature as well to make sure enough heat can be transported. The main reason for this function is to avoid water running sounds in the piping an radiators.
Explanation: During DHW run the maxPumpDuty will be high (140) to allow high power transport to the boiler & during DHW run the piping doesn't produce noice. Almost at the end of the run the maxPumpSpeed is reduced (to 90) to avoid short noice peak when 3way valve returs back to 0. If @Pump_Flowrate_mode == 1 (direct) maxPumpDuty will be set based on actual water flow (see below), else the actual water flow will not be used as feedback as the HP controls pump duty itselfs based on dT. During Heat maxPumpDuty will be set in such way the water flow will 10 to 13 liter per minute depending on the outside temperature. During Idle maxPumpDuty will be set in such way the water flow will be 8 liter per minute. When HP switches off maxPumpDuty will be set back to default value.
Called by: timer=1
maxPumpDuty
on pumpDuty then
if #allowPumpSpeed == 1 then
#allowPumpSpeed = 0;
$pFM = @Pump_Flowrate_mode;
if #3WVS == 1 then
$mPD = 140;
$oST = @Outside_Temp;
if (@Sterilization_State == 0 && @DHW_Temp > @DHW_Target_Temp) || (@Sterilization_State == 1 && @DHW_Temp > 57) then
$mPD = 10 + #maxPDuty;
end
else
if @Heatpump_State == 1 then
$mPD = @Max_Pump_Duty;
if @Compressor_Freq == 0 && @Defrosting_State != 1 then
$mPF = 8;
else
$fH = 10; $fL = 14; $tH = 11; $tL = -3;
if $oST >= $tH then
$mPF = $fH;
else
if $oST <= $tL then
$mPF = $fL;
else
$mPF = 1 + floor(0.9 + $fH + (($tH - $oST) * ($fL - $fH) / ($tH - $tL)));
end
end
end
if $pFM == 1 then
if @Pump_Flow < $mPF then
$mPD = $mPD + 3;
else
if @Pump_Flow > ($mPF + 1) then
$mPD = $mPD - 1;
end
end
else
$mPD = 55+ floor($mPF * 3);
end
else
$mPD = #maxPDuty;
end
end
if @Max_Pump_Duty != $mPD then
@SetMaxPumpDuty = $mPD;
end
setTimer(5, 60);
end
end
on timer=5 then
#allowPumpSpeed = 1;
endPurpose: execute @SetQuietMode command
Called by: silentMode, @Defrosting_State
Purpose: to define #silentMode value based on outside temperature and time of day.
Explanation: #ilentMode/Quiet Mode is used for 2 reasons: 1) to limit the noice from the HP during night time, 2) to limit the startup power (which comes with noice as well) to prevent short runs. During DHW mode in dayTime the QM level will be 1 step reduced to have more power available. This function runs every 2 minutes.
Called by: timer=1
siletMode / quietmode
on quietMode then
$qM = @Quiet_Mode_Level;
if $qM != #silentMode then
@SetQuietMode = #silentMode;
end
end
on silentMode then
if #allowSilentMode == 1 && @Defrosting_State == 0 then
#allowSilentMode = 2;
$cF = @Compressor_Freq;
$qM = @Quiet_Mode_Level;
if #compRunTime < 3 then
#silentMode = 3;
else
if $cF < 24 || ($qM == 0 && $cF < 27) then
#silentMode = 0;
else
if $cF < 30 || ($qM == 1 && $cF < 33) then
#silentMode = 1;
else
if $cF < 50 || ($qM == 2 && $cF < 53) then
#silentMode = 2;
else
#silentMode = 3;
end
end
end
end
if #silentMode > 1 && #3WVS == 1 && #dayTime == 1 then
#silentMode = -1 + #silentMode;
end
quietMode();
setTimer(3,120);
end
end
on timer=3 then
#allowSilentMode = 1;
endPurpose: 1) synchronizes several ?opentherm values with their corresponding @heatpump values and vice versa, 2) sync #chEnable with ?chEnable, 3) set #chEnableTimeOff variable.
Explanation: Most of the sync is straight forward, ?chEnable is sometime switched off for a short moment, the logic keeps #chEnable 1 as long as ?chEnable is 0 for less than 5 minutes or ?chSetpoint = 10. #chEnableTimeOff is used in OTTThermostat to swich off compressor and/or water pump. ?maxTSet is only cynch with #maxTA when #maxTA is set. During Defrost both ?chState & DHWState are set to 0. This function runs every 15 seconds (in same pace as Timer=1)
Result: #chE(nable), #chETimeOff
Called by: timer=1
syncOpenTherm
on syncOT 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
#chE = 1;
if #chETimeOff != -1 then
#chETimeOff = -1;
#chEOffTime = -1;
end
else
if #chETimeOff == -1 then
#chETimeOff = #timeRef;
end
#chEOffTime = #timeRef - #chETimeOff;
if #chEOffTime < 0 then
#chEOffTime = #timeRef - #chETimeOff + 10080;
end
if (#chEOffTime > 5 || ?chSetpoint == 10) then
#chE = 0;
end
end
?maxTSet = #maxTa;
if @Compressor_Freq == 0 then
?flameState = 0;
?chState = 0;
?dhwState = 0;
else
?flameState = 1;
if @Defrosting_State == 0 then
if #3WVS == 0 then
?chState = 1;
?dhwState = 0;
else
?chState = 0;
?dhwState = 1;
end
else
?chState = 0;
?dhwState = 0;
end
end
#roomTDelta = ?roomTempSet - ?roomTemp;
end
endPurpose: to calculate the required T_Outlet as function of the outside temperature using a compensation curve. If @Heating_Mode == 1 (direct) Z1_Heat_Curve_Target_High_Temp is set in this function as @Z1_Heat_Curve_Target_High_Temp is set to @SetZ1HeatRequestTemperature during direct mode. This function runs every 30 minutes.
Result: #maxTA which is used in the OTTThermostat function.
Called by: timer=1
WAR
on WAR then
if #allowWAR == 1 then
#allowWAR = 0;
$oST = @Outside_Temp;
$Ta1 = @Z1_Heat_Curve_Target_Low_Temp;
$Tb1 = @Z1_Heat_Curve_Outside_High_Temp;
if @Heating_Mode == 1 then
$Ta2 = 36;
else
$Ta2 = @Z1_Heat_Curve_Target_High_Temp;
end
$Tb2 = @Z1_Heat_Curve_Outside_Low_Temp;
if $oST >= $Tb1 then
#maxTa = $Ta1;
else
if $oST <= $Tb2 then
#maxTa = $Ta2;
else
#maxTa = floor(0.9 + $Ta1 + (($Tb1 - $oST) * ($Ta2 - $Ta1) / ($Tb1 - $Tb2)));
end
end
setTimer(4,1800);
end
end
on timer=4 then
#allowWAR = 1;
end