@opentrons/shared-data 0.0.0-alpha.2

package/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/protocol/README.md

@@ -0,0 +1,12 @@
+# Schema Bump Checklist
+
+1. Create new JSON schema in `shared-data/protocol/schemas/${schemaVersion}.json`
+2. Create TS types for new schema in `shared-data/protocol/types`
+3. Create or modify Python types as necessary in both `python/opentrons_shared_data/protocol/dev_types` and in the python api `dev_types` in `api/src/opentrons/protocol_api/dev_types.py`
+4. Create new executor in api to handle new schema. Be sure to include unit tests
+5. Add new test in `api/tests/opentrons/test_execute.py` for the schema
+6. Add new test in `shared-data/js/__tests__/protocolSchemaV${schemaVersion}.test.js` to ensure new schema definition functions as intended
+7. Add new schema fixture to `shared-data/protocol/fixtures/${schemaVersion}/${schemaVersion}.json` that the above test will read
+8. Update `MAX_SUPPORTED_VERSION` in `api/src/opentrons/protocols/parse.py`
+
+**IMPORTANT**: Be sure to clearly communicate the schema bump to the software + QA teams. This is a strict contract that should be honored by both the frontend and robot stack.

package/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
+          }
+        }
+      ]
+    }
+  ]
+}