@opentrons/shared-data 0.0.0-alpha.2

package/protocol/types/schemaV6/command/module.ts

@@ -0,0 +1,302 @@
+import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
+
+export type ModuleRunTimeCommand =
+  | MagneticModuleEngageMagnetRunTimeCommand
+  | MagneticModuleDisengageRunTimeCommand
+  | TemperatureModuleSetTargetTemperatureRunTimeCommand
+  | TemperatureModuleDeactivateRunTimeCommand
+  | TemperatureModuleAwaitTemperatureRunTimeCommand
+  | TCSetTargetBlockTemperatureRunTimeCommand
+  | TCSetTargetLidTemperatureRunTimeCommand
+  | TCWaitForBlockTemperatureRunTimeCommand
+  | TCWaitForLidTemperatureRunTimeCommand
+  | TCOpenLidRunTimeCommand
+  | TCCloseLidRunTimeCommand
+  | TCDeactivateBlockRunTimeCommand
+  | TCDeactivateLidRunTimeCommand
+  | TCRunProfileRunTimeCommand
+  | TCAwaitProfileCompleteRunTimeCommand
+  | HeaterShakerSetTargetTemperatureRunTimeCommand
+  | HeaterShakerWaitForTemperatureRunTimeCommand
+  | HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand
+  | HeaterShakerOpenLatchRunTimeCommand
+  | HeaterShakerCloseLatchRunTimeCommand
+  | HeaterShakerDeactivateHeaterRunTimeCommand
+  | HeaterShakerDeactivateShakerRunTimeCommand
+
+export type ModuleCreateCommand =
+  | MagneticModuleEngageMagnetCreateCommand
+  | MagneticModuleDisengageCreateCommand
+  | TemperatureModuleSetTargetTemperatureCreateCommand
+  | TemperatureModuleDeactivateCreateCommand
+  | TemperatureModuleAwaitTemperatureCreateCommand
+  | TCSetTargetBlockTemperatureCreateCommand
+  | TCSetTargetLidTemperatureCreateCommand
+  | TCWaitForBlockTemperatureCreateCommand
+  | TCWaitForLidTemperatureCreateCommand
+  | TCOpenLidCreateCommand
+  | TCCloseLidCreateCommand
+  | TCDeactivateBlockCreateCommand
+  | TCDeactivateLidCreateCommand
+  | TCRunProfileCreateCommand
+  | TCAwaitProfileCompleteCreateCommand
+  | HeaterShakerWaitForTemperatureCreateCommand
+  | HeaterShakerSetAndWaitForShakeSpeedCreateCommand
+  | HeaterShakerOpenLatchCreateCommand
+  | HeaterShakerCloseLatchCreateCommand
+  | HeaterShakerDeactivateHeaterCreateCommand
+  | HeaterShakerDeactivateShakerCreateCommand
+  | HeaterShakerSetTargetTemperatureCreateCommand
+
+export interface MagneticModuleEngageMagnetCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'magneticModule/engage'
+  params: EngageMagnetParams
+}
+export interface MagneticModuleEngageMagnetRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    MagneticModuleEngageMagnetCreateCommand {
+  result?: any
+}
+export interface MagneticModuleDisengageCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'magneticModule/disengage'
+  params: ModuleOnlyParams
+}
+export interface MagneticModuleDisengageRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    MagneticModuleDisengageCreateCommand {
+  result?: any
+}
+export interface TemperatureModuleSetTargetTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'temperatureModule/setTargetTemperature'
+  params: TemperatureParams
+}
+export interface TemperatureModuleSetTargetTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TemperatureModuleSetTargetTemperatureCreateCommand {
+  result?: any
+}
+export interface TemperatureModuleDeactivateCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'temperatureModule/deactivate'
+  params: ModuleOnlyParams
+}
+export interface TemperatureModuleDeactivateRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TemperatureModuleDeactivateCreateCommand {
+  result?: any
+}
+export interface TemperatureModuleAwaitTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'temperatureModule/waitForTemperature'
+  params: TemperatureParams
+}
+export interface TemperatureModuleAwaitTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TemperatureModuleAwaitTemperatureCreateCommand {
+  result?: any
+}
+export interface TCSetTargetBlockTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/setTargetBlockTemperature'
+  params: ThermocyclerSetTargetBlockTemperatureParams
+}
+export interface TCSetTargetBlockTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCSetTargetBlockTemperatureCreateCommand {
+  result?: any
+}
+export interface TCSetTargetLidTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/setTargetLidTemperature'
+  params: TemperatureParams
+}
+export interface TCSetTargetLidTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCSetTargetLidTemperatureCreateCommand {
+  result?: any
+}
+export interface TCWaitForBlockTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/waitForBlockTemperature'
+  params: ModuleOnlyParams
+}
+export interface TCWaitForBlockTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCWaitForBlockTemperatureCreateCommand {
+  result?: any
+}
+export interface TCWaitForLidTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/waitForLidTemperature'
+  params: ModuleOnlyParams
+}
+export interface TCWaitForLidTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCWaitForLidTemperatureCreateCommand {
+  result?: any
+}
+export interface TCOpenLidCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/openLid'
+  params: ModuleOnlyParams
+}
+export interface TCOpenLidRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCOpenLidCreateCommand {
+  result?: any
+}
+export interface TCCloseLidCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/closeLid'
+  params: ModuleOnlyParams
+}
+export interface TCCloseLidRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCCloseLidCreateCommand {
+  result?: any
+}
+export interface TCDeactivateBlockCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/deactivateBlock'
+  params: ModuleOnlyParams
+}
+export interface TCDeactivateBlockRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCDeactivateBlockCreateCommand {
+  result?: any
+}
+export interface TCDeactivateLidCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/deactivateLid'
+  params: ModuleOnlyParams
+}
+export interface TCDeactivateLidRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCDeactivateLidCreateCommand {
+  result?: any
+}
+export interface TCRunProfileCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/runProfile'
+  params: TCProfileParams
+}
+export interface TCRunProfileRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCRunProfileCreateCommand {
+  result?: any
+}
+export interface TCAwaitProfileCompleteCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'thermocycler/awaitProfileComplete'
+  params: ModuleOnlyParams
+}
+export interface TCAwaitProfileCompleteRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    TCAwaitProfileCompleteCreateCommand {
+  result?: any
+}
+export interface HeaterShakerSetTargetTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'heaterShaker/setTargetTemperature'
+  params: TemperatureParams
+}
+export interface HeaterShakerSetTargetTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HeaterShakerSetTargetTemperatureCreateCommand {
+  result?: any
+}
+export interface HeaterShakerWaitForTemperatureCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'heaterShaker/waitForTemperature'
+  params: ModuleOnlyParams
+}
+export interface HeaterShakerWaitForTemperatureRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HeaterShakerWaitForTemperatureCreateCommand {
+  result?: any
+}
+export interface HeaterShakerSetAndWaitForShakeSpeedCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'heaterShaker/setAndWaitForShakeSpeed'
+  params: ShakeSpeedParams
+}
+export interface HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HeaterShakerSetAndWaitForShakeSpeedCreateCommand {
+  result?: any
+}
+export interface HeaterShakerDeactivateHeaterCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'heaterShaker/deactivateHeater'
+  params: ModuleOnlyParams
+}
+export interface HeaterShakerDeactivateHeaterRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HeaterShakerDeactivateHeaterCreateCommand {
+  result?: any
+}
+export interface HeaterShakerOpenLatchCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'heaterShaker/openLabwareLatch'
+  params: ModuleOnlyParams
+}
+export interface HeaterShakerOpenLatchRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HeaterShakerOpenLatchCreateCommand {
+  result?: any
+}
+export interface HeaterShakerCloseLatchCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'heaterShaker/closeLabwareLatch'
+  params: ModuleOnlyParams
+}
+export interface HeaterShakerCloseLatchRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HeaterShakerCloseLatchCreateCommand {
+  result?: any
+}
+export interface HeaterShakerDeactivateShakerCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'heaterShaker/deactivateShaker'
+  params: ModuleOnlyParams
+}
+export interface HeaterShakerDeactivateShakerRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HeaterShakerDeactivateShakerCreateCommand {
+  result?: any
+}
+
+export interface EngageMagnetParams {
+  moduleId: string
+  height: number
+}
+
+export interface TemperatureParams {
+  moduleId: string
+  celsius: number
+}
+export interface ShakeSpeedParams {
+  moduleId: string
+  rpm: number
+}
+
+export interface AtomicProfileStep {
+  holdSeconds: number
+  celsius: number
+}
+
+export interface TCProfileParams {
+  moduleId: string
+  profile: AtomicProfileStep[]
+  blockMaxVolumeUl?: number
+}
+
+export interface ModuleOnlyParams {
+  moduleId: string
+}
+
+export interface ThermocyclerSetTargetBlockTemperatureParams {
+  moduleId: string
+  celsius: number
+  volume?: number
+  holdTimeSeconds?: number
+}

package/protocol/types/schemaV6/command/pipetting.ts

@@ -0,0 +1,114 @@
+import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
+export type PipettingRunTimeCommand =
+  | AspirateRunTimeCommand
+  | DispenseRunTimeCommand
+  | BlowoutRunTimeCommand
+  | TouchTipRunTimeCommand
+  | PickUpTipRunTimeCommand
+  | DropTipRunTimeCommand
+export type PipettingCreateCommand =
+  | AspirateCreateCommand
+  | DispenseCreateCommand
+  | BlowoutCreateCommand
+  | TouchTipCreateCommand
+  | PickUpTipCreateCommand
+  | DropTipCreateCommand
+
+export interface AspirateCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'aspirate'
+  params: AspDispAirgapParams
+}
+export interface AspirateRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    AspirateCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+export interface DispenseCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'dispense'
+  params: AspDispAirgapParams
+}
+export interface DispenseRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    DispenseCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
+export interface BlowoutCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'blowout'
+  params: BlowoutParams
+}
+export interface BlowoutRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    BlowoutCreateCommand {
+  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 type AspDispAirgapParams = FlowRateParams &
+  PipetteAccessParams &
+  VolumeParams &
+  WellLocationParam
+export type BlowoutParams = FlowRateParams &
+  PipetteAccessParams &
+  WellLocationParam
+export type TouchTipParams = PipetteAccessParams & WellLocationParam
+export type DropTipParams = TouchTipParams
+export type PickUpTipParams = TouchTipParams
+
+interface FlowRateParams {
+  flowRate: number // µL/s
+}
+
+interface PipetteAccessParams {
+  pipetteId: string
+  labwareId: string
+  wellName: string
+}
+
+interface VolumeParams {
+  volume: number // µL
+}
+
+interface WellLocationParam {
+  wellLocation?: {
+    // default value is 'top'
+    // value of 'default' is only valid for drop tip commands
+    origin?: 'top' | 'bottom' | 'center' | 'default'
+    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/protocol/types/schemaV6/command/setup.ts

@@ -0,0 +1,127 @@
+import type {
+  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 type SetupRunTimeCommand =
+  | LoadPipetteRunTimeCommand
+  | LoadLabwareRunTimeCommand
+  | LoadModuleRunTimeCommand
+  | LoadLiquidRunTimeCommand
+  | MoveLabwareRunTimeCommand
+export type SetupCreateCommand =
+  | LoadPipetteCreateCommand
+  | LoadLabwareCreateCommand
+  | LoadModuleCreateCommand
+  | LoadLiquidCreateCommand
+  | MoveLabwareCreateCommand
+
+export type LabwareLocation =
+  | { slotName: string }
+  | { moduleId: string }
+  | 'offDeck'
+
+export type LabwareMovementStrategy =
+  | 'usingGripper'
+  | 'manualMoveWithPause'
+  | 'manualMoveWithoutPause'
+
+export interface ModuleLocation {
+  slotName: string
+}
+interface LoadPipetteParams {
+  pipetteId: string
+  mount: 'left' | 'right'
+}
+interface LoadPipetteResult {
+  pipetteId: string
+}
+interface LoadLabwareParams {
+  labwareId: string
+  location: LabwareLocation
+  displayName?: string
+}
+interface LoadLabwareResult {
+  labwareId: string
+  definition: LabwareDefinition2
+  offset: LabwareOffset
+}
+export interface MoveLabwareParams {
+  labwareId: string
+  newLocation: LabwareLocation
+  strategy: LabwareMovementStrategy
+}
+interface MoveLabwareResult {
+  offsetId: string
+}
+interface LoadModuleParams {
+  moduleId: string
+  location: ModuleLocation
+}
+interface LoadModuleResult {
+  moduleId: string
+}
+interface LoadLiquidParams {
+  liquidId: string
+  labwareId: string
+  volumeByWell: { [wellName: string]: number }
+}
+interface LoadLiquidResult {
+  liquidId: string
+}

package/protocol/types/schemaV6/command/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 }