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

package/lib/labware/fixtures/2/fixture_trash.json

@@ -1,50 +0,0 @@
-{
-    "ordering": [["A1"]],
-    "schemaVersion": 2,
-    "version": 1,
-    "namespace": "fixture",
-    "metadata": {
-        "displayCategory": "trash",
-        "displayVolumeUnits": "L",
-        "displayName": "Tall Fixed Trash",
-        "tags": ["trash", "opentrons", "tall"]
-    },
-    "dimensions": {
-        "xDimension": 172.86,
-        "yDimension": 165.86,
-        "zDimension": 82
-    },
-    "parameters": {
-        "format": "trash",
-        "isTiprack": false,
-        "loadName": "fixture_trash",
-        "isMagneticModuleCompatible": false,
-        "quirks": ["fixedTrash", "centerMultichannelOnWells", "touchTipDisabled"]
-    },
-    "wells": {
-        "A1": {
-            "shape": "rectangular",
-            "yDimension": 165.67,
-            "xDimension": 107.11,
-            "totalLiquidVolume": 1100000,
-            "depth": 77,
-            "x": 82.84,
-            "y": 53.56,
-            "z": 5
-        }
-    },
-    "brand": {
-        "brand": "Opentrons"
-    },
-    "groups": [
-        {
-            "wells": ["A1"],
-            "metadata": {}
-        }
-    ],
-    "cornerOffsetFromSlot": {
-        "x": 0,
-        "y": 0,
-        "z": 0
-    }
-}

package/lib/labware/schemas/2.json

@@ -1,372 +0,0 @@
-{
-    "$id": "opentronsLabwareSchemaV2",
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "positiveNumber": {
-            "type": "number",
-            "minimum": 0
-        },
-        "brandData": {
-            "type": "object",
-            "additionalProperties": false,
-            "required": ["brand"],
-            "properties": {
-                "brand": {
-                    "type": "string",
-                    "description": "Brand/manufacturer name"
-                },
-                "brandId": {
-                    "type": "array",
-                    "description": "An array of manufacture numbers pertaining to a given labware",
-                    "items": {
-                        "type": "string"
-                    }
-                },
-                "links": {
-                    "type": "array",
-                    "description": "URLs for manufacturer page(s)",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
-        },
-        "displayCategory": {
-            "type": "string",
-            "enum": [
-                "tipRack",
-                "tubeRack",
-                "reservoir",
-                "trash",
-                "wellPlate",
-                "aluminumBlock",
-                "adapter",
-                "other"
-            ]
-        },
-        "safeString": {
-            "description": "a string safe to use for loadName / namespace. Lowercase-only.",
-            "type": "string",
-            "pattern": "^[a-z0-9._]+$"
-        },
-        "coordinates": {
-            "type": "object",
-            "additionalProperties": false,
-            "required": ["x", "y", "z"],
-            "properties": {
-                "x": {
-                    "type": "number"
-                },
-                "y": {
-                    "type": "number"
-                },
-                "z": {
-                    "type": "number"
-                }
-            }
-        }
-    },
-    "type": "object",
-    "additionalProperties": false,
-    "required": [
-        "schemaVersion",
-        "version",
-        "namespace",
-        "metadata",
-        "brand",
-        "parameters",
-        "cornerOffsetFromSlot",
-        "ordering",
-        "dimensions",
-        "wells",
-        "groups"
-    ],
-    "properties": {
-        "schemaVersion": {
-            "description": "Which schema version a labware is using",
-            "type": "number",
-            "enum": [2]
-        },
-        "version": {
-            "description": "Version of the labware definition itself (eg myPlate v1/v2/v3). An incrementing integer",
-            "type": "integer",
-            "minimum": 1
-        },
-        "namespace": {
-            "$ref": "#/definitions/safeString"
-        },
-        "metadata": {
-            "type": "object",
-            "description": "Properties used for search and display",
-            "additionalProperties": false,
-            "required": ["displayName", "displayCategory", "displayVolumeUnits"],
-            "properties": {
-                "displayName": {
-                    "description": "Easy to remember name of labware",
-                    "type": "string"
-                },
-                "displayCategory": {
-                    "$ref": "#/definitions/displayCategory",
-                    "description": "Label(s) used in UI to categorize labware"
-                },
-                "displayVolumeUnits": {
-                    "description": "Volume units for display",
-                    "type": "string",
-                    "enum": ["µL", "mL", "L"]
-                },
-                "tags": {
-                    "type": "array",
-                    "description": "List of descriptions for a given labware",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
-        },
-        "brand": {
-            "$ref": "#/definitions/brandData",
-            "description": "Real-world labware that the definition is modeled from and/or compatible with"
-        },
-        "parameters": {
-            "type": "object",
-            "description": "Internal describers used to determine pipette movement to labware",
-            "additionalProperties": false,
-            "required": [
-                "format",
-                "isTiprack",
-                "loadName",
-                "isMagneticModuleCompatible"
-            ],
-            "properties": {
-                "format": {
-                    "description": "Property to determine compatibility with multichannel pipette",
-                    "type": "string",
-                    "enum": ["96Standard", "384Standard", "trough", "irregular", "trash"]
-                },
-                "quirks": {
-                    "description": "Property to classify a specific behavior this labware should have",
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                },
-                "isTiprack": {
-                    "description": "Flag marking whether this labware is a tip rack or not",
-                    "type": "boolean"
-                },
-                "tipLength": {
-                    "description": "Required if this labware is a tip rack. Specifies the total length of one of this rack's tips, from top to bottom, as specified by technical drawings or as measured with calipers.",
-                    "$ref": "#/definitions/positiveNumber"
-                },
-                "tipOverlap": {
-                    "description": "Required if this labware is a tip rack. Specifies how far one of this rack's tips is expected to overlap with the nozzle of a pipette. In other words: tipLength, minus the distance between the bottom of the pipette and the bottom of the tip. A robot's positional calibration may fine-tune this estimate.",
-                    "$ref": "#/definitions/positiveNumber"
-                },
-                "loadName": {
-                    "description": "Name used to reference a labware definition",
-                    "$ref": "#/definitions/safeString"
-                },
-                "isMagneticModuleCompatible": {
-                    "description": "Flag marking whether a labware is compatible by default with the Magnetic Module",
-                    "type": "boolean"
-                },
-                "magneticModuleEngageHeight": {
-                    "description": "Distance to move magnetic module magnets to engage",
-                    "$ref": "#/definitions/positiveNumber"
-                }
-            }
-        },
-        "ordering": {
-            "type": "array",
-            "description": "Generated array that keeps track of how wells should be ordered in a labware",
-            "items": {
-                "type": "array",
-                "items": {
-                    "type": "string"
-                }
-            }
-        },
-        "cornerOffsetFromSlot": {
-            "type": "object",
-            "additionalProperties": false,
-            "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.",
-            "required": ["x", "y", "z"],
-            "properties": {
-                "x": { "type": "number" },
-                "y": { "type": "number" },
-                "z": { "type": "number" }
-            }
-        },
-        "dimensions": {
-            "type": "object",
-            "additionalProperties": false,
-            "description": "Outer dimensions of a labware",
-            "required": ["xDimension", "yDimension", "zDimension"],
-            "properties": {
-                "yDimension": {
-                    "$ref": "#/definitions/positiveNumber"
-                },
-                "zDimension": {
-                    "$ref": "#/definitions/positiveNumber"
-                },
-                "xDimension": {
-                    "$ref": "#/definitions/positiveNumber"
-                }
-            }
-        },
-        "wells": {
-            "type": "object",
-            "description": "Unordered object of well objects with position and dimensional information",
-            "additionalProperties": false,
-            "patternProperties": {
-                "[A-Z]+[0-9]+": {
-                    "type": "object",
-                    "additionalProperties": false,
-                    "required": ["depth", "shape", "totalLiquidVolume", "x", "y", "z"],
-                    "oneOf": [
-                        { "required": ["xDimension", "yDimension"] },
-                        { "required": ["diameter"] }
-                    ],
-                    "not": {
-                        "anyOf": [
-                            { "required": ["diameter", "xDimension"] },
-                            { "required": ["diameter", "yDimension"] }
-                        ]
-                    },
-                    "properties": {
-                        "depth": {
-                            "description": "The distance between the top and bottom of this well. If the labware is a tip rack, this will be ignored in favor of tipLength, but the values should match.",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "x": {
-                            "description": "x location of center-bottom of well in reference to left-front-bottom of labware",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "y": {
-                            "description": "y location of center-bottom of well in reference to left-front-bottom of labware",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "z": {
-                            "description": "z location of center-bottom of well in reference to left-front-bottom of labware",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "totalLiquidVolume": {
-                            "description": "Total well, tube, or tip volume in microliters",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "xDimension": {
-                            "description": "x dimension of rectangular wells",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "yDimension": {
-                            "description": "y dimension of rectangular wells",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "diameter": {
-                            "description": "diameter of circular wells",
-                            "$ref": "#/definitions/positiveNumber"
-                        },
-                        "shape": {
-                            "description": "If 'rectangular', use xDimension and yDimension; if 'circular' use diameter",
-                            "type": "string",
-                            "enum": ["rectangular", "circular"]
-                        }
-                    }
-                }
-            }
-        },
-        "groups": {
-            "type": "array",
-            "description": "Logical well groupings for metadata/display purposes; changes in groups do not affect protocol execution",
-            "items": {
-                "type": "object",
-                "required": ["wells", "metadata"],
-                "additionalProperties": false,
-                "properties": {
-                    "wells": {
-                        "type": "array",
-                        "description": "An array of wells that contain the same metadata",
-                        "items": {
-                            "type": "string"
-                        }
-                    },
-                    "metadata": {
-                        "type": "object",
-                        "description": "Metadata specific to a grid of wells in a labware",
-                        "required": [],
-                        "additionalProperties": false,
-                        "properties": {
-                            "displayName": {
-                                "type": "string",
-                                "description": "User-readable name for the well group"
-                            },
-                            "displayCategory": {
-                                "$ref": "#/definitions/displayCategory",
-                                "description": "Label(s) used in UI to categorize well groups"
-                            },
-                            "wellBottomShape": {
-                                "type": "string",
-                                "description": "Bottom shape of the well for UI purposes",
-                                "enum": ["flat", "u", "v"]
-                            }
-                        }
-                    },
-                    "brand": {
-                        "$ref": "#/definitions/brandData",
-                        "description": "Brand data for the well group (e.g. for tubes)"
-                    }
-                }
-            }
-        },
-        "allowedRoles": {
-            "type": "array",
-            "description": "Allowed behaviors and usage of a labware in a protocol.",
-            "items": {
-                "type": "string",
-                "enum": ["labware", "adapter", "fixture", "maintenance"]
-            }
-        },
-        "stackingOffsetWithLabware": {
-            "type": "object",
-            "description": "Supported labware that can be stacked upon, with overlap height between both labware.",
-            "additionalProperties": {
-                "$ref": "#/definitions/coordinates"
-            }
-        },
-        "stackingOffsetWithModule": {
-            "type": "object",
-            "description": "Supported module that can be stacked upon, with overlap height between labware and module.",
-            "additionalProperties": {
-                "$ref": "#/definitions/coordinates"
-            }
-        },
-        "gripperOffsets": {
-            "type": "object",
-            "description": "Offsets to be added when calculating the coordinates a gripper should go to when picking up or dropping a labware on this labware.",
-            "properties": {
-                "default": {
-                    "type": "object",
-                    "properties": {
-                        "pickUpOffset": {
-                            "$ref": "#/definitions/coordinates",
-                            "description": "Offset added to calculate pick-up coordinates of a labware placed on this labware."
-                        },
-                        "dropOffset": {
-                            "$ref": "#/definitions/coordinates",
-                            "description": "Offset added to calculate drop coordinates of a labware placed on this labware."
-                        }
-                    },
-                    "required": ["pickUpOffset", "dropOffset"]
-                }
-            }
-        },
-        "gripForce": {
-            "type": "number",
-            "description": "Force, in Newtons, with which the gripper should grip the labware."
-        },
-        "gripHeightFromLabwareBottom": {
-            "type": "number",
-            "description": "Recommended Z-height, from labware bottom to the center of gripper pads, when gripping the labware."
-        }
-    }
-}

package/lib/liquid/schemas/1.json

@@ -1,21 +0,0 @@
-{
-    "$id": "opentronsLiquidSchemaV1",
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "description": "Fields describing a single liquid",
-    "type": "object",
-    "required": ["displayName", "description"],
-    "properties": {
-        "displayName": {
-            "description": "An human-readable name for this liquid.",
-            "type": "string"
-        },
-        "description": {
-            "description": "A description of this liquid.",
-            "type": "string"
-        },
-        "displayColor": {
-            "description": "Hex color code, with hash included, to represent the specified liquid. Standard three-value, four-value, six-value, and eight-value syntax are all acceptable.",
-            "type": "string"
-        }
-    }
-}

package/lib/liquid/types/index.d.ts

@@ -1,5 +0,0 @@
-export interface Liquid {
-    displayName: string;
-    description: string;
-    displayColor: string;
-}

package/lib/module/definitions/1.json

@@ -1,57 +0,0 @@
-{
-    "magdeck": {
-        "labwareOffset": {
-            "x": 0.125,
-            "y": -0.125,
-            "z": 82.25
-        },
-        "dimensions": {
-            "bareOverallHeight": 110.152,
-            "overLabwareHeight": 4.052
-        },
-        "calibrationPoint": {
-            "x": 124.875,
-            "y": 2.75
-        },
-        "displayName": "Magnetic Module",
-        "loadName": "magdeck",
-        "quirks": []
-    },
-    "tempdeck": {
-        "labwareOffset": {
-            "x": -0.15,
-            "y": -0.15,
-            "z": 80.09
-        },
-        "dimensions": {
-            "bareOverallHeight": 84,
-            "overLabwareHeight": 0
-        },
-        "calibrationPoint": {
-            "x": 12.0,
-            "y": 8.75
-        },
-        "displayName": "Temperature Module",
-        "loadName": "tempdeck",
-        "quirks": []
-    },
-    "thermocycler": {
-        "labwareOffset": {
-            "x": 0,
-            "y": 82.56,
-            "z": 97.8
-        },
-        "dimensions": {
-            "bareOverallHeight": 98.0,
-            "overLabwareHeight": 0.0,
-            "lidHeight": 37.7
-        },
-        "calibrationPoint": {
-            "x": 14.4,
-            "y": 64.93
-        },
-        "displayName": "Thermocycler Module",
-        "loadName": "thermocycler",
-        "quirks": []
-    }
-}

package/lib/module/definitions/2/magneticModuleV1.json

@@ -1,22 +0,0 @@
-{
-    "$otSharedSchema": "module/schemas/2",
-    "moduleType": "magneticModuleType",
-    "model": "magneticModuleV1",
-    "labwareOffset": {
-        "x": 0.125,
-        "y": -0.125,
-        "z": 82.25
-    },
-    "dimensions": {
-        "bareOverallHeight": 110.152,
-        "overLabwareHeight": 4.052
-    },
-    "calibrationPoint": {
-        "x": 124.875,
-        "y": 2.75
-    },
-    "displayName": "Magnetic Module GEN1",
-    "quirks": [],
-    "slotTransforms": {},
-    "compatibleWith": []
-}

package/lib/module/definitions/2/magneticModuleV2.json

@@ -1,69 +0,0 @@
-{
-    "$otSharedSchema": "module/schemas/2",
-    "moduleType": "magneticModuleType",
-    "model": "magneticModuleV2",
-    "labwareOffset": {
-        "x": -1.175,
-        "y": -0.125,
-        "z": 82.25
-    },
-    "dimensions": {
-        "bareOverallHeight": 110.152,
-        "overLabwareHeight": 4.052
-    },
-    "calibrationPoint": {
-        "x": 124.875,
-        "y": 2.75
-    },
-    "displayName": "Magnetic Module GEN2",
-    "quirks": [],
-    "slotTransforms": {
-        "ot2_standard": {
-            "3": {
-                "labwareOffset": [
-                    [-1, 0, 0.25],
-                    [0, 1, 0],
-                    [0, 0, 1]
-                ]
-            },
-            "6": {
-                "labwareOffset": [
-                    [-1, 0, 0.25],
-                    [0, 1, 0],
-                    [0, 0, 1]
-                ]
-            },
-            "9": {
-                "labwareOffset": [
-                    [-1, 0, 0.25],
-                    [0, 1, 0],
-                    [0, 0, 1]
-                ]
-            }
-        },
-        "ot2_short_trash": {
-            "3": {
-                "labwareOffset": [
-                    [-1, 0, 0.3],
-                    [0, 1, 0],
-                    [0, 0, 1]
-                ]
-            },
-            "6": {
-                "labwareOffset": [
-                    [-1, 0, 0.3],
-                    [0, 1, 0],
-                    [0, 0, 1]
-                ]
-            },
-            "9": {
-                "labwareOffset": [
-                    [-1, 0, 0.3],
-                    [0, 1, 0],
-                    [0, 0, 1]
-                ]
-            }
-        }
-    },
-    "compatibleWith": []
-}

package/lib/module/definitions/2/temperatureModuleV1.json

@@ -1,22 +0,0 @@
-{
-    "$otSharedSchema": "module/schemas/2",
-    "moduleType": "temperatureModuleType",
-    "model": "temperatureModuleV1",
-    "labwareOffset": {
-        "x": -0.15,
-        "y": -0.15,
-        "z": 80.09
-    },
-    "dimensions": {
-        "bareOverallHeight": 84,
-        "overLabwareHeight": 0
-    },
-    "calibrationPoint": {
-        "x": 12.0,
-        "y": 8.75
-    },
-    "displayName": "Temperature Module GEN1",
-    "quirks": [],
-    "slotTransforms": {},
-    "compatibleWith": ["temperatureModuleV2"]
-}