opentrons-shared-data 8.7.0a11__py3-none-any.whl → 8.8.0a6__py3-none-any.whl

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p1000/3_5.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p1000/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p1000/3_6.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p1000/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p1000/3_7.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p1000/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p50/3_0.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p50/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p50/3_3.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p50/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p50/3_4.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p50/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p50/3_5.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p50/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data/pipette/definitions/2/geometry/single_channel/p50/3_6.json

@@ -3,8 +3,8 @@
   "pathTo3D": "pipette/definitions/2/geometry/single_channel/p50/placeholder.gltf",
   "nozzleOffset": [-8.0, -22.0, -259.15],
   "pipetteBoundingBoxOffsets": {
-    "backLeftCorner": [-8.0, -22.0, -259.15],
-    "frontRightCorner": [-8.0, -22.0, -259.15]
+    "backLeftCorner": [-38.0, 0.0, -259.15],
+    "frontRightCorner": [11.5, -64.0, -259.15]
   },
   "orderedRows": [{ "key": "A", "orderedNozzles": ["A1"] }],
   "orderedColumns": [{ "key": "1", "orderedNozzles": ["A1"] }],

opentrons_shared_data/data_files/__init__.py

@@ -0,0 +1,26 @@
+"""Types and functions for accessing data files."""
+
+from .types import (
+    DataFileInfo,
+    InputDataFileInfo,
+    OutputDataFileInfo,
+    CmdDataFileInfo,
+    MimeType,
+    IODataFileInfo,
+    DataFileSource,
+    DataFileInfoWithCommands,
+    RunFileNameMetadata,
+)
+
+
+__all__ = [
+    "DataFileInfo",
+    "InputDataFileInfo",
+    "OutputDataFileInfo",
+    "IODataFileInfo",
+    "CmdDataFileInfo",
+    "MimeType",
+    "DataFileSource",
+    "RunFileNameMetadata",
+    "DataFileInfoWithCommands",
+]

opentrons_shared_data/data_files/types.py

@@ -0,0 +1,84 @@
+"""opentrons_shared_data.data_files.types: types for data files."""
+
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import Union, Optional
+
+
+@dataclass(frozen=True)
+class RunFileNameMetadata:
+    """Data from the run used that may be used to build a finalized file name."""
+
+    robot_name: str
+    run_id: str
+    run_created_at: datetime
+    protocol_name: Optional[str]
+
+
+class MimeType(str, Enum):
+    """File mime types."""
+
+    TEXT_CSV = "text/csv"
+    IMAGE_JPEG = "image/jpeg"
+
+
+class DataFileSource(Enum):
+    """The source this data file is from."""
+
+    UPLOADED = "uploaded"
+    GENERATED = "generated"
+
+
+@dataclass(frozen=True)
+class DataFileInfo:
+    """Metadata about a data file."""
+
+    id: str
+    name: str
+    path: str
+    stored: bool
+    generated: bool
+    file_hash: str
+    mime_type: MimeType
+    created_at: datetime
+
+
+@dataclass(frozen=True)
+class CmdDataFileInfo:
+    """Command metadata info utilized by data files."""
+
+    command_id: str
+    prev_command_id: str
+
+
+@dataclass(frozen=True)
+class DataFileInfoWithCommands(DataFileInfo):
+    """Data file info with associated command information."""
+
+    command_info: CmdDataFileInfo
+
+
+@dataclass(frozen=True)
+class BaseInputOutputDataFileInfo:
+    """Base metadata info for data files acting as input or output to a run."""
+
+    run_id: str
+    file_id: str
+
+
+@dataclass(frozen=True)
+class InputDataFileInfo(BaseInputOutputDataFileInfo):
+    """Metadata of a data file used as input to a run."""
+
+    command_info: None
+
+
+@dataclass(frozen=True)
+class OutputDataFileInfo(BaseInputOutputDataFileInfo):
+    """Metadata of a data file used as output from a run."""
+
+    command_info: CmdDataFileInfo
+
+
+IODataFileInfo = Union[InputDataFileInfo, OutputDataFileInfo]

opentrons_shared_data/deck/types.py

@@ -7,7 +7,7 @@ This should only be imported if typing.TYPE_CHECKING is True
 from typing import Any, Dict, List, NewType, Union
 from typing_extensions import Literal, TypedDict
 
-from ..module.types import ModuleType
+from ..module.types import ModuleType, ModuleOrientation
 from opentrons_shared_data.labware.types import LocatingFeatures
 
 
@@ -46,6 +46,7 @@ class SlotDefV3(TypedDict, total=False):
     compatibleModuleTypes: List[ModuleType]
     matingSurfaceUnitVector: List[Union[Literal[1], Literal[-1]]]
     features: LocatingFeatures
+    orientation: ModuleOrientation
 
 
 class CalibrationPoint(TypedDict):
@@ -112,6 +113,7 @@ class AddressableAreaV5(_RequiredAddressableArea, total=False):
     ableToDropTips: bool
     ableToDropLabware: bool
     features: LocatingFeatures
+    orientation: Union[ModuleOrientation, None]
 
 
 class Cutout(TypedDict):

opentrons_shared_data/errors/codes.py

@@ -98,6 +98,8 @@ class ErrorCodes(Enum):
     MISSING_CONFIGURATION_DATA = _code_from_dict_entry("4009")
     RUNTIME_PARAMETER_VALUE_REQUIRED = _code_from_dict_entry("4010")
     INCORRECT_API_VERSION = _code_from_dict_entry("4011")
+    LABWARE_LOCATING_FEATURE_ERROR = _code_from_dict_entry("4012")
+    CAMERA_ERROR = _code_from_dict_entry("4013")
 
     @classmethod
     @lru_cache(25)

opentrons_shared_data/errors/exceptions.py

@@ -1,6 +1,18 @@
 """Exception hierarchy for error codes."""
 
-from typing import Dict, Any, Optional, List, Iterator, Union, Sequence, overload
+from __future__ import annotations
+from typing import (
+    Dict,
+    Any,
+    Optional,
+    List,
+    Iterator,
+    Union,
+    Sequence,
+    overload,
+    Type,
+    TypeVar,
+)
 from logging import getLogger
 from traceback import format_exception_only, format_tb
 import inspect
@@ -16,6 +28,18 @@ log = getLogger(__name__)
 class EnumeratedError(Exception):
     """The root class of error-code-bearing exceptions."""
 
+    @classmethod
+    def ensure(cls: Type[_ET], exception: Exception) -> _ET:
+        """Ensure that an exception is enumerated.
+
+        If the passed exception is an EnumeratedError, returns it; otherwise, wraps it in an appropriate
+        child class.
+        """
+        if isinstance(exception, cls):
+            return exception
+        else:
+            return PythonException(exception)  # type: ignore[return-value]
+
     def __init__(
         self,
         code: ErrorCodes,
@@ -50,6 +74,9 @@ class EnumeratedError(Exception):
         )
 
 
+_ET = TypeVar("_ET", bound=EnumeratedError, covariant=True)
+
+
 class CommunicationError(EnumeratedError):
     """An exception indicating an unknown communications error.
 

opentrons_shared_data/labware/labware_definition.py

@@ -608,6 +608,7 @@ class LabwareDefinition3(BaseModel):
     wells: dict[str, WellDefinition3]
     groups: list[Group]
     stackingOffsetWithLabware: dict[str, Vector3D] = Field(default_factory=dict)
+    legacyStackingOffsetWithLabware: dict[str, Vector3D] = Field(default_factory=dict)
     stackingOffsetWithModule: dict[str, Vector3D] = Field(default_factory=dict)
     allowedRoles: list[LabwareRole] = Field(default_factory=list)
     gripperOffsets: dict[str, GripperOffsets] = Field(default_factory=dict)

opentrons_shared_data/labware/types.py

@@ -180,6 +180,29 @@ class OpentronsFlexTipRackLidAsChildFeature(TypedDict):
     matingZ: float
 
 
+class HeaterShakerUniversalFlatAdapterDeckSide(TypedDict):
+    wallX: float
+    screwCenter: Vector3D
+
+
+class HeaterShakerUniversalFlatAdapterFeature(TypedDict):
+    flatSupportThermalCouplingZ: float
+    deckLeft: HeaterShakerUniversalFlatAdapterDeckSide
+    deckRight: HeaterShakerUniversalFlatAdapterDeckSide
+
+
+class FlatSupportThermalCouplingAsChildFeature(TypedDict):
+    wellExteriorBottomZ: float
+
+
+class ScrewAnchoredAsParentFeature(TypedDict):
+    screwCenter: Vector3D
+
+
+class ScrewAnchoredAsChildFeature(TypedDict):
+    screwCenter: Vector3D
+
+
 class LocatingFeatures(TypedDict):
     """A dictionary of locating features."""
 
@@ -188,6 +211,14 @@ class LocatingFeatures(TypedDict):
     springDirectionalForceAsParent: NotRequired[SpringDirectionalForce]
     opentronsFlexTipRackLidAsParent: NotRequired[OpentronsFlexTipRackLidAsParentFeature]
     opentronsFlexTipRackLidAsChild: NotRequired[OpentronsFlexTipRackLidAsChildFeature]
+    heaterShakerUniversalFlatAdapter: NotRequired[
+        HeaterShakerUniversalFlatAdapterFeature
+    ]
+    flatSupportThermalCouplingAsChild: NotRequired[
+        FlatSupportThermalCouplingAsChildFeature
+    ]
+    screwAnchoredAsParent: NotRequired[ScrewAnchoredAsParentFeature]
+    screwAnchoredAsChild: NotRequired[ScrewAnchoredAsChildFeature]
 
 
 class LabwareDefinition2(TypedDict):
@@ -237,6 +268,7 @@ class LabwareDefinition3(_OTSharedSchemaMixin, TypedDict):
     wells: dict[str, WellDefinition3]
     groups: list[WellGroup]
     stackingOffsetWithLabware: NotRequired[dict[str, Vector3D]]
+    legacyStackingOffsetWithLabware: NotRequired[dict[str, Vector3D]]
     stackingOffsetWithModule: NotRequired[dict[str, Vector3D]]
     allowedRoles: NotRequired[list[LabwareRoles]]
     gripperOffsets: NotRequired[dict[str, GripperOffsets]]

opentrons_shared_data/module/types.py

@@ -2,7 +2,7 @@
 opentrons_shared_data.module.types: types requiring typing_extensions
 for modules
 """
-
+import enum
 from typing import Any, Dict, List, Union
 from typing_extensions import Literal, TypedDict
 
@@ -112,6 +112,13 @@ class TOFSensorBaseline(TypedDict):
     Z: TOFBaseline
 
 
+class ModuleOrientation(enum.Enum):
+    LEFT = "left"
+    RIGHT = "right"
+    CENTER = "center"
+    NOT_APPLICABLE = None
+
+
 # TODO(mc, 2022-03-18): potentially move from typed-dict to Pydantic
 ModuleDefinitionV3 = TypedDict(
     "ModuleDefinitionV3",
@@ -133,6 +140,7 @@ ModuleDefinitionV3 = TypedDict(
         "uniqueModuleData": Dict[str, Any],
         "incompatibleWithDecks": List[str],
         "gripperOffsets": Dict[str, GripperOffsets],
+        "orientation": Dict[str, str],
     },
     total=False,
 )

opentrons_shared_data/protocol/models/shared_models.py

@@ -86,6 +86,7 @@ class Location(BaseModel):
 class ProfileStep(BaseModel):
     celsius: float
     holdSeconds: float
+    rampRate: float
 
 
 class WellLocation(BaseModel):

{opentrons_shared_data-8.7.0a11.dist-info → opentrons_shared_data-8.8.0a6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentrons_shared_data
-Version: 8.7.0a11
+Version: 8.8.0a6
 Summary: A bundle of data and python binding that supports the Opentrons API.Does not need to be installed manually; only a dependency of the opentrons package
 Project-URL: Source Code, https://github.com/Opentrons/opentrons
 Author-email: Opentrons <engineering@opentrons.com>