@opentrons/shared-data 0.1.1 → 0.1.2-alpha.0

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

@@ -0,0 +1,89 @@
+{
+    "$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

@@ -0,0 +1,81 @@
+{
+    "$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" },
+        "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" }
+            }
+        }
+    }
+}

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

@@ -0,0 +1,120 @@
+{
+    "$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",
+        "defaultTipOverlapDictionary"
+    ],
+    "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"
+                            },
+                            "defaultDispenseFlowRate": {
+                                "$ref": "#/definitions/flowRate"
+                            },
+                            "defaultBlowOutFlowRate": {
+                                "$ref": "#/definitions/flowRate"
+                            },
+                            "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" }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "defaultTipOverlapDictionary": {
+            "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" }
+        },
+        "maxVolume": { "$ref": "#/definitions/positiveNumber" },
+        "minVolume": { "$ref": "#/definitions/positiveNumber" },
+        "defaultTipracks": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        }
+    }
+}

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

@@ -0,0 +1,287 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "opentronsPipettePropertiesSchemaV2",
+    "definitions": {
+        "channels": {
+            "enum": [1, 8, 96, 384]
+        },
+        "displayCategory": {
+            "type": "string",
+            "enum": ["GEN1", "GEN2", "FLEX"]
+        },
+        "positiveNumber": {
+            "type": "number",
+            "minimum": 0
+        },
+        "currentRange": {
+            "type": "number",
+            "minimum": 0.01,
+            "maximum": 2.5
+        },
+        "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" }
+            }
+        },
+        "partialTipCount": {
+            "type": "number",
+            "enum": [1, 2, 3, 4, 5, 6, 7, 8, 12, 96, 384]
+        },
+        "currentByTipCount": {
+            "type": "object",
+            "patternProperties": {
+                "\\d+": { "$ref": "#/definitions/currentRange" }
+            }
+        }
+    },
+    "description": "Version-level pipette specifications, which may vary across different versions of the same pipette",
+    "type": "object",
+    "required": [
+        "$otSharedSchema",
+        "pickUpTipConfigurations",
+        "dropTipConfigurations",
+        "partialTipConfigurations",
+        "plungerPositionsConfigurations",
+        "plungerMotorConfigurations",
+        "displayCategory",
+        "channels",
+        "model",
+        "displayName",
+        "backCompatNames"
+    ],
+    "properties": {
+        "additionalProperties": false,
+        "$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/pipettePropertiesSchema.json is a reference to this schema."
+        },
+        "backCompatNames": {
+            "type": "array",
+            "description": "Array of pipette names that are compatible with the given pipette",
+            "items": { "type": "string" }
+        },
+        "quirks": {
+            "type": "array",
+            "description": "Array of pipette quirks supported on the current pipette",
+            "items": { "type": "string" }
+        },
+        "channels": { "$ref": "#/definitions/channels" },
+        "partialTipConfigurations": {
+            "description": "Object containing information on partial tip configurations",
+            "oneof": [
+                {
+                    "type": "object",
+                    "required": ["partialTipSupported"],
+                    "properties": {
+                        "partialTipSupported": { "const": false },
+                        "availableConfigurations": null
+                    }
+                },
+                {
+                    "type": "object",
+                    "required": ["partialTipSupported", "availableConfigurations"],
+                    "properties": {
+                        "partialTipSupported": { "const": true },
+                        "availableConfigurations": {
+                            "type": "array",
+                            "description": "Array of available configurations",
+                            "items": { "$ref": "#/definitions/partialTipCount" }
+                        }
+                    }
+                }
+            ]
+        },
+        "availableSensors": {
+            "type": "object",
+            "description": "object with keyed by sensor and number available",
+            "required": ["sensors"],
+            "properties": {
+                "sensors": {
+                    "type": "array",
+                    "description": "Array of available sensor types",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "patternProperties": {
+                    "description": "The count of each sensor type available on a given pipette model.",
+                    "type": "object",
+                    ".*": {
+                        "required": ["count"],
+                        "count": { "type": "integer" }
+                    }
+                }
+            }
+        },
+        "plungerPositionsConfigurations": {
+            "type": "object",
+            "description": "Key positions of the plunger, by liquid configuration",
+            "required": ["default"],
+            "patternProperties": {
+                "\\w+": {
+                    "type": "object",
+                    "description": "Plunger positions for this liquid configuration",
+                    "required": ["top", "bottom", "blowout", "drop"],
+                    "properties": {
+                        "top": { "type": "number" },
+                        "bottom": { "type": "number" },
+                        "blowout": { "type": "number" },
+                        "drop": { "type": "number" }
+                    }
+                }
+            }
+        },
+        "plungerMotorConfigurations": {
+            "type": "object",
+            "description": "Object containing configurations specific to the plunger motor",
+            "required": ["idle", "run"],
+            "properties": {
+                "idle": { "$ref": "#/definitions/currentRange" },
+                "run": { "$ref": "#/definitions/currentRange" }
+            }
+        },
+        "gearMotorConfigurations": {
+            "type": "object",
+            "description": "Object containing configurations specific to the clamp motors, if applicable",
+            "required": ["idle", "run"],
+            "properties": {
+                "idle": { "$ref": "#/definitions/currentRange" },
+                "run": { "$ref": "#/definitions/currentRange" }
+            }
+        },
+        "pickUpTipConfigurations": {
+            "description": "Object containing configurations for picking up tips common to all partial configurations",
+            "anyOf": [
+                {
+                    "type": "object",
+                    "required": ["pressFit"],
+                    "properties": {
+                        "pressFit": {
+                            "type": "object",
+                            "required": [
+                                "presses",
+                                "speed",
+                                "increment",
+                                "distance",
+                                "currentByTipCount"
+                            ],
+                            "additionalProperties": false,
+                            "properties": {
+                                "presses": { "$ref": "#/definitions/positiveNumber" },
+                                "speed": { "$ref": "#/definitions/positiveNumber" },
+                                "increment": { "$ref": "#/definitions/positiveNumber" },
+                                "distance": { "$ref": "#/definitions/positiveNumber" },
+                                "currentByTipCount": {
+                                    "$ref": "#/definitions/currentByTipCount"
+                                }
+                            }
+                        }
+                    }
+                },
+                {
+                    "type": "object",
+                    "required": ["camAction"],
+                    "properties": {
+                        "camAction": {
+                            "type": "object",
+                            "required": [
+                                "prep_move_distance",
+                                "prep_move_speed",
+                                "speed",
+                                "distance",
+                                "currentByTipCount"
+                            ],
+                            "additionalProperties": false,
+                            "properties": {
+                                "prep_move_distance": {
+                                    "$ref": "#/definitions/positiveNumber"
+                                },
+                                "prep_move_speed": { "$ref": "#/definitions/positiveNumber" },
+                                "speed": { "$ref": "#/definitions/positiveNumber" },
+                                "distance": { "$ref": "#/definitions/positiveNumber" },
+                                "currentByTipCount": {
+                                    "$ref": "#/definitions/currentByTipCount"
+                                },
+                                "connectTiprackDistanceMM": {
+                                    "$ref": "#/definitions/positiveNumber"
+                                }
+                            }
+                        }
+                    }
+                }
+            ]
+        },
+        "dropTipConfigurations": {
+            "type": "object",
+            "description": "Object containing configurations specific to dropping tips",
+            "anyOf": [
+                {
+                    "type": "object",
+                    "required": ["plungerEject"],
+                    "properties": {
+                        "plungerEject": {
+                            "type": "object",
+                            "required": ["current", "speed"],
+                            "additionalProperties": false,
+                            "properties": {
+                                "current": { "$ref": "#/definitions/currentRange" },
+                                "speed": { "$ref": "#/definitions/positiveNumber" }
+                            }
+                        }
+                    }
+                },
+                {
+                    "type": "object",
+                    "required": ["camAction"],
+                    "properties": {
+                        "camAction": {
+                            "type": "object",
+                            "required": [
+                                "current",
+                                "prep_move_distance",
+                                "prep_move_speed",
+                                "distance",
+                                "speed"
+                            ],
+                            "additionalProperties": false,
+                            "properties": {
+                                "current": { "$ref": "#/definitions/currentRange" },
+                                "prep_move_distance": {
+                                    "$ref": "#/definitions/positiveNumber"
+                                },
+                                "prep_move_speed": { "$ref": "#/definitions/positiveNumber" },
+                                "distance": { "$ref": "#/definitions/positiveNumber" },
+                                "speed": { "$ref": "#/definitions/positiveNumber" }
+                            }
+                        }
+                    }
+                }
+            ]
+        },
+        "displayName": {
+            "type": "string",
+            "description": "Display name of the pipette include model and generation number in readable format."
+        },
+        "tipPresenceCheckDistanceMM": {
+            "$ref": "#/definitions/positiveNumber",
+            "description": "The distance to move the gear motors down to check tip presence status."
+        },
+        "endTipActionRetractDistanceMM": {
+            "$ref": "#/definitions/positiveNumber",
+            "description": "The distance to move the z stage up after a tip pickup or dropoff."
+        },
+        "model": {
+            "type": "string",
+            "description": "the model of the pipette, for example an eightChannel pipette"
+        },
+        "displayCategory": { "$ref": "#/definitions/displayCategory" }
+    }
+}

package/lib/protocol/fixtures/1/simple.json

@@ -0,0 +1,73 @@
+{
+    "protocol-schema": "1.0.0",
+    "default-values": {
+        "aspirate-flow-rate": {
+            "p300_single_v1": 101
+        },
+        "dispense-flow-rate": {
+            "p300_single_v1": 102
+        },
+        "aspirate-mm-from-bottom": 0,
+        "dispense-mm-from-bottom": 0
+    },
+    "metadata": {
+        "protocol-name": "Simple test protocol v1",
+        "author": "engineering <engineering@opentrons.com>",
+        "description": "A short test protocol",
+        "created": 1223131231,
+        "last-modified": null,
+        "category": null,
+        "subcategory": null,
+        "tags": ["unitTest"]
+    },
+    "robot": {
+        "model": "OT-2 Standard"
+    },
+    "labware": {
+        "sourcePlateId": {
+            "slot": "10",
+            "model": "96-flat"
+        },
+        "destPlateId": {
+            "slot": "11",
+            "model": "96-flat"
+        }
+    },
+    "pipettes": {
+        "pipetteId": {
+            "mount": "left",
+            "model": "p300_single_v1"
+        }
+    },
+    "procedure": [
+        {
+            "subprocedure": [
+                {
+                    "command": "aspirate",
+                    "params": {
+                        "pipette": "pipetteId",
+                        "labware": "sourcePlateId",
+                        "well": "A1",
+                        "volume": 5,
+                        "flow-rate": 123
+                    }
+                },
+                {
+                    "command": "delay",
+                    "params": {
+                        "wait": 42
+                    }
+                },
+                {
+                    "command": "dispense",
+                    "params": {
+                        "pipette": "pipetteId",
+                        "labware": "destPlateId",
+                        "well": "B1",
+                        "volume": 4.5
+                    }
+                }
+            ]
+        }
+    ]
+}