@opentrons/shared-data 0.2.0-alpha.0 → 0.2.1-alpha.0

package/lib/deck/schemas/3.json

@@ -1,296 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "opentronsDeckSchemaV3",
-    "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",
-            "description": "The active area (both pipettes can reach) of a fixture on the deck",
-            "required": ["xDimension", "yDimension", "zDimension"],
-            "properties": {
-                "xDimension": { "$ref": "#/definitions/positiveNumber" },
-                "yDimension": { "$ref": "#/definitions/positiveNumber" },
-                "zDimension": { "$ref": "#/definitions/positiveNumber" }
-            }
-        },
-        "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": "#/definitions/svgsonNode" }
-                },
-                "attributes": {
-                    "type": "object",
-                    "description": "Attributes for the element"
-                }
-            }
-        }
-    },
-    "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",
-        "layers"
-    ],
-    "properties": {
-        "otId": {
-            "description": "Unique internal ID generated using UUID",
-            "type": "string"
-        },
-        "schemaVersion": {
-            "description": "Schema version of a deck is a single integer",
-            "enum": [3]
-        },
-        "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": ["orderedSlots", "calibrationPoints"],
-            "properties": {
-                "orderedSlots": {
-                    "type": "array",
-                    "description": "Ordered slots available for placing labware",
-                    "items": {
-                        "type": "object",
-                        "required": [
-                            "id",
-                            "position",
-                            "boundingBox",
-                            "displayName",
-                            "compatibleModuleTypes"
-                        ],
-                        "properties": {
-                            "id": {
-                                "description": "Unique identifier for slot",
-                                "type": "string"
-                            },
-                            "position": {
-                                "$ref": "#/definitions/xyzArray"
-                            },
-                            "matingSurfaceUnitVector": {
-                                "$ref": "#/definitions/unitVector",
-                                "description": "An optional diagonal direction of force, defined by spring location, which governs the mating surface of objects placed in slot."
-                            },
-                            "boundingBox": {
-                                "$ref": "#/definitions/boundingBox"
-                            },
-                            "displayName": {
-                                "description": "A human-readable nickname for this slot Eg \"Slot 1\" or \"Fixed Trash\"",
-                                "type": "string"
-                            },
-                            "compatibleModuleTypes": {
-                                "description": "An array of module types that can be placed in this slot.",
-                                "type": "array",
-                                "items": {
-                                    "type": "string",
-                                    "enum": [
-                                        "magneticModuleType",
-                                        "temperatureModuleType",
-                                        "thermocyclerModuleType",
-                                        "heaterShakerModuleType",
-                                        "magneticBlockType"
-                                    ]
-                                }
-                            }
-                        }
-                    }
-                },
-                "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"
-                            }
-                        }
-                    }
-                },
-                "fixtures": {
-                    "type": "array",
-                    "description": "Fixed position objects on the deck.",
-                    "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"
-                            },
-                            "boundingBox": {
-                                "$ref": "#/definitions/boundingBox"
-                            },
-                            "slot": {
-                                "description": "Slot location of the fixed object",
-                                "type": "string"
-                            },
-                            "position": {
-                                "$ref": "#/definitions/xyzArray"
-                            },
-                            "displayName": {
-                                "description": "An optional human-readable nickname for this fixture Eg \"Tall Fixed Trash\" or \"Short Fixed Trash\"",
-                                "type": "string"
-                            }
-                        },
-                        "oneOf": [
-                            {
-                                "anyOf": [
-                                    {
-                                        "required": ["labware", "slot"]
-                                    },
-                                    {
-                                        "required": ["labware", "position"]
-                                    }
-                                ]
-                            },
-                            {
-                                "anyOf": [
-                                    {
-                                        "required": ["boundingBox", "slot"]
-                                    },
-                                    {
-                                        "required": ["boundingBox", "position"]
-                                    }
-                                ]
-                            }
-                        ]
-                    }
-                }
-            }
-        },
-        "layers": {
-            "type": "array",
-            "description": "Layered feature groups of the deck.",
-            "items": {
-                "$ref": "#/definitions/svgsonNode"
-            }
-        },
-        "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"]
-        }
-    }
-}

package/lib/deck/schemas/4.json

@@ -1,319 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "opentronsDeckSchemaV4",
-    "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" }
-            }
-        }
-    },
-    "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": [4]
-        },
-        "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"
-                        ],
-                        "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"
-                                ]
-                            },
-                            "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"
-                            },
-                            "compatibleModuleTypes": {
-                                "description": "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"
-                            }
-                        }
-                    }
-                },
-                "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.",
-                    "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",
-                    "mayMountTo",
-                    "displayName",
-                    "providesAddressableAreas",
-                    "height"
-                ],
-                "properties": {
-                    "id": {
-                        "description": "Unique identifier for the cutout fixture.",
-                        "type": "string"
-                    },
-                    "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"
-                            }
-                        }
-                    },
-                    "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"]
-        }
-    }
-}