opentrons 8.2.0a4__py2.py3-none-any.whl → 8.3.0__py2.py3-none-any.whl

opentrons/hardware_control/types.py

@@ -1,3 +1,4 @@
+from asyncio import Queue
 import enum
 import logging
 from dataclasses import dataclass
@@ -712,3 +713,63 @@ class FailedTipStateCheck(RuntimeError):
         super().__init__(
             f"Expected tip state {expected_state}, but received {actual_state}."
         )
+
+
+@enum.unique
+class PipetteSensorId(int, enum.Enum):
+    """Sensor IDs available.
+
+    Not to be confused with SensorType. This is the ID value that separate
+    two or more of the same type of sensor within a system.
+
+    Note that this is a copy of an enum defined in opentrons_hardware.firmware_bindings.constants. That version
+    is authoritative; this version is here because this data is exposed above the hardware control layer and
+    therefore needs a typing source here so that we don't create a dependency on the internal hardware package.
+    """
+
+    S0 = 0x0
+    S1 = 0x1
+    UNUSED = 0x2
+    BOTH = 0x3
+
+
+@enum.unique
+class PipetteSensorType(int, enum.Enum):
+    """Sensor types available.
+
+    Note that this is a copy of an enum defined in opentrons_hardware.firmware_bindings.constants. That version
+    is authoritative; this version is here because this data is exposed above the hardware control layer and
+    therefore needs a typing source here so that we don't create a dependency on the internal hardware package.
+    """
+
+    tip = 0x00
+    capacitive = 0x01
+    environment = 0x02
+    pressure = 0x03
+    pressure_temperature = 0x04
+    humidity = 0x05
+    temperature = 0x06
+
+
+@dataclass(frozen=True)
+class PipetteSensorData:
+    """Sensor data from a monitored sensor.
+
+    Note that this is a copy of an enum defined in opentrons_hardware.firmware_bindings.constants. That version
+    is authoritative; this version is here because this data is exposed above the hardware control layer and
+    therefore needs a typing source here so that we don't create a dependency on the internal hardware package.
+    """
+
+    sensor_type: PipetteSensorType
+    _as_int: int
+    _as_float: float
+
+    def to_float(self) -> float:
+        return self._as_float
+
+    @property
+    def to_int(self) -> int:
+        return self._as_int
+
+
+PipetteSensorResponseQueue = Queue[Dict[PipetteSensorId, List[PipetteSensorData]]]

opentrons/legacy_commands/commands.py

@@ -299,3 +299,40 @@ def move_to_disposal_location(
         "name": command_types.MOVE_TO_DISPOSAL_LOCATION,
         "payload": {"instrument": instrument, "location": location, "text": text},
     }
+
+
+def seal(
+    instrument: InstrumentContext,
+    location: Well,
+) -> command_types.SealCommand:
+    location_text = stringify_location(location)
+    text = f"Sealing to {location_text}"
+    return {
+        "name": command_types.SEAL,
+        "payload": {"instrument": instrument, "location": location, "text": text},
+    }
+
+
+def unseal(
+    instrument: InstrumentContext,
+    location: Well,
+) -> command_types.UnsealCommand:
+    location_text = stringify_location(location)
+    text = f"Unsealing from {location_text}"
+    return {
+        "name": command_types.UNSEAL,
+        "payload": {"instrument": instrument, "location": location, "text": text},
+    }
+
+
+def resin_tip_dispense(
+    instrument: InstrumentContext,
+    flow_rate: float | None,
+) -> command_types.PressurizeCommand:
+    if flow_rate is None:
+        flow_rate = 10  # The Protocol Engine default for Resin Tip Dispense
+    text = f"Pressurize pipette to dispense from resin tip at {flow_rate}uL/s."
+    return {
+        "name": command_types.PRESSURIZE,
+        "payload": {"instrument": instrument, "text": text},
+    }

opentrons/legacy_commands/types.py

@@ -43,6 +43,10 @@ TOUCH_TIP: Final = "command.TOUCH_TIP"
 RETURN_TIP: Final = "command.RETURN_TIP"
 MOVE_TO: Final = "command.MOVE_TO"
 MOVE_TO_DISPOSAL_LOCATION: Final = "command.MOVE_TO_DISPOSAL_LOCATION"
+SEAL: Final = "command.SEAL"
+UNSEAL: Final = "command.UNSEAL"
+PRESSURIZE: Final = "command.PRESSURIZE"
+
 
 # Modules #
 
@@ -535,11 +539,40 @@ class MoveLabwareCommandPayload(TextOnlyPayload):
     pass
 
 
+class SealCommandPayload(TextOnlyPayload):
+    instrument: InstrumentContext
+    location: Union[None, Location, Well]
+
+
+class UnsealCommandPayload(TextOnlyPayload):
+    instrument: InstrumentContext
+    location: Union[None, Location, Well]
+
+
+class PressurizeCommandPayload(TextOnlyPayload):
+    instrument: InstrumentContext
+
+
 class MoveLabwareCommand(TypedDict):
     name: Literal["command.MOVE_LABWARE"]
     payload: MoveLabwareCommandPayload
 
 
+class SealCommand(TypedDict):
+    name: Literal["command.SEAL"]
+    payload: SealCommandPayload
+
+
+class UnsealCommand(TypedDict):
+    name: Literal["command.UNSEAL"]
+    payload: UnsealCommandPayload
+
+
+class PressurizeCommand(TypedDict):
+    name: Literal["command.PRESSURIZE"]
+    payload: PressurizeCommandPayload
+
+
 Command = Union[
     DropTipCommand,
     DropTipInDisposalLocationCommand,
@@ -588,6 +621,9 @@ Command = Union[
     MoveToCommand,
     MoveToDisposalLocationCommand,
     MoveLabwareCommand,
+    SealCommand,
+    UnsealCommand,
+    PressurizeCommand,
 ]
 
 
@@ -637,6 +673,9 @@ CommandPayload = Union[
     MoveToCommandPayload,
     MoveToDisposalLocationCommandPayload,
     MoveLabwareCommandPayload,
+    SealCommandPayload,
+    UnsealCommandPayload,
+    PressurizeCommandPayload,
 ]
 
 

opentrons/protocol_api/__init__.py

@@ -30,7 +30,16 @@ from .module_contexts import (
 )
 from .disposal_locations import TrashBin, WasteChute
 from ._liquid import Liquid, LiquidClass
-from ._types import OFF_DECK
+from ._types import (
+    OFF_DECK,
+    PLUNGER_BLOWOUT,
+    PLUNGER_TOP,
+    PLUNGER_BOTTOM,
+    PLUNGER_DROPTIP,
+    ASPIRATE_ACTION,
+    DISPENSE_ACTION,
+    BLOWOUT_ACTION,
+)
 from ._nozzle_layout import (
     COLUMN,
     PARTIAL_COLUMN,
@@ -69,12 +78,22 @@ __all__ = [
     "Liquid",
     "LiquidClass",
     "Parameters",
+    # Partial Tip types
     "COLUMN",
     "PARTIAL_COLUMN",
     "SINGLE",
     "ROW",
     "ALL",
+    # Deck location types
     "OFF_DECK",
+    # Pipette plunger types
+    "PLUNGER_BLOWOUT",
+    "PLUNGER_TOP",
+    "PLUNGER_BOTTOM",
+    "PLUNGER_DROPTIP",
+    "ASPIRATE_ACTION",
+    "DISPENSE_ACTION",
+    "BLOWOUT_ACTION",
     "RuntimeParameterRequiredError",
     "CSVParameter",
     # For internal Opentrons use only:

opentrons/protocol_api/_liquid.py

@@ -1,13 +1,15 @@
+from __future__ import annotations
+
 from dataclasses import dataclass
-from typing import Optional, Sequence
+from typing import Optional, Dict
 
 from opentrons_shared_data.liquid_classes.liquid_class_definition import (
     LiquidClassSchemaV1,
-    AspirateProperties,
-    SingleDispenseProperties,
-    MultiDispenseProperties,
-    ByPipetteSetting,
-    ByTipTypeSetting,
+)
+
+from ._liquid_properties import (
+    TransferProperties,
+    build_transfer_properties,
 )
 
 
@@ -29,46 +31,29 @@ class Liquid:
     display_color: Optional[str]
 
 
-# TODO (spp, 2024-10-17): create PAPI-equivalent types for all the properties
-#  and have validation on value updates with user-facing error messages
-@dataclass
-class TransferProperties:
-    _aspirate: AspirateProperties
-    _dispense: SingleDispenseProperties
-    _multi_dispense: Optional[MultiDispenseProperties]
-
-    @property
-    def aspirate(self) -> AspirateProperties:
-        """Aspirate properties."""
-        return self._aspirate
-
-    @property
-    def dispense(self) -> SingleDispenseProperties:
-        """Single dispense properties."""
-        return self._dispense
-
-    @property
-    def multi_dispense(self) -> Optional[MultiDispenseProperties]:
-        """Multi dispense properties."""
-        return self._multi_dispense
-
-
 @dataclass
 class LiquidClass:
     """A data class that contains properties of a specific class of liquids."""
 
     _name: str
     _display_name: str
-    _by_pipette_setting: Sequence[ByPipetteSetting]
+    _by_pipette_setting: Dict[str, Dict[str, TransferProperties]]
 
     @classmethod
     def create(cls, liquid_class_definition: LiquidClassSchemaV1) -> "LiquidClass":
         """Liquid class factory method."""
 
+        by_pipette_settings: Dict[str, Dict[str, TransferProperties]] = {}
+        for by_pipette in liquid_class_definition.byPipette:
+            tip_settings: Dict[str, TransferProperties] = {}
+            for tip_type in by_pipette.byTipType:
+                tip_settings[tip_type.tiprack] = build_transfer_properties(tip_type)
+            by_pipette_settings[by_pipette.pipetteModel] = tip_settings
+
         return cls(
             _name=liquid_class_definition.liquidClassName,
             _display_name=liquid_class_definition.displayName,
-            _by_pipette_setting=liquid_class_definition.byPipette,
+            _by_pipette_setting=by_pipette_settings,
         )
 
     @property
@@ -81,26 +66,16 @@ class LiquidClass:
 
     def get_for(self, pipette: str, tiprack: str) -> TransferProperties:
         """Get liquid class transfer properties for the specified pipette and tip."""
-        settings_for_pipette: Sequence[ByPipetteSetting] = [
-            pip_setting
-            for pip_setting in self._by_pipette_setting
-            if pip_setting.pipetteModel == pipette
-        ]
-        if len(settings_for_pipette) == 0:
+        try:
+            settings_for_pipette = self._by_pipette_setting[pipette]
+        except KeyError:
             raise ValueError(
                 f"No properties found for {pipette} in {self._name} liquid class"
             )
-        settings_for_tip: Sequence[ByTipTypeSetting] = [
-            tip_setting
-            for tip_setting in settings_for_pipette[0].byTipType
-            if tip_setting.tiprack == tiprack
-        ]
-        if len(settings_for_tip) == 0:
+        try:
+            transfer_properties = settings_for_pipette[tiprack]
+        except KeyError:
             raise ValueError(
                 f"No properties found for {tiprack} in {self._name} liquid class"
             )
-        return TransferProperties(
-            _aspirate=settings_for_tip[0].aspirate,
-            _dispense=settings_for_tip[0].singleDispense,
-            _multi_dispense=settings_for_tip[0].multiDispense,
-        )
+        return transfer_properties