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

package/labware/fixtures/2/index.ts

@@ -1,9 +1,10 @@
-import fixture_12_trough from './fixture_12_trough.json'
 import fixture_12_trough_v2 from './fixture_12_trough_v2.json'
+import fixture_12_trough from './fixture_12_trough.json'
 import fixture_24_tuberack from './fixture_24_tuberack.json'
-import fixture_384_plate from './fixture_384_plate.json'
 import fixture_96_plate from './fixture_96_plate.json'
+import fixture_384_plate from './fixture_384_plate.json'
 import fixture_calibration_block from './fixture_calibration_block.json'
+import fixture_corning_96_wellplate_360_flat from './fixture_corning_96_wellplate_360_flat.json'
 import fixture_flex_96_tiprack_1000ul from './fixture_flex_96_tiprack_1000ul.json'
 import fixture_flex_96_tiprack_adapter from './fixture_flex_96_tiprack_adapter.json'
 import fixture_irregular_example_1 from './fixture_irregular_example_1.json'
@@ -11,11 +12,10 @@ import fixture_overlappy_wellplate from './fixture_overlappy_wellplate.json'
 import fixture_regular_example_1 from './fixture_regular_example_1.json'
 import fixture_regular_example_2 from './fixture_regular_example_2.json'
 import fixture_tiprack_10_ul from './fixture_tiprack_10_ul.json'
-import fixture_tiprack_1000_ul from './fixture_tiprack_1000_ul.json'
 import fixture_tiprack_300_ul from './fixture_tiprack_300_ul.json'
+import fixture_tiprack_1000_ul from './fixture_tiprack_1000_ul.json'
 import fixture_trash from './fixture_trash.json'
 import fixture_universal_flat_bottom_adapter from './fixture_universal_flat_bottom_adapter.json'
-import fixture_corning_96_wellplate_360_flat from './fixture_corning_96_wellplate_360_flat.json'
 
 export {
   fixture_12_trough_v2,

package/labware/fixtures/3/fixture_2_plate.json

@@ -8,10 +8,32 @@
     "displayVolumeUnits": "mL",
     "displayCategory": "reservoir"
   },
-  "dimensions": {
-    "xDimension": 127.76,
-    "yDimension": 85.8,
-    "zDimension": 44.45
+  "extents": {
+    "total": {
+      "backLeftBottom": {
+        "x": 0,
+        "y": 0,
+        "z": 0
+      },
+      "frontRightTop": {
+        "x": 127.76,
+        "y": -85.8,
+        "z": 44.45
+      }
+    }
+  },
+  "features": {
+    "slotFootprintAsChild": {
+      "z": 0,
+      "backLeft": {
+        "x": 0,
+        "y": 0
+      },
+      "frontRight": {
+        "x": 127.76,
+        "y": -85.8
+      }
+    }
   },
   "parameters": {
     "format": "trough",
@@ -27,7 +49,7 @@
       "diameter": 35.0,
       "totalLiquidVolume": 22000,
       "x": 13.94,
-      "y": 42.9,
+      "y": -42.9,
       "z": 2.29,
       "geometryDefinitionId": "iuweofiuwhfn"
     },
@@ -38,7 +60,7 @@
       "yDimension": 71.88,
       "totalLiquidVolume": 22000,
       "x": 23.03,
-      "y": 42.9,
+      "y": -42.9,
       "z": 2.29,
       "geometryDefinitionId": "daiwudhadfhiew"
     }
@@ -55,11 +77,6 @@
       }
     }
   ],
-  "cornerOffsetFromSlot": {
-    "x": 0,
-    "y": 0,
-    "z": 0
-  },
   "innerLabwareGeometry": {
     "daiwudhadfhiew": {
       "sections": [

package/labware/fixtures/3/fixture_corning_24_plate.json

@@ -16,17 +16,39 @@
   },
   "schemaVersion": 3,
   "version": 3,
-  "namespace": "opentrons",
+  "namespace": "fixture",
   "metadata": {
     "displayName": "Corning 24 Well Plate 3.4 mL Flat",
     "displayVolumeUnits": "mL",
     "displayCategory": "wellPlate",
     "tags": []
   },
-  "dimensions": {
-    "xDimension": 127.76,
-    "yDimension": 85.47,
-    "zDimension": 20.27
+  "extents": {
+    "total": {
+      "backLeftBottom": {
+        "x": 0,
+        "y": 0,
+        "z": 0
+      },
+      "frontRightTop": {
+        "x": 127.76,
+        "y": -85.47,
+        "z": 20.27
+      }
+    }
+  },
+  "features": {
+    "slotFootprintAsChild": {
+      "z": 0,
+      "backLeft": {
+        "x": 0,
+        "y": 0
+      },
+      "frontRight": {
+        "x": 127.76,
+        "y": -85.47
+      }
+    }
   },
   "wells": {
     "D1": {
@@ -35,7 +57,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 17.48,
-      "y": 13.77,
+      "y": -71.7,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -45,7 +67,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 17.48,
-      "y": 33.07,
+      "y": -52.4,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -55,7 +77,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 17.48,
-      "y": 52.37,
+      "y": -33.1,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -65,7 +87,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 17.48,
-      "y": 71.67,
+      "y": -13.8,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -75,7 +97,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 36.78,
-      "y": 13.77,
+      "y": -71.7,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -85,7 +107,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 36.78,
-      "y": 33.07,
+      "y": -52.4,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -95,7 +117,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 36.78,
-      "y": 52.37,
+      "y": -33.1,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -105,7 +127,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 36.78,
-      "y": 71.67,
+      "y": -13.8,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -115,7 +137,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 56.08,
-      "y": 13.77,
+      "y": -71.7,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -125,7 +147,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 56.08,
-      "y": 33.07,
+      "y": -52.4,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -135,7 +157,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 56.08,
-      "y": 52.37,
+      "y": -33.1,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -145,7 +167,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 56.08,
-      "y": 71.67,
+      "y": -13.8,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -155,7 +177,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 75.38,
-      "y": 13.77,
+      "y": -71.7,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -165,7 +187,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 75.38,
-      "y": 33.07,
+      "y": -52.4,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -175,7 +197,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 75.38,
-      "y": 52.37,
+      "y": -33.1,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -185,7 +207,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 75.38,
-      "y": 71.67,
+      "y": -13.8,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -195,7 +217,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 94.68,
-      "y": 13.77,
+      "y": -71.7,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -205,7 +227,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 94.68,
-      "y": 33.07,
+      "y": -52.4,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -215,7 +237,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 94.68,
-      "y": 52.37,
+      "y": -33.1,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -225,7 +247,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 94.68,
-      "y": 71.67,
+      "y": -13.8,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -235,7 +257,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 113.98,
-      "y": 13.77,
+      "y": -71.7,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -245,7 +267,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 113.98,
-      "y": 33.07,
+      "y": -52.4,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -255,7 +277,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 113.98,
-      "y": 52.37,
+      "y": -33.1,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     },
@@ -265,7 +287,7 @@
       "diameter": 16.26,
       "totalLiquidVolume": 3400,
       "x": 113.98,
-      "y": 71.67,
+      "y": -13.8,
       "z": 2.87,
       "geometryDefinitionId": "venirhgerug"
     }
@@ -309,11 +331,6 @@
       }
     }
   ],
-  "cornerOffsetFromSlot": {
-    "x": 0,
-    "y": 0,
-    "z": 0
-  },
   "stackingOffsetWithLabware": {
     "opentrons_aluminum_flat_bottom_plate": {
       "x": 0,

package/labware/fixtures/3/index.ts

@@ -0,0 +1,4 @@
+import fixture_2_plate from './fixture_2_plate.json'
+import fixture_corning_24_plate from './fixture_corning_24_plate.json'
+
+export { fixture_2_plate, fixture_corning_24_plate }

package/labware/schemas/2.json

@@ -438,6 +438,34 @@
           }
         }
       }
+    },
+    "HeightVolumePair": {
+      "type": "object",
+      "required": ["height", "volume"],
+      "properties": {
+        "height": {
+          "description": "The height within a well at a user-defined volume.",
+          "type": "number"
+        },
+        "volume": {
+          "description": "A user-defined volume at a known height within a well.",
+          "type": "number"
+        }
+      }
+    },
+    "UserDefinedVolumes": {
+      "type": "object",
+      "required": ["heightToVolumeMap"],
+      "properties": {
+        "heightToVolumeMap": {
+          "description": "A list mapping heights to volumes [height, volume]. Must be ordered from top (highest z) to bottom (lowest z).",
+          "type": "array",
+          "minItems": 2,
+          "items": {
+            "$ref": "#/definitions/HeightVolumePair"
+          }
+        }
+      }
     }
   },
   "type": "object",
@@ -713,7 +741,14 @@
       "type": ["object", "null"],
       "description": "A dictionary holding all unique inner well geometries in a labware.",
       "additionalProperties": {
-        "$ref": "#/definitions/InnerWellGeometry"
+        "oneOf": [
+          {
+            "$ref": "#/definitions/InnerWellGeometry"
+          },
+          {
+            "$ref": "#/definitions/UserDefinedVolumes"
+          }
+        ]
       }
     }
   }

package/labware/schemas/3.json

@@ -51,7 +51,20 @@
       "type": "string",
       "pattern": "^[a-z0-9._]+$"
     },
-    "vector": {
+    "vector2D": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["x", "y"],
+      "properties": {
+        "x": {
+          "type": "number"
+        },
+        "y": {
+          "type": "number"
+        }
+      }
+    },
+    "vector3D": {
       "type": "object",
       "additionalProperties": false,
       "required": ["x", "y", "z"],
@@ -67,16 +80,46 @@
         }
       }
     },
+    "axisAlignedBoundingBox2D": {
+      "type": "object",
+      "required": ["backLeft", "frontRight"],
+      "additionalProperties": false,
+      "properties": {
+        "backLeft": {
+          "description": "(-x, +y) relative to the labware origin.",
+          "$ref": "#/definitions/vector2D"
+        },
+        "frontRight": {
+          "description": "(+x, -y) relative to the labware origin.",
+          "$ref": "#/definitions/vector2D"
+        }
+      }
+    },
+    "axisAlignedBoundingBox3D": {
+      "type": "object",
+      "required": ["backLeftBottom", "frontRightTop"],
+      "additionalProperties": false,
+      "properties": {
+        "backLeftBottom": {
+          "description": "(-x, +y, -z) relative to the labware origin.",
+          "$ref": "#/definitions/vector3D"
+        },
+        "frontRightTop": {
+          "description": "(+x, -y, +z) relative to the labware origin.",
+          "$ref": "#/definitions/vector3D"
+        }
+      }
+    },
     "pickUpAndDropOffsets": {
       "type": "object",
       "required": ["pickUpOffset", "dropOffset"],
       "properties": {
         "pickUpOffset": {
-          "$ref": "#/definitions/vector",
+          "$ref": "#/definitions/vector3D",
           "description": "Offset added to calculate pick-up coordinates."
         },
         "dropOffset": {
-          "$ref": "#/definitions/vector",
+          "$ref": "#/definitions/vector3D",
           "description": "Offset added to calculate drop coordinates."
         }
       }
@@ -164,15 +207,16 @@
           "$ref": "#/definitions/positiveNumber"
         },
         "x": {
-          "description": "x location of center-bottom of well in reference to left-front-bottom of labware",
+          "description": "x location of center-bottom of well in reference to the labware origin",
           "$ref": "#/definitions/positiveNumber"
         },
         "y": {
-          "description": "y location of center-bottom of well in reference to left-front-bottom of labware",
-          "$ref": "#/definitions/positiveNumber"
+          "description": "y location of center-bottom of well in reference to the labware origin",
+          "type": "number",
+          "maximum": 0
         },
         "z": {
-          "description": "z location of center-bottom of well in reference to left-front-bottom of labware",
+          "description": "z location of center-bottom of well in reference to the labware origin",
           "$ref": "#/definitions/positiveNumber"
         },
         "geometryDefinitionId": {
@@ -450,9 +494,9 @@
     "metadata",
     "brand",
     "parameters",
-    "cornerOffsetFromSlot",
     "ordering",
-    "dimensions",
+    "extents",
+    "features",
     "wells",
     "groups"
   ],
@@ -570,24 +614,70 @@
         }
       }
     },
-    "cornerOffsetFromSlot": {
-      "description": "Distance from left-front-bottom corner of slot to left-front-bottom corner of labware bounding box. Used for labware that spans multiple slots. For labware that does not span multiple slots, x/y/z should all be zero.",
-      "$ref": "#/definitions/vector"
-    },
-    "dimensions": {
+    "extents": {
+      "description": "The outer dimensions of the labware. Includes offsets from `cornerOffsetFromSlot`.",
       "type": "object",
+      "required": ["total"],
       "additionalProperties": false,
-      "description": "Outer dimensions of a labware",
-      "required": ["xDimension", "yDimension", "zDimension"],
       "properties": {
-        "yDimension": {
-          "$ref": "#/definitions/positiveNumber"
-        },
-        "zDimension": {
-          "$ref": "#/definitions/positiveNumber"
+        "total": {
+          "description": "The all-encompassing outer dimensions of the labware.",
+          "$ref": "#/definitions/axisAlignedBoundingBox3D"
+        }
+      }
+    },
+    "features": {
+      "type": "object",
+      "description": "Locating features when this labware is a part of a stackup.",
+      "required": [],
+      "properties": {
+        "slotFootprintAsChild": {
+          "description": "The 3D plane of the labware that makes physical contact with a parent entity. Constrained by the dimensions of a slot.",
+          "type": "object",
+          "required": ["backLeft", "frontRight", "z"],
+          "properties": {
+            "backLeft": {
+              "description": "(-x, +y) relative to the labware origin.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "frontRight": {
+              "description": "(+x, -y) relative to the labware origin.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "z": {
+              "description": "Always zero by convention. Z-coordinate of the footprint plane.",
+              "type": "number"
+            },
+            "springDirectionalForce": {
+              "description": "Applicable when the labware contains a spring that influences its position when placed on a parent deck item.",
+              "type": "string",
+              "enum": ["backLeftBottom"]
+            }
+          }
         },
-        "xDimension": {
-          "$ref": "#/definitions/positiveNumber"
+        "slotFootprintAsParent": {
+          "description": "The 2D plane on which a child deck item resides.",
+          "type": "object",
+          "required": ["backLeft", "frontRight", "z"],
+          "properties": {
+            "backLeft": {
+              "description": "(-x, +y), the back left corner of a labware's mating plane.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "frontRight": {
+              "description": "(+x, -y), the back left corner of a labware's module plane.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "z": {
+              "description": "The z-offset from this labware's origin to the plane on which a child deck item resides.",
+              "type": "number"
+            },
+            "springDirectionalForce": {
+              "description": "Applicable when the labware contains a spring that influences the positioning of a child deck item.",
+              "type": "string",
+              "enum": ["backLeftBottom"]
+            }
+          }
         }
       }
     },
@@ -663,14 +753,14 @@
       "type": "object",
       "description": "Supported labware that can be stacked upon, with overlap height between both labware.",
       "additionalProperties": {
-        "$ref": "#/definitions/vector"
+        "$ref": "#/definitions/vector3D"
       }
     },
     "stackingOffsetWithModule": {
       "type": "object",
       "description": "Supported module that can be stacked upon, with overlap height between labware and module.",
       "additionalProperties": {
-        "$ref": "#/definitions/vector"
+        "$ref": "#/definitions/vector3D"
       }
     },
     "gripperOffsets": {