@opentrons/shared-data 0.1.6-alpha.4 → 0.1.6-alpha.7

package/lib/command/types/setup.d.ts

@@ -0,0 +1,133 @@
+import type { AddressableAreaName, CommonCommandRunTimeInfo, CommonCommandCreateInfo, LabwareDefinition2, LabwareOffset, PipetteName, ModuleModel } from '../../js';
+export interface LoadPipetteCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'loadPipette';
+    params: LoadPipetteParams;
+}
+export interface LoadPipetteRunTimeCommand extends CommonCommandRunTimeInfo, Omit<LoadPipetteCreateCommand, 'params'> {
+    params: LoadPipetteParams & {
+        pipetteName: PipetteName;
+    };
+    result?: LoadPipetteResult;
+}
+export interface LoadLabwareCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'loadLabware';
+    params: LoadLabwareParams;
+}
+export interface LoadLabwareRunTimeCommand extends CommonCommandRunTimeInfo, LoadLabwareCreateCommand {
+    result?: LoadLabwareResult;
+}
+export interface MoveLabwareCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'moveLabware';
+    params: MoveLabwareParams;
+}
+export interface MoveLabwareRunTimeCommand extends CommonCommandRunTimeInfo, MoveLabwareCreateCommand {
+    result?: MoveLabwareResult;
+}
+export interface LoadModuleCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'loadModule';
+    params: LoadModuleParams;
+}
+export interface LoadModuleRunTimeCommand extends CommonCommandRunTimeInfo, Omit<LoadModuleCreateCommand, 'params'> {
+    params: LoadModuleParams & {
+        model: ModuleModel;
+    };
+    result?: LoadModuleResult;
+}
+export interface LoadLiquidCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'loadLiquid';
+    params: LoadLiquidParams;
+}
+export interface LoadLiquidRunTimeCommand extends CommonCommandRunTimeInfo, LoadLiquidCreateCommand {
+    result?: LoadLiquidResult;
+}
+export interface ConfigureNozzleLayoutCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'configureNozzleLayout';
+    params: ConfigureNozzleLayoutParams;
+}
+export interface ConfigureNozzleLayoutRunTimeCommand extends CommonCommandRunTimeInfo, ConfigureNozzleLayoutCreateCommand {
+    result?: {};
+}
+export type SetupRunTimeCommand = ConfigureNozzleLayoutRunTimeCommand | LoadPipetteRunTimeCommand | LoadLabwareRunTimeCommand | LoadModuleRunTimeCommand | LoadLiquidRunTimeCommand | MoveLabwareRunTimeCommand;
+export type SetupCreateCommand = ConfigureNozzleLayoutCreateCommand | LoadPipetteCreateCommand | LoadLabwareCreateCommand | LoadModuleCreateCommand | LoadLiquidCreateCommand | MoveLabwareCreateCommand;
+export type LabwareLocation = 'offDeck' | {
+    slotName: string;
+} | {
+    moduleId: string;
+} | {
+    labwareId: string;
+} | {
+    addressableAreaName: AddressableAreaName;
+};
+export type NonStackedLocation = 'offDeck' | {
+    slotName: string;
+} | {
+    moduleId: string;
+} | {
+    addressableAreaName: AddressableAreaName;
+};
+export interface ModuleLocation {
+    slotName: string;
+}
+export interface LoadPipetteParams {
+    pipetteName: string;
+    pipetteId: string;
+    mount: 'left' | 'right';
+}
+interface LoadPipetteResult {
+    pipetteId: string;
+}
+interface LoadLabwareParams {
+    location: LabwareLocation;
+    version: number;
+    namespace: string;
+    loadName: string;
+    displayName?: string;
+    labwareId?: string;
+}
+interface LoadLabwareResult {
+    labwareId: string;
+    definition: LabwareDefinition2;
+    offset: LabwareOffset;
+}
+export type LabwareMovementStrategy = 'usingGripper' | 'manualMoveWithPause' | 'manualMoveWithoutPause';
+export interface MoveLabwareParams {
+    labwareId: string;
+    newLocation: LabwareLocation;
+    strategy: LabwareMovementStrategy;
+}
+interface MoveLabwareResult {
+    offsetId: string;
+}
+interface LoadModuleParams {
+    moduleId?: string;
+    location: ModuleLocation;
+    model: ModuleModel;
+}
+interface LoadModuleResult {
+    moduleId: string;
+}
+interface LoadLiquidParams {
+    liquidId: string;
+    labwareId: string;
+    volumeByWell: {
+        [wellName: string]: number;
+    };
+}
+interface LoadLiquidResult {
+    liquidId: string;
+}
+export declare const COLUMN = "COLUMN";
+declare const SINGLE = "SINGLE";
+declare const ROW = "ROW";
+declare const QUADRANT = "QUADRANT";
+export declare const ALL = "ALL";
+export type NozzleConfigurationStyle = typeof COLUMN | typeof SINGLE | typeof ROW | typeof QUADRANT | typeof ALL;
+interface NozzleConfigurationParams {
+    primaryNozzle?: string;
+    style: NozzleConfigurationStyle;
+}
+interface ConfigureNozzleLayoutParams {
+    pipetteId: string;
+    configurationParams: NozzleConfigurationParams;
+}
+export {};

package/lib/command/types/timing.d.ts

@@ -0,0 +1,39 @@
+import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.';
+export type TimingCreateCommand = WaitForResumeCreateCommand | WaitForDurationCreateCommand | DeprecatedDelayCreateCommand;
+export type TimingRunTimeCommand = WaitForResumeRunTimeCommand | WaitForDurationRunTimeCommand | DeprecatedDelayRunTimeCommand;
+export interface WaitForResumeCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'waitForResume' | 'pause';
+    params: WaitForResumeParams;
+}
+export interface WaitForResumeRunTimeCommand extends CommonCommandRunTimeInfo, WaitForResumeCreateCommand {
+    result?: any;
+}
+interface WaitForResumeParams {
+    message?: string;
+}
+export interface WaitForDurationCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'waitForDuration';
+    params: WaitForDurationParams;
+}
+export interface WaitForDurationRunTimeCommand extends CommonCommandRunTimeInfo, WaitForDurationCreateCommand {
+    result?: any;
+}
+interface WaitForDurationParams {
+    seconds: number;
+    message?: string;
+}
+export interface DeprecatedDelayCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'delay';
+    params: DeprecatedDelayParams;
+}
+export interface DeprecatedDelayRunTimeCommand extends CommonCommandRunTimeInfo, DeprecatedDelayCreateCommand {
+    result?: {};
+}
+type DeprecatedDelayParams = {
+    waitForResume: true;
+    message?: string;
+} | {
+    seconds: number;
+    message?: string;
+};
+export {};

package/lib/commandAnnotation/schemas/1.json

@@ -0,0 +1,74 @@
+{
+    "$id": "opentronsCommandAnnotationSchemaV1#",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$defs": {
+        "baseAnnotation": {
+            "description": "Things all annotations have",
+            "type": "object",
+            "required": ["annotationType", "commandKeys"],
+            "properties": {
+                "commandKeys": {
+                    "type": "array",
+                    "items": {
+                        "description": "Command keys to which this annotation applies",
+                        "type": "string"
+                    }
+                },
+                "annotationType": {
+                    "description": "The type of annotation (for machine parsing)",
+                    "type": "string"
+                }
+            }
+        },
+        "secondOrderCommand": {
+            "description": "Annotates a group of atomic commands which were the direct result of a second order command (e.g. transfer, consolidate, mix)",
+            "allOf": [{ "$ref": "#/$defs/baseAnnotation" }],
+            "type": "object",
+            "required": [
+                "annotationType",
+                "commandKeys",
+                "params",
+                "machineReadableName"
+            ],
+            "properties": {
+                "annotationType": {
+                    "type": "string",
+                    "enum": ["secondOrderCommand"]
+                },
+                "params": {
+                    "description": "key value pairs of the parameters that were passed to the second order command that this annotates",
+                    "type": "object"
+                },
+                "machineReadableName": {
+                    "description": "The name of the second order command in the form that the generating software refers to it. (e.g. 'transfer', 'thermocyclerStep')",
+                    "type": "string"
+                },
+                "userSpecifiedName": {
+                    "description": "The optional user-specified name of the second order command",
+                    "type": "string"
+                },
+                "userSpecifiedDescription": {
+                    "description": "The optional user-specified description of the second order command",
+                    "type": "string"
+                }
+            }
+        },
+        "custom": {
+            "description": "Annotates a group of atomic commands in some manner that Opentrons software does not anticipate or originate",
+            "allOf": [{ "$ref": "#/$defs/baseAnnotation" }],
+            "type": "object",
+            "required": ["annotationType", "commandKeys"],
+            "properties": {
+                "annotationType": {
+                    "type": "string",
+                    "enum": ["custom"]
+                }
+            },
+            "additionalProperties": true
+        }
+    },
+    "oneOf": [
+        { "$ref": "#/$defs/secondOrderCommand" },
+        { "$ref": "#/$defs/custom" }
+    ]
+}

package/lib/commandAnnotation/types/index.d.ts

@@ -0,0 +1,19 @@
+interface SharedCommandAnnotationProperties {
+    commandKeys: string[];
+}
+export type CustomCommandAnnotation = SharedCommandAnnotationProperties & {
+    [key: string]: any;
+} & {
+    annotationType: 'custom';
+};
+export interface SecondOrderCommandAnnotation extends SharedCommandAnnotationProperties {
+    annotationType: 'secondOrderCommand';
+    machineReadableName: string;
+    params: {
+        [key: string]: any;
+    };
+    userSpecifiedName?: string;
+    userSpecifiedDescription?: string;
+}
+export type CommandAnnotation = SecondOrderCommandAnnotation | CustomCommandAnnotation;
+export {};