Add abort api

evolver/app/main.py

@@ -141,6 +141,16 @@ async def calibrate(name: str, data: dict = None):
     return calibrator.run_calibration_procedure(data)  # TODO: or **data?
 
 
+@app.post("/abort")
+async def abort():
+    app.state.evolver.abort()
+    # Disable commit also in persistent config in case application needs to restart
+    config = Evolver.Config.load(app_settings.CONFIG_FILE)
+    config.enable_control = False
+    config.enable_commit = False
+    config.save(app_settings.CONFIG_FILE)
+
+
 app.mount("/html", html_app)
 
 

evolver/app/tests/test_app.py

@@ -207,6 +207,14 @@ def test_history(self, app_client, query_params):
         else:
             assert response.json() == {"data": {}}
 
+    def test_abort_endpoint(self, app_client):
+        assert app.state.evolver.enable_commit
+        response = app_client.post("/abort")
+        assert response.status_code == 200
+        assert not app.state.evolver.enable_commit
+        saved_config = Evolver.Config.load(app_settings.CONFIG_FILE)
+        assert not saved_config.enable_commit
+
 
 def test_app_load_file(app_client):
     config = Evolver.Config(

evolver/device.py

@@ -93,6 +93,12 @@ def loop_once(self):
         if self.enable_commit:
             self.commit_proposals()
 
+    def abort(self):
+        self.enable_control = False
+        self.enable_commit = False
+        for device in self.effectors.values():
+            device.off()
+
     def __enter__(self):
         return self
 

evolver/hardware/demo.py

@@ -31,5 +31,11 @@ def get(self):
 
 
 class NoOpEffectorDriver(EffectorDriver):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
     def commit(self):
         self.committed = copy(self.proposal)
+
+    def off(self):
+        pass

evolver/hardware/interface.py

@@ -81,3 +81,13 @@ def set(self, input: Input):
     @abstractmethod
     def commit(self):
         pass
+
+    @abstractmethod
+    def off(self):
+        """Immediately turn device into off state.
+
+        Used by framework in aborting an experiment. Implementations should
+        define off condition and implement in such a way that a commit call is
+        not necessary (i.e. the device turns off upon calling this method).
+        """
+        pass

evolver/hardware/standard/led.py

@@ -34,3 +34,8 @@ def from_brightness(brightness):
         with self.serial as comm:
             comm.communicate(SerialData(addr=self.addr, data=cmd))
         self.committed = inputs
+
+    def off(self):
+        cmd = [b"0"] * self.slots
+        with self.serial as comm:
+            comm.communicate(SerialData(addr=self.addr, data=cmd))

evolver/hardware/standard/pump.py

@@ -95,6 +95,14 @@ def commit(self):
             comm.communicate(SerialData(addr=self.addr, data=cmd))
         self.committed = inputs
 
+    def off(self):
+        cmd = [b"0"] * self.slots
+        for pump in self.ipp_pumps:
+            for solenoid in range(3):
+                cmd[pump * 3 + solenoid] = f"0|{pump}|{solenoid+1}".encode()
+        with self.serial as comm:
+            comm.communicate(SerialData(addr=self.addr, data=cmd))
+
 
 class VialIEPumpCalibrator(GenericPumpCalibrator):
     def run_calibration_procedure(self, *args, **kwargs):
@@ -155,3 +163,6 @@ def commit(self):
                 )
         self._generic_pump.commit()
         self.committed = copy(self.proposal)
+
+    def off(self):
+        self._generic_pump.off()

evolver/hardware/standard/stir.py

@@ -34,3 +34,8 @@ def commit(self):
         with self.serial as comm:
             comm.communicate(SerialData(addr=self.addr, data=cmd))
         self.committed = inputs
+
+    def off(self):
+        cmd = [b"0"] * self.slots
+        with self.serial as comm:
+            comm.communicate(SerialData(addr=self.addr, data=cmd))

evolver/hardware/standard/temperature.py

@@ -70,3 +70,8 @@ def read(self):
 
     def commit(self):
         self._do_serial(from_proposal=True)
+
+    def off(self):
+        cmd = [self.HEAT_OFF] * self.slots
+        with self.serial as comm:
+            comm.communicate(SerialData(addr=self.addr, data=cmd))

evolver/hardware/standard/tests/test_standard.py

@@ -83,6 +83,7 @@ def test_default_calibrator(self):
 )
 class TestTempEffectorMode(SerialVialEffectorHardwareTestSuite):
     driver = Temperature
+    abort_command = ({"addr": "temp", "slots": 2}, b"tempr,4095,4095,_!")
 
 
 @pytest.mark.parametrize(
@@ -107,6 +108,7 @@ class TestTempEffectorMode(SerialVialEffectorHardwareTestSuite):
 )
 class TestLED(SerialVialEffectorHardwareTestSuite):
     driver = LED
+    abort_command = ({"addr": "od_led", "slots": 2}, b"od_ledr,0,0,_!")
 
 
 @pytest.mark.parametrize(
@@ -126,6 +128,7 @@ class TestLED(SerialVialEffectorHardwareTestSuite):
 )
 class TestStir(SerialVialEffectorHardwareTestSuite):
     driver = Stir
+    abort_command = ({"addr": "stir", "slots": 2}, b"stirr,0,0,_!")
 
 
 @pytest.mark.parametrize(
@@ -155,3 +158,4 @@ class TestStir(SerialVialEffectorHardwareTestSuite):
 )
 class TestPump(SerialVialEffectorHardwareTestSuite):
     driver = VialIEPump
+    abort_command = ({"addr": "pump", "slots": 2, "ipp_pumps": [1]}, b"pumpr,0,0,0,0|1|1,0|1|2,0|1|3,_!")

evolver/hardware/test_utils.py

@@ -96,6 +96,7 @@ class TestMyEffector(SerialVialEffectorHardwareTestSuite):
     """
 
     driver: HardwareDriver = None
+    abort_command = None
 
     def _load_and_check(self, hw, values, serial_out):
         expected_committed = {}
@@ -118,3 +119,11 @@ def test_from_config_descriptor(self, config_params, values, serial_out):
     def test_from_evolver_config(self, config_params, values, serial_out):
         evolver = _from_evolver_conf(self.driver, config_params, {})
         self._load_and_check(evolver.hardware["testhw"], values, serial_out)
+
+    def test_abort(self, config_params, values, serial_out):
+        if self.abort_command == "none_expected":
+            return
+        config, command = self.abort_command
+        hw = _from_config_desc(self.driver, config, {})
+        hw.off()
+        assert hw.evolver.serial.backend.hits_map[command] == 1

evolver/tests/test_device.py

@@ -7,7 +7,7 @@
 from evolver.connection.interface import Connection
 from evolver.controller.interface import Controller
 from evolver.device import DEFAULT_HISTORY, DEFAULT_SERIAL, Evolver
-from evolver.hardware.demo import NoOpSensorDriver
+from evolver.hardware.demo import NoOpEffectorDriver, NoOpSensorDriver
 from evolver.hardware.interface import HardwareDriver
 from evolver.history.interface import History
 
@@ -144,3 +144,19 @@ def test_calibration_status(self, demo_evolver):
         assert isinstance(status["testsensor"].input_transformer, Status)
         assert isinstance(status["testsensor"].output_transformer, Status)
         assert status["testsensor"].ok
+
+    def test_abort(self, demo_evolver):
+        class AbortEffector(NoOpEffectorDriver):
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+                self.aborted = False
+
+            def off(self):
+                super().off()
+                self.aborted = True
+
+        demo_evolver.hardware["testeffector"] = AbortEffector()
+        demo_evolver.enable_commit = True
+        demo_evolver.abort()
+        assert not demo_evolver.enable_commit
+        assert demo_evolver.hardware["testeffector"].aborted