opentrons-shared-data 8.8.0a10__py3-none-any.whl

opentrons_shared_data/data/deck/schemas/5.json

@@ -0,0 +1,396 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "opentronsDeckSchemaV5",
+  "definitions": {
+    "positiveNumber": {
+      "type": "number",
+      "minimum": 0
+    },
+    "xyzArray": {
+      "type": "array",
+      "description": "Array of 3 numbers, [x, y, z]",
+      "items": { "type": "number" },
+      "minItems": 3,
+      "maxItems": 3
+    },
+    "coordinates": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["x", "y", "z"],
+      "properties": {
+        "x": {
+          "type": "number"
+        },
+        "y": {
+          "type": "number"
+        },
+        "z": {
+          "type": "number"
+        }
+      }
+    },
+    "unitVector": {
+      "type": "array",
+      "description": "Array of 3 unit directions, [x, y, z]",
+      "items": {
+        "type": "number",
+        "enum": [1, -1]
+      },
+      "minItems": 3,
+      "maxItems": 3
+    },
+    "boundingBox": {
+      "type": "object",
+      "required": ["xDimension", "yDimension", "zDimension"],
+      "properties": {
+        "xDimension": { "$ref": "#/definitions/positiveNumber" },
+        "yDimension": { "$ref": "#/definitions/positiveNumber" },
+        "zDimension": { "$ref": "#/definitions/positiveNumber" }
+      }
+    },
+    "vector2D": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["x", "y"],
+      "properties": {
+        "x": {
+          "type": "number"
+        },
+        "y": {
+          "type": "number"
+        }
+      }
+    }
+  },
+  "description": "Deck specifications, where x,y,z (0,0,0) is at front the bottom left corner.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "otId",
+    "schemaVersion",
+    "cornerOffsetFromOrigin",
+    "dimensions",
+    "metadata",
+    "robot",
+    "locations",
+    "cutoutFixtures"
+  ],
+  "properties": {
+    "otId": {
+      "description": "Unique internal ID generated using UUID",
+      "type": "string"
+    },
+    "schemaVersion": {
+      "description": "Schema version of a deck is a single integer",
+      "enum": [5]
+    },
+    "cornerOffsetFromOrigin": {
+      "$ref": "#/definitions/xyzArray",
+      "description": "Position of left-front-bottom corner of entire deck to robot coordinate system origin"
+    },
+    "dimensions": {
+      "$ref": "#/definitions/xyzArray",
+      "description": "Outer dimensions of a deck bounding box"
+    },
+    "metadata": {
+      "description": "Optional metadata about the Deck",
+      "type": "object",
+      "properties": {
+        "displayName": {
+          "description": "A short, human-readable name for the deck",
+          "type": "string"
+        },
+        "tags": {
+          "description": "Tags to be used in searching for this deck",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "robot": {
+      "type": "object",
+      "required": ["model"],
+      "properties": {
+        "model": {
+          "description": "Model of the robot",
+          "type": "string",
+          "enum": ["OT-2 Standard", "OT-3 Standard"]
+        }
+      }
+    },
+    "locations": {
+      "type": "object",
+      "required": [
+        "addressableAreas",
+        "calibrationPoints",
+        "cutouts",
+        "legacyFixtures"
+      ],
+      "properties": {
+        "addressableAreas": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "description": "An addressable area is a named area in 3D space that the robot can interact with--for example, as a place to drop tips, or hold a labware.",
+            "required": [
+              "id",
+              "areaType",
+              "offsetFromCutoutFixture",
+              "boundingBox",
+              "displayName",
+              "features",
+              "orientation"
+            ],
+            "properties": {
+              "id": {
+                "description": "Unique identifier for slot",
+                "type": "string"
+              },
+              "areaType": {
+                "description": "The type of addressable area, defining allowed behavior.",
+                "type": "string",
+                "enum": [
+                  "slot",
+                  "stagingSlot",
+                  "movableTrash",
+                  "fixedTrash",
+                  "wasteChute",
+                  "lidDock",
+                  "heaterShaker",
+                  "magneticBlock",
+                  "temperatureModule",
+                  "thermocycler",
+                  "absorbanceReader",
+                  "flexStacker"
+                ]
+              },
+              "offsetFromCutoutFixture": {
+                "$ref": "#/definitions/xyzArray",
+                "description": "The offset from the origin of the cutout fixture that's providing this addressable area (which is currently identical to the position of the underlying cutout), to the -x, -y, -z corner of this addressable area's bounding box."
+              },
+              "matingSurfaceUnitVector": {
+                "$ref": "#/definitions/unitVector",
+                "description": "An optional diagonal direction of force, defined by spring location, which governs the mating surface of objects placed in this addressable area. Meant to be used when this addressable area is a slot."
+              },
+              "boundingBox": {
+                "description": "The active area (both pipettes can reach) of this addressable area.",
+                "$ref": "#/definitions/boundingBox"
+              },
+              "displayName": {
+                "description": "A human-readable nickname for this area e.g. \"Slot A1\" or \"Trash Bin in A1\"",
+                "type": "string"
+              },
+              "features": {
+                "type": "object",
+                "description": "Locating features when this addressable area is a part of a stackup.",
+                "required": [],
+                "properties": {
+                  "slotFootprintAsParent": {
+                    "description": "The 2D plane on which a child deck item resides.",
+                    "type": "object",
+                    "required": ["backLeft", "frontRight", "z"],
+                    "properties": {
+                      "backLeft": {
+                        "description": "(-x, +y), the back left corner of an addressable area.",
+                        "$ref": "#/definitions/vector2D"
+                      },
+                      "frontRight": {
+                        "description": "(+x, -y), the back left corner of an addressable area.",
+                        "$ref": "#/definitions/vector2D"
+                      },
+                      "z": {
+                        "description": "Always zero by convention. The z-offset from the bottom of the addressable area's plane to the plane on which a child deck item resides.",
+                        "type": "number"
+                      },
+                      "springDirectionalForce": {
+                        "description": "Applicable when the addressable area contains a spring that influences a child deck item.",
+                        "type": "string",
+                        "enum": ["backLeftBottom"]
+                      }
+                    }
+                  }
+                }
+              },
+              "compatibleModuleTypes": {
+                "description": "OT-2 Only parameter. An array of module types that can be placed in this area. The module type names can be found in the moduleType field of a module definition.",
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "ableToDropTips": {
+                "description": "Whether tips are allowed to be dropped into this area. If `true`, the top-center of the `boundingBox` should be a good location for the bottom-center of all the tips when they're dropped.",
+                "type": "boolean"
+              },
+              "ableToDropLabware": {
+                "description": "Whether labware is allowed to be dropped (different from being placed) into this area. If `true`, the top-center of the `boundingBox` should be a good location for the bottom-center of the labware when it's dropped.",
+                "type": "boolean"
+              },
+              "orientation": {
+                "description": "The orientation of the underlying module when this addressable area overlays a module.",
+                "type": "string",
+                "enum": ["left", "right", "center", null]
+              }
+            }
+          }
+        },
+        "calibrationPoints": {
+          "type": "array",
+          "description": "Key points for deck calibration",
+          "items": {
+            "type": "object",
+            "required": ["id", "position", "displayName"],
+            "properties": {
+              "id": {
+                "description": "Unique identifier for calibration point",
+                "type": "string"
+              },
+              "position": {
+                "$ref": "#/definitions/xyzArray"
+              },
+              "displayName": {
+                "description": "An optional human-readable nickname for this point Eg \"Slot 3 Cross\" or \"Slot 1 Dot\"",
+                "type": "string"
+              }
+            }
+          }
+        },
+        "cutouts": {
+          "type": "array",
+          "description": "The machined cutout slots on the deck surface.",
+          "items": {
+            "type": "object",
+            "required": ["id", "position", "displayName"],
+            "properties": {
+              "id": {
+                "description": "Unique identifier for the cutout",
+                "type": "string"
+              },
+              "position": {
+                "description": "Absolute position of the cutout",
+                "$ref": "#/definitions/xyzArray"
+              },
+              "displayName": {
+                "description": "An optional human-readable nickname for this cutout e.g. \"Cutout A1\"",
+                "type": "string"
+              }
+            }
+          }
+        },
+        "legacyFixtures": {
+          "type": "array",
+          "description": "Fixed position objects on the deck and fixture-dependant Module labware Eg Plate Reader Lid.",
+          "items": {
+            "type": "object",
+            "required": ["id", "displayName"],
+            "properties": {
+              "id": {
+                "description": "Unique identifier for fixed object",
+                "type": "string"
+              },
+              "labware": {
+                "description": "Valid labware loadName for fixed object",
+                "type": "string"
+              },
+              "slot": {
+                "description": "Slot location of the fixed object",
+                "type": "string"
+              },
+              "displayName": {
+                "description": "An optional human-readable nickname for this fixture Eg \"Tall Fixed Trash\" or \"Short Fixed Trash\"",
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    },
+    "cutoutFixtures": {
+      "type": "array",
+      "items": {
+        "description": "A cutout fixture is a physical thing that can be mounted onto one of the deck cutouts.",
+        "type": "object",
+        "required": [
+          "id",
+          "expectOpentronsModuleSerialNumber",
+          "mayMountTo",
+          "displayName",
+          "providesAddressableAreas",
+          "fixtureGroup",
+          "height"
+        ],
+        "properties": {
+          "id": {
+            "description": "Unique identifier for the cutout fixture.",
+            "type": "string"
+          },
+          "expectOpentronsModuleSerialNumber": {
+            "description": "Determines whether or not a fixture expects a serial number for a connected Opentrons Module.",
+            "type": "boolean"
+          },
+          "mayMountTo": {
+            "description": "A list of compatible cutouts this fixture may be mounted to. These must match `id`s in `cutouts`.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "displayName": {
+            "description": "A human-readable nickname for this area e.g. \"Standard Right Slot\" or \"Slot With Movable Trash\"",
+            "type": "string"
+          },
+          "providesAddressableAreas": {
+            "description": "The addressable areas that this cutout fixture provides, when it's mounted. It can provide different addressable areas depending on where it's mounted. Keys must match values from this object's `mayMountTo`. Values must match `id`s from `addressableAreas`.",
+            "type": "object",
+            "additionalProperties": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "fixtureGroup": {
+            "description": "The map of fixtures that must exist in the deck configuration if this fixture exists, with the mounting location acting as a key to determine the location of the rest of the group.",
+            "type": "object",
+            "additionalProperties": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "height": {
+            "description": "The vertical distance (mm) from the cutout fixture's origin to its tallest physical feature that an instrument could collide with.",
+            "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 this deck.",
+      "properties": {
+        "default": {
+          "type": "object",
+          "properties": {
+            "pickUpOffset": {
+              "$ref": "#/definitions/coordinates",
+              "description": "Offset added to calculate pick-up coordinates of a labware placed on this deck."
+            },
+            "dropOffset": {
+              "$ref": "#/definitions/coordinates",
+              "description": "Offset added to calculate drop coordinates of a labware placed on this deck."
+            }
+          },
+          "required": ["pickUpOffset", "dropOffset"]
+        }
+      },
+      "required": ["default"]
+    }
+  }
+}

opentrons_shared_data/data/errors/definitions/1/errors.json

@@ -0,0 +1,286 @@
+{
+  "categories": {
+    "hardwareCommunicationError": {
+      "detail": "Hardware communications failed",
+      "codePrefix": "1"
+    },
+    "roboticsControlError": {
+      "detail": "A robot action failed",
+      "codePrefix": "2"
+    },
+    "roboticsInteractionError": {
+      "detail": "A robot interaction failed",
+      "codePrefix": "3"
+    },
+    "generalError": {
+      "detail": "A software error occurred",
+      "codePrefix": "4"
+    }
+  },
+  "codes": {
+    "1000": {
+      "detail": "Communication Error",
+      "category": "hardwareCommunicationError"
+    },
+    "1001": {
+      "detail": "CANBus Communication Error",
+      "category": "hardwareCommunicationError"
+    },
+    "1002": {
+      "detail": "Internal USB Communication Error",
+      "category": "hardwareCommunicationError"
+    },
+    "1003": {
+      "detail": "Module Communication Error",
+      "category": "hardwareCommunicationError"
+    },
+    "1004": {
+      "detail": "Command Timed Out",
+      "category": "hardwareCommunicationError"
+    },
+    "1005": {
+      "detail": "Firmware Update Failed",
+      "category": "hardwareCommunicationError"
+    },
+    "1006": {
+      "detail": "Internal Message Format Error",
+      "category": "hardwareCommunicationError"
+    },
+    "1007": {
+      "detail": "CANBus Configuration Error",
+      "category": "hardwareCommunicationError"
+    },
+    "1008": {
+      "detail": "CANBus Bus Error",
+      "category": "hardwareCommunicationError"
+    },
+    "2000": {
+      "detail": "Robotics Control Error",
+      "category": "roboticsControlError"
+    },
+    "2001": {
+      "detail": "Motion Failed",
+      "category": "roboticsControlError"
+    },
+    "2002": {
+      "detail": "Homing Failed",
+      "category": "roboticsControlError"
+    },
+    "2003": {
+      "detail": "Stall or Collision Detected",
+      "category": "roboticsControlError"
+    },
+    "2004": {
+      "detail": "Motion Planning Failure",
+      "category": "roboticsControlError"
+    },
+    "2005": {
+      "detail": "Position Estimation Invalid",
+      "category": "roboticsControlError"
+    },
+    "2006": {
+      "detail": "Move Condition Not Met",
+      "category": "roboticsControlError"
+    },
+    "2007": {
+      "detail": "Calibration Structure Not Found",
+      "category": "roboticsControlError"
+    },
+    "2008": {
+      "detail": "Calibration Edge Not Found",
+      "category": "roboticsControlError"
+    },
+    "2009": {
+      "detail": "Early Capacitance Sense Trigger",
+      "category": "roboticsControlError"
+    },
+    "2010": {
+      "detail": "Inaccurate Non-Contact Sweep",
+      "category": "roboticsControlError"
+    },
+    "2011": {
+      "detail": "Misaligned Gantry",
+      "category": "roboticsControlError"
+    },
+    "2012": {
+      "detail": "Unmatched tip presence states",
+      "category": "roboticsControlError"
+    },
+    "2013": {
+      "detail": "Position Unknown",
+      "category": "roboticsControlError"
+    },
+    "2014": {
+      "detail": "Execution Cancelled",
+      "category": "roboticsControlError"
+    },
+    "2015": {
+      "detail": "Gripper Pickup Failed",
+      "category": "roboticsControlError"
+    },
+    "2016": {
+      "detail": "Motor Driver Error",
+      "category": "roboticsControlError"
+    },
+    "2017": {
+      "detail": "Liquid Not Found",
+      "category": "roboticsControlError"
+    },
+    "2018": {
+      "detail": "Tip Hit Well Bottom",
+      "category": "roboticsControlError"
+    },
+    "2019": {
+      "detail": "Flex Stacker Stall or Collision Detected",
+      "category": "roboticsControlError"
+    },
+    "3000": {
+      "detail": "A robotics interaction error occurred.",
+      "category": "roboticsInteractionError"
+    },
+    "3001": {
+      "detail": "Labware Dropped",
+      "category": "roboticsInteractionError"
+    },
+    "3002": {
+      "detail": "Labware Not Picked Up",
+      "category": "roboticsInteractionError"
+    },
+    "3003": {
+      "detail": "Tip Pickup Failed",
+      "category": "roboticsInteractionError"
+    },
+    "3004": {
+      "detail": "Tip Drop Failed",
+      "category": "roboticsInteractionError"
+    },
+    "3005": {
+      "detail": "Unexpected Tip Removal",
+      "category": "roboticsInteractionError"
+    },
+    "3006": {
+      "detail": "Pipette Overpressure",
+      "category": "roboticsInteractionError"
+    },
+    "3008": {
+      "detail": "E-Stop Activated",
+      "category": "roboticsInteractionError"
+    },
+    "3009": {
+      "detail": "E-Stop Not Present",
+      "category": "roboticsInteractionError"
+    },
+    "3010": {
+      "detail": "Pipette Not Present",
+      "category": "roboticsInteractionError"
+    },
+    "3011": {
+      "detail": "Gripper Not Present",
+      "category": "roboticsInteractionError"
+    },
+    "3012": {
+      "detail": "Unexpected Tip Presence",
+      "category": "roboticsInteractionError"
+    },
+    "3013": {
+      "detail": "Firmware Update Required",
+      "category": "roboticsInteractionError"
+    },
+    "3014": {
+      "detail": "Invalid Actuator",
+      "category": "roboticsInteractionError"
+    },
+    "3015": {
+      "detail": "Module Not Present",
+      "category": "roboticsInteractionError"
+    },
+    "3016": {
+      "detail": "Invalid Instrument Data",
+      "category": "roboticsInteractionError"
+    },
+    "3017": {
+      "detail": "Invalid Liquid Class Name",
+      "category": "roboticsInteractionError"
+    },
+    "3018": {
+      "detail": "Tip Detector Not Created",
+      "category": "roboticsInteractionError"
+    },
+    "3019": {
+      "detail": "HEPA UV Failed",
+      "category": "roboticsInteractionError"
+    },
+    "3020": {
+      "detail": "Flex Stacker Shuttle Missing",
+      "category": "roboticsInteractionError"
+    },
+    "3021": {
+      "detail": "Flex Stacker Shuttle Labware Detection Failed",
+      "category": "roboticsInteractionError"
+    },
+    "3022": {
+      "detail": "Flex Stacker Hopper Labware Detection Failed",
+      "category": "roboticsInteractionError"
+    },
+    "3023": {
+      "detail": "Flex Stacker Shuttle Occupied",
+      "category": "roboticsInteractionError"
+    },
+    "4000": {
+      "detail": "Unknown or Uncategorized Error",
+      "category": "generalError"
+    },
+    "4001": {
+      "detail": "Robot In Use",
+      "category": "generalError"
+    },
+    "4002": {
+      "detail": "API Removed",
+      "category": "generalError"
+    },
+    "4003": {
+      "detail": "Not supported on this robot type",
+      "category": "generalError"
+    },
+    "4004": {
+      "detail": "Command Precondition Violated",
+      "category": "generalError"
+    },
+    "4005": {
+      "detail": "Command Parameter Limit Violated",
+      "category": "generalError"
+    },
+    "4006": {
+      "detail": "Invalid Protocol Data",
+      "category": "generalError"
+    },
+    "4007": {
+      "detail": "API Command is misconfigured",
+      "category": "generalError"
+    },
+    "4008": {
+      "detail": "Invalid stored data",
+      "category": "generalError"
+    },
+    "4009": {
+      "detail": "Missing configuration data",
+      "category": "generalError"
+    },
+    "4010": {
+      "detail": "Runtime Parameter Value Required",
+      "category": "generalError"
+    },
+    "4011": {
+      "detail": "Incorrect API Version",
+      "category": "generalError"
+    },
+    "4012": {
+      "detail": "Labware Locating Feature Error",
+      "category": "generalError"
+    },
+    "4013": {
+      "detail": "Camera Related Error",
+      "category": "generalError"
+    }
+  }
+}