Add config.boost_mode.start/stop_slot_min_diff

Add hot water slot parameter to find_working_temp_action
tyhdefu · Mar 5, 2024 · 599dbf3 · 599dbf3
1 parent 54c8f5a
commit 599dbf3
Show file tree

Hide file tree

Showing 11 changed files with 74 additions and 19 deletions.
diff --git a/src/brain/modes/circulate.rs b/src/brain/modes/circulate.rs
@@ -47,7 +47,7 @@ impl Mode for CirculateMode {
             &range,
             &config.hp_circulation,
             CurrentHeatDirection::Falling,
-            None,
+            None, None,
         ) {
             Ok(WorkingTempAction::Cool { circulate: true }) => Ok(Intention::YieldHeatUps),
             Ok(WorkingTempAction::Cool { circulate: false }) => {

diff --git a/src/brain/modes/dhw_only.rs b/src/brain/modes/dhw_only.rs
@@ -80,6 +80,7 @@ impl Mode for DhwOnlyMode {
                 &config.hp_circulation,
                 CurrentHeatDirection::Falling,
                 None,
+                Some(slot),
             ) {
                 Ok(WorkingTempAction::Cool { .. }) => {
                     debug!("Continuing to heat hot water as we would be circulating.");
@@ -180,7 +181,7 @@ mod test {
     use crate::time_util::mytime::DummyTimeProvider;
     use crate::time_util::test_utils::{date, time, utc_datetime, utc_time_slot};
     use chrono::{TimeZone, Utc};
-    use crate::brain::python_like::config::overrun_config::{DhwBap, DhwTemps};
+    use crate::brain::python_like::config::overrun_config::DhwBap;
 
     #[test]
     fn test_results() {

diff --git a/src/brain/modes/equalise.rs b/src/brain/modes/equalise.rs
@@ -74,7 +74,7 @@ impl Mode for EqualiseMode {
             &working_temp,
             &config.hp_circulation,
             CurrentHeatDirection::Falling,
-            None,
+            None, None,
         ) {
             Ok(WorkingTempAction::Cool { circulate: true }) => Ok(Intention::SwitchForce(
                 HeatingMode::TryCirculate(TryCirculateMode::new(Instant::now())),

diff --git a/src/brain/modes/heating_mode/mod.rs b/src/brain/modes/heating_mode/mod.rs
@@ -455,6 +455,7 @@ pub fn handle_finish_mode(
                 &config.hp_circulation,
                 CurrentHeatDirection::Climbing,
                 mixed_mode,
+                None,
             );
 
             let heating_mode = match working_temp_action {
@@ -538,7 +539,7 @@ pub fn handle_finish_mode(
                 &info_cache.get_working_temp_range(),
                 &config.hp_circulation,
                 CurrentHeatDirection::None,
-                None,
+                None, None,
             ) {
                 Ok(WorkingTempAction::Heat { .. }) => {
                     info!("Call for heat: turning on");

diff --git a/src/brain/modes/mixed.rs b/src/brain/modes/mixed.rs
@@ -79,6 +79,7 @@ impl Mode for MixedMode {
             &config.hp_circulation,
             CurrentHeatDirection::Climbing,
             Some(MixedState::MixedHeating),
+            Some(slot),
         ) {
             Ok(WorkingTempAction::Heat { mixed_state }) => {
                 match allow_dhw_mixed {
@@ -116,7 +117,7 @@ mod tests {
     use crate::brain::modes::{HeatingState, InfoCache, Mode};
     use crate::brain::python_like::config::PythonBrainConfig;
     use crate::brain::BrainFailure;
-    use crate::brain::python_like::config::overrun_config::{DhwTemps, DhwBap};
+    use crate::brain::python_like::config::overrun_config::DhwBap;
     use crate::io::dummy_io_bundle::new_dummy_io;
     use crate::io::temperatures::Sensor;
     use crate::time_util::mytime::DummyTimeProvider;

diff --git a/src/brain/modes/on.rs b/src/brain/modes/on.rs
@@ -107,6 +107,7 @@ impl Mode for OnMode {
             &config.hp_circulation,
             CurrentHeatDirection::Climbing,
             Some(if heating.try_get_heat_pump()? == HeatPumpMode::BoostedHeating { MixedState::BoostedHeating } else { MixedState::NotMixed }),
+            None,
         ) {
             Ok(WorkingTempAction::Heat { mixed_state: MixedState::MixedHeating }) => {
                 debug!("Finishing On mode to check for mixed mode.");

diff --git a/src/brain/modes/try_circulate.rs b/src/brain/modes/try_circulate.rs
@@ -80,6 +80,7 @@ impl Mode for TryCirculateMode {
                 &config.hp_circulation,
                 CurrentHeatDirection::Falling,
                 Some(MixedState::NotMixed),
+                None,
             ) {
                 Ok(WorkingTempAction::Heat { .. }) => {
                     info!("End of try period, heating is recommended.");
@@ -113,6 +114,7 @@ impl Mode for TryCirculateMode {
             &config.hp_circulation,
             CurrentHeatDirection::None,
             Some(MixedState::NotMixed),
+            None,
         ) {
             Ok(WorkingTempAction::Heat { .. }) => {
                 info!("Decided we should heat instead while trying circulation.");

diff --git a/src/brain/modes/turning_on.rs b/src/brain/modes/turning_on.rs
@@ -70,6 +70,7 @@ impl Mode for TurningOnMode {
             &config.hp_circulation,
             CurrentHeatDirection::None,
             Some(if heating.try_get_heat_pump()? == HeatPumpMode::BoostedHeating { MixedState::BoostedHeating } else { MixedState::NotMixed }),
+            None,
         ) {
             Ok(WorkingTempAction::Heat { mixed_state: MixedState::BoostedHeating }) => {
                 heating.set_heat_pump(HeatPumpMode::BoostedHeating, Some("Enabling boost from hot water tank"))?;

diff --git a/src/brain/modes/working_temp.rs b/src/brain/modes/working_temp.rs
@@ -1,4 +1,4 @@
-use crate::brain::modes::heating_mode::PossibleTemperatureContainer;
+use crate::brain::{modes::heating_mode::PossibleTemperatureContainer, python_like::config::overrun_config::DhwBap};
 use crate::brain::python_like::config::heat_pump_circulation::HeatPumpCirculationConfig;
 use crate::brain::python_like::config::working_temp_model::WorkingTempModelConfig;
 use crate::io::temperatures::Sensor;
@@ -233,6 +233,7 @@ pub fn find_working_temp_action(
     config:         &HeatPumpCirculationConfig,
     heat_direction: CurrentHeatDirection,
     mixed_state:    Option<MixedState>,
+    dhw_slot:       Option<&DhwBap>,
 ) -> Result<WorkingTempAction, Sensor> {
     let hx_pct = forecast_hx_pct(temps, config, &heat_direction, range)?;
 
@@ -275,7 +276,7 @@ pub fn find_working_temp_action(
     }
 
     if !should_cool {
-        return Ok(WorkingTempAction::Heat { mixed_state: get_mixed_state(temps, config, mixed_state, hx_pct)? });
+        return Ok(WorkingTempAction::Heat { mixed_state: get_mixed_state(temps, config, mixed_state, hx_pct, dhw_slot)? });
     }
 
     Ok(WorkingTempAction::Cool {
@@ -287,7 +288,8 @@ fn get_mixed_state(
     temps:          &impl PossibleTemperatureContainer,
     config:         &HeatPumpCirculationConfig,
     mixed_state:    Option<MixedState>,
-    hx_pct:         f32
+    hx_pct:         f32,
+    dhw_slot:       Option<&DhwBap>,
 ) -> Result<MixedState, Sensor> {
     if let Some(mixed_state) = mixed_state {
         // Possible candidate for boosting. This is where the heat pump is on, but the values and pump speeds
@@ -313,18 +315,31 @@ fn get_mixed_state(
         let tkfl = temps.get_sensor_temp(&Sensor::TKFL).ok_or(Sensor::TKFL)?;
         let hpfl = temps.get_sensor_temp(&Sensor::HPFL).ok_or(Sensor::HPFL)?;
 
+        let slot_margin = if let Some(dhw_slot) = dhw_slot {
+            let temp = temps.get_sensor_temp(&dhw_slot.temps.sensor).ok_or(dhw_slot.temps.sensor.clone())?;
+            *temp - dhw_slot.temps.min
+        }
+        else {
+            0.0
+        };
+
+
         match mixed_state {
             MixedState::BoostedHeating => {
-                if hx_pct < config.boost_mode.stop_heat_pct && tkfl - hpfl >= config.boost_mode.stop_tkfl_hpfl_diff {
-                    return Ok(MixedState::BoostedHeating)
+                if hx_pct      <  config.boost_mode.stop_heat_pct &&
+                   tkfl - hpfl >= config.boost_mode.stop_tkfl_hpfl_diff &&
+                   slot_margin >  config.boost_mode.stop_slot_min_diff {
+                        return Ok(MixedState::BoostedHeating)
                 }
             }
             MixedState::NotMixed | MixedState::MixedHeating => {
-                if hx_pct < config.boost_mode.start_heat_pct && tkfl - hpfl >= config.boost_mode.start_tkfl_hpfl_diff {
-                    return Ok(MixedState::BoostedHeating)
+                if hx_pct      <  config.boost_mode.start_heat_pct &&
+                   tkfl - hpfl >= config.boost_mode.start_tkfl_hpfl_diff &&
+                   slot_margin >  config.boost_mode.start_slot_min_diff {
+                        return Ok(MixedState::BoostedHeating)
                 }
             }
-        }            
+        }
 
         match mixed_state {
             MixedState::MixedHeating => 
@@ -521,6 +536,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::None,
             mixed_state,
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::NotMixed }, action);
@@ -545,7 +561,7 @@ mod test {
             &range,
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::None,
-            None,
+            None, None,
         )?;
 
         assert_eq!(WorkingTempAction::Cool { circulate: true }, action);
@@ -570,7 +586,7 @@ mod test {
             &range,
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::None,
-            None,
+            None, None,
         )?;
 
         assert_eq!(WorkingTempAction::Cool { circulate: false }, action);
@@ -595,7 +611,7 @@ mod test {
             &range,
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::None,
-            None,
+            None, None,
         )?;
 
         assert_eq!(WorkingTempAction::Cool { circulate: false }, action);
@@ -620,7 +636,7 @@ mod test {
             &range,
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Climbing,
-            None,
+            None, None,
         )?;
 
         assert_eq!(WorkingTempAction::Cool { circulate: false }, action);
@@ -648,6 +664,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Climbing,
             Some(MixedState::NotMixed),
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::MixedHeating }, action);
@@ -675,6 +692,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Climbing,
             Some(MixedState::MixedHeating),
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::MixedHeating }, action);
@@ -702,6 +720,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Climbing,
             Some(MixedState::NotMixed),
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::NotMixed }, action);
@@ -729,6 +748,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Climbing,
             Some(MixedState::MixedHeating),
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::MixedHeating }, action);
@@ -756,6 +776,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Climbing,
             Some(MixedState::MixedHeating),
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::NotMixed }, action);
@@ -780,7 +801,7 @@ mod test {
             &range,
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Climbing,
-            None,
+            None, None,
         )?;
 
         assert_eq!(WorkingTempAction::Cool { circulate: true }, action);
@@ -809,6 +830,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Falling,
             Some(MixedState::MixedHeating),
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::NotMixed }, action);
@@ -837,6 +859,7 @@ mod test {
             &PythonBrainConfig::default().hp_circulation,
             CurrentHeatDirection::Falling,
             Some(MixedState::NotMixed),
+            None,
         )?;
 
         assert_eq!(WorkingTempAction::Heat { mixed_state: MixedState::NotMixed }, action);

diff --git a/src/brain/python_like/config/heat_pump_circulation.rs b/src/brain/python_like/config/heat_pump_circulation.rs
@@ -59,10 +59,33 @@ pub struct MixedModeConfig {
 #[serde_as]
 #[derive(Clone, Deserialize, Debug, PartialEq)]
 pub struct BoostModeConfig {
+    /// The maximum percentage within the heating range to start boosting
+    /// Lower than this the rooms will heat up sufficiently quickly without boosting
     pub start_heat_pct:       f32,
+
+    /// The maximum percentage within the heating range to continue boosting once started
+    /// If too close to start_heat_pct then this will result in excessive valve movement
+    /// to little effect.
     pub stop_heat_pct:        f32,
+
+    /// The minimum difference between the TKFL and HPFL to start boosting
+    /// Lower than this would achieve very little.
     pub start_tkfl_hpfl_diff: f32,
+
+    /// The minimum difference between the TKFL and HPFL to continue boosting once started
+    /// If too close to start_tkfl_hpfl_diff then this will result in excessive valve movement
+    /// to little effect.
     pub stop_tkfl_hpfl_diff:  f32,
+
+    /// The minimum difference between the configured minimum tank temperature for the current
+    /// slot to start boosting
+    pub start_slot_min_diff: f32,
+
+    /// The minimum difference between the configured minimum tank temperature for the current
+    /// slot to continue boosting once started
+    /// If too close to start_slot_min_diff then this will result in excessive valve movement
+    /// to little effect.
+    pub stop_slot_min_diff:  f32,
 }
 
 impl Default for HeatPumpCirculationConfig {
@@ -85,6 +108,8 @@ impl Default for HeatPumpCirculationConfig {
                 stop_heat_pct:        0.10,
                 start_tkfl_hpfl_diff: 2.0,
                 stop_tkfl_hpfl_diff:  1.0,
+                start_slot_min_diff:  3.5,
+                stop_slot_min_diff:   1.5,
             },
             sample_tank_time: Duration::from_secs(30),
         }

diff --git a/test/python_brain/test_brain_config.toml b/test/python_brain/test_brain_config.toml
@@ -17,7 +17,7 @@ offset        = 31.2
 hp_pump_on_time = 70
 hp_pump_off_time = 30
 initial_hp_sleep = 300
-boost_mode = { start_heat_pct = 0.00, stop_heat_pct = 0.10, start_tkfl_hpfl_diff = 10.0, stop_tkfl_hpfl_diff = 5.0 }
+boost_mode = { start_heat_pct = 0.00, stop_heat_pct = 0.10, start_tkfl_hpfl_diff = 10.0, stop_tkfl_hpfl_diff = 5.0, start_slot_min_diff = 3.5, stop_slot_min_diff = 1.5 }
 
 [[immersion_heater_model.parts]]
 start = { time = "00:30:00", temp = 35.0 }