Add ph calibration states

Author: samuelnguyen999

src/ui_state/set_menu/set_ph_calibration.py

@@ -2,6 +2,11 @@
 The file to hold the PHCalibration class
 """
 
+from src.ui_state.set_menu.set_ph_calibration_mid import (
+    PHCalibrationHigher,
+    PHCalibrationMid,
+    PHCalibrationOnly,
+)
 from src.ui_state.ui_state import UIState
 
 
@@ -28,14 +33,15 @@ def handle_key(self, key):
         if key == "1":
             self.titrator.lcd.print("1-pt pH calib...", line=2)
             self.return_to_main_menu(ms_delay=3000)
+            self._set_next_state(PHCalibrationOnly(self.titrator, self), True)
 
         if key == "2":
             self.titrator.lcd.print("2 Point Cali", line=2)
-            self.return_to_main_menu(ms_delay=3000)
+            self._set_next_state(PHCalibrationHigher(self.titrator, self), True)
 
         if key == "3":
             self.titrator.lcd.print("3 Point Cali", line=2)
-            self.return_to_main_menu(ms_delay=3000)
+            self._set_next_state(PHCalibrationMid(self.titrator, self), True)
 
         if key == "4":
             self._set_next_state(self.previous_state, True)

src/ui_state/set_menu/set_ph_calibration_high.py

@@ -0,0 +1,35 @@
+"""
+The file to hold the Set pH Calibration Highpoint class
+"""
+
+from src.ui_state.set_menu.set_ph_calibration_low import PHCalibrationLow
+from src.ui_state.user_value import UserValue
+
+
+class PHCalibrationHigh(UserValue):
+    """
+    UI state to set the pH Calibration Highpoint.
+    Uses UserValue's keypad flow: implement get_label and save_value.
+    """
+
+    def __init__(self, titrator, previous_state=None):
+        super().__init__(titrator, previous_state)
+        self.previous_state = previous_state
+        self.value = str(self.titrator.ph_probe._highpoint_calibration or "")
+
+    def get_label(self):
+        """
+        Returns the label for the user value input.
+        """
+        return "High buffer pH"
+
+    def save_value(self):
+        """
+        Saves the entered pH Calibration Highpoint to the pH probe.
+        """
+        self.titrator.ph_probe.set_highpoint_calibration(float(self.value))
+
+        self.titrator.lcd.print(
+            f"High = {self.titrator.ph_probe._highpoint_calibration}", line=2
+        )
+        self._set_next_state(PHCalibrationLow(self.titrator, self), True)

src/ui_state/set_menu/set_ph_calibration_low.py

@@ -0,0 +1,62 @@
+"""
+The file to hold the Set pH Calibration Lowpoint class
+"""
+
+from src.ui_state.user_value import UserValue
+
+
+class PHCalibrationLower(UserValue):
+    """
+    Docstring for PHCalibrationLower
+    """
+
+    def __init__(self, titrator, previous_state=None):
+        super().__init__(titrator, previous_state)
+        self.previous_state = previous_state
+        self.value = str(self.titrator.ph_probe._lowpoint_calibration or "")
+
+    def get_label(self):
+        """
+        Returns the label for the user value input.
+        """
+        return "Lower buffer pH"
+
+    def save_value(self):
+        """
+        Saves the entered pH Calibration Lowpoint to the pH probe.
+        """
+        self.titrator.ph_probe._lowpoint_calibration = float(self.value)
+
+        self.titrator.lcd.print(
+            f"Low = {self.titrator.ph_probe._lowpoint_calibration}", line=2
+        )
+        self.return_to_main_menu(ms_delay=3000)
+
+
+class PHCalibrationLow(UserValue):
+    """
+    UI state to set the pH Calibration Lowpoint.
+    Uses UserValue's keypad flow: implement get_label and save_value.
+    """
+
+    def __init__(self, titrator, previous_state=None):
+        super().__init__(titrator, previous_state)
+        self.previous_state = previous_state
+        self.value = str(self.titrator.ph_probe._lowpoint_calibration or "")
+
+    def get_label(self):
+        """
+        Returns the label for the user value input.
+        """
+        return "Low buffer pH"
+
+    def save_value(self):
+        """
+        Saves the entered pH Calibration Lowpoint to the pH probe.
+        """
+        self.titrator.ph_probe.set_lowpoint_calibration(float(self.value))
+
+        self.titrator.lcd.print(
+            f"Low = {self.titrator.ph_probe._lowpoint_calibration}", line=2
+        )
+        self.return_to_main_menu(ms_delay=3000)

src/ui_state/set_menu/set_ph_calibration_mid.py

@@ -0,0 +1,93 @@
+"""
+The file to hold the Set pH Calibration Midpoint class
+"""
+
+from src.ui_state.set_menu.set_ph_calibration_high import PHCalibrationHigh
+from src.ui_state.set_menu.set_ph_calibration_low import PHCalibrationLower
+from src.ui_state.user_value import UserValue
+
+
+class PHCalibrationOnly(UserValue):
+    """
+    UI state to set the pH Calibration Midpoint.
+    Uses UserValue's keypad flow: implement get_label and save_value.
+    """
+
+    def __init__(self, titrator, previous_state=None):
+        super().__init__(titrator, previous_state)
+        self.previous_state = previous_state
+        self.value = str(self.titrator.ph_probe._midpoint_calibration or "")
+
+    def get_label(self):
+        """
+        Returns the label for the user value input.
+        """
+        return "Buffer pH"
+
+    def save_value(self):
+        """
+        Saves the entered pH Calibration Midpoint to the pH probe.
+        """
+        self.titrator.ph_probe._midpoint_calibration = float(self.value)
+
+        self.titrator.lcd.print(
+            f"Buffer = {self.titrator.ph_probe._midpoint_calibration}", line=2
+        )
+        self.return_to_main_menu(ms_delay=3000)
+
+
+class PHCalibrationHigher(UserValue):
+    """
+    Docstring for PHCalibrationHigher
+    """
+
+    def __init__(self, titrator, previous_state=None):
+        super().__init__(titrator, previous_state)
+        self.previous_state = previous_state
+        self.value = str(self.titrator.ph_probe._midpoint_calibration or "")
+
+    def get_label(self):
+        """
+        Returns the label for the user value input.
+        """
+        return "Higher buffer pH"
+
+    def save_value(self):
+        """
+        Saves the entered pH Calibration Midpoint to the pH probe.
+        """
+        self.titrator.ph_probe._midpoint_calibration = float(self.value)
+
+        self.titrator.lcd.print(
+            f"Mid = {self.titrator.ph_probe._midpoint_calibration}", line=2
+        )
+        self._set_next_state(PHCalibrationLower(self.titrator, self), True)
+
+
+class PHCalibrationMid(UserValue):
+    """
+    UI state to set the pH Calibration Midpoint.
+    Uses UserValue's keypad flow: implement get_label and save_value.
+    """
+
+    def __init__(self, titrator, previous_state=None):
+        super().__init__(titrator, previous_state)
+        self.previous_state = previous_state
+        self.value = str(self.titrator.ph_probe._midpoint_calibration or "")
+
+    def get_label(self):
+        """
+        Returns the label for the user value input.
+        """
+        return "Mid buffer pH"
+
+    def save_value(self):
+        """
+        Saves the entered pH Calibration Midpoint to the pH probe.
+        """
+        self.titrator.ph_probe._midpoint_calibration = float(self.value)
+
+        self.titrator.lcd.print(
+            f"Mid = {self.titrator.ph_probe._midpoint_calibration}", line=2
+        )
+        self._set_next_state(PHCalibrationHigh(self.titrator, self), True)

tests/ui_state/set_menu/set_ph_calibration_high_test.py

@@ -0,0 +1,40 @@
+"""
+The file to test the PHCalibrationHigh class
+"""
+
+from unittest import mock
+
+from src.devices.library import LiquidCrystal
+from src.titrator import Titrator
+from src.ui_state.set_menu.set_ph_calibration_high import PHCalibrationHigh
+from src.ui_state.set_menu.set_ph_calibration_low import PHCalibrationLow
+from src.ui_state.ui_state import UIState
+
+
+class MockPreviousState(UIState):
+    """
+    A mock previous state for testing purposes
+    """
+
+    def __init__(self, titrator):
+        super().__init__(titrator)
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_ph_calibration_high(print_mock):
+    """
+    Test the PHCalibrationHigh state.
+    """
+    titrator = Titrator()
+    state = PHCalibrationHigh(titrator, MockPreviousState(titrator))
+
+    state.loop()
+    print_mock.assert_any_call("High buffer pH", line=1)
+
+    state.value = "10.0"
+    state.save_value()
+    assert titrator.ph_probe._highpoint_calibration == 10.0
+    print_mock.assert_any_call("High = 10.0", line=2)
+
+    assert isinstance(titrator.state, PHCalibrationLow)
+    assert isinstance(titrator.state.previous_state, PHCalibrationHigh)

tests/ui_state/set_menu/set_ph_calibration_low_test.py

@@ -0,0 +1,61 @@
+"""
+The file to test the PHCalibrationLow 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_ph_calibration_low import (
+    PHCalibrationLow,
+    PHCalibrationLower,
+)
+from src.ui_state.ui_state import UIState
+
+
+class MockPreviousState(UIState):
+    """
+    A mock previous state for testing purposes
+    """
+
+    def __init__(self, titrator):
+        super().__init__(titrator)
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_ph_calibration_lower(print_mock):
+    """
+    Test the PHCalibrationLower state.
+    """
+    titrator = Titrator()
+    state = PHCalibrationLower(titrator, MockPreviousState(titrator))
+
+    state.loop()
+    print_mock.assert_any_call("Lower buffer pH", line=1)
+
+    state.value = "3.5"
+    state.save_value()
+    assert titrator.ph_probe._lowpoint_calibration == 3.5
+    print_mock.assert_any_call("Low = 3.5", line=2)
+
+    assert isinstance(titrator.state.next_state, MainMenu)
+
+
+@mock.patch.object(LiquidCrystal, "print")
+def test_ph_calibration_low(print_mock):
+    """
+    Test the PHCalibrationLow state.
+    """
+    titrator = Titrator()
+    state = PHCalibrationLow(titrator, MockPreviousState(titrator))
+
+    state.loop()
+    print_mock.assert_any_call("Low buffer pH", line=1)
+
+    state.value = "4.0"
+    state.save_value()
+    assert titrator.ph_probe._lowpoint_calibration == 4.0
+    print_mock.assert_any_call("Low = 4.0", line=2)
+
+    assert isinstance(titrator.state.next_state, MainMenu)