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

package/lib/labware/fixtures/3/fixture_2_plate.json

@@ -20,8 +20,11 @@
                 "y": -85.8,
                 "z": 44.45
             }
-        },
-        "footprint": {
+        }
+    },
+    "features": {
+        "slotFootprintAsChild": {
+            "z": 0,
             "backLeft": {
                 "x": 0,
                 "y": 0

package/lib/labware/fixtures/3/fixture_corning_24_plate.json

@@ -16,7 +16,7 @@
     },
     "schemaVersion": 3,
     "version": 3,
-    "namespace": "opentrons",
+    "namespace": "fixture",
     "metadata": {
         "displayName": "Corning 24 Well Plate 3.4 mL Flat",
         "displayVolumeUnits": "mL",
@@ -35,8 +35,11 @@
                 "y": -85.47,
                 "z": 20.27
             }
-        },
-        "footprint": {
+        }
+    },
+    "features": {
+        "slotFootprintAsChild": {
+            "z": 0,
             "backLeft": {
                 "x": 0,
                 "y": 0

package/lib/labware/fixtures/3/index.d.ts

@@ -0,0 +1,3 @@
+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/lib/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/lib/labware/schemas/3.json

@@ -496,6 +496,7 @@
         "parameters",
         "ordering",
         "extents",
+        "features",
         "wells",
         "groups"
     ],
@@ -614,18 +615,69 @@
             }
         },
         "extents": {
-            "description": "The outer dimensions of the labware.",
+            "description": "The outer dimensions of the labware. Includes offsets from `cornerOffsetFromSlot`.",
             "type": "object",
-            "required": ["total", "footprint"],
+            "required": ["total"],
             "additionalProperties": false,
             "properties": {
                 "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"]
+                        }
+                    }
                 },
-                "footprint": {
-                    "description": "The outer dimensions of the labware where it meets the deck.",
-                    "$ref": "#/definitions/axisAlignedBoundingBox2D"
+                "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"]
+                        }
+                    }
                 }
             }
         },