chore(shared-data): version tip overlap

Tip overlap dictionaries now have a version. Which version gets loaded will depend on what protocol execution frontends request from the engine with a notAfter constraint.
Opentrons · Jun 3, 2024 · 74a25f9 · 74a25f9
1 parent c34aed7
commit 74a25f9
Show file tree

Hide file tree

Showing 82 changed files with 884 additions and 6,658 deletions.
diff --git a/shared-data/js/__tests__/__snapshots__/pipettes.test.ts.snap b/shared-data/js/__tests__/__snapshots__/pipettes.test.ts.snap
diff --git a/shared-data/js/__tests__/pipettes.test.ts b/shared-data/js/__tests__/pipettes.test.ts
@@ -82,14 +82,16 @@ describe('pipette data accessors', () => {
           default: {
             $otSharedSchema:
               '#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json',
-            defaultTipOverlapDictionary: {
-              default: 10.5,
-              'opentrons/opentrons_flex_96_tiprack_1000ul/1': 10.5,
-              'opentrons/opentrons_flex_96_tiprack_200ul/1': 10.5,
-              'opentrons/opentrons_flex_96_tiprack_50ul/1': 10.5,
-              'opentrons/opentrons_flex_96_filtertiprack_1000ul/1': 10.5,
-              'opentrons/opentrons_flex_96_filtertiprack_200ul/1': 10.5,
-              'opentrons/opentrons_flex_96_filtertiprack_50ul/1': 10.5,
+            versionedTipOverlapDictionary: {
+              v0: {
+                default: 10.5,
+                'opentrons/opentrons_flex_96_tiprack_1000ul/1': 10.5,
+                'opentrons/opentrons_flex_96_tiprack_200ul/1': 10.5,
+                'opentrons/opentrons_flex_96_tiprack_50ul/1': 10.5,
+                'opentrons/opentrons_flex_96_filtertiprack_1000ul/1': 10.5,
+                'opentrons/opentrons_flex_96_filtertiprack_200ul/1': 10.5,
+                'opentrons/opentrons_flex_96_filtertiprack_50ul/1': 10.5,
+              },
             },
             defaultTipracks: [
               'opentrons/opentrons_flex_96_tiprack_1000ul/1',
@@ -148,10 +150,12 @@ describe('pipette data accessors', () => {
 
     const mockLiquidDefault = {
       $otSharedSchema: '#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json',
-      defaultTipOverlapDictionary: {
-        default: 10.5,
-        [tiprackFilter50uL]: 10.5,
-        [tiprack50uL]: 10.5,
+      versionedTipOverlapDictionary: {
+        v0: {
+          default: 10.5,
+          [tiprackFilter50uL]: 10.5,
+          [tiprack50uL]: 10.5,
+        },
       },
       defaultTipracks: [tiprack50uL, tiprackFilter50uL],
       maxVolume: 50,
@@ -196,10 +200,12 @@ describe('pipette data accessors', () => {
     } as PipetteV2LiquidSpecs
     const mockLiquidLowVolume = {
       $otSharedSchema: '#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json',
-      defaultTipOverlapDictionary: {
-        default: 10.5,
-        [tiprackFilter50uL]: 10.5,
-        [tiprack50uL]: 10.5,
+      versionedTipOverlapDictionary: {
+        v0: {
+          default: 10.5,
+          [tiprackFilter50uL]: 10.5,
+          [tiprack50uL]: 10.5,
+        },
       },
       defaultTipracks: [tiprack50uL, tiprackFilter50uL],
       maxVolume: 30,

diff --git a/shared-data/js/types.ts b/shared-data/js/types.ts
@@ -502,7 +502,7 @@ export interface SupportedTips {
 export interface PipetteV2LiquidSpecs {
   $otSharedSchema: string
   supportedTips: SupportedTips
-  defaultTipOverlapDictionary: Record<string, number>
+  versionedTipOverlapDictionary: Record<string, Record<string, number>>
   maxVolume: number
   minVolume: number
   defaultTipracks: string[]

diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_0.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_0.json
@@ -41,18 +41,20 @@
       "defaultPushOutVolume": 0
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 3.29,
-    "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
-    "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
-    "opentrons/geb_96_tiprack_10ul/1": 6.2,
-    "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
-  },
   "maxVolume": 10,
   "minVolume": 1.0,
   "defaultTipracks": [
     "opentrons/opentrons_96_tiprack_10ul/1",
     "opentrons/opentrons_96_filtertiprack_10ul/1",
     "opentrons/geb_96_tiprack_10ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 3.29,
+      "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
+      "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
+      "opentrons/geb_96_tiprack_10ul/1": 6.2,
+      "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_3.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_3.json
@@ -41,18 +41,20 @@
       "defaultPushOutVolume": 0
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 3.29,
-    "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
-    "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
-    "opentrons/geb_96_tiprack_10ul/1": 6.2,
-    "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
-  },
   "maxVolume": 10,
   "minVolume": 1.0,
   "defaultTipracks": [
     "opentrons/opentrons_96_tiprack_10ul/1",
     "opentrons/opentrons_96_filtertiprack_10ul/1",
     "opentrons/geb_96_tiprack_10ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 3.29,
+      "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
+      "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
+      "opentrons/geb_96_tiprack_10ul/1": 6.2,
+      "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_4.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_4.json
@@ -41,18 +41,20 @@
       "defaultPushOutVolume": 0
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 3.29,
-    "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
-    "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
-    "opentrons/geb_96_tiprack_10ul/1": 6.2,
-    "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
-  },
   "maxVolume": 10,
   "minVolume": 1.0,
   "defaultTipracks": [
     "opentrons/opentrons_96_tiprack_10ul/1",
     "opentrons/opentrons_96_filtertiprack_10ul/1",
     "opentrons/geb_96_tiprack_10ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 3.29,
+      "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
+      "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
+      "opentrons/geb_96_tiprack_10ul/1": 6.2,
+      "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_5.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_5.json
@@ -30,18 +30,20 @@
       "defaultPushOutVolume": 0
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 3.29,
-    "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
-    "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
-    "opentrons/geb_96_tiprack_10ul/1": 6.2,
-    "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
-  },
   "maxVolume": 10,
   "minVolume": 1.0,
   "defaultTipracks": [
     "opentrons/opentrons_96_tiprack_10ul/1",
     "opentrons/opentrons_96_filtertiprack_10ul/1",
     "opentrons/geb_96_tiprack_10ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 3.29,
+      "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
+      "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
+      "opentrons/geb_96_tiprack_10ul/1": 6.2,
+      "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_6.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p10/default/1_6.json
@@ -38,18 +38,20 @@
       "defaultPushOutVolume": 0
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 3.29,
-    "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
-    "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
-    "opentrons/geb_96_tiprack_10ul/1": 6.2,
-    "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
-  },
   "maxVolume": 10,
   "minVolume": 1.0,
   "defaultTipracks": [
     "opentrons/opentrons_96_tiprack_10ul/1",
     "opentrons/opentrons_96_filtertiprack_10ul/1",
     "opentrons/geb_96_tiprack_10ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 3.29,
+      "opentrons/opentrons_96_tiprack_10ul/1": 3.29,
+      "opentrons/opentrons_96_filtertiprack_10ul/1": 3.29,
+      "opentrons/geb_96_tiprack_10ul/1": 6.2,
+      "opentrons/eppendorf_96_tiprack_10ul_eptips/1": 1.0
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/1_0.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/1_0.json
@@ -340,17 +340,19 @@
       "defaultPushOutVolume": 20
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.5
-  },
   "maxVolume": 1000,
   "minVolume": 5,
   "defaultTipracks": [
     "opentrons/opentrons_flex_96_tiprack_1000ul/1",
     "opentrons/opentrons_flex_96_tiprack_200ul/1",
     "opentrons/opentrons_flex_96_tiprack_50ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 10.5,
+      "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.5,
+      "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.5,
+      "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.5
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_0.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_0.json
@@ -340,15 +340,6 @@
       "defaultPushOutVolume": 20
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
-    "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
-  },
   "maxVolume": 1000,
   "minVolume": 5,
   "defaultTipracks": [
@@ -358,5 +349,16 @@
     "opentrons/opentrons_flex_96_filtertiprack_1000ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_200ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 10.5,
+      "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
+      "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_3.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_3.json
@@ -343,15 +343,6 @@
       "defaultPushOutVolume": 20
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
-    "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
-  },
   "maxVolume": 1000,
   "minVolume": 5,
   "defaultTipracks": [
@@ -361,5 +352,16 @@
     "opentrons/opentrons_flex_96_filtertiprack_1000ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_200ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 10.5,
+      "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
+      "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_4.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_4.json
@@ -343,15 +343,6 @@
       "defaultPushOutVolume": 20
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
-    "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
-  },
   "maxVolume": 1000,
   "minVolume": 5,
   "defaultTipracks": [
@@ -361,5 +352,16 @@
     "opentrons/opentrons_flex_96_filtertiprack_1000ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_200ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 10.5,
+      "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
+      "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
+    }
+  }
 }
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_5.json b/shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_5.json
@@ -223,15 +223,6 @@
       "defaultPushOutVolume": 20
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
-    "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
-    "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
-    "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
-  },
   "maxVolume": 1000,
   "minVolume": 5,
   "defaultTipracks": [
@@ -241,5 +232,16 @@
     "opentrons/opentrons_flex_96_filtertiprack_1000ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_200ul/1",
     "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
-  ]
+  ],
+  "versionedTipOverlapDictionary": {
+    "v0": {
+      "default": 10.5,
+      "opentrons/opentrons_flex_96_tiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_tiprack_1000ul/1": 10.17,
+      "opentrons/opentrons_flex_96_filtertiprack_200ul/1": 10.1,
+      "opentrons/opentrons_flex_96_filtertiprack_50ul/1": 10.05,
+      "opentrons/opentrons_flex_96_filtertiprack_1000ul/1": 10.17
+    }
+  }
 }