@opentrons/shared-data 0.0.0-alpha.14

package/protocol/types/schemaV4.ts

@@ -0,0 +1,146 @@
+import type { DeckSlotId, ModuleModel } from '../../js/types'
+import type {
+  ProtocolFile as V3ProtocolFile,
+  AspDispAirgapParams,
+  BlowoutParams,
+  TouchTipParams,
+  PipetteAccessParams,
+  MoveToSlotParams,
+  DelayParams,
+} from './schemaV3'
+
+export type { BlowoutParams, FilePipette, FileLabware } from './schemaV3'
+
+export interface FileModule {
+  slot: DeckSlotId
+  model: ModuleModel
+}
+
+export interface EngageMagnetParams {
+  module: string
+  engageHeight: number
+}
+
+export interface TemperatureParams {
+  module: string
+  temperature: number
+}
+
+export interface AtomicProfileStep {
+  holdTime: number
+  temperature: number
+}
+
+export interface TCProfileParams {
+  module: string
+  profile: AtomicProfileStep[]
+  volume: number
+}
+
+export interface ModuleOnlyParams {
+  module: string
+}
+
+export interface ThermocyclerSetBlockTemperatureArgs {
+  module: string
+  temperature: number
+  volume?: number
+}
+
+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
+    }
+  | {
+      command: 'magneticModule/engageMagnet'
+      params: EngageMagnetParams
+    }
+  | {
+      command: 'magneticModule/disengageMagnet'
+      params: ModuleOnlyParams
+    }
+  | {
+      command: 'temperatureModule/setTargetTemperature'
+      params: TemperatureParams
+    }
+  | {
+      command: 'temperatureModule/deactivate'
+      params: ModuleOnlyParams
+    }
+  | {
+      command: 'temperatureModule/awaitTemperature'
+      params: TemperatureParams
+    }
+  | {
+      command: 'thermocycler/setTargetBlockTemperature'
+      params: ThermocyclerSetBlockTemperatureArgs
+    }
+  | {
+      command: 'thermocycler/setTargetLidTemperature'
+      params: TemperatureParams
+    }
+  | {
+      command: 'thermocycler/awaitBlockTemperature'
+      params: TemperatureParams
+    }
+  | {
+      command: 'thermocycler/awaitLidTemperature'
+      params: TemperatureParams
+    }
+  | {
+      command: 'thermocycler/openLid'
+      params: ModuleOnlyParams
+    }
+  | {
+      command: 'thermocycler/closeLid'
+      params: ModuleOnlyParams
+    }
+  | {
+      command: 'thermocycler/deactivateBlock'
+      params: ModuleOnlyParams
+    }
+  | {
+      command: 'thermocycler/deactivateLid'
+      params: ModuleOnlyParams
+    }
+  | {
+      command: 'thermocycler/runProfile'
+      params: TCProfileParams
+    }
+  | {
+      command: 'thermocycler/awaitProfileComplete'
+      params: ModuleOnlyParams
+    }
+
+// NOTE: must be kept in sync with '../schemas/4.json'
+export interface ProtocolFile<DesignerApplicationData>
+  extends Omit<
+    V3ProtocolFile<DesignerApplicationData>,
+    'schemaVersion' | 'commands'
+  > {
+  $otSharedSchema: '#/protocol/schemas/4'
+  schemaVersion: 4
+  modules: Record<string, FileModule>
+  commands: Command[]
+}

package/protocol/types/schemaV5.ts

@@ -0,0 +1,34 @@
+import type { ProtocolFile as V3ProtocolFile } from './schemaV3'
+import type { Command as V4Command, FileModule } from './schemaV4'
+
+export interface MoveToWellParams {
+  pipette: string
+  labware: string
+  well: string
+  offset?: {
+    x: number
+    y: number
+    z: number
+  }
+  minimumZHeight?: number
+  forceDirect?: boolean
+}
+
+export type Command =
+  | V4Command
+  | {
+      command: 'moveToWell'
+      params: MoveToWellParams
+    }
+
+// NOTE: must be kept in sync with '../schemas/5.json'
+export interface ProtocolFile<DesignerApplicationData>
+  extends Omit<
+    V3ProtocolFile<DesignerApplicationData>,
+    'schemaVersion' | 'commands'
+  > {
+  $otSharedSchema: '#/protocol/schemas/5'
+  schemaVersion: 5
+  modules: Record<string, FileModule>
+  commands: Command[]
+}

package/protocol/types/schemaV5Addendum.ts

@@ -0,0 +1,27 @@
+/* NOTE: this file is only necessary until step-generation and protocol-designer
+ * implement protocol schema V6. This file was orginally created when it was decided
+ * that certain features of V6 schema were needed, but the actual making of said schema
+ * was punted. Now that schema V6 does exist, this intermediate type that SG and PD support
+ * can be phased out as the two are updated to the V6 schema support.
+ */
+
+import type { ProtocolFile as V3ProtocolFile, AirGapParams } from './schemaV3'
+import type { FileModule } from './schemaV4'
+import type { Command as V5Command } from './schemaV5'
+
+export type Command =
+  | V5Command
+  | {
+      command: 'dispenseAirGap'
+      params: AirGapParams
+    }
+
+// NOTE: must be kept in sync with '../schemas/5.json'
+export type ProtocolFile<
+  DesignerApplicationData
+> = V3ProtocolFile<DesignerApplicationData> & {
+  $otSharedSchema: '#/protocol/schemas/5'
+  schemaVersion: 5
+  modules: Record<string, FileModule>
+  commands: Command[]
+}

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

@@ -0,0 +1,146 @@
+import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
+import type { MotorAxis, Coordinates, MotorAxes } from '../../../../js/types'
+
+export interface MoveToSlotCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'moveToSlot'
+  params: MoveToSlotParams
+}
+export interface MoveToSlotRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    MoveToSlotCreateCommand {
+  result?: {}
+}
+export interface MoveToWellCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'moveToWell'
+  params: MoveToWellParams
+}
+export interface MoveToWellRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    MoveToWellCreateCommand {
+  result?: {}
+}
+export interface MoveToCoordinatesCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'moveToCoordinates'
+  params: MoveToCoordinatesParams
+}
+export interface MoveToCoordinatesRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    MoveToCoordinatesCreateCommand {
+  result?: {}
+}
+export interface MoveRelativeCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'moveRelative'
+  params: MoveRelativeParams
+}
+export interface MoveRelativeRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    MoveRelativeCreateCommand {
+  result?: {
+    position: Coordinates
+  }
+}
+export interface SavePositionCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'savePosition'
+  params: SavePositionParams
+}
+export interface SavePositionRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    SavePositionCreateCommand {
+  result?: {
+    positionId: string
+    position: Coordinates
+  }
+}
+export interface HomeCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'home'
+  params: HomeParams
+}
+export interface HomeRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    HomeCreateCommand {
+  result?: {}
+}
+export interface RetractAxisCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'retractAxis'
+  params: RetractAxisParams
+}
+export interface RetractAxisRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    RetractAxisCreateCommand {
+  result?: {}
+}
+export type GantryRunTimeCommand =
+  | MoveToSlotRunTimeCommand
+  | MoveToWellRunTimeCommand
+  | MoveToCoordinatesRunTimeCommand
+  | MoveRelativeRunTimeCommand
+  | SavePositionRunTimeCommand
+  | HomeRunTimeCommand
+  | RetractAxisRunTimeCommand
+export type GantryCreateCommand =
+  | MoveToSlotCreateCommand
+  | MoveToWellCreateCommand
+  | MoveToCoordinatesCreateCommand
+  | MoveRelativeCreateCommand
+  | SavePositionCreateCommand
+  | HomeCreateCommand
+  | RetractAxisCreateCommand
+
+interface MoveToSlotParams {
+  pipetteId: string
+  slotName: string
+  offset?: {
+    x: number
+    y: number
+    z: number
+  }
+  minimumZHeight?: number
+  forceDirect?: boolean
+}
+
+export interface MoveToWellParams {
+  pipetteId: string
+  labwareId: string
+  wellName: string
+  wellLocation?: {
+    origin?: 'top' | 'bottom'
+    offset?: {
+      x?: number
+      y?: number
+      z?: number
+    }
+  }
+  minimumZHeight?: number
+  forceDirect?: boolean
+}
+
+interface MoveToCoordinatesParams {
+  pipetteId: string
+  coordinates: {
+    x: number
+    y: number
+    z: number
+  }
+  minimumZHeight?: number
+  forceDirect?: boolean
+}
+
+interface MoveRelativeParams {
+  pipetteId: string
+  axis: 'x' | 'y' | 'z'
+  distance: number
+}
+
+interface SavePositionParams {
+  pipetteId: string // pipette to use in measurement
+  positionId?: string // position ID, auto-assigned if left blank
+}
+
+interface HomeParams {
+  axes?: MotorAxes
+}
+
+interface RetractAxisParams {
+  axis: MotorAxis
+}

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

@@ -0,0 +1,65 @@
+import type {
+  PipettingRunTimeCommand,
+  PipettingCreateCommand,
+} from './pipetting'
+import type { GantryRunTimeCommand, GantryCreateCommand } from './gantry'
+import type { ModuleRunTimeCommand, ModuleCreateCommand } from './module'
+import type { SetupRunTimeCommand, SetupCreateCommand } from './setup'
+import type { TimingRunTimeCommand, TimingCreateCommand } from './timing'
+
+export * from './pipetting'
+export * from './gantry'
+export * from './module'
+export * from './setup'
+export * from './timing'
+
+// NOTE: these key/value pairs will only be present on commands at analysis/run time
+// they pertain only to the actual execution status of a command on hardware, as opposed to
+// the command's identity and parameters which can be known prior to runtime
+
+export type CommandStatus = 'queued' | 'running' | 'succeeded' | 'failed'
+export interface CommonCommandRunTimeInfo {
+  key?: string
+  id: string
+  status: CommandStatus
+  error?: RunCommandError | null
+  createdAt: string
+  startedAt: string | null
+  completedAt: string | null
+  intent?: 'protocol' | 'setup'
+}
+export interface CommonCommandCreateInfo {
+  key?: string
+  meta?: { [key: string]: any }
+}
+
+export type CreateCommand =
+  | PipettingCreateCommand // involves the pipettes plunger motor
+  | GantryCreateCommand // movement that only effects the x,y,z position of the gantry/pipette
+  | ModuleCreateCommand // directed at a hardware module
+  | SetupCreateCommand // only effecting robot's equipment setup (pipettes, labware, modules, liquid), no hardware side-effects
+  | TimingCreateCommand // effecting the timing of command execution
+  | ({
+      commandType: 'custom'
+      params: { [key: string]: any }
+    } & CommonCommandCreateInfo) // allows for experimentation between schema versions with no expectation of system support
+
+// commands will be required to have a key, but will not be created with one
+export type RunTimeCommand =
+  | PipettingRunTimeCommand // involves the pipettes plunger motor
+  | GantryRunTimeCommand // movement that only effects the x,y,z position of the gantry/pipette
+  | ModuleRunTimeCommand // directed at a hardware module
+  | SetupRunTimeCommand // only effecting robot's equipment setup (pipettes, labware, modules, liquid), no hardware side-effects
+  | TimingRunTimeCommand // effecting the timing of command execution
+  | ({
+      commandType: 'custom'
+      params: { [key: string]: any }
+      result?: any
+    } & CommonCommandRunTimeInfo) // allows for experimentation between schema versions with no expectation of system support
+
+interface RunCommandError {
+  id: string
+  errorType: string
+  createdAt: string
+  detail: string
+}