opentrons-shared-data 8.7.0a1__py3-none-any.whl → 8.7.0a2__py3-none-any.whl

opentrons_shared_data/data/labware/definitions/3/schema3test_tough_pcr_auto_sealing_lid/999.json

@@ -63,53 +63,6 @@
       "z": 0
     }
   },
-  "stackingOffsetWithLabware": {
-    "default": {
-      "x": 0,
-      "y": 0,
-      "z": 8.193
-    },
-    "opentrons_tough_pcr_auto_sealing_lid": {
-      "x": 0,
-      "y": 0,
-      "z": 6.492
-    },
-    "schema3test_tough_pcr_auto_sealing_lid": {
-      "x": 0,
-      "y": 0,
-      "z": 6.492
-    },
-    "armadillo_96_wellplate_200ul_pcr_full_skirt": {
-      "x": 0,
-      "y": 0,
-      "z": 8.193
-    },
-    "opentrons_96_wellplate_200ul_pcr_full_skirt": {
-      "x": 0,
-      "y": 0,
-      "z": 8.193
-    },
-    "schema3test_96_wellplate_200ul_pcr_full_skirt": {
-      "x": 0,
-      "y": 0,
-      "z": 8.193
-    },
-    "biorad_96_wellplate_200ul_pcr": {
-      "x": 0,
-      "y": 0,
-      "z": 8.08
-    },
-    "opentrons_flex_deck_riser": {
-      "x": 0,
-      "y": 0,
-      "z": 34
-    },
-    "protocol_engine_lid_stack_object": {
-      "x": 0,
-      "y": 0,
-      "z": 0
-    }
-  },
   "stackLimit": 5,
   "compatibleParentLabware": [
     "armadillo_96_wellplate_200ul_pcr_full_skirt",

opentrons_shared_data/data/labware/definitions/3/schema3test_universal_flat_adapter/999.json

@@ -14,18 +14,38 @@
   "extents": {
     "total": {
       "backLeftBottom": {
-        "x": 8.5,
-        "y": -5.5,
+        "x": 0,
+        "y": 0,
         "z": 0
       },
       "frontRightTop": {
-        "x": 119.5,
-        "y": -80.5,
+        "x": 127.2,
+        "y": -74.8,
         "z": 12
       }
     }
   },
-  "features": {},
+  "features": {
+    "heaterShakerUniversalFlatAdapter": {
+      "flatSupportThermalCouplingZ": 4.7,
+      "deckLeft": {
+        "wallX": 7.52,
+        "screwCenter": {
+          "x": 71.7,
+          "y": -37.4,
+          "z": 0
+        }
+      },
+      "deckRight": {
+        "wallX": -7.52,
+        "screwCenter": {
+          "x": 55.5,
+          "y": -37.4,
+          "z": 0
+        }
+      }
+    }
+  },
   "wells": {},
   "groups": [
     {

opentrons_shared_data/data/labware/schemas/2.json

@@ -684,7 +684,7 @@
     },
     "stackingOffsetWithLabware": {
       "type": "object",
-      "description": "Supported labware that can be stacked upon, with overlap height between both labware.",
+      "description": "Supported labware that this one can be stacked atop, with overlaps between both labware. x and y should always equal 0 to preserve intended behavior. z=0 means the bottom of this labware is at the top of the labware below it. +z moves this labware down.",
       "additionalProperties": {
         "$ref": "#/definitions/vector"
       }

opentrons_shared_data/data/labware/schemas/3.json

@@ -700,6 +700,77 @@
               "type": "number"
             }
           }
+        },
+        "heaterShakerUniversalFlatAdapter": {
+          "description": "Designates this labware as the Opentrons Universal Flat Adapter",
+          "type": "object",
+          "required": ["flatSupportThermalCouplingZ", "deckLeft", "deckRight"],
+          "properties": {
+            "flatSupportThermalCouplingZ": {
+              "description": "The bottom of the labware to the top of the labware's surface that makes contact with a child labware's wells.",
+              "type": "number"
+            },
+            "deckLeft": {
+              "type": "object",
+              "required": ["wallX", "screwCenter"],
+              "properties": {
+                "wallX": {
+                  "description": "The +x coordinate in mm from the edge of the labware's external protrusion to the interior of the `wall` when the labware is placed on the left side of the deck.",
+                  "type": "number"
+                },
+                "screwCenter": {
+                  "description": "The +x,-y,+z coordinate offset from the labware origin to the bottom center of the pilot hole when the labware is placed on the left side of the deck.",
+                  "$ref": "#/definitions/vector3D"
+                }
+              }
+            },
+            "deckRight": {
+              "type": "object",
+              "required": ["wallX", "screwCenter"],
+              "properties": {
+                "wallX": {
+                  "description": "The -x coordinate in mm from the edge of the labware's external protrusion to the interior of the `wall` when the labware is placed on the right side of the deck.",
+                  "type": "number"
+                },
+                "screwCenter": {
+                  "description": "The +x,-y,+z coordinate offset from the labware origin to the bottom center of the pilot hole when the labware is placed on the right side of the deck.",
+                  "$ref": "#/definitions/vector3D"
+                }
+              }
+            }
+          }
+        },
+        "flatSupportThermalCouplingAsChild": {
+          "type": "object",
+          "required": ["wellExteriorBottomZ"],
+          "properties": {
+            "wellExteriorBottomZ": {
+              "description": "The +z-coordinate in mm from the bottom of the labware's exterior wells to the bottom of the labware.",
+              "type": "number"
+            }
+          }
+        },
+        "screwAnchoredAsParent": {
+          "description": "The labware provides a threaded hole into which a child deck item may be screwed securely.",
+          "type": "object",
+          "required": ["screwCenter"],
+          "properties": {
+            "screwCenter": {
+              "description": "The +x,-y,+z coordinate offset from the labware origin to the center of the threaded hole. The +z coordinate is zero by convention.",
+              "$ref": "#/definitions/vector3D"
+            }
+          }
+        },
+        "screwAnchoredAsChild": {
+          "description": "The labware contains a pilot hole through which the labware may be screwed securely to a parent deck item.",
+          "type": "object",
+          "required": ["screwCenter"],
+          "properties": {
+            "screwCenter": {
+              "description": "The +x,-y,+z coordinate offset from the labware origin to the center of the pilot hole. The +z coordinate is zero by convention.",
+              "$ref": "#/definitions/vector3D"
+            }
+          }
         }
       }
     },
@@ -778,6 +849,13 @@
         "$ref": "#/definitions/vector3D"
       }
     },
+    "legacyStackingOffsetWithLabware": {
+      "type": "object",
+      "description": "Legacy labware stacking offsets for Labware Schema 2 compatibility. See Labware Schema 2 `stackingOffsetWithLabware` documentation.",
+      "additionalProperties": {
+        "$ref": "#/definitions/vector3D"
+      }
+    },
     "stackingOffsetWithModule": {
       "type": "object",
       "description": "Supported module that can be stacked upon, with overlap height between labware and module.",

opentrons_shared_data/data/module/definitions/3/absorbanceReaderV1.json

@@ -48,6 +48,12 @@
     "ot2_short_trash": {},
     "ot3_standard": {}
   },
+  "orientation": {
+    "A3": "right",
+    "B3": "right",
+    "C3": "right",
+    "D3": "right"
+  },
   "compatibleWith": [],
   "incompatibleWithDecks": ["ot2_standard", "ot2_short_trash"],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/definitions/3/flexStackerModuleV1.json

@@ -154,6 +154,16 @@
       }
     }
   },
+  "orientation": {
+    "A3": "right",
+    "A4": "right",
+    "B3": "right",
+    "B4": "right",
+    "C3": "right",
+    "C4": "right",
+    "D3": "right",
+    "D4": "right"
+  },
   "compatibleWith": [],
   "incompatibleWithDecks": ["ot2_standard", "ot2_short_trash"],
   "uniqueModuleData": {

opentrons_shared_data/data/module/definitions/3/heaterShakerModuleV1.json

@@ -7,7 +7,15 @@
     "y": 1.125,
     "z": 68.275
   },
-  "features": {},
+  "features": {
+    "screwAnchoredAsParent": {
+      "screwCenter": {
+        "x": 64,
+        "y": 43,
+        "z": 0
+      }
+    }
+  },
   "dimensions": {
     "bareOverallHeight": 82,
     "overLabwareHeight": 0,
@@ -184,6 +192,27 @@
       }
     }
   },
+  "orientation": {
+    "1": "left",
+    "2": "center",
+    "3": "right",
+    "4": "left",
+    "5": "center",
+    "6": "right",
+    "7": "left",
+    "8": "center",
+    "9": "right",
+    "10": "left",
+    "11": "center",
+    "A1": "left",
+    "A3": "right",
+    "B1": "left",
+    "B3": "right",
+    "C1": "left",
+    "C3": "right",
+    "D1": "left",
+    "D3": "right"
+  },
   "compatibleWith": [],
   "incompatibleWithDecks": []
 }

opentrons_shared_data/data/module/definitions/3/magneticBlockV1.json

@@ -64,6 +64,20 @@
     "ot2_short_trash": {},
     "ot3_standard": {}
   },
+  "orientation": {
+    "A1": "center",
+    "A2": "center",
+    "A3": "center",
+    "B1": "center",
+    "B2": "center",
+    "B3": "center",
+    "C1": "center",
+    "C2": "center",
+    "C3": "center",
+    "D1": "center",
+    "D2": "center",
+    "D3": "center"
+  },
   "compatibleWith": [],
   "incompatibleWithDecks": [],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/definitions/3/magneticModuleV1.json

@@ -48,6 +48,19 @@
   "displayName": "Magnetic Module GEN1",
   "quirks": [],
   "slotTransforms": {},
+  "orientation": {
+    "1": "left",
+    "2": "center",
+    "3": "right",
+    "4": "left",
+    "5": "center",
+    "6": "right",
+    "7": "left",
+    "8": "center",
+    "9": "right",
+    "10": "left",
+    "11": "center"
+  },
   "compatibleWith": [],
   "incompatibleWithDecks": ["ot3_standard"],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/definitions/3/magneticModuleV2.json

@@ -101,6 +101,19 @@
       }
     }
   },
+  "orientation": {
+    "1": "left",
+    "2": "center",
+    "3": "right",
+    "4": "left",
+    "5": "center",
+    "6": "right",
+    "7": "left",
+    "8": "center",
+    "9": "right",
+    "10": "left",
+    "11": "center"
+  },
   "compatibleWith": [],
   "incompatibleWithDecks": ["ot3_standard"],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/definitions/3/temperatureModuleV1.json

@@ -49,6 +49,19 @@
   "displayName": "Temperature Module GEN1",
   "quirks": [],
   "slotTransforms": {},
+  "orientation": {
+    "1": "left",
+    "2": "center",
+    "3": "right",
+    "4": "left",
+    "5": "center",
+    "6": "right",
+    "7": "left",
+    "8": "center",
+    "9": "right",
+    "10": "left",
+    "11": "center"
+  },
   "compatibleWith": ["temperatureModuleV2"],
   "incompatibleWithDecks": ["ot3_standard"],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/definitions/3/temperatureModuleV2.json

@@ -182,6 +182,27 @@
       }
     }
   },
+  "orientation": {
+    "1": "left",
+    "2": "center",
+    "3": "right",
+    "4": "left",
+    "5": "center",
+    "6": "right",
+    "7": "left",
+    "8": "center",
+    "9": "right",
+    "10": "left",
+    "11": "center",
+    "A1": "left",
+    "A3": "right",
+    "B1": "left",
+    "B3": "right",
+    "C1": "left",
+    "C3": "right",
+    "D1": "left",
+    "D3": "right"
+  },
   "compatibleWith": ["temperatureModuleV1"],
   "incompatibleWithDecks": [],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/definitions/3/thermocyclerModuleV1.json

@@ -52,6 +52,9 @@
   "displayName": "Thermocycler Module GEN1",
   "quirks": [],
   "slotTransforms": {},
+  "orientation": {
+    "7": "left"
+  },
   "compatibleWith": ["thermocyclerModuleV1"],
   "incompatibleWithDecks": ["ot3_standard"],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/definitions/3/thermocyclerModuleV2.json

@@ -83,6 +83,10 @@
       }
     }
   },
+  "orientation": {
+    "7": "left",
+    "B1": "left"
+  },
   "compatibleWith": [],
   "incompatibleWithDecks": [],
   "uniqueModuleData": {}

opentrons_shared_data/data/module/schemas/3.json

@@ -111,6 +111,7 @@
     "displayName",
     "quirks",
     "slotTransforms",
+    "orientation",
     "compatibleWith",
     "incompatibleWithDecks"
   ],
@@ -180,6 +181,17 @@
               "enum": ["backLeftBottom"]
             }
           }
+        },
+        "screwAnchoredAsParent": {
+          "description": "The module provides a threaded hole into which a child deck item may be screwed securely.",
+          "type": "object",
+          "required": ["screwCenter"],
+          "properties": {
+            "screwCenter": {
+              "description": "The +x,+y,+z coordinate offset measured from the module's X/Y labware interface dimension origin to the center of the threaded hole. The +z is 0 by convention. When the threaded hole is located in a spring-loaded plate, the z represents the top of the threaded hole when the plate is compressed.",
+              "$ref": "#/definitions/vector3D"
+            }
+          }
         }
       }
     },
@@ -297,6 +309,18 @@
         }
       }
     },
+    "orientation": {
+      "type": "object",
+      "description": "The orientation of the module when placed in a particular cutout id.",
+      "patternProperties": {
+        "^([1-9]|10|11|[A-D][1-4])$": {
+          "description": "The keys are the id of cutouts.",
+          "type": "string",
+          "enum": ["left", "right", "center"]
+        }
+      },
+      "additionalProperties": false
+    },
     "compatibleWith": {
       "type": "array",
       "items": {

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,7 @@ 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")
 
     @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

@@ -604,6 +604,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.0a1.dist-info → opentrons_shared_data-8.7.0a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentrons_shared_data
-Version: 8.7.0a1
+Version: 8.7.0a2
 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>