@opentrons/shared-data 0.1.5 → 0.1.6-alpha.10

package/pipette/definitions/2/liquid/single_channel/p50/default/3_6.json

@@ -0,0 +1,80 @@
+{
+  "$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
+  "supportedTips": {
+    "t50": {
+      "uiMaxFlowRate": 57,
+      "defaultAspirateFlowRate": {
+        "default": 35,
+        "valuesByApiLevel": { "2.14": 35 }
+      },
+      "defaultDispenseFlowRate": {
+        "default": 57,
+        "valuesByApiLevel": { "2.14": 57 }
+      },
+      "defaultBlowOutFlowRate": {
+        "default": 57,
+        "valuesByApiLevel": { "2.14": 57 }
+      },
+      "defaultFlowAcceleration": 1200.0,
+      "defaultTipLength": 57.9,
+      "defaultReturnTipHeight": 0.71,
+      "aspirate": {
+        "default": {
+          "1": [
+            [0.5175, 0.200812, 0.234783],
+            [0.675, 0.306434, 0.180124],
+            [0.965, 0.202975, 0.249958],
+            [1.3175, 0.174205, 0.277721],
+            [1.9175, 0.098216, 0.377837],
+            [2.71, 0.059576, 0.451928],
+            [3.0675, -0.013969, 0.651237],
+            [3.4125, 0.02245, 0.539521],
+            [3.8375, 0.027713, 0.52156],
+            [4.39, 0.072919, 0.348082],
+            [5.14, 0.022924, 0.567563],
+            [5.97, 0.013633, 0.615316],
+            [7.415, 0.009346, 0.640908],
+            [9.1925, 0.005809, 0.667137],
+            [10.235, 0.003508, 0.688285],
+            [13.885, 0.001976, 0.703972],
+            [27.41, 0.000922, 0.718603],
+            [51.005, 0.000207, 0.738189],
+            [53.4675, -0.000417, 0.770047]
+          ]
+        }
+      },
+      "dispense": {
+        "default": {
+          "1": [
+            [0.5175, 0.200812, 0.234783],
+            [0.675, 0.306434, 0.180124],
+            [0.965, 0.202975, 0.249958],
+            [1.3175, 0.174205, 0.277721],
+            [1.9175, 0.098216, 0.377837],
+            [2.71, 0.059576, 0.451928],
+            [3.0675, -0.013969, 0.651237],
+            [3.4125, 0.02245, 0.539521],
+            [3.8375, 0.027713, 0.52156],
+            [4.39, 0.072919, 0.348082],
+            [5.14, 0.022924, 0.567563],
+            [5.97, 0.013633, 0.615316],
+            [7.415, 0.009346, 0.640908],
+            [9.1925, 0.005809, 0.667137],
+            [10.235, 0.003508, 0.688285],
+            [13.885, 0.001976, 0.703972],
+            [27.41, 0.000922, 0.718603],
+            [51.005, 0.000207, 0.738189],
+            [53.4675, -0.000417, 0.770047]
+          ]
+        }
+      },
+      "defaultPushOutVolume": 2
+    }
+  },
+  "maxVolume": 50,
+  "minVolume": 5,
+  "defaultTipracks": [
+    "opentrons/opentrons_flex_96_tiprack_50ul/1",
+    "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
+  ]
+}

package/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_0.json

@@ -68,11 +68,10 @@
       "defaultPushOutVolume": 7
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.5
-  },
   "maxVolume": 30,
   "minVolume": 1,
-  "defaultTipracks": ["opentrons/opentrons_flex_96_tiprack_50ul/1"]
+  "defaultTipracks": [
+    "opentrons/opentrons_flex_96_tiprack_50ul/1",
+    "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
+  ]
 }

package/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_3.json

@@ -2,6 +2,7 @@
   "$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
   "supportedTips": {
     "t50": {
+      "uiMaxFlowRate": 31.8,
       "defaultAspirateFlowRate": {
         "default": 8,
         "valuesByApiLevel": { "2.14": 8 }
@@ -68,11 +69,10 @@
       "defaultPushOutVolume": 7
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.5
-  },
   "maxVolume": 30,
   "minVolume": 1,
-  "defaultTipracks": ["opentrons/opentrons_flex_96_tiprack_50ul/1"]
+  "defaultTipracks": [
+    "opentrons/opentrons_flex_96_tiprack_50ul/1",
+    "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
+  ]
 }

package/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_4.json

@@ -2,17 +2,18 @@
   "$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
   "supportedTips": {
     "t50": {
+      "uiMaxFlowRate": 31.8,
       "defaultAspirateFlowRate": {
-        "default": 35,
-        "valuesByApiLevel": { "2.14": 35 }
+        "default": 31.8,
+        "valuesByApiLevel": { "2.14": 31.8 }
       },
       "defaultDispenseFlowRate": {
-        "default": 57,
-        "valuesByApiLevel": { "2.14": 57 }
+        "default": 31.8,
+        "valuesByApiLevel": { "2.14": 31.8 }
       },
       "defaultBlowOutFlowRate": {
-        "default": 57,
-        "valuesByApiLevel": { "2.14": 57 }
+        "default": 31.8,
+        "valuesByApiLevel": { "2.14": 31.8 }
       },
       "defaultFlowAcceleration": 1200.0,
       "defaultTipLength": 57.9,
@@ -68,11 +69,10 @@
       "defaultPushOutVolume": 7
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.5
-  },
   "maxVolume": 30,
   "minVolume": 1,
-  "defaultTipracks": ["opentrons/opentrons_flex_96_tiprack_50ul/1"]
+  "defaultTipracks": [
+    "opentrons/opentrons_flex_96_tiprack_50ul/1",
+    "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
+  ]
 }

package/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_5.json

@@ -2,17 +2,18 @@
   "$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
   "supportedTips": {
     "t50": {
+      "uiMaxFlowRate": 26.7,
       "defaultAspirateFlowRate": {
-        "default": 35,
-        "valuesByApiLevel": { "2.14": 35 }
+        "default": 26.7,
+        "valuesByApiLevel": { "2.14": 26.7 }
       },
       "defaultDispenseFlowRate": {
-        "default": 57,
-        "valuesByApiLevel": { "2.14": 57 }
+        "default": 26.7,
+        "valuesByApiLevel": { "2.14": 26.7 }
       },
       "defaultBlowOutFlowRate": {
-        "default": 57,
-        "valuesByApiLevel": { "2.14": 57 }
+        "default": 26.7,
+        "valuesByApiLevel": { "2.14": 26.7 }
       },
       "defaultFlowAcceleration": 1200.0,
       "defaultTipLength": 57.9,
@@ -66,11 +67,10 @@
       "defaultPushOutVolume": 7
     }
   },
-  "defaultTipOverlapDictionary": {
-    "default": 10.5,
-    "opentrons/opentrons_flex_96_tiprack_50ul/1": 10.5
-  },
   "maxVolume": 30,
   "minVolume": 1,
-  "defaultTipracks": ["opentrons/opentrons_flex_96_tiprack_50ul/1"]
+  "defaultTipracks": [
+    "opentrons/opentrons_flex_96_tiprack_50ul/1",
+    "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
+  ]
 }

package/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_6.json

@@ -0,0 +1,78 @@
+{
+  "$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
+  "supportedTips": {
+    "t50": {
+      "uiMaxFlowRate": 26.7,
+      "defaultAspirateFlowRate": {
+        "default": 26.7,
+        "valuesByApiLevel": { "2.14": 26.7 }
+      },
+      "defaultDispenseFlowRate": {
+        "default": 26.7,
+        "valuesByApiLevel": { "2.14": 26.7 }
+      },
+      "defaultBlowOutFlowRate": {
+        "default": 26.7,
+        "valuesByApiLevel": { "2.14": 26.7 }
+      },
+      "defaultFlowAcceleration": 1200.0,
+      "defaultTipLength": 57.9,
+      "defaultReturnTipHeight": 0.71,
+      "aspirate": {
+        "default": {
+          "1": [
+            [0.541667, 0.302563, 0.190632],
+            [0.668333, 0.225982, 0.232113],
+            [1.028333, 0.255401, 0.212451],
+            [1.365, 0.149807, 0.321038],
+            [1.965, 0.091112, 0.401156],
+            [2.78, 0.060163, 0.46197],
+            [3.136667, -0.019962, 0.684718],
+            [3.471667, 0.014059, 0.578005],
+            [3.916667, 0.031571, 0.51721],
+            [4.458333, 0.069665, 0.368009],
+            [5.173333, 0.015715, 0.608534],
+            [5.99, 0.011271, 0.631526],
+            [7.39, 0.006269, 0.661487],
+            [9.18, 0.006559, 0.659347],
+            [10.193333, 0.001667, 0.704254],
+            [13.87, 0.002548, 0.695269],
+            [27.368333, 0.000899, 0.718151],
+            [45.855, 0.000182, 0.737772]
+          ]
+        }
+      },
+      "dispense": {
+        "default": {
+          "1": [
+            [0.541667, 0.302563, 0.190632],
+            [0.668333, 0.225982, 0.232113],
+            [1.028333, 0.255401, 0.212451],
+            [1.365, 0.149807, 0.321038],
+            [1.965, 0.091112, 0.401156],
+            [2.78, 0.060163, 0.46197],
+            [3.136667, -0.019962, 0.684718],
+            [3.471667, 0.014059, 0.578005],
+            [3.916667, 0.031571, 0.51721],
+            [4.458333, 0.069665, 0.368009],
+            [5.173333, 0.015715, 0.608534],
+            [5.99, 0.011271, 0.631526],
+            [7.39, 0.006269, 0.661487],
+            [9.18, 0.006559, 0.659347],
+            [10.193333, 0.001667, 0.704254],
+            [13.87, 0.002548, 0.695269],
+            [27.368333, 0.000899, 0.718151],
+            [45.855, 0.000182, 0.737772]
+          ]
+        }
+      },
+      "defaultPushOutVolume": 7
+    }
+  },
+  "maxVolume": 30,
+  "minVolume": 1,
+  "defaultTipracks": [
+    "opentrons/opentrons_flex_96_tiprack_50ul/1",
+    "opentrons/opentrons_flex_96_filtertiprack_50ul/1"
+  ]
+}

package/pipette/fixtures/index.ts

@@ -0,0 +1,58 @@
+import fixtureP10SingleGeneral from '../../pipette/definitions/2/general/single_channel/p10/1_0.json'
+import fixtureP10SingleGeometry from '../../pipette/definitions/2/geometry/single_channel/p10/1_0.json'
+import fixturep10SingleLiquids from '../../pipette/definitions/2/liquid/single_channel/p10/default/1_0.json'
+import fixtureP10MultiGeneral from '../../pipette/definitions/2/general/eight_channel/p10/1_0.json'
+import fixtureP10MultiGeometry from '../../pipette/definitions/2/geometry/eight_channel/p10/1_0.json'
+import fixtureP10MultiLiquids from '../../pipette/definitions/2/liquid/eight_channel/p10/default/1_0.json'
+import fixtureP300SingleGeneral from '../../pipette/definitions/2/general/single_channel/p300/1_0.json'
+import fixtureP300SingleGeometry from '../../pipette/definitions/2/geometry/single_channel/p300/1_0.json'
+import fixtureP300SingleLiquids from '../../pipette/definitions/2/liquid/single_channel/p300/default/1_0.json'
+import fixtureP300MultiGeneral from '../../pipette/definitions/2/general/eight_channel/p300/1_0.json'
+import fixtureP300MultiGeometry from '../../pipette/definitions/2/geometry/eight_channel/p300/1_0.json'
+import fixtureP300MultiLiquids from '../../pipette/definitions/2/liquid/eight_channel/p300/default/1_0.json'
+import fixtureP100096General from '../../pipette/definitions/2/general/ninety_six_channel/p1000/1_0.json'
+import fixtureP100096Geometry from '../../pipette/definitions/2/geometry/ninety_six_channel/p1000/1_0.json'
+import fixtureP100096Liquids from '../../pipette/definitions/2/liquid/ninety_six_channel/p1000/default/1_0.json'
+import fixtureP1000SingleGeneral from '../../pipette/definitions/2/general/single_channel/p1000/1_0.json'
+import fixtureP1000SingleGeometry from '../../pipette/definitions/2/geometry/single_channel/p1000/1_0.json'
+import fixtureP1000SingleLiquids from '../../pipette/definitions/2/liquid/single_channel/p1000/default/1_0.json'
+
+import type { PipetteV2Specs } from '../../js'
+
+//  need to type as any first because channels and displayCategory types are
+//  incompatible.
+export const fixtureP10SingleV2Specs: PipetteV2Specs = {
+  ...fixtureP10SingleGeneral,
+  ...fixtureP10SingleGeometry,
+  liquids: { default: { ...fixturep10SingleLiquids } },
+} as any
+
+export const fixtureP10MultiV2Specs: PipetteV2Specs = {
+  ...fixtureP10MultiGeneral,
+  ...fixtureP10MultiGeometry,
+  liquids: { default: { ...fixtureP10MultiLiquids } },
+} as any
+
+export const fixtureP300SingleV2Specs: PipetteV2Specs = {
+  ...fixtureP300SingleGeneral,
+  ...fixtureP300SingleGeometry,
+  liquids: { default: { ...fixtureP300SingleLiquids } },
+} as any
+
+export const fixtureP300MultiV2Specs: PipetteV2Specs = {
+  ...fixtureP300MultiGeneral,
+  ...fixtureP300MultiGeometry,
+  liquids: { default: { ...fixtureP300MultiLiquids } },
+} as any
+
+export const fixtureP100096V2Specs: PipetteV2Specs = {
+  ...fixtureP100096General,
+  ...fixtureP100096Geometry,
+  liquids: { default: { ...fixtureP100096Liquids } },
+} as any
+
+export const fixtureP1000SingleV2Specs: PipetteV2Specs = {
+  ...fixtureP1000SingleGeneral,
+  ...fixtureP1000SingleGeometry,
+  liquids: { default: { ...fixtureP1000SingleLiquids } },
+} as any

package/pipette/fixtures/name/index.ts

@@ -1,7 +1,7 @@
 import _pipetteNameSpecFixtures from './pipetteNameSpecFixtures.json'
 import type { PipetteName, PipetteNameSpecs } from '../../../js'
 
-const pipetteNameSpecFixtures = _pipetteNameSpecFixtures as Record<
+export const pipetteNameSpecFixtures = _pipetteNameSpecFixtures as Record<
   PipetteName,
   PipetteNameSpecs
 >

package/pipette/schemas/2/pipetteGeometrySchema.json

@@ -84,6 +84,34 @@
       "patternProperties": {
         "[A-Z]+[0-9]+": { "$ref": "#/definitions/xyzArray" }
       }
+    },
+    "lldSettings": {
+      "type": "object",
+      "description": "Minimum space requirements for Liquid Level Detection to work properly",
+      "additionalProperties": false,
+      "properties": {
+        "t50": {
+          "type": "object",
+          "properties": {
+            "minHeight": { "type": "number" },
+            "minVolume": { "type": "number" }
+          }
+        },
+        "t200": {
+          "type": "object",
+          "properties": {
+            "minHeight": { "type": "number" },
+            "minVolume": { "type": "number" }
+          }
+        },
+        "t1000": {
+          "type": "object",
+          "properties": {
+            "minHeight": { "type": "number" },
+            "minVolume": { "type": "number" }
+          }
+        }
+      }
     }
   }
 }

package/pipette/schemas/2/pipetteLiquidPropertiesSchema.json

@@ -41,8 +41,7 @@
     "maxVolume",
     "minVolume",
     "defaultTipracks",
-    "supportedTips",
-    "defaultTipOverlapDictionary"
+    "supportedTips"
   ],
   "additionalProperties": false,
   "properties": {
@@ -68,13 +67,16 @@
             ],
             "properties": {
               "defaultAspirateFlowRate": {
-                "$ref": "#/definitions/flowRate"
+                "$ref": "#/definitions/flowRate",
+                "$comment": "for lowVolumeDefault only, the flowRate matches the uiMaxFlowRate. This does not change physical behavior and was made for UI purposes"
               },
               "defaultDispenseFlowRate": {
-                "$ref": "#/definitions/flowRate"
+                "$ref": "#/definitions/flowRate",
+                "$comment": "for lowVolumeDefault only, the flowRate matches the uiMaxFlowRate. This does not change physical behavior and was made for UI purposes"
               },
               "defaultBlowOutFlowRate": {
-                "$ref": "#/definitions/flowRate"
+                "$ref": "#/definitions/flowRate",
+                "$comment": "for lowVolumeDefault only, the flowRate matches the uiMaxFlowRate. This does not change physical behavior and was made for UI purposes"
               },
               "defaultFlowAcceleration": {
                 "$ref": "#/definitions/positiveNumber"
@@ -92,22 +94,17 @@
               "dispense": {
                 "type": "array",
                 "items": { "$ref": "#/definitions/liquidHandlingSpecs" }
+              },
+              "uiMaxFlowRate": {
+                "$ref": "#/definitions/positiveNumber",
+                "$comment": "To be used in frontend applications only since it is the limit-to-lowest-max",
+                "description": "An optional number to represent each pipette's supported tip max flow rate for aspirate and dispense. The limit is the lowest max flow rate given all the tip's volumes minus 2% for safety."
               }
             }
           }
         }
       }
     },
-    "defaultTipOverlapDictionary": {
-      "type": "object",
-      "description": "Map of tip overlap values with defaults",
-      "required": ["default"],
-      "$comment": "Other keys in here should be labware URIs",
-      "properties": {
-        "default": { "type": "number" }
-      },
-      "additionalProperties": { "type": "number" }
-    },
     "maxVolume": { "$ref": "#/definitions/positiveNumber" },
     "minVolume": { "$ref": "#/definitions/positiveNumber" },
     "defaultTipracks": {

package/pipette/schemas/2/pipettePropertiesSchema.json

@@ -13,6 +13,16 @@
       "type": "number",
       "minimum": 0
     },
+    "distanceRange": {
+      "type": "number",
+      "minimum": 0.0,
+      "maximum": 100
+    },
+    "speedRange": {
+      "type": "number",
+      "minimum": 0.0,
+      "maximum": 100
+    },
     "currentRange": {
       "type": "number",
       "minimum": 0.01,
@@ -35,10 +45,36 @@
       "type": "number",
       "enum": [1, 2, 3, 4, 5, 6, 7, 8, 12, 96, 384]
     },
-    "currentByTipCount": {
+    "configurationsByNozzleMap": {
       "type": "object",
-      "patternProperties": {
-        "\\d+": { "$ref": "#/definitions/currentRange" }
+      "description": "Pipette configurations keyed by validated sets of nozzle layouts. Maps must be ordered from smallest to largest regarding nozzle count.",
+      "items": {
+        "type": "object",
+        "description": "Tip types by which each set of configration values are differentiated.",
+        "required": ["default"],
+        "items": {
+          "speed": { "$ref": "#/definitions/speedRange" },
+          "distance": { "$ref": "#/definitions/distanceRange" },
+          "current": { "$ref": "#/definitions/currentRange" },
+          "tipOverlaps": {
+            "type": "object",
+            "description": "Set of versioned tip overlap values with version 0 acting as the default",
+            "required": ["v0"],
+            "patternProperties": {
+              "^v\\d+$": {
+                "type": "object",
+                "description": "Map of tip overlap values with defaults",
+                "required": ["default"],
+                "$comment": "Other keys in here should be labware URIs",
+                "properties": {
+                  "default": { "type": "number" }
+                },
+                "additionalProperties": { "type": "number" }
+              }
+            },
+            "additionalProperties": false
+          }
+        }
       }
     }
   },
@@ -157,6 +193,18 @@
         "run": { "$ref": "#/definitions/currentRange" }
       }
     },
+    "validNozzleMaps": {
+      "maps": {
+        "description": "The Opentrons validated map configurations for this pipette.",
+        "type": "object",
+        "additionalProperties": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
     "pickUpTipConfigurations": {
       "description": "Object containing configurations for picking up tips common to all partial configurations",
       "anyOf": [
@@ -166,21 +214,13 @@
           "properties": {
             "pressFit": {
               "type": "object",
-              "required": [
-                "presses",
-                "speed",
-                "increment",
-                "distance",
-                "currentByTipCount"
-              ],
+              "required": ["presses", "increment", "configurationsByNozzleMap"],
               "additionalProperties": false,
               "properties": {
                 "presses": { "$ref": "#/definitions/positiveNumber" },
-                "speed": { "$ref": "#/definitions/positiveNumber" },
                 "increment": { "$ref": "#/definitions/positiveNumber" },
-                "distance": { "$ref": "#/definitions/positiveNumber" },
-                "currentByTipCount": {
-                  "$ref": "#/definitions/currentByTipCount"
+                "configurationsByNozzleMap": {
+                  "$ref": "#/definitions/configurationsByNozzleMap"
                 }
               }
             }
@@ -195,9 +235,7 @@
               "required": [
                 "prep_move_distance",
                 "prep_move_speed",
-                "speed",
-                "distance",
-                "currentByTipCount"
+                "configurationsByNozzleMap"
               ],
               "additionalProperties": false,
               "properties": {
@@ -205,10 +243,8 @@
                   "$ref": "#/definitions/positiveNumber"
                 },
                 "prep_move_speed": { "$ref": "#/definitions/positiveNumber" },
-                "speed": { "$ref": "#/definitions/positiveNumber" },
-                "distance": { "$ref": "#/definitions/positiveNumber" },
-                "currentByTipCount": {
-                  "$ref": "#/definitions/currentByTipCount"
+                "configurationsByNozzleMap": {
+                  "$ref": "#/definitions/configurationsByNozzleMap"
                 },
                 "connectTiprackDistanceMM": {
                   "$ref": "#/definitions/positiveNumber"

package/protocol/README.md

@@ -2,7 +2,7 @@
 
 1. Create new JSON schema in `shared-data/protocol/schemas/${schemaVersion}.json`
 2. Create TS types for new schema in `shared-data/protocol/types`
-3. Create or modify Python types as necessary in both `python/opentrons_shared_data/protocol/dev_types` and in the python api `dev_types` in `api/src/opentrons/protocol_api/dev_types.py`
+3. Create or modify Python types as necessary in both `python/opentrons_shared_data/protocol/types` and in the python api `types` in `api/src/opentrons/protocol_api/types.py`
 4. Create new executor in api to handle new schema. Be sure to include unit tests
 5. Add new test in `api/tests/opentrons/test_execute.py` for the schema
 6. Add new test in `shared-data/js/__tests__/protocolSchemaV${schemaVersion}.test.js` to ensure new schema definition functions as intended