@opentrons/shared-data 0.1.6-alpha.18 → 0.1.6-alpha.21

package/lib/pipette/schemas/1/pipetteModelSpecsSchema.json

@@ -1,153 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "positiveNumber": {
-            "type": "number",
-            "minimum": 0
-        },
-        "returnTipHeightRange": {
-            "type": "number",
-            "minimum": 0.25,
-            "maximum": 1.25
-        },
-        "idleCurrentRange": {
-            "type": "number",
-            "minimum": 0.01,
-            "maximum": 1.0
-        },
-        "xyzArray": {
-            "type": "array",
-            "description": "Array of 3 numbers, [x, y, z]",
-            "items": { "type": "number" },
-            "minItems": 3,
-            "maxItems": 3
-        },
-        "linearEquations": {
-            "description": "Array containing any number of 3-arrays. Each inner 3-array describes a line segment: [boundary, slope, intercept]. So [1, 2, 3] would mean 'where (next_boundary > x >= 1), y = 2x + 3'",
-            "type": "array",
-            "items": {
-                "type": "array",
-                "items": { "type": "number" },
-                "minItems": 3,
-                "maxItems": 3
-            }
-        },
-        "liquidHandlingSpecs": {
-            "description": "Object containing linear equations for translating between uL of liquid and mm of plunger travel. There is one linear equation for aspiration and one for dispense",
-            "type": "object",
-            "required": ["aspirate", "dispense"],
-            "additionalProperties": false,
-            "properties": {
-                "aspirate": { "$ref": "#/definitions/linearEquations" },
-                "dispense": { "$ref": "#/definitions/linearEquations" }
-            }
-        },
-        "editConfigurations": {
-            "type": "object",
-            "description": "Object allowing you to modify a config",
-            "required": ["value"],
-            "properties": {
-                "value": { "type": ["number", "array"] },
-                "min": { "type": "number" },
-                "max": { "type": "number" },
-                "units": { "type": "string" },
-                "type": { "type": "string" },
-                "displayName": { "type": "string" }
-            }
-        }
-    },
-    "type": "object",
-    "additionalProperties": false,
-    "required": ["config", "mutableConfigs"],
-    "properties": {
-        "config": {
-            "description": "Version-level pipette specifications, which may vary across different versions of the same pipette",
-            "type": "object",
-            "$comment": "Example key: 'p10_single_v1.3'",
-            "patternProperties": {
-                ".*": {
-                    "required": [
-                        "name",
-                        "top",
-                        "bottom",
-                        "blowout",
-                        "dropTip",
-                        "pickUpCurrent",
-                        "pickUpDistance",
-                        "pickUpIncrement",
-                        "pickUpPresses",
-                        "pickUpSpeed",
-                        "modelOffset",
-                        "plungerCurrent",
-                        "dropTipCurrent",
-                        "dropTipSpeed",
-                        "ulPerMm",
-                        "tipLength",
-                        "nozzleOffset"
-                    ],
-                    "additionalProperties": false,
-                    "properties": {
-                        "name": {
-                            "description": "reference to name of this version, should match a key in corresponding pipetteNameSpecs.json file",
-                            "type": "string"
-                        },
-                        "backCompatNames": {
-                            "description": "Optional reference for name of backwards compatible pipette corresponding to a key in pipetteNameSpecs.json, only relevant to gen2 pipettes",
-                            "type": "array"
-                        },
-                        "top": { "$ref": "#/definitions/editConfigurations" },
-                        "bottom": { "$ref": "#/definitions/editConfigurations" },
-                        "blowout": { "$ref": "#/definitions/editConfigurations" },
-                        "dropTip": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpCurrent": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpDistance": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpPresses": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpIncrement": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpSpeed": { "$ref": "#/definitions/editConfigurations" },
-                        "modelOffset": { "$ref": "#/definitions/xyzArray" },
-                        "nozzleOffset": { "$ref": "#/definitions/xyzArray" },
-                        "plungerCurrent": { "$ref": "#/definitions/editConfigurations" },
-                        "dropTipCurrent": { "$ref": "#/definitions/editConfigurations" },
-                        "dropTipSpeed": { "$ref": "#/definitions/editConfigurations" },
-                        "ulPerMm": {
-                            "type": "array",
-                            "items": { "$ref": "#/definitions/liquidHandlingSpecs" }
-                        },
-                        "quirks": {
-                            "type": "array",
-                            "items": {
-                                "type": "string"
-                            }
-                        },
-                        "tipLength": {
-                            "type": "object",
-                            "value": { "$ref": "#/definitions/positiveNumber" }
-                        },
-                        "idleCurrent": { "$ref": "#/definitions/idleCurrentRange" },
-                        "returnTipHeight": { "$ref": "#/definitions/returnTipHeightRange" },
-                        "tipOverlap": {
-                            "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" }
-                        }
-                    }
-                }
-            }
-        },
-        "mutableConfigs": {
-            "type": "array",
-            "description": "Array of mutable configs for a given pipette",
-            "items": { "type": "string" }
-        },
-        "validQuirks": {
-            "type": "array",
-            "description": "Array of valid quirks for a given pipette",
-            "items": { "type": "string" }
-        }
-    }
-}

package/lib/pipette/schemas/1/pipetteNameSpecsSchema.json

@@ -1,89 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "positiveNumber": {
-            "type": "number",
-            "minimum": 0
-        },
-        "channels": {
-            "enum": [1, 8, 96]
-        },
-        "displayCategory": {
-            "type": "string",
-            "enum": ["GEN1", "GEN2", "FLEX"]
-        },
-        "valuesByApiLevel": {
-            "type": "object",
-            "required": ["2.0"],
-            "additionalProperties": false,
-            "patternProperties": {
-                "^\\d\\.\\d+$": {
-                    "$ref": "#/definitions/positiveNumber"
-                }
-            }
-        },
-        "configValue": {
-            "type": "object",
-            "required": ["value", "min", "max", "valuesByApiLevel"],
-            "properties": {
-                "value": {
-                    "$ref": "#/definitions/positiveNumber",
-                    "$comment": "This key is deprecated in favor of valuesByApiLevel"
-                },
-                "min": { "$ref": "#/definitions/positiveNumber" },
-                "max": { "$ref": "#/definitions/positiveNumber" },
-                "valuesByApiLevel": { "$ref": "#/definitions/valuesByApiLevel" }
-            }
-        }
-    },
-    "description": "Model-level pipette specifications. These do not vary across different versions of the same model",
-    "type": "object",
-    "$comment": "Example key: 'p10_single'",
-    "patternProperties": {
-        ".*": {
-            "type": "object",
-            "required": [
-                "channels",
-                "displayName",
-                "defaultAspirateFlowRate",
-                "defaultDispenseFlowRate",
-                "defaultBlowOutFlowRate",
-                "maxVolume",
-                "minVolume",
-                "defaultTipracks"
-            ],
-            "additionalProperties": false,
-            "properties": {
-                "channels": { "$ref": "#/definitions/channels" },
-                "defaultAspirateFlowRate": {
-                    "$ref": "#/definitions/configValue"
-                },
-                "defaultDispenseFlowRate": {
-                    "$ref": "#/definitions/configValue"
-                },
-                "defaultBlowOutFlowRate": {
-                    "$ref": "#/definitions/configValue"
-                },
-                "displayName": { "type": "string" },
-                "displayCategory": { "$ref": "#/definitions/displayCategory" },
-                "maxVolume": { "$ref": "#/definitions/positiveNumber" },
-                "minVolume": { "$ref": "#/definitions/positiveNumber" },
-                "smoothieConfigs": {
-                    "type": "object",
-                    "description": "Runtime smoothie configs per pipette type",
-                    "properties": {
-                        "stepsPerMM": { "type": "number" },
-                        "homePosition": { "type": "number" },
-                        "travelDistance": { "type": "number" }
-                    }
-                },
-                "defaultTipracks": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
-        }
-    }
-}

package/lib/pipette/schemas/2/pipetteGeometrySchema.json

@@ -1,117 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "xyzArray": {
-            "type": "array",
-            "description": "Array of 3 numbers, [x, y, z]",
-            "items": { "type": "number" },
-            "minItems": 3,
-            "maxItems": 3
-        },
-        "nozzleName": {
-            "type": "string",
-            "pattern": "[A-Z]+[0-9]+"
-        },
-        "rowName": {
-            "type": "string",
-            "pattern": "[A-Z]+",
-            "description": "The name of a row of nozzles"
-        },
-        "columnName": {
-            "type": "string",
-            "pattern": "[0-9]+",
-            "description": "The name of a column of nozzles"
-        }
-    },
-    "type": "object",
-    "required": ["$otSharedSchema", "nozzleOffset", "pathTo3D"],
-    "additionalProperties": false,
-    "properties": {
-        "$otSharedSchema": {
-            "type": "string",
-            "description": "The path to a valid Opentrons shared schema relative to the shared-data directory, without its extension. For instance, #/pipette/schemas/2/pipetteGeometrySchema.json is a reference to this schema."
-        },
-        "nozzleOffset": { "$ref": "#/definitions/xyzArray" },
-        "pipetteBoundingBoxOffsets": {
-            "description": "Offsets from the pipette mount position to the back-left & front-right corners of the pipette's bounding box which includes the outer casing and all nozzles.",
-            "type": "object",
-            "properties": {
-                "backLeftCorner": { "$ref": "#/definitions/xyzArray" },
-                "frontRightCorner": { "$ref": "#/definitions/xyzArray" }
-            }
-        },
-        "pathTo3D": {
-            "description": "path to the gltf file representing the 3D pipette model",
-            "type": "string",
-            "pattern": "^pipette/definitions/[2]/geometry/([a-z]*_[a-z]*)+/p[0-9]{2,4}/[a-z]*[.]gltf"
-        },
-        "orderedRows": {
-            "type": "array",
-            "items": {
-                "type": "object",
-                "description": "A row of nozzle keys",
-                "required": ["key", "orderedNozzles"],
-                "properties": {
-                    "key": { "$ref": "#/definitions/rowName" },
-                    "orderedNozzles": {
-                        "type": "array",
-                        "description": "The list of nozzle names in this row",
-                        "items": { "$ref": "#/definitions/nozzleName" }
-                    }
-                }
-            }
-        },
-        "orderedColumns": {
-            "type": "array",
-            "items": {
-                "type": "object",
-                "description": "A column of nozzle keys",
-                "required": ["key", "orderedNozzles"],
-                "properties": {
-                    "key": { "$ref": "#/definitions/columnName" },
-                    "orderedNozzles": {
-                        "type": "array",
-                        "description": "The list of nozzle names in this column",
-                        "items": { "$ref": "#/definitions/nozzleName" }
-                    }
-                }
-            }
-        },
-        "nozzleMap": {
-            "type": "object",
-            "description": "Unordered object of well objects with position and dimensional information",
-            "additionalProperties": false,
-            "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/lib/pipette/schemas/2/pipetteLiquidPropertiesSchema.json

@@ -1,117 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "positiveNumber": {
-            "type": "number",
-            "minimum": 0
-        },
-        "xyzArray": {
-            "type": "array",
-            "description": "Array of 3 numbers, [x, y, z]",
-            "items": { "type": "number" },
-            "minItems": 3,
-            "maxItems": 3
-        },
-        "liquidHandlingSpecs": {
-            "description": "Object containing linear equations for translating between uL of liquid and mm of plunger travel. There is one linear equation for aspiration and one for dispense",
-            "type": "object",
-            "required": ["aspirate", "dispense"],
-            "additionalProperties": false,
-            "properties": {
-                "aspirate": { "$ref": "#/definitions/xyzArray" },
-                "dispense": { "$ref": "#/definitions/xyzArray" }
-            }
-        },
-        "flowRate": {
-            "description": "Object with a default value and optional dict keyed by api level. If API level is unavailable, default is used.",
-            "type": "object",
-            "required": ["default", "valuesByApiLevel"],
-            "properties": {
-                "default": {
-                    "$ref": "#/definitions/positiveNumber",
-                    "$comment": "The default value of the flowrate"
-                },
-                "valuesByApiLevel": { "type": "object", "required": [] }
-            }
-        }
-    },
-    "type": "object",
-    "required": [
-        "$otSharedSchema",
-        "maxVolume",
-        "minVolume",
-        "defaultTipracks",
-        "supportedTips"
-    ],
-    "additionalProperties": false,
-    "properties": {
-        "$otSharedSchema": {
-            "type": "string",
-            "description": "The path to a valid Opentrons shared schema relative to the shared-data directory, without its extension. For instance, #/pipette/schemas/2/pipetteLiquidPropertiesSchema.json is a reference to this schema."
-        },
-        "supportedTips": {
-            "type": "object",
-            "description": "A container of supported tip types",
-            "properties": {
-                "patternProperties": {
-                    "description": "Tip specific liquid handling properties for a given pipette. Using the active tip on a pipette, we will look up the pipetting configurations associated with that tip+pipette combo.",
-                    "type": "object",
-                    "$comment": "Example key: 't50'",
-                    "^t[0-9]{2,4}": {
-                        "required": [
-                            "defaultAspirateFlowRate",
-                            "defaultDispenseFlowRate",
-                            "defaultBlowOutFlowRate",
-                            "aspirate",
-                            "dispense"
-                        ],
-                        "properties": {
-                            "defaultAspirateFlowRate": {
-                                "$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",
-                                "$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",
-                                "$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"
-                            },
-                            "defaultTipLength": {
-                                "$ref": "#/definitions/positiveNumber"
-                            },
-                            "defaultReturnTipHeight": {
-                                "$ref": "#/definitions/positiveNumber"
-                            },
-                            "aspirate": {
-                                "type": "array",
-                                "items": { "$ref": "#/definitions/liquidHandlingSpecs" }
-                            },
-                            "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."
-                            }
-                        }
-                    }
-                }
-            }
-        },
-        "maxVolume": { "$ref": "#/definitions/positiveNumber" },
-        "minVolume": { "$ref": "#/definitions/positiveNumber" },
-        "defaultTipracks": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            }
-        }
-    }
-}