add set therm sine and make thermal related tests

Author: samuelnguyen999

src/devices/thermal_control.py

@@ -26,6 +26,8 @@ def __init__(self, titrator):
         self._ramp_time_start_seconds = 0
         self._ramp_time_end_seconds = 0
         self._ramp_initial_value = 0.0
+        self._amplitude = 0.0
+        self._period_in_seconds = 0
 
     def get_heat(self, default):
         """
@@ -130,3 +132,32 @@ def set_ramp_duration_hours(self, new_ph_ramp_duration):
             self._ramp_time_end_seconds = 0
             self._thermal_function_type = ThermalControl.FLAT_TYPE
             print("Set ramp time to 0")
+
+    def get_amplitude(self):
+        """
+        Get the amplitude for the pH function.
+        """
+        return self._amplitude
+
+    def set_amplitude(self, amplitude):
+        """
+        Set the amplitude for the pH function.
+        """
+        self._amplitude = amplitude
+
+    def get_period_in_seconds(self):
+        """
+        Get the period in seconds for the pH function.
+        """
+        return self._period_in_seconds
+
+    def set_sine_amplitude_and_hours(self, amplitude, period_in_hours):
+        """
+        Set the amplitude and period (in hours) for the sine wave pH function.
+        """
+        if amplitude > 0 and period_in_hours > 0:
+            self._amplitude = amplitude
+            self._period_in_seconds = int(period_in_hours * 3600)
+            self._thermal_function_type = ThermalControl.SINE_TYPE
+        else:
+            raise ValueError("Amp and period !> than 0.")

src/ui_state/set_menu/set_thermal_sine_wave.py

@@ -2,10 +2,57 @@
 The file to hold the Set Thermal Sine Wave class
 """
 
-from src.ui_state.ui_state import UIState
+from src.ui_state.user_value import UserValue
 
 
-class SetThermalSineWave(UIState):
+class SetThermalSineWave(UserValue):
     """
     This is a class for the SetThermalSineWave state of the Tank Controller
     """
+
+    def __init__(self, titrator, previous_state=None):
+        """
+        Constructor for the SetThermalTarget class
+        """
+        super().__init__(titrator, previous_state)
+        self.previous_state = previous_state
+        self.prompts = ["Set T Set Point", "Set Amplitude:", "Set Period hrs:"]
+        self.values = [0.0] * 3
+        self.sub_state = 0
+
+    def get_label(self):
+        """
+        Returns the label for the user value input.
+        """
+        return self.prompts[self.sub_state]
+
+    def save_value(self):
+        """
+        Saves the entered value for the current sub-state and advances to the next sub-state.
+        """
+        self.values[self.sub_state] = float(self.value)
+        self.sub_state += 1
+
+        if self.sub_state < len(self.values):
+            self.value = ""
+        else:
+            self.titrator.thermal_control.set_base_thermal_target(self.values[0])
+            self.titrator.thermal_control.set_sine_amplitude_and_hours(
+                self.values[1], self.values[2]
+            )
+            temperature = f"New Temp={self.values[0]:.2f}"
+            amplitude_and_period = f"A={self.values[1]:.2f} P={self.values[2]:.3f}"
+            self.titrator.lcd.print(temperature, line=1)
+            self.titrator.lcd.print(amplitude_and_period, line=2)
+
+            self.return_to_main_menu(ms_delay=3000)
+
+    def handle_key(self, key):
+        """
+        Handles key presses and updates the display accordingly.
+        """
+        if key == "A" and self.value not in ("", "."):
+            self.save_value()
+            self.value = ""
+        else:
+            super().handle_key(key)

tests/devices/thermal_control_test.py

@@ -68,6 +68,9 @@ def test_get_and_set_thermal_function_type():
     thermal_control.set_thermal_function_type(ThermalControl.RAMP_TYPE)
     assert thermal_control.get_thermal_function_type() == ThermalControl.RAMP_TYPE
 
+    thermal_control.set_thermal_function_type(ThermalControl.SINE_TYPE)
+    assert thermal_control.get_thermal_function_type() == ThermalControl.SINE_TYPE
+
     try:
         thermal_control.set_thermal_function_type(99)
     except ValueError as err:
@@ -90,3 +93,21 @@ def test_set_ramp_duration_hours():
     thermal_control.set_ramp_duration_hours(0)
     assert thermal_control.get_ramp_time_end() == 0
     assert thermal_control.get_thermal_function_type() == ThermalControl.FLAT_TYPE
+
+
+def test_set_sine_amplitude_and_hours():
+    """
+    Test setting the sine amplitude and period in hours.
+    """
+    mock_titrator = Mock()
+    thermal_control = ThermalControl(mock_titrator)
+
+    thermal_control.set_sine_amplitude_and_hours(1.5, 4)
+    assert thermal_control.get_amplitude() == 1.5
+    assert thermal_control.get_period_in_seconds() == 14400
+    assert thermal_control.get_thermal_function_type() == ThermalControl.SINE_TYPE
+
+    try:
+        thermal_control.set_sine_amplitude_and_hours(-1, 4)
+    except ValueError as err:
+        assert str(err) == "Amp and period !> than 0."

tests/ui_state/set_menu/set_tank_id.py …ts/ui_state/set_menu/set_tank_id_test.pytests/ui_state/set_menu/set_tank_id.py renamed to tests/ui_state/set_menu/set_tank_id_test.py tests/ui_state/set_menu/set_tank_id.py renamed to tests/ui_state/set_menu/set_tank_id_test.py

@@ -0,0 +1,52 @@
+"""
+The file to test the ResetPHCalibration class
+"""
+
+from unittest import mock
+
+from src.devices.library import LiquidCrystal
+from src.titrator import Titrator
+from src.ui_state.main_menu import MainMenu
+from src.ui_state.set_menu.set_thermal_calibration_clear import (
+    ResetThermalCalibration,
+)
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_reset_ph_calibration(print_mock):
+    """
+    Test that pressing 'A' clears pH calibration and transitions to ViewPHCalibration.
+    """
+    titrator = Titrator()
+    state = ResetThermalCalibration(titrator, MainMenu(titrator))
+    titrator.thermal_probe.clear_thermal_correction = mock.Mock()
+
+    state.loop()
+    print_mock.assert_any_call("A: Clear TempCal", line=1)
+
+    state.handle_key("A")
+    titrator.thermal_probe.clear_thermal_correction.assert_called_once()
+    print_mock.assert_any_call("Cleared TempCali", line=1)
+
+    assert isinstance(titrator.state.next_state, MainMenu)
+
+
+def test_set_calibration_get_label():
+    """
+    Test the label returned by get_label.
+    """
+    titrator = Titrator()
+    state = ResetThermalCalibration(titrator, MainMenu(titrator))
+
+    assert state.get_label() == "A: Clear TempCal"
+
+
+def test_handle_key_d():
+    """
+    The function to test the reset handle keys
+    """
+    titrator = Titrator()
+    titrator.state = ResetThermalCalibration(titrator, MainMenu(titrator))
+
+    titrator.state.handle_key("D")
+    assert isinstance(titrator.state, MainMenu)

tests/ui_state/set_menu/set_thermal_calibration_clear_test.py

@@ -0,0 +1,70 @@
+"""
+The file to test the SetThermalCalibration class
+"""
+
+from unittest import mock
+
+from src.devices.library import LiquidCrystal
+from src.titrator import Titrator
+from src.ui_state.main_menu import MainMenu
+from src.ui_state.set_menu.set_thermal_calibration import SetThermalCalibration
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_set_thermal_calibration_valid_input(print_mock):
+    """
+    Unittest that entering a valid tank ID sets EEPROM and shows confirmation.
+    """
+    titrator = Titrator()
+    titrator.thermal_probe.set_thermal_correction(2.5)
+    state = SetThermalCalibration(titrator, MainMenu(titrator))
+    assert state.value == "2.5"
+
+    state.save_value()
+    assert titrator.thermal_probe.get_thermal_correction() == 2.5
+    print_mock.assert_any_call("New correction=2.5", line=2)
+
+    assert isinstance(titrator.state.next_state, MainMenu)
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_user_thermal_calibration_string_input(print_mock):
+    """
+    Test entering a tank ID value through the UserValue interface.
+    """
+    titrator = Titrator()
+    state = SetThermalCalibration(titrator, MainMenu(titrator))
+
+    state.handle_key("C")
+    assert state.value == ""
+    state.handle_key("1")
+    assert state.value == "1"
+    state.handle_key("0")
+    assert state.value == "10"
+    state.handle_key("A")
+
+    assert titrator.thermal_probe.get_thermal_correction() == 10
+    print_mock.assert_any_call("New correction=10.0", line=2)
+
+    assert isinstance(titrator.state.next_state, MainMenu)
+
+
+def test_set_thermal_calibration_get_label():
+    """
+    Test the label returned by get_label.
+    """
+    titrator = Titrator()
+    state = SetThermalCalibration(titrator, MainMenu(titrator))
+
+    assert state.get_label() == "Real Temperature"
+
+
+def test_handle_key_d():
+    """
+    The function to test the reset handle keys
+    """
+    titrator = Titrator()
+    titrator.state = SetThermalCalibration(titrator, MainMenu(titrator))
+
+    titrator.state.handle_key("D")
+    assert isinstance(titrator.state, MainMenu)

tests/ui_state/set_menu/set_thermal_calibration_test.py

@@ -0,0 +1,101 @@
+"""
+Test file for the Set Thermal Sine Wave UI state
+"""
+
+from unittest import mock
+
+from src.devices.library import LiquidCrystal
+from src.titrator import Titrator
+from src.ui_state.main_menu import MainMenu
+from src.ui_state.set_menu.set_thermal_sine_wave import SetThermalSineWave
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_set_thermal_sine_wave_handle_key(print_mock):
+    """
+    Test that handle_key processes key presses correctly.
+    """
+    titrator = Titrator()
+    state = SetThermalSineWave(titrator, MainMenu(titrator))
+
+    state.loop()
+    print_mock.assert_any_call("Set T Set Point", line=1)
+
+    state.handle_key("7")
+    state.handle_key("A")
+
+    assert state.sub_state == 1
+    assert state.values[0] == 7
+
+    state.loop()
+    print_mock.assert_any_call("Set Amplitude:", line=1)
+    print_mock.assert_any_call("", style="center", line=2)
+
+
+def test_set_thermal_sine_wave_advances_substates():
+    """
+    Test that the state advances through substates correctly.
+    """
+    titrator = Titrator()
+    state = SetThermalSineWave(titrator, MainMenu(titrator))
+
+    state.value = "7.5"
+    state.save_value()
+    assert state.sub_state == 1
+    state.value = "2.0"
+    state.save_value()
+    assert state.sub_state == 2
+    state.value = "24.0"
+    state.save_value()
+    assert state.sub_state == 3
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_set_thermal_sine_wave_valid_input(print_mock):
+    """
+    Test that valid pH mean, amplitude, and period inputs are saved and displayed correctly.
+    """
+    titrator = Titrator()
+    titrator.thermal_control = mock.Mock()
+    state = SetThermalSineWave(titrator, MainMenu(titrator))
+
+    state.value = "7.5"
+    state.save_value()
+    state.value = "2.0"
+    state.save_value()
+    state.value = "24.0"
+    state.save_value()
+
+    titrator.thermal_control.set_base_thermal_target.assert_called_once_with(7.5)
+    titrator.thermal_control.set_sine_amplitude_and_hours.assert_called_once_with(
+        2.0, 24.0
+    )
+
+    print_mock.assert_any_call("New Temp=7.50", line=1)
+    print_mock.assert_any_call("A=2.00 P=24.000", line=2)
+    assert isinstance(titrator.state.next_state, MainMenu)
+
+
+def test_set_thermal_sine_wave_get_label():
+    """
+    Test the label returned by get_label.
+    """
+    titrator = Titrator()
+    state = SetThermalSineWave(titrator, MainMenu(titrator))
+
+    assert state.get_label() == "Set T Set Point"
+    state.sub_state = 1
+    assert state.get_label() == "Set Amplitude:"
+    state.sub_state = 2
+    assert state.get_label() == "Set Period hrs:"
+
+
+def test_handle_key_d():
+    """
+    Test that entering 'D' returns to the main menu.
+    """
+    titrator = Titrator()
+    state = SetThermalSineWave(titrator, MainMenu(titrator))
+
+    state.handle_key("D")
+    assert isinstance(titrator.state, MainMenu)