@opentrons/shared-data 0.1.5 → 0.1.6-alpha.5

package/lib/protocol/schemas/7.json

@@ -1,270 +0,0 @@
-{
-    "$id": "opentronsProtocolSchemaV7",
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "pipetteName": {
-            "description": "Name of a pipette. Does not contain info about specific model/version. Should match keys in pipetteNameSpecs.json file",
-            "type": "string",
-            "enum": [
-                "p10_single",
-                "p10_multi",
-                "p20_single_gen2",
-                "p20_multi_gen2",
-                "p50_single",
-                "p50_multi",
-                "p300_single",
-                "p300_multi",
-                "p300_single_gen2",
-                "p300_multi_gen2",
-                "p1000_single",
-                "p1000_single_gen2",
-                "p50_single_flex",
-                "p50_multi_flex",
-                "p1000_single_flex",
-                "p1000_multi_flex",
-                "p1000_96"
-            ]
-        },
-        "moduleOnlyParams": {
-            "required": ["moduleId"],
-            "additionalProperties": false,
-            "properties": {
-                "moduleId": {
-                    "type": "string",
-                    "description": "Unique identifier of module to target. Must be a key from the top level 'modules' object"
-                }
-            }
-        },
-        "offset": {
-            "description": "x, y, and z component of offset vector in mm",
-            "properties": {
-                "x": { "type": "number" },
-                "y": { "type": "number" },
-                "z": { "type": "number" }
-            }
-        },
-        "pipetteAccessParams": {
-            "required": ["pipetteId", "labwareId", "wellName"],
-            "properties": {
-                "pipetteId": {
-                    "type": "string"
-                },
-                "labwareId": {
-                    "type": "string"
-                },
-                "wellName": {
-                    "type": "string"
-                }
-            }
-        },
-        "volumeParams": {
-            "required": ["volume"],
-            "volume": {
-                "type": "number"
-            }
-        },
-        "flowRate": {
-            "required": ["flowRate"],
-            "properties": {
-                "flowRate": {
-                    "description": "flow rate in ul/sec",
-                    "type": "number",
-                    "exclusiveMinimum": 0
-                }
-            }
-        },
-        "wellLocation": {
-            "properties": {
-                "origin": {
-                    "type": "string",
-                    "description": "reference location with respect to a well from which to apply an offset if given (e.g. 'bottom' || 'top')"
-                },
-                "offset": {
-                    "$ref": "#/definitions/offset",
-                    "description": "X, Y, Z offset from the specified origin with respect to well"
-                }
-            }
-        },
-        "labwareLocation": {
-            "oneOf": [
-                {
-                    "required": ["slotName"],
-                    "properties": {
-                        "slotName": {
-                            "description": "Unique string identifier that corresponds to a slot in the referenced deck definition's locations",
-                            "type": "string"
-                        }
-                    }
-                },
-                {
-                    "required": ["moduleId"],
-                    "properties": {
-                        "moduleId": {
-                            "description": "Unique identifier of destination module. Must be a key from the top level 'modules' object.",
-                            "type": "string"
-                        }
-                    }
-                },
-                {
-                    "const": "offDeck",
-                    "description": "String literal 'offDeck'. Used to load a labware without placing it on the deck"
-                }
-            ]
-        }
-    },
-    "type": "object",
-    "additionalProperties": false,
-    "required": [
-        "$otSharedSchema",
-        "schemaVersion",
-        "metadata",
-        "robot",
-        "labwareDefinitions",
-        "commands"
-    ],
-    "properties": {
-        "$otSharedSchema": {
-            "description": "The path to a valid Opentrons shared schema relative to the shared-data directory, without its extension.",
-            "enum": ["#/protocol/schemas/7"]
-        },
-        "schemaVersion": {
-            "description": "Schema version of a protocol is a single integer",
-            "enum": [7]
-        },
-        "metadata": {
-            "description": "Optional metadata about the protocol",
-            "type": "object",
-            "properties": {
-                "protocolName": {
-                    "description": "A short, human-readable name for the protocol",
-                    "type": "string"
-                },
-                "author": {
-                    "description": "The author or organization who created the protocol",
-                    "type": "string"
-                },
-                "description": {
-                    "description": "A text description of the protocol.",
-                    "type": ["string", "null"]
-                },
-                "created": {
-                    "description": "UNIX timestamp when this file was created",
-                    "type": "number"
-                },
-                "lastModified": {
-                    "description": "UNIX timestamp when this file was last modified",
-                    "type": ["number", "null"]
-                },
-                "category": {
-                    "description": "Category of protocol (eg, \"Basic Pipetting\")",
-                    "type": ["string", "null"]
-                },
-                "subcategory": {
-                    "description": "Subcategory of protocol (eg, \"Cell Plating\")",
-                    "type": ["string", "null"]
-                },
-                "tags": {
-                    "description": "Tags to be used in searching for this protocol",
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
-        },
-        "designerApplication": {
-            "description": "Optional data & metadata not required to execute the protocol, used by the application that created this protocol",
-            "type": "object",
-            "properties": {
-                "name": {
-                    "description": "Name of the application that created the protocol. Should be namespaced under the organization or individual who owns the organization, eg \"opentrons/protocol-designer\"",
-                    "type": "string"
-                },
-                "version": {
-                    "description": "Version of the application that created the protocol",
-                    "type": "string"
-                },
-                "data": {
-                    "description": "Any data used by the application that created this protocol",
-                    "type": "object"
-                }
-            }
-        },
-        "robot": {
-            "required": ["model", "deckId"],
-            "properties": {
-                "model": {
-                    "description": "Model of the robot this protocol is written for",
-                    "type": "string",
-                    "enum": ["OT-2 Standard", "OT-3 Standard"]
-                },
-                "deckId": {
-                    "description": "Identifier of physical deck this protocol is written for. This should match a top-level key in shared-data/deck/definitions/3.json",
-                    "type": "string"
-                }
-            }
-        },
-        "labwareDefinitions": {
-            "description": "All labware definitions used by labware in this protocol, keyed by a unique identifier (definitionId)",
-            "patternProperties": {
-                ".+": {
-                    "$ref": "opentronsLabwareSchemaV2"
-                }
-            }
-        },
-        "liquids": {
-            "description": "All instances of liquid used in this protocol, keyed by a unique identifier (liquidId)",
-            "patternProperties": {
-                ".+": {
-                    "description": "Fields describing a single liquid",
-                    "type": "object",
-                    "required": ["displayName", "description"],
-                    "properties": {
-                        "displayName": {
-                            "description": "An human-readable name for this liquid.",
-                            "type": "string"
-                        },
-                        "description": {
-                            "description": "A description of this liquid.",
-                            "type": "string"
-                        },
-                        "displayColor": {
-                            "description": "Hex color code, with hash included, to represent the specified liquid. Standard three-value, four-value, six-value, and eight-value syntax are all acceptable.",
-                            "type": "string"
-                        }
-                    }
-                }
-            }
-        },
-        "commands": {
-            "description": "An array of command objects representing steps to be executed on the robot.",
-            "type": "array",
-            "items": { "$ref": "opentronsCommandSchemaV7" }
-        },
-        "commandAnnotations": {
-            "type": "array",
-            "items": {
-                "description": "An optional object of annotations associated with commands.",
-                "type": "object",
-                "required": ["commandIds", "annotationType"],
-                "properties": {
-                    "commandIds": {
-                        "description": "An array of command ids that correspond to the targeted grouping of this annotation",
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        }
-                    },
-                    "annotationType": {
-                        "description": "The type of annotation (e.g. 'transfer', 'initialSetup')",
-                        "type": "string"
-                    },
-                    "params": {
-                        "description": "The parameters used to create this grouping of atomic commands",
-                        "type": "object"
-                    }
-                }
-            }
-        }
-    }
-}

package/lib/protocol/schemas/8.json

@@ -1,141 +0,0 @@
-{
-    "$id": "opentronsProtocolSchemaV8",
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {},
-    "type": "object",
-    "additionalProperties": false,
-    "required": [
-        "$otSharedSchema",
-        "schemaVersion",
-        "metadata",
-        "robot",
-        "labwareDefinitions",
-        "labwareDefinitionSchemaId",
-        "commands",
-        "commandSchemaId",
-        "commandAnnotations",
-        "commandAnnotationSchemaId",
-        "liquids",
-        "liquidSchemaId"
-    ],
-    "properties": {
-        "$otSharedSchema": {
-            "description": "The path to a valid Opentrons shared schema relative to the shared-data directory, without its extension.",
-            "enum": ["#/protocol/schemas/8"]
-        },
-        "schemaVersion": {
-            "description": "Schema version of a protocol is a single integer",
-            "enum": [8]
-        },
-        "metadata": {
-            "description": "Optional metadata about the protocol",
-            "type": "object",
-            "properties": {
-                "protocolName": {
-                    "description": "A short, human-readable name for the protocol",
-                    "type": "string"
-                },
-                "author": {
-                    "description": "The author or organization who created the protocol",
-                    "type": "string"
-                },
-                "description": {
-                    "description": "A text description of the protocol.",
-                    "type": ["string", "null"]
-                },
-                "created": {
-                    "description": "UNIX timestamp when this file was created",
-                    "type": "number"
-                },
-                "lastModified": {
-                    "description": "UNIX timestamp when this file was last modified",
-                    "type": ["number", "null"]
-                },
-                "category": {
-                    "description": "Category of protocol (eg, \"Basic Pipetting\")",
-                    "type": ["string", "null"]
-                },
-                "subcategory": {
-                    "description": "Subcategory of protocol (eg, \"Cell Plating\")",
-                    "type": ["string", "null"]
-                },
-                "tags": {
-                    "description": "Tags to be used in searching for this protocol",
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
-        },
-        "designerApplication": {
-            "description": "Optional data & metadata not required to execute the protocol, used by the application that created this protocol",
-            "type": "object",
-            "properties": {
-                "name": {
-                    "description": "Name of the application that created the protocol. Should be namespaced under the organization or individual who owns the organization, eg \"opentrons/protocol-designer\"",
-                    "type": "string"
-                },
-                "version": {
-                    "description": "Version of the application that created the protocol",
-                    "type": "string"
-                },
-                "data": {
-                    "description": "Any data used by the application that created this protocol",
-                    "type": "object"
-                }
-            }
-        },
-        "robot": {
-            "required": ["model", "deckId"],
-            "properties": {
-                "model": {
-                    "description": "Model of the robot this protocol is written for",
-                    "type": "string",
-                    "enum": ["OT-2 Standard", "OT-3 Standard"]
-                },
-                "deckId": {
-                    "description": "Identifier of physical deck this protocol is written for. This should match a definition in the shared-data directory matching the schema id",
-                    "type": "string"
-                }
-            }
-        },
-        "labwareDefinitionSchemaId": {
-            "description": "The schema to use for labware definitions.",
-            "type": "string"
-        },
-        "labwareDefinitions": {
-            "description": "All labware definitions used by labware in this protocol, keyed by a unique identifier (definitionId)",
-            "patternProperties": {
-                ".+": { "type": "object" }
-            }
-        },
-        "liquidSchemaId": {
-            "description": "The schema to use for liquid definitions.",
-            "type": "string"
-        },
-        "liquids": {
-            "description": "All instances of liquid used in this protocol, keyed by a unique identifier (liquidId)",
-            "patternProperties": {
-                ".+": { "type": "object" }
-            }
-        },
-        "commandSchemaId": {
-            "description": "The schema to which the commands adhere.",
-            "type": "string"
-        },
-        "commands": {
-            "description": "An array of command objects representing steps to be executed on the robot.",
-            "type": "array",
-            "items": { "type": "object" }
-        },
-        "commandAnnotationSchemaId": {
-            "description": "The schema to which the command annotations adhere.",
-            "type": "string"
-        },
-        "commandAnnotations": {
-            "type": "array",
-            "items": { "type": "object" }
-        }
-    }
-}

package/lib/protocol/types/schemaV1.d.ts

@@ -1,89 +0,0 @@
-import type { DeckSlotId, PipetteMount as Mount } from '../../js/types';
-export interface PipetteLabwareFields {
-    pipette: string;
-    labware: string;
-    well: string;
-}
-export interface AspirateDispenseArgs extends PipetteLabwareFields {
-    volume: number;
-    offsetFromBottomMm?: number | null;
-    'flow-rate'?: number | null;
-}
-export type Command = {
-    command: 'aspirate' | 'dispense';
-    params: AspirateDispenseArgs;
-} | {
-    command: 'pick-up-tip' | 'drop-tip' | 'blowout';
-    params: PipetteLabwareFields;
-} | {
-    command: 'touch-tip';
-    params: PipetteLabwareFields & {
-        offsetFromBottomMm?: number | null;
-    };
-} | {
-    command: 'delay';
-    /** number of seconds to delay (fractional values OK),
-or `true` for delay until user input */
-    params: {
-        wait: number | true;
-        message: string | null | undefined;
-    };
-} | {
-    command: 'air-gap';
-    params: {
-        pipette: string;
-        volume: number;
-    };
-};
-type VersionString = string;
-type PipetteModel = string;
-type PipetteName = string;
-export interface FilePipette {
-    mount: Mount;
-    model: PipetteModel;
-    name?: PipetteName;
-}
-export interface FileLabware {
-    slot: DeckSlotId;
-    model: string;
-    'display-name'?: string;
-}
-type FlowRateForPipettes = Record<PipetteModel, number>;
-export interface ProtocolFile<DesignerApplicationData> {
-    'protocol-schema': VersionString;
-    metadata: {
-        'protocol-name'?: string;
-        author?: string;
-        description?: string;
-        created?: number;
-        'last-modified'?: number | null;
-        category?: string | null;
-        subcategory?: string | null;
-        tags?: string[];
-    };
-    'default-values': {
-        'aspirate-flow-rate': FlowRateForPipettes;
-        'dispense-flow-rate': FlowRateForPipettes;
-        'aspirate-mm-from-bottom': number;
-        'dispense-mm-from-bottom': number;
-        'touch-tip-mm-from-top'?: number;
-    };
-    'designer-application': {
-        'application-name': string;
-        'application-version': string | null | undefined;
-        data: DesignerApplicationData;
-    };
-    robot: {
-        model: 'OT-2 Standard';
-    };
-    pipettes: Record<string, FilePipette>;
-    labware: Record<string, FileLabware>;
-    procedure: Array<{
-        annotation: {
-            name: string;
-            description: string;
-        };
-        subprocedure: Command[];
-    }>;
-}
-export {};

package/lib/protocol/types/schemaV3.d.ts

@@ -1,100 +0,0 @@
-import { PipetteName } from '../../js';
-import type { DeckSlotId, LabwareDefinition2, PipetteMount as Mount } from '../../js/types';
-export interface FilePipette {
-    mount: Mount;
-    name: PipetteName;
-}
-export interface FileLabware {
-    slot: DeckSlotId;
-    definitionId: string;
-    displayName?: string;
-}
-interface FlowRateParams {
-    flowRate: number;
-}
-export interface PipetteAccessParams {
-    pipette: string;
-    labware: string;
-    well: string;
-}
-interface VolumeParams {
-    volume: number;
-}
-interface OffsetParams {
-    offsetFromBottomMm: number;
-}
-export type AspDispAirgapParams = FlowRateParams & PipetteAccessParams & VolumeParams & OffsetParams & {
-    isAirGap?: boolean;
-};
-export type AspirateParams = AspDispAirgapParams;
-export type DispenseParams = AspDispAirgapParams;
-export type AirGapParams = AspDispAirgapParams;
-export type BlowoutParams = FlowRateParams & PipetteAccessParams & OffsetParams;
-export type TouchTipParams = PipetteAccessParams & OffsetParams;
-export type PickUpTipParams = PipetteAccessParams;
-export type DropTipParams = PipetteAccessParams;
-export interface MoveToSlotParams {
-    pipette: string;
-    slot: string;
-    offset?: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    minimumZHeight?: number;
-    forceDirect?: boolean;
-}
-export interface DelayParams {
-    wait: number | true;
-    message?: string;
-}
-export type Command = {
-    command: 'aspirate' | 'dispense' | 'airGap';
-    params: AspDispAirgapParams;
-} | {
-    command: 'blowout';
-    params: BlowoutParams;
-} | {
-    command: 'touchTip';
-    params: TouchTipParams;
-} | {
-    command: 'pickUpTip' | 'dropTip';
-    params: PipetteAccessParams;
-} | {
-    command: 'moveToSlot';
-    params: MoveToSlotParams;
-} | {
-    command: 'delay';
-    params: DelayParams;
-};
-export interface ProtocolFile<DesignerApplicationData> {
-    schemaVersion: 3;
-    metadata: {
-        protocolName?: string;
-        author?: string;
-        description?: string | null | undefined;
-        created?: number;
-        lastModified?: number | null | undefined;
-        category?: string | null | undefined;
-        subcategory?: string | null | undefined;
-        tags?: string[];
-    };
-    designerApplication?: {
-        name?: string;
-        version?: string;
-        data?: DesignerApplicationData;
-    };
-    robot: {
-        model: 'OT-2 Standard';
-    };
-    pipettes: Record<string, FilePipette>;
-    labwareDefinitions: Record<string, LabwareDefinition2>;
-    labware: Record<string, {
-        slot: string;
-        definitionId: string;
-        displayName?: string;
-    }>;
-    commands: Command[];
-    commandAnnotations?: Record<string, any>;
-}
-export {};