@opentrons/shared-data 0.0.0-alpha.14

package/command/types/pipetting.ts

@@ -0,0 +1,228 @@
+import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
+export type PipettingRunTimeCommand =
+  | AspirateInPlaceRunTimeCommand
+  | AspirateRunTimeCommand
+  | AspirateInPlaceRunTimeCommand
+  | BlowoutInPlaceRunTimeCommand
+  | BlowoutRunTimeCommand
+  | ConfigureForVolumeRunTimeCommand
+  | DispenseInPlaceRunTimeCommand
+  | DispenseRunTimeCommand
+  | DropTipInPlaceRunTimeCommand
+  | DropTipRunTimeCommand
+  | PickUpTipRunTimeCommand
+  | PrepareToAspirateRunTimeCommand
+  | TouchTipRunTimeCommand
+
+export type PipettingCreateCommand =
+  | AspirateCreateCommand
+  | AspirateInPlaceCreateCommand
+  | BlowoutCreateCommand
+  | BlowoutInPlaceCreateCommand
+  | ConfigureForVolumeCreateCommand
+  | DispenseCreateCommand
+  | DispenseInPlaceCreateCommand
+  | DropTipCreateCommand
+  | DropTipInPlaceCreateCommand
+  | PickUpTipCreateCommand
+  | PrepareToAspirateCreateCommand
+  | TouchTipCreateCommand
+
+export interface ConfigureForVolumeCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'configureForVolume'
+  params: ConfigureForVolumeParams
+}
+
+export interface ConfigureForVolumeParams {
+  pipetteId: string
+  volume: number
+}
+export interface ConfigureForVolumeRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    ConfigureForVolumeCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+export interface AspirateCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'aspirate'
+  params: AspDispAirgapParams
+}
+export interface AspirateRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    AspirateCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+
+export interface AspirateInPlaceCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'aspirateInPlace'
+  params: AspirateInPlaceParams
+}
+export interface AspirateInPlaceRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    AspirateInPlaceCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+
+export type DispenseParams = AspDispAirgapParams & { pushOut?: number }
+export interface DispenseCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'dispense'
+  params: DispenseParams
+}
+export interface DispenseRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    DispenseCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+
+export interface DispenseInPlaceCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'dispenseInPlace'
+  params: DispenseInPlaceParams
+}
+export interface DispenseInPlaceRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    DispenseInPlaceCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+
+export interface BlowoutCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'blowout'
+  params: BlowoutParams
+}
+export interface BlowoutRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    BlowoutCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+export interface BlowoutInPlaceCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'blowOutInPlace'
+  params: BlowoutInPlaceParams
+}
+export interface BlowoutInPlaceRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    BlowoutInPlaceCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+
+export interface TouchTipCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'touchTip'
+  params: TouchTipParams
+}
+export interface TouchTipRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TouchTipCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+export interface PickUpTipCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'pickUpTip'
+  params: PickUpTipParams
+}
+export interface PickUpTipRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    PickUpTipCreateCommand {
+  result?: any
+}
+export interface DropTipCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'dropTip'
+  params: DropTipParams
+}
+export interface DropTipRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    DropTipCreateCommand {
+  result?: any
+}
+export interface DropTipInPlaceCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'dropTipInPlace'
+  params: DropTipInPlaceParams
+}
+export interface DropTipInPlaceRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    DropTipInPlaceCreateCommand {
+  result?: any
+}
+
+export interface PrepareToAspirateCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'prepareToAspirate'
+  params: PipetteIdentityParams
+}
+
+export interface PrepareToAspirateRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    PrepareToAspirateCreateCommand {
+  result?: any
+}
+
+export type AspDispAirgapParams = FlowRateParams &
+  PipetteAccessParams &
+  VolumeParams &
+  WellLocationParam
+export type BlowoutParams = FlowRateParams &
+  PipetteAccessParams &
+  WellLocationParam
+export type TouchTipParams = PipetteAccessParams & WellLocationParam
+export type DropTipParams = PipetteAccessParams & {
+  wellLocation?: {
+    origin?: 'default' | 'top' | 'center' | 'bottom'
+    offset?: {
+      // mm values all default to 0
+      x?: number
+      y?: number
+      z?: number
+    }
+  }
+}
+export type PickUpTipParams = TouchTipParams
+export interface DropTipInPlaceParams {
+  pipetteId: string
+}
+export interface BlowoutInPlaceParams {
+  pipetteId: string
+  flowRate: number // µL/s
+}
+
+export interface DispenseInPlaceParams {
+  pipetteId: string
+  volume: number
+  flowRate: number // µL/s
+  pushOut?: number
+}
+
+export interface AspirateInPlaceParams {
+  pipetteId: string
+  volume: number
+  flowRate: number // µL/s
+}
+interface FlowRateParams {
+  flowRate: number // µL/s
+}
+
+interface PipetteIdentityParams {
+  pipetteId: string
+}
+
+interface PipetteAccessParams extends PipetteIdentityParams {
+  labwareId: string
+  wellName: string
+}
+
+interface VolumeParams {
+  volume: number // µL
+}
+
+interface WellLocationParam {
+  wellLocation?: {
+    // default value is 'top'
+    origin?: 'top' | 'center' | 'bottom'
+    offset?: {
+      // mm
+      // all values default to 0
+      x?: number
+      y?: number
+      z?: number
+    }
+  }
+}
+
+interface BasicLiquidHandlingResult {
+  volume: number // Amount of liquid in uL handled in the operation
+}

package/command/types/setup.ts

@@ -0,0 +1,199 @@
+import type {
+  CommonCommandRunTimeInfo,
+  CommonCommandCreateInfo,
+  LabwareDefinition2,
+  LabwareOffset,
+  PipetteName,
+  ModuleModel,
+  Cutout,
+} 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
+}
+//  TODO(jr, 10/31/23): update `loadFixture` to `loadAddressableArea`
+export interface LoadFixtureCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'loadFixture'
+  params: LoadFixtureParams
+}
+export interface LoadFixtureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    LoadFixtureCreateCommand {
+  result?: LoadLabwareResult
+}
+
+export interface ConfigureNozzleLayoutCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'configureNozzleLayout'
+  params: ConfigureNozzleLayoutParams
+}
+
+export interface ConfigureNozzleLayoutRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    ConfigureNozzleLayoutCreateCommand {
+  result?: {}
+}
+
+export type SetupRunTimeCommand =
+  | ConfigureNozzleLayoutRunTimeCommand
+  | LoadPipetteRunTimeCommand
+  | LoadLabwareRunTimeCommand
+  | LoadFixtureRunTimeCommand
+  | LoadModuleRunTimeCommand
+  | LoadLiquidRunTimeCommand
+  | MoveLabwareRunTimeCommand
+
+export type SetupCreateCommand =
+  | ConfigureNozzleLayoutCreateCommand
+  | LoadPipetteCreateCommand
+  | LoadLabwareCreateCommand
+  | LoadFixtureCreateCommand
+  | LoadModuleCreateCommand
+  | LoadLiquidCreateCommand
+  | MoveLabwareCreateCommand
+
+export type LabwareLocation =
+  | 'offDeck'
+  | { slotName: string }
+  | { moduleId: string }
+  | { labwareId: string }
+  | { addressableAreaName: string }
+
+export type NonStackedLocation =
+  | 'offDeck'
+  | { slotName: string }
+  | { moduleId: string }
+  | { addressableAreaName: string }
+
+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
+}
+
+interface LoadFixtureParams {
+  location: { cutout: Cutout }
+  loadName: string
+  fixtureId?: string
+}
+
+const COLUMN = 'COLUMN'
+const SINGLE = 'SINGLE'
+const ROW = 'ROW'
+const QUADRANT = 'QUADRANT'
+const EMPTY = 'EMPTY'
+
+export type NozzleConfigurationStyle =
+  | typeof COLUMN
+  | typeof SINGLE
+  | typeof ROW
+  | typeof QUADRANT
+  | typeof EMPTY
+
+interface NozzleConfigurationParams {
+  primary_nozzle: string
+  style: NozzleConfigurationStyle
+}
+
+interface ConfigureNozzleLayoutParams {
+  pipetteId: string
+  configuration_params: NozzleConfigurationParams
+}

package/command/types/timing.ts

@@ -0,0 +1,58 @@
+import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
+
+export type TimingCreateCommand =
+  | WaitForResumeCreateCommand
+  | WaitForDurationCreateCommand
+  | DeprecatedDelayCreateCommand
+
+export type TimingRunTimeCommand =
+  | WaitForResumeRunTimeCommand
+  | WaitForDurationRunTimeCommand
+  | DeprecatedDelayRunTimeCommand
+
+export interface WaitForResumeCreateCommand extends CommonCommandCreateInfo {
+  // NOTE: `pause` accepted for backwards compatibility
+  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 }

package/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/commandAnnotation/types/index.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