@opentrons/shared-data 0.1.7-alpha.0 → 0.2.0-alpha.0

package/liquid-class/fixtures/1/fixture_glycerol50.json

@@ -3,6 +3,7 @@
   "displayName": "Viscous",
   "description": "50% glycerol",
   "schemaVersion": 1,
+  "version": 1,
   "namespace": "opentrons",
   "byPipette": [
     {
@@ -12,11 +13,13 @@
           "tiprack": "opentrons_96_tiprack_20ul",
           "aspirate": {
             "submerge": {
-              "positionReference": "liquid-meniscus",
-              "offset": {
-                "x": 0,
-                "y": 0,
-                "z": -5
+              "startPosition": {
+                "positionReference": "liquid-meniscus",
+                "offset": {
+                  "x": 0,
+                  "y": 0,
+                  "z": -5
+                }
               },
               "speed": 100,
               "delay": {
@@ -27,11 +30,13 @@
               }
             },
             "retract": {
-              "positionReference": "well-top",
-              "offset": {
-                "x": 0,
-                "y": 0,
-                "z": 5
+              "endPosition": {
+                "positionReference": "well-top",
+                "offset": {
+                  "x": 0,
+                  "y": 0,
+                  "z": 5
+                }
               },
               "speed": 100,
               "airGapByVolume": [
@@ -42,7 +47,7 @@
                 "enable": true,
                 "params": {
                   "zOffset": 2,
-                  "mmToEdge": 1,
+                  "mmFromEdge": 1,
                   "speed": 50
                 }
               },
@@ -53,11 +58,13 @@
                 }
               }
             },
-            "positionReference": "well-bottom",
-            "offset": {
-              "x": 0,
-              "y": 0,
-              "z": -5
+            "aspiratePosition": {
+              "positionReference": "well-bottom",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": -5
+              }
             },
             "flowRateByVolume": [[10.0, 50.0]],
             "correctionByVolume": [
@@ -81,11 +88,13 @@
           },
           "singleDispense": {
             "submerge": {
-              "positionReference": "liquid-meniscus",
-              "offset": {
-                "x": 0,
-                "y": 0,
-                "z": -5
+              "startPosition": {
+                "positionReference": "liquid-meniscus",
+                "offset": {
+                  "x": 0,
+                  "y": 0,
+                  "z": -5
+                }
               },
               "speed": 100,
               "delay": {
@@ -96,11 +105,13 @@
               }
             },
             "retract": {
-              "positionReference": "well-top",
-              "offset": {
-                "x": 0,
-                "y": 0,
-                "z": 5
+              "endPosition": {
+                "positionReference": "well-top",
+                "offset": {
+                  "x": 0,
+                  "y": 0,
+                  "z": 5
+                }
               },
               "speed": 100,
               "airGapByVolume": [
@@ -118,7 +129,7 @@
                 "enable": true,
                 "params": {
                   "zOffset": 2,
-                  "mmToEdge": 1,
+                  "mmFromEdge": 1,
                   "speed": 50
                 }
               },
@@ -129,11 +140,13 @@
                 }
               }
             },
-            "positionReference": "well-bottom",
-            "offset": {
-              "x": 0,
-              "y": 0,
-              "z": -5
+            "dispensePosition": {
+              "positionReference": "well-bottom",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": -5
+              }
             },
             "flowRateByVolume": [
               [10.0, 40.0],
@@ -163,11 +176,13 @@
           },
           "multiDispense": {
             "submerge": {
-              "positionReference": "liquid-meniscus",
-              "offset": {
-                "x": 0,
-                "y": 0,
-                "z": -5
+              "startPosition": {
+                "positionReference": "liquid-meniscus",
+                "offset": {
+                  "x": 0,
+                  "y": 0,
+                  "z": -5
+                }
               },
               "speed": 100,
               "delay": {
@@ -178,11 +193,13 @@
               }
             },
             "retract": {
-              "positionReference": "well-top",
-              "offset": {
-                "x": 0,
-                "y": 0,
-                "z": 5
+              "endPosition": {
+                "positionReference": "well-top",
+                "offset": {
+                  "x": 0,
+                  "y": 0,
+                  "z": 5
+                }
               },
               "speed": 100,
               "airGapByVolume": [
@@ -193,7 +210,7 @@
                 "enable": true,
                 "params": {
                   "zOffset": 2,
-                  "mmToEdge": 1,
+                  "mmFromEdge": 1,
                   "speed": 50
                 }
               },
@@ -207,11 +224,13 @@
                 "enable": false
               }
             },
-            "positionReference": "well-bottom",
-            "offset": {
-              "x": 0,
-              "y": 0,
-              "z": -5
+            "dispensePosition": {
+              "positionReference": "well-bottom",
+              "offset": {
+                "x": 0,
+                "y": 0,
+                "z": -5
+              }
             },
             "flowRateByVolume": [
               [10.0, 40.0],

package/liquid-class/schemas/1.json

@@ -58,6 +58,20 @@
       "required": ["x", "y", "z"],
       "additionalProperties": false
     },
+    "tipPosition": {
+      "type": "object",
+      "description": "Positional reference and relative offset for where a tip should go.",
+      "properties": {
+        "positionReference": {
+          "$ref": "#/definitions/positionReference"
+        },
+        "offset": {
+          "$ref": "#/definitions/coordinate"
+        }
+      },
+      "required": ["positionReference", "offset"],
+      "additionalProperties": false
+    },
     "touchTip": {
       "type": "object",
       "description": "Shared properties for the touch-tip function.",
@@ -73,7 +87,7 @@
               "type": "number",
               "description": "Offset from the top of the well for touch-tip, in millimeters."
             },
-            "mmToEdge": {
+            "mmFromEdge": {
               "type": "number",
               "description": "Offset away from the the well edge, in millimeters."
             },
@@ -82,7 +96,7 @@
               "description": "Touch-tip speed, in millimeters per second."
             }
           },
-          "required": ["zOffset", "mmToEdge", "speed"],
+          "required": ["zOffset", "mmFromEdge", "speed"],
           "additionalProperties": false
         }
       },
@@ -214,11 +228,8 @@
       "type": "object",
       "description": "Shared properties for the submerge function before aspiration or dispense.",
       "properties": {
-        "positionReference": {
-          "$ref": "#/definitions/positionReference"
-        },
-        "offset": {
-          "$ref": "#/definitions/coordinate"
+        "startPosition": {
+          "$ref": "#/definitions/tipPosition"
         },
         "speed": {
           "$ref": "#/definitions/positiveNumber",
@@ -228,18 +239,15 @@
           "$ref": "#/definitions/delay"
         }
       },
-      "required": ["positionReference", "offset", "speed", "delay"],
+      "required": ["startPosition", "speed", "delay"],
       "additionalProperties": false
     },
     "retractAspirate": {
       "type": "object",
       "description": "Shared properties for the retract function after aspiration or dispense.",
       "properties": {
-        "positionReference": {
-          "$ref": "#/definitions/positionReference"
-        },
-        "offset": {
-          "$ref": "#/definitions/coordinate"
+        "endPosition": {
+          "$ref": "#/definitions/tipPosition"
         },
         "speed": {
           "$ref": "#/definitions/positiveNumber",
@@ -255,24 +263,15 @@
           "$ref": "#/definitions/delay"
         }
       },
-      "required": [
-        "positionReference",
-        "offset",
-        "speed",
-        "airGapByVolume",
-        "delay"
-      ],
+      "required": ["endPosition", "speed", "airGapByVolume", "delay"],
       "additionalProperties": false
     },
     "retractDispense": {
       "type": "object",
       "description": "Shared properties for the retract function after aspiration or dispense.",
       "properties": {
-        "positionReference": {
-          "$ref": "#/definitions/positionReference"
-        },
-        "offset": {
-          "$ref": "#/definitions/coordinate"
+        "endPosition": {
+          "$ref": "#/definitions/tipPosition"
         },
         "speed": {
           "$ref": "#/definitions/positiveNumber",
@@ -292,8 +291,7 @@
         }
       },
       "required": [
-        "positionReference",
-        "offset",
+        "endPosition",
         "speed",
         "airGapByVolume",
         "blowout",
@@ -312,11 +310,8 @@
         "retract": {
           "$ref": "#/definitions/retractAspirate"
         },
-        "positionReference": {
-          "$ref": "#/definitions/positionReference"
-        },
-        "offset": {
-          "$ref": "#/definitions/coordinate"
+        "aspiratePosition": {
+          "$ref": "#/definitions/tipPosition"
         },
         "flowRateByVolume": {
           "$ref": "#/definitions/flowRateByVolume"
@@ -338,8 +333,7 @@
       "required": [
         "submerge",
         "retract",
-        "positionReference",
-        "offset",
+        "aspiratePosition",
         "flowRateByVolume",
         "correctionByVolume",
         "preWet",
@@ -358,11 +352,8 @@
         "retract": {
           "$ref": "#/definitions/retractDispense"
         },
-        "positionReference": {
-          "$ref": "#/definitions/positionReference"
-        },
-        "offset": {
-          "$ref": "#/definitions/coordinate"
+        "dispensePosition": {
+          "$ref": "#/definitions/tipPosition"
         },
         "flowRateByVolume": {
           "$ref": "#/definitions/flowRateByVolume"
@@ -383,8 +374,7 @@
       "required": [
         "submerge",
         "retract",
-        "positionReference",
-        "offset",
+        "dispensePosition",
         "flowRateByVolume",
         "correctionByVolume",
         "mix",
@@ -403,11 +393,8 @@
         "retract": {
           "$ref": "#/definitions/retractDispense"
         },
-        "positionReference": {
-          "$ref": "#/definitions/positionReference"
-        },
-        "offset": {
-          "$ref": "#/definitions/coordinate"
+        "dispensePosition": {
+          "$ref": "#/definitions/tipPosition"
         },
         "flowRateByVolume": {
           "$ref": "#/definitions/flowRateByVolume"
@@ -428,8 +415,7 @@
       "required": [
         "submerge",
         "retract",
-        "positionReference",
-        "offset",
+        "dispensePosition",
         "flowRateByVolume",
         "correctionByVolume",
         "conditioningByVolume",
@@ -457,6 +443,11 @@
       "type": "number",
       "enum": [1]
     },
+    "version": {
+      "description": "Version of the liquid class definition itself (eg water v1/v2/v3). An incrementing integer",
+      "type": "integer",
+      "minimum": 1
+    },
     "namespace": {
       "$ref": "#/definitions/safeString"
     },
@@ -506,6 +497,7 @@
     "displayName",
     "description",
     "schemaVersion",
+    "version",
     "namespace",
     "byPipette"
   ],