@opentrons/shared-data 0.0.0-alpha.2

package/module/fixtures/3/compatibleGenerationV1.json

@@ -0,0 +1,69 @@
+{
+  "$otSharedSchema": "module/schemas/3",
+  "moduleType": "compatibleModuleType",
+  "model": "compatibleGenerationV1",
+  "labwareOffset": {
+    "x": -1.45,
+    "y": -0.15,
+    "z": 80.09
+  },
+  "dimensions": {
+    "bareOverallHeight": 84,
+    "overLabwareHeight": 0
+  },
+  "calibrationPoint": {
+    "x": 11.7,
+    "y": 8.75
+  },
+  "displayName": "Compatible Across Generations",
+  "quirks": [],
+  "slotTransforms": {
+    "ot2_standard": {
+      "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]
+        ]
+      }
+    },
+    "ot2_short_trash": {
+      "3": {
+        "labwareOffset": [
+          [-1, 0, -0.15],
+          [0, 1, 0],
+          [0, 0, 1]
+        ]
+      },
+      "6": {
+        "labwareOffset": [
+          [-1, 0, -0.15],
+          [0, 1, 0],
+          [0, 0, 1]
+        ]
+      },
+      "9": {
+        "labwareOffset": [
+          [-1, 0, -0.15],
+          [0, 1, 0],
+          [0, 0, 1]
+        ]
+      }
+    }
+  },
+  "compatibleWith": ["compatibleGenerationV2"]
+}

package/module/fixtures/3/compatibleGenerationV2.json

@@ -0,0 +1,69 @@
+{
+  "$otSharedSchema": "module/schemas/3",
+  "moduleType": "compatibleModuleType",
+  "model": "compatibleGenerationV2",
+  "labwareOffset": {
+    "x": -1.45,
+    "y": -0.15,
+    "z": 80.09
+  },
+  "dimensions": {
+    "bareOverallHeight": 84,
+    "overLabwareHeight": 0
+  },
+  "calibrationPoint": {
+    "x": 11.7,
+    "y": 8.75
+  },
+  "displayName": "Compatible Across Generations GEN2",
+  "quirks": [],
+  "slotTransforms": {
+    "ot2_standard": {
+      "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]
+        ]
+      }
+    },
+    "ot2_short_trash": {
+      "3": {
+        "labwareOffset": [
+          [-1, 0, -0.15],
+          [0, 1, 0],
+          [0, 0, 1]
+        ]
+      },
+      "6": {
+        "labwareOffset": [
+          [-1, 0, -0.15],
+          [0, 1, 0],
+          [0, 0, 1]
+        ]
+      },
+      "9": {
+        "labwareOffset": [
+          [-1, 0, -0.15],
+          [0, 1, 0],
+          [0, 0, 1]
+        ]
+      }
+    }
+  },
+  "compatibleWith": ["compatibleGenerationV1"]
+}

package/module/fixtures/3/incompatibleGenerationV1.json

@@ -0,0 +1,22 @@
+{
+  "$otSharedSchema": "module/schemas/3",
+  "moduleType": "incompatibleGenerationType",
+  "model": "incompatibleGenerationV1",
+  "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": "Incompatible Across Generations",
+  "quirks": [],
+  "slotTransforms": {},
+  "compatibleWith": []
+}

package/module/fixtures/3/incompatibleGenerationV2.json

@@ -0,0 +1,69 @@
+{
+  "$otSharedSchema": "module/schemas/3",
+  "moduleType": "incompatibleGenerationType",
+  "model": "incompatibleGenerationV2",
+  "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": "Incompatible Across Generations 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/module/schemas/1.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+
+  "definitions": {
+    "coordinates": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["x", "y"],
+      "properties": {
+        "x": { "type": "number" },
+        "y": { "type": "number" },
+        "z": { "type": "number" }
+      }
+    }
+  },
+  "description": "Module specifications",
+  "type": "object",
+  "$comment": "Example key: 'magdeck'",
+  "patternProperties": {
+    ".*": {
+      "type": "object",
+      "required": [
+        "labwareOffset",
+        "dimensions",
+        "calibrationPoint",
+        "displayName",
+        "loadName",
+        "quirks"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "labwareOffset": { "$ref": "#/definitions/coordinates" },
+        "dimensions": {
+          "type": "object",
+          "required": ["bareOverallHeight", "overLabwareHeight"],
+          "properties": {
+            "bareOverallHeight": { "type": "number" },
+            "overLabwareHeight": { "type": "number" },
+            "lidHeight": { "type": "number" }
+          }
+        },
+        "calibrationPoint": { "$ref": "#/definitions/coordinates" },
+        "displayName": { "type": "string" },
+        "loadName": { "type": "string" },
+        "quirks": {
+          "type": "array",
+          "description": "List of quirks for a given module",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

package/module/schemas/2.json

@@ -0,0 +1,112 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "coordinates": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["x", "y"],
+      "properties": {
+        "x": { "type": "number" },
+        "y": { "type": "number" },
+        "z": { "type": "number" }
+      }
+    },
+    "affineTransform": {
+      "description": "A 3x3 row-major matrix describing an affine transform to apply to the labwareOffset and calibrationPoint coordinates of the module (in certain circumstances, e.g. per slot)",
+      "type": "array",
+      "minItems": 3,
+      "maxItems": 3,
+      "items": {
+        "type": "array",
+        "minItems": 3,
+        "maxItems": 3,
+        "items": {
+          "type": "number"
+        }
+      }
+    }
+  },
+  "description": "Module specification",
+  "type": "object",
+  "required": [
+    "$otSharedSchema",
+    "moduleType",
+    "model",
+    "labwareOffset",
+    "dimensions",
+    "calibrationPoint",
+    "displayName",
+    "quirks",
+    "slotTransforms",
+    "compatibleWith"
+  ],
+  "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, #/module/schemas/2 is a reference to this schema."
+    },
+    "moduleType": {
+      "enum": [
+        "temperatureModuleType",
+        "magneticModuleType",
+        "thermocyclerModuleType"
+      ],
+      "type": "string"
+    },
+    "model": {
+      "type": "string",
+      "pattern": "^(temperatureModule|magneticModule|thermocyclerModule)V[0-9]+$"
+    },
+    "labwareOffset": { "$ref": "#/definitions/coordinates" },
+    "dimensions": {
+      "type": "object",
+      "required": ["bareOverallHeight", "overLabwareHeight"],
+      "properties": {
+        "bareOverallHeight": { "type": "number" },
+        "overLabwareHeight": { "type": "number" },
+        "lidHeight": { "type": "number" }
+      }
+    },
+    "calibrationPoint": { "$ref": "#/definitions/coordinates" },
+    "displayName": { "type": "string" },
+    "quirks": {
+      "type": "array",
+      "description": "List of quirks for a given module",
+      "items": {
+        "type": "string"
+      }
+    },
+    "slotTransforms": {
+      "type": "object",
+      "description": "Per-deckmap sets of per-slot transforms, properties should be ids of decks such as \"ot2_standard\". Transforms for a deck not explicitly listed are the identity.",
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "patternProperties:": {
+            "^([1-9]|10|11)$": {
+              "type": "object",
+              "description": "Holds 2-D affine transforms that should be applied to top level keys plus the special property $image for applying to images images. If any top level key has no corresponding entry, it is an identity transform. If the transform applies to an entity specifying a 3D position, it should be applied only to the x and y.",
+              "patternProperties": {
+                ".*": {
+                  "type": "object",
+                  "description": "The keys identify transforms that apply to different sections of the module definition. Most will be top level keys of the module def (for instance, \"labwareOffset\") but there may also be additional meta keys for values that are not in the def",
+                  "patternProperties": {
+                    ".*": { "$ref": "#/definitions/affineTransform" }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "compatibleWith": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "description": "A compatible module model (e.g. temperatureModuleV1)"
+      }
+    }
+  }
+}

package/module/schemas/3.json

@@ -0,0 +1,206 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "coordinates": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["x", "y", "z"],
+      "properties": {
+        "x": { "type": "number" },
+        "y": { "type": "number" },
+        "z": { "type": "number" }
+      }
+    },
+    "affineTransform": {
+      "description": "A 4x4 row-major matrix describing an affine transform to apply to the labwareOffset and calibrationPoint coordinates of the module (in certain circumstances, e.g. per slot)",
+      "type": "array",
+      "minItems": 4,
+      "maxItems": 4,
+      "items": {
+        "type": "array",
+        "minItems": 4,
+        "maxItems": 4,
+        "items": {
+          "type": "number"
+        }
+      }
+    },
+    "svgsonNode": {
+      "type": "object",
+      "description": "An svgson node that corresponds to a single svg tag",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Element name, like svg, circle, line…"
+        },
+        "type": {
+          "type": "string",
+          "description": "Element type like element, text…"
+        },
+        "value": {
+          "type": "string",
+          "description": "Element value, used in text nodes."
+        },
+        "children": {
+          "type": "array",
+          "description": "List of element children",
+          "items": { "$ref": "#" }
+        },
+        "attributes": {
+          "type": "object",
+          "description": "Attributes for the element"
+        }
+      }
+    }
+  },
+  "description": "Module specification",
+  "type": "object",
+  "required": [
+    "$otSharedSchema",
+    "moduleType",
+    "model",
+    "labwareOffset",
+    "cornerOffsetFromSlot",
+    "dimensions",
+    "calibrationPoint",
+    "displayName",
+    "quirks",
+    "slotTransforms",
+    "compatibleWith",
+    "twoDimensionalRendering"
+  ],
+  "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, #/module/schemas/3 is a reference to this schema."
+    },
+    "moduleType": {
+      "enum": [
+        "temperatureModuleType",
+        "magneticModuleType",
+        "thermocyclerModuleType",
+        "heaterShakerModuleType",
+        "magneticBlockType"
+      ],
+      "type": "string"
+    },
+    "model": {
+      "type": "string",
+      "pattern": "^(temperatureModule|magneticModule|thermocyclerModule|heaterShakerModule|magneticBlock)V[0-9]+$"
+    },
+    "labwareOffset": { "$ref": "#/definitions/coordinates" },
+    "dimensions": {
+      "type": "object",
+      "required": [
+        "bareOverallHeight",
+        "overLabwareHeight",
+        "xDimension",
+        "yDimension"
+      ],
+      "properties": {
+        "bareOverallHeight": { "type": "number" },
+        "overLabwareHeight": { "type": "number" },
+        "lidHeight": { "type": "number" },
+        "xDimension": { "type": "number" },
+        "yDimension": { "type": "number" },
+        "footprintXDimension": { "type": "number" },
+        "footprintYDimension": { "type": "number" },
+        "labwareInterfaceXDimension": { "type": "number" },
+        "labwareInterfaceYDimension": { "type": "number" }
+      }
+    },
+    "cornerOffsetFromSlot": {
+      "$ref": "#/definitions/coordinates",
+      "description": "Position of left-front-bottom corner of entire module chassis to slot footprint origin (left-front-bottom)"
+    },
+    "calibrationPoint": {
+      "$ref": "#/definitions/coordinates",
+      "description": "A point on the module's interaction plane (where labware is placed) used for calibrating the module. Slated for future use (as of 2022-05-20)."
+    },
+    "config": {
+      "type": "object",
+      "description": "Module's hardware-defined constraints",
+      "properties": {
+        "minPlateTemperature": { "type": "number" },
+        "maxPlateTemperature": { "type": "number" },
+        "minShakeSpeed": { "type": "number" },
+        "maxShakeSpeed": { "type": "number" },
+        "maxEngageHeight": { "type": "number" },
+        "minTemperature": { "type": "number" },
+        "maxTemperature": { "type": "number" },
+        "minBlockTemperature": { "type": "number" },
+        "maxBlockTemperature": { "type": "number" },
+        "minLidTemperature": { "type": "number" },
+        "maxLidTemperature": { "type": "number" },
+        "minBlockVolume": { "type": "number" },
+        "maxBlockVolume": { "type": "number" }
+      }
+    },
+    "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 a module.",
+      "properties": {
+        "default": {
+          "type": "object",
+          "properties": {
+            "pickUpOffset": {
+              "$ref": "#/definitions/coordinates",
+              "description": "Offset added to calculate pick-up coordinates of a labware placed on this module."
+            },
+            "dropOffset": {
+              "$ref": "#/definitions/coordinates",
+              "description": "Offset added to calculate drop coordinates of a labware placed on this module."
+            }
+          },
+          "required": ["pickUpOffset", "dropOffset"]
+        }
+      },
+      "required": ["default"]
+    },
+    "displayName": { "type": "string" },
+    "quirks": {
+      "type": "array",
+      "description": "List of quirks for a given module",
+      "items": {
+        "type": "string"
+      }
+    },
+    "slotTransforms": {
+      "type": "object",
+      "description": "Per-deckmap sets of per-slot transforms, properties should be ids of decks such as \"ot2_standard\". Transforms for a deck not explicitly listed are the identity.",
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "patternProperties:": {
+            "^([1-9]|10|11)$": {
+              "type": "object",
+              "description": "Holds 2-D affine transforms that should be applied to top level keys plus the special property $image for applying to images images. If any top level key has no corresponding entry, it is an identity transform. If the transform applies to an entity specifying a 3D position, it should be applied only to the x and y.",
+              "patternProperties": {
+                ".*": {
+                  "type": "object",
+                  "description": "The keys identify transforms that apply to different sections of the module definition. Most will be top level keys of the module def (for instance, \"labwareOffset\") but there may also be additional meta keys for values that are not in the def",
+                  "patternProperties": {
+                    ".*": { "$ref": "#/definitions/affineTransform" }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "compatibleWith": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "description": "A compatible module model (e.g. temperatureModuleV1)"
+      }
+    },
+    "twoDimensionalRendering": {
+      "type": "object",
+      "description": "SVG rendering of the module represented as svgson",
+      "items": { "$ref": "#/definitions/svgsonNode" }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@opentrons/shared-data",
+  "version": "0.0.0-alpha.2",
+  "description": "Shared system definitions and utilities for Opentrons robots and software",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Opentrons/opentrons.git"
+  },
+  "author": "Opentrons Labworks",
+  "license": "Apache-2.0",
+  "source": "js/index.ts",
+  "types": "lib/js/index.d.ts",
+  "flow:main": "flow-types/js/index.js.flow",
+  "dependencies": {
+    "ajv": "^6.12.3",
+    "html-react-parser": "^1.2.8",
+    "lodash": "4.17.21",
+    "svgson": "^5.2.1"
+  }
+}

package/pipette/README.md

@@ -0,0 +1,50 @@
+# Pipette Configurations
+
+## Schema Version 2
+
+Information about our pipettes is now split into 3 different categories of data. Each data file is organized into `<configuration_type>/<pipette_type>/<pipette_model>/<pipette_version>`.
+
+- `configuration_type` is the top level category of data (i.e. `geometry` or `liquid`)
+- `pipette_type` is the type of pipette generally referred to by the channel size (i.e. `single_channel` or `eight_channel`)
+- `pipette_model` is the max volume of the pipette (i.e. `p50` or `p1000`)
+- `pipette_version` is the version number flashed to the pipette (i.e. `v1` or `v1.2`)
+
+This organization is subject to change based on the model name changes that product might make.
+
+### Geometry Configurations: `shared-data/pipette/schemas/2/pipetteGeometrySchema.json`
+
+Pipette geometry configurations includes physical properties that map the pipette end effector in space. In this section of data, we would also like to store 3D model descriptor files that are compatible with typescript and other 3D modeling visualization software for future applications.
+
+We are planning to use [gltf](https://www.khronos.org/gltf/) formatted files as you can choose your 3D model anchors inside solidworks and export the file.
+
+### Liquid Configurations: `shared-data/pipette/schemas/2/pipetteLiquidPropertiesSchema.json`
+
+Pipette liquid configurations include all pipette properties that may affect liquid handling. This includes pipetting function and default flow rates based on tip size.
+
+We have now added in the ability to categorize liquid handling properties by tip type (which can also vary by brand). Eventually, we may need this to be more complex than just a look up dictionary of `tip_type` : `brand+liquid` but we can decide to make that change at a different time.
+
+### General Properties Configurations: `shared-data/pipette/schemas/2/pipettePropertiesSchema.json`
+
+Pipette general properties should be similar to schema version 1 name specs that are shared across pipette type + model.
+
+## Schema Version 1
+
+Information about our pipettes is split into 2 different files.
+
+### Name Level: `shared-data/pipette/schemas/1/pipetteNameSpecs.json`
+
+A pipette name is what is communicated with customers, what is listed in the store, etc. Name-level information does not vary across pipettes with the same "name", it includes: min and max volume, display name, number of channels, and default aspirate/dispense flow rates.
+
+The "name" is all that is communicated to the average user about a pipette. Both JSON and Python protocols specify pipettes by name; they never specify the pipette model/version.
+
+`"p10_single"` is an example of a name.
+
+### Model Level: `shared-data/pipette/schemas/1/pipetteModelSpecs.json`
+
+A "model" is synonymous with a part number. Our models / part numbers look like `"p10_single_v1.3"`. Although the name is a substring of the model string, it isn't a good idea to infer name by parsing it out of the model.
+
+The model level contains information specific to particular pipette models. The model can be read off of a pipette's EEPROM at runtime. This information is required for protocol execution on the robot, but is not used directly in the code of JSON or Python protocols.
+
+## JSON Schemas
+
+In `shared-data/pipette/schemas/` there are JSON schemas for these files, which ensure data integrity. Further descriptions about the individual fields are written into the schemas.