introduction of fixture groups to the v5 deck configuration schema

Opentrons · Mar 20, 2024 · 934b28a · 934b28a
1 parent a8b71f9
commit 934b28a
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 0 deletions.
diff --git a/robot-server/robot_server/deck_configuration/validation.py b/robot-server/robot_server/deck_configuration/validation.py
@@ -67,13 +67,23 @@ class UnexpectedSerialNumberError:
     opentrons_module_serial_number: str
 
 
+@dataclass(frozen=True)
+class MissingGroupFixtureError:
+    """When a member of a fixture group has been mounted but other required members of that group have not."""
+
+    cutout_id: str
+    cutout_fixture_id: str
+    missing_fixture_id: str
+
+
 ConfigurationError = Union[
     UnoccupiedCutoutError,
     OvercrowdedCutoutError,
     InvalidLocationError,
     UnrecognizedCutoutFixtureError,
     InvalidSerialNumberError,
     UnexpectedSerialNumberError,
+    MissingGroupFixtureError,
 ]
 
 
@@ -139,6 +149,21 @@ def get_configuration_errors(
                     )
                 )
 
+            for fixture_id in found_cutout_fixture["fixtureGroup"]:
+                result = [
+                    placement.cutout_fixture_id
+                    for placement in placements
+                    if fixture_id in placement.cutout_fixture_id
+                ]
+                if len(result) == 0:
+                    errors.add(
+                        MissingGroupFixtureError(
+                            cutout_id=placement.cutout_id,
+                            cutout_fixture_id=placement.cutout_fixture_id,
+                            missing_fixture_id=fixture_id,
+                        )
+                    )
+
     return errors
 
 

diff --git a/shared-data/deck/definitions/5/ot3_standard.json b/shared-data/deck/definitions/5/ot3_standard.json
@@ -758,6 +758,7 @@
         "cutoutB1": ["B1"],
         "cutoutA1": ["A1"]
       },
+      "fixtureGroup": [],
       "height": 0
     },
     {
@@ -771,6 +772,7 @@
         "cutoutB2": ["B2"],
         "cutoutA2": ["A2"]
       },
+      "fixtureGroup": [],
       "height": 0
     },
     {
@@ -784,6 +786,7 @@
         "cutoutB3": ["B3"],
         "cutoutA3": ["A3"]
       },
+      "fixtureGroup": [],
       "height": 0
     },
     {
@@ -797,6 +800,7 @@
         "cutoutB3": ["B3", "B4"],
         "cutoutA3": ["A3", "A4"]
       },
+      "fixtureGroup": [],
       "height": 0
     },
     {
@@ -823,6 +827,7 @@
         "cutoutB3": ["movableTrashB3"],
         "cutoutA3": ["movableTrashA3"]
       },
+      "fixtureGroup": [],
       "height": 40
     },
     {
@@ -833,6 +838,7 @@
       "providesAddressableAreas": {
         "cutoutD3": ["1ChannelWasteChute", "8ChannelWasteChute"]
       },
+      "fixtureGroup": [],
       "height": 124.5
     },
     {
@@ -848,6 +854,7 @@
           "gripperWasteChute"
         ]
       },
+      "fixtureGroup": [],
       "height": 124.5
     },
     {
@@ -858,6 +865,7 @@
       "providesAddressableAreas": {
         "cutoutD3": ["1ChannelWasteChute", "8ChannelWasteChute", "D4"]
       },
+      "fixtureGroup": [],
       "height": 124.5
     },
     {
@@ -874,6 +882,7 @@
           "D4"
         ]
       },
+      "fixtureGroup": [],
       "height": 124.5
     },
     {
@@ -882,6 +891,7 @@
       "mayMountTo": ["cutoutA1"],
       "displayName": "Rear Slot portion of the Thermocycler Moduler",
       "providesAddressableAreas": {},
+      "fixtureGroup": ["thermocyclerModuleV2Rear", "thermocyclerModuleV2Front"],
       "height": 124.5
     },
     {
@@ -892,6 +902,7 @@
       "providesAddressableAreas": {
         "cutoutB1": ["thermocyclerModuleV2"]
       },
+      "fixtureGroup": ["thermocyclerModuleV2Rear", "thermocyclerModuleV2Front"],
       "height": 124.5
     },
     {
@@ -918,6 +929,7 @@
         "cutoutB3": ["heaterShakerV1B3"],
         "cutoutA3": ["heaterShakerV1A3"]
       },
+      "fixtureGroup": [],
       "height": 40
     },
     {
@@ -944,6 +956,7 @@
         "cutoutB3": ["temperatureModuleV2B3"],
         "cutoutA3": ["temperatureModuleV2A3"]
       },
+      "fixtureGroup": [],
       "height": 40
     },
     {
@@ -978,6 +991,7 @@
         "cutoutB3": ["magneticBlockV1B3"],
         "cutoutA3": ["magneticBlockV1A3"]
       },
+      "fixtureGroup": [],
       "height": 40
     }
   ],

diff --git a/shared-data/deck/schemas/5.json b/shared-data/deck/schemas/5.json
@@ -292,6 +292,13 @@
               }
             }
           },
+          "fixtureGroup": {
+            "description": "The group of fixtures that must exist in the deck configuration if this fixture exists.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "height": {
             "description": "The vertical distance (mm) from the cutout fixture's origin to its tallest physical feature that an instrument could collide with.",
             "type": "number"

diff --git a/shared-data/python/opentrons_shared_data/deck/dev_types.py b/shared-data/python/opentrons_shared_data/deck/dev_types.py
@@ -116,6 +116,7 @@ class CutoutFixture(TypedDict):
     mayMountTo: List[str]
     displayName: str
     providesAddressableAreas: Dict[str, List[str]]
+    fixtureGroup: List[str]
     height: float