opentrons 8.7.0a9__py3-none-any.whl → 8.8.0a7__py3-none-any.whl

opentrons/protocol_api/core/module.py

@@ -18,6 +18,7 @@ from opentrons.hardware_control.modules.types import (
     SpeedStatus,
 )
 from .labware import LabwareCoreType, AbstractLabware
+from .tasks import AbstractTaskCore
 from opentrons.protocol_engine.types import ABSMeasureMode
 from opentrons.types import DeckSlotName
 
@@ -59,7 +60,7 @@ class AbstractTemperatureModuleCore(
         """Get the module's unique hardware serial number."""
 
     @abstractmethod
-    def set_target_temperature(self, celsius: float) -> None:
+    def set_target_temperature(self, celsius: float) -> AbstractTaskCore:
         """Set the Temperature Module's target temperature in °C."""
 
     @abstractmethod
@@ -161,6 +162,7 @@ class AbstractThermocyclerCore(
     def set_target_block_temperature(
         self,
         celsius: float,
+        ramp_rate: Optional[float],
         hold_time_seconds: Optional[float] = None,
         block_max_volume: Optional[float] = None,
     ) -> None:
@@ -178,6 +180,25 @@ class AbstractThermocyclerCore(
                 will default to 25µL/well.
         """
 
+    @abstractmethod
+    def start_set_target_block_temperature(
+        self,
+        celsius: float,
+        ramp_rate: Optional[float],
+        block_max_volume: Optional[float] = None,
+    ) -> AbstractTaskCore:
+        """Start setting the target temperature for the well block, in °C.
+
+        Note:
+            If ``hold_time_seconds`` is not specified, the Thermocycler
+            will proceed to the next command after ``temperature`` is reached.
+        Args:
+            celsius: The target temperature, in °C.
+            block_max_volume: The maximum volume of any individual well
+                of the loaded labware. If not supplied, the thermocycler
+                will default to 25µL/well.
+        """
+
     @abstractmethod
     def wait_for_block_temperature(self) -> None:
         """Wait for target block temperature to be reached."""
@@ -186,6 +207,10 @@ class AbstractThermocyclerCore(
     def set_target_lid_temperature(self, celsius: float) -> None:
         """Set the target temperature for the heated lid, in °C."""
 
+    @abstractmethod
+    def start_set_target_lid_temperature(self, celsius: float) -> AbstractTaskCore:
+        """Start setting the target temperature for the heated lid, in °C."""
+
     @abstractmethod
     def wait_for_lid_temperature(self) -> None:
         """Wait for target lid temperature to be reached."""
@@ -217,6 +242,33 @@ class AbstractThermocyclerCore(
                 will default to 25µL/well.
         """
 
+    @abstractmethod
+    def start_execute_profile(
+        self,
+        steps: List[ThermocyclerStep],
+        repetitions: int,
+        block_max_volume: Optional[float] = None,
+    ) -> AbstractTaskCore:
+        """Start a Thermocycler Profile.
+
+        Profile defined as a cycle of ``steps`` to repeat for a given number of ``repetitions``
+
+        Note:
+            Unlike the :py:meth:`execute_profile`, once the profile has started
+            the protocol will immediately move on to the next command, rather than waiting
+            for it to finish.
+        Args:
+            steps: List of unique steps that make up a single cycle.
+                Each list item should be a dictionary that maps to
+                the parameters of the :py:meth:`set_block_temperature`
+                method with keys 'temperature', 'hold_time_seconds',
+                and 'hold_time_minutes'.
+            repetitions: The number of times to repeat the cycled steps.
+            block_max_volume: The maximum volume of any individual well
+                of the loaded labware. If not supplied, the thermocycler
+                will default to 25µL/well.
+        """
+
     @abstractmethod
     def deactivate_lid(self) -> None:
         """Turn off the heated lid."""
@@ -294,7 +346,7 @@ class AbstractHeaterShakerCore(
         """Get the module's unique hardware serial number."""
 
     @abstractmethod
-    def set_target_temperature(self, celsius: float) -> None:
+    def set_target_temperature(self, celsius: float) -> AbstractTaskCore:
         """Set the labware plate's target temperature in °C."""
 
     @abstractmethod
@@ -305,6 +357,10 @@ class AbstractHeaterShakerCore(
     def set_and_wait_for_shake_speed(self, rpm: int) -> None:
         """Set the shaker's target shake speed and wait for it to spin up."""
 
+    @abstractmethod
+    def set_shake_speed(self, rpm: int) -> AbstractTaskCore:
+        """Set the shaker's target shake speed."""
+
     @abstractmethod
     def open_labware_latch(self) -> None:
         """Open the labware latch."""

opentrons/protocol_api/core/protocol.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from abc import abstractmethod, ABC
-from typing import Generic, List, Optional, Union, Tuple, Dict, TYPE_CHECKING
+from typing import Generic, List, Optional, Union, Tuple, Dict, TYPE_CHECKING, Sequence
 
 from opentrons_shared_data.deck.types import DeckDefinitionV5, SlotDefV3
 from opentrons_shared_data.pipette.types import PipetteNameType
@@ -24,6 +24,7 @@ from opentrons.protocols.api_support.util import AxisMaxSpeeds
 from .instrument import InstrumentCoreType
 from .labware import LabwareCoreType, LabwareLoadParams
 from .module import ModuleCoreType
+from .tasks import TaskCoreType
 from .._liquid import Liquid, LiquidClass
 from .robot import AbstractRobot
 from .._types import OffDeckType
@@ -34,7 +35,7 @@ if TYPE_CHECKING:
 
 
 class AbstractProtocol(
-    ABC, Generic[InstrumentCoreType, LabwareCoreType, ModuleCoreType]
+    ABC, Generic[InstrumentCoreType, LabwareCoreType, ModuleCoreType, TaskCoreType]
 ):
     @property
     @abstractmethod
@@ -192,6 +193,14 @@ class AbstractProtocol(
     def delay(self, seconds: float, msg: Optional[str]) -> None:
         ...
 
+    @abstractmethod
+    def wait_for_tasks(self, task_cores: Sequence[TaskCoreType]) -> None:
+        ...
+
+    @abstractmethod
+    def create_timer(self, seconds: float) -> TaskCoreType:
+        ...
+
     @abstractmethod
     def home(self) -> None:
         ...
@@ -306,6 +315,18 @@ class AbstractProtocol(
     ) -> Union[str, LabwareCoreType, ModuleCoreType, OffDeckType]:
         """Get labware parent location."""
 
+    @abstractmethod
+    def capture_image(
+        self,
+        filename: Optional[str] = None,
+        resolution: Optional[Tuple[int, int]] = None,
+        zoom: Optional[float] = None,
+        contrast: Optional[float] = None,
+        brightness: Optional[float] = None,
+        saturation: Optional[float] = None,
+    ) -> None:
+        "Capture an image using a camera."
+
     @abstractmethod
     def load_robot(self) -> AbstractRobot:
         """Load a Robot Core context into a protocol"""

opentrons/protocol_api/core/tasks.py

@@ -0,0 +1,31 @@
+from abc import abstractmethod, ABC
+from datetime import datetime
+from typing import TypeVar
+
+
+class AbstractTaskCore(ABC):
+    @abstractmethod
+    def get_created_at_timestamp(self) -> datetime:
+        """Get the createdAt timestamp of the task."""
+        ...
+
+    @abstractmethod
+    def is_done(self) -> bool:
+        """Returns ``True`` if the task is done."""
+        ...
+
+    @abstractmethod
+    def is_started(self) -> bool:
+        """Returns ``True`` if the task has started."""
+        ...
+
+    @abstractmethod
+    def get_finished_at_timestamp(self) -> datetime | None:
+        """The timestamp of the when the task finished.
+
+        Returns ``None`` if the task hasn't finished yet.
+        """
+        ...
+
+
+TaskCoreType = TypeVar("TaskCoreType", bound=AbstractTaskCore)

opentrons/protocol_api/core/well.py

@@ -112,5 +112,9 @@ class AbstractWellCore(ABC):
     def volume_from_height(self, height: LiquidTrackingType) -> LiquidTrackingType:
         """Return the volume contained in a well at any height."""
 
+    @abstractmethod
+    def has_tracked_liquid(self) -> bool:
+        """Return true if liquid has been loaded or probed."""
+
 
 WellCoreType = TypeVar("WellCoreType", bound=AbstractWellCore)