@opentrons/shared-data 0.1.6-alpha.8 → 0.1.7-alpha.0

package/command/schemas/7.json

@@ -1297,7 +1297,8 @@
         "p1000_single_gen2",
         "p1000_single_flex",
         "p1000_multi_flex",
-        "p1000_96"
+        "p1000_96",
+        "p200_96"
       ],
       "type": "string"
     },

package/command/types/annotation.ts

@@ -17,7 +17,7 @@ export interface CommentRunTimeCommand
   result?: any
 }
 
-interface CommentParams {
+export interface CommentParams {
   message: string
 }
 

package/command/types/gantry.ts

@@ -163,7 +163,7 @@ interface RetractAxisParams {
   axis: MotorAxis
 }
 
-interface AddressableOffsetVector {
+export interface AddressableOffsetVector {
   x: number
   y: number
   z: number

package/command/types/index.ts

@@ -30,7 +30,7 @@ export * from './pipetting'
 export * from './setup'
 export * from './timing'
 export * from './unsafe'
-
+export * from './support'
 // 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

package/command/types/module.ts

@@ -1,4 +1,6 @@
 import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
+import type { LabwareLocationSequence } from './setup'
+import type { LabwareDefinition2 } from '../../js'
 
 export type ModuleRunTimeCommand =
   | MagneticModuleEngageMagnetRunTimeCommand
@@ -28,6 +30,11 @@ export type ModuleRunTimeCommand =
   | AbsorbanceReaderCloseLidRunTimeCommand
   | AbsorbanceReaderInitializeRunTimeCommand
   | AbsorbanceReaderReadRunTimeCommand
+  | FlexStackerSetStoredLabwareRunTimeCommand
+  | FlexStackerRetrieveRunTimeCommand
+  | FlexStackerStoreRunTimeCommand
+  | FlexStackerFillRunTimeCommand
+  | FlexStackerEmptyRunTimeCommand
 
 export type ModuleCreateCommand =
   | MagneticModuleEngageMagnetCreateCommand
@@ -57,6 +64,11 @@ export type ModuleCreateCommand =
   | AbsorbanceReaderCloseLidCreateCommand
   | AbsorbanceReaderInitializeCreateCommand
   | AbsorbanceReaderReadCreateCommand
+  | FlexStackerSetStoredLabwareCreateCommand
+  | FlexStackerRetrieveCreateCommand
+  | FlexStackerStoreCreateCommand
+  | FlexStackerFillCreateCommand
+  | FlexStackerEmptyCreateCommand
 
 export interface MagneticModuleEngageMagnetCreateCommand
   extends CommonCommandCreateInfo {
@@ -327,7 +339,7 @@ export interface AbsorbanceReaderInitializeCreateCommand
 export interface AbsorbanceReaderReadCreateCommand
   extends CommonCommandCreateInfo {
   commandType: 'absorbanceReader/read'
-  params: ModuleOnlyParams
+  params: { moduleId: string; fileName?: string | null }
 }
 export interface EngageMagnetParams {
   moduleId: string
@@ -380,3 +392,134 @@ export interface TCExtendedProfileParams {
   profileElements: Array<TCProfileCycle | AtomicProfileStep>
   blockMaxVolumeUl?: number
 }
+
+export interface FlexStackerStoredLabwareDetails {
+  loadName: string
+  namespace: string
+  version: number
+}
+
+export interface FlexStackerSetStoredLabwareCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'flexStacker/setStoredLabware'
+  params: {
+    moduleId: string
+    initialCount: number
+    primaryLabware: FlexStackerStoredLabwareDetails
+    lidLabware: FlexStackerStoredLabwareDetails | null
+    adapterLabware: FlexStackerStoredLabwareDetails | null
+  }
+}
+
+export interface FlexStackerSetStoredLabwareRunTimeCommand
+  extends FlexStackerSetStoredLabwareCreateCommand,
+    CommonCommandRunTimeInfo {
+  result?: {
+    primaryLabwareDefinition: LabwareDefinition2
+    lidLabwareDefinition?: LabwareDefinition2 | null
+    adapterLabwareDefinition?: LabwareDefinition2 | null
+    count: number
+  }
+}
+
+export interface FlexStackerRetrieveCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'flexStacker/retrieve'
+  params: {
+    moduleId: string
+  }
+}
+
+export interface FlexStackerStoreCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'flexStacker/store'
+  params: { moduleId: string }
+}
+
+export interface FlexStackerFillCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'flexStacker/fill'
+  params: {
+    moduleId: string
+    strategy: 'manualWithPause' | 'logical'
+    message?: string
+    count?: number
+  }
+}
+
+export interface FlexStackerEmptyCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'flexStacker/empty'
+  params: {
+    moduleId: string
+    strategy: 'manualWithPause' | 'logical'
+    message?: string
+    count?: number
+  }
+}
+interface RetrieveResultPrimary {
+  labwareId: string
+  primaryLocationSequence: LabwareLocationSequence
+  primaryLabwareURI: string
+}
+
+interface RetrieveResultNoLid {
+  lidId?: null
+  lidLocationSequence?: null
+  lidLabwareURI?: null
+}
+
+interface RetrieveResultLid {
+  lidId: string
+  lidLocationSequence: LabwareLocationSequence
+  lidLabwareURI: string
+}
+
+interface RetrieveResultAdapter {
+  adapterId: string
+  adapterLocationSequence: LabwareLocationSequence
+  adapterLabwareURI: string
+}
+
+interface RetrieveResultNoAdapter {
+  adapterId?: null
+  adapterLocationSequence?: null
+  adapterLabwareURI?: null
+}
+
+export interface FlexStackerRetrieveRunTimeCommand
+  extends FlexStackerRetrieveCreateCommand,
+    CommonCommandRunTimeInfo {
+  result?:
+    | (RetrieveResultPrimary & RetrieveResultNoLid & RetrieveResultNoAdapter)
+    | (RetrieveResultPrimary & RetrieveResultLid & RetrieveResultNoAdapter)
+    | (RetrieveResultPrimary & RetrieveResultNoLid & RetrieveResultAdapter)
+    | (RetrieveResultPrimary & RetrieveResultAdapter & RetrieveResultLid)
+}
+
+export interface FlexStackerStoreRunTimeCommand
+  extends FlexStackerStoreCreateCommand,
+    CommonCommandRunTimeInfo {
+  result?: {
+    eventualDestinationLocationSequence?: LabwareLocationSequence
+    primaryOriginLocationSequence?: LabwareLocationSequence
+    primaryLabwareId?: string
+    adapterOriginLocationSequence?: LabwareLocationSequence
+    adapterLabwareId?: string
+    lidOriginLocationSequence?: LabwareLocationSequence
+    lidLabwareId?: LabwareLocationSequence
+  }
+}
+
+export interface FlexStackerFillRunTimeCommand
+  extends FlexStackerFillCreateCommand,
+    CommonCommandRunTimeInfo {
+  result?: {
+    count: number
+  }
+}
+
+export interface FlexStackerEmptyRunTimeCommand
+  extends FlexStackerEmptyCreateCommand,
+    CommonCommandRunTimeInfo {
+  result?: {
+    count: number
+  }
+}

package/command/types/pipetting.ts

@@ -13,6 +13,7 @@ export type PipettingRunTimeCommand =
   | DropTipInPlaceRunTimeCommand
   | DropTipRunTimeCommand
   | GetTipPresenceRunTimeCommand
+  | GetNextTipRunTimeCommand
   | MoveToAddressableAreaForDropTipRunTimeCommand
   | PickUpTipRunTimeCommand
   | PrepareToAspirateRunTimeCommand
@@ -21,6 +22,9 @@ export type PipettingRunTimeCommand =
   | LiquidProbeRunTimeCommand
   | TryLiquidProbeRunTimeCommand
   | AirGapInPlaceRunTimeCommand
+  | PipetteSealToTipRunTimeCommand
+  | PipetteUnsealFromTipRunTimeCommand
+  | PressureDispenseRunTimeCommand
 
 export type PipettingCreateCommand =
   | AspirateCreateCommand
@@ -33,6 +37,7 @@ export type PipettingCreateCommand =
   | DropTipCreateCommand
   | DropTipInPlaceCreateCommand
   | GetTipPresenceCreateCommand
+  | GetNextTipCreateCommand
   | MoveToAddressableAreaForDropTipCreateCommand
   | PickUpTipCreateCommand
   | PrepareToAspirateCreateCommand
@@ -41,6 +46,9 @@ export type PipettingCreateCommand =
   | LiquidProbeCreateCommand
   | TryLiquidProbeCreateCommand
   | AirGapInPlaceCreateCommand
+  | PipetteSealToTipCreateCommand
+  | PipetteUnsealFromTipCreateCommand
+  | PressureDispenseCreateCommand
 
 export interface ConfigureForVolumeCreateCommand
   extends CommonCommandCreateInfo {
@@ -206,6 +214,16 @@ export interface GetTipPresenceRunTimeCommand
   result?: TipPresenceResult
 }
 
+export interface GetNextTipCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'getNextTip'
+  params: GetNextTipParams
+}
+export interface GetNextTipRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    GetNextTipCreateCommand {
+  result?: GetNextTipResult
+}
+
 export interface VerifyTipPresenceCreateCommand
   extends CommonCommandCreateInfo {
   commandType: 'verifyTipPresence'
@@ -237,6 +255,38 @@ export interface TryLiquidProbeRunTimeCommand
   result?: Record<string, unknown>
 }
 
+export interface PipetteSealToTipCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'sealPipetteToTip'
+  params: PipetteAccessParams & WellLocationParam
+}
+export interface PipetteUnsealFromTipCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'unsealPipetteFromTip'
+  params: PipetteAccessParams & WellLocationParam
+}
+
+export interface PressureDispenseCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'pressureDispense'
+  params: PipetteAccessParams &
+    WellLocationParam &
+    FlowRateParams &
+    VolumeParams
+}
+export interface PipetteSealToTipRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    PipetteSealToTipCreateCommand {
+  result?: PipetteSealToTipResult
+}
+export interface PipetteUnsealFromTipRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    PipetteUnsealFromTipCreateCommand {
+  result?: PipetteUnsealFromTipResult
+}
+export interface PressureDispenseRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    PressureDispenseCreateCommand {
+  result?: BasicLiquidHandlingResult
+}
 export type AspDispAirgapParams = FlowRateParams &
   PipetteAccessParams &
   VolumeParams &
@@ -244,9 +294,25 @@ export type AspDispAirgapParams = FlowRateParams &
 export type BlowoutParams = FlowRateParams &
   PipetteAccessParams &
   WellLocationParam
-export type TouchTipParams = PipetteAccessParams & WellLocationParam
+export type TouchTipParams = PipetteAccessParams &
+  WellLocationParam & {
+    speed?: number
+    mmFromEdge?: number
+  }
 export type DropTipParams = PipetteAccessParams & DropTipWellLocationParam
-export type PickUpTipParams = TouchTipParams
+export interface GetNextTipParams {
+  pipetteId: string
+  labwareIds: string[]
+}
+
+export interface GetNextTipResult {
+  nextTipInfo: {
+    labwareId: string
+    tipStartingWell: string
+  }
+}
+export type PickUpTipParams = PipetteAccessParams & WellLocationParam
+export type PrepareToAspirateParams = PipetteIdentityParams
 
 interface AddressableOffsetVector {
   x: number
@@ -321,3 +387,13 @@ interface TipPresenceResult {
   // ot2 should alwasy return unknown
   status?: 'present' | 'absent' | 'unknown'
 }
+
+interface PipetteSealToTipResult {
+  position: AddressableOffsetVector
+  tipVolume: number
+  tipLength: number
+  tipDiameter: number
+}
+interface PipetteUnsealFromTipResult {
+  position: AddressableOffsetVector
+}

package/command/types/setup.ts

@@ -6,6 +6,9 @@ import type {
   LabwareOffset,
   PipetteName,
   ModuleModel,
+  AspirateProperties,
+  MultiDispenseProperties,
+  SingleDispenseProperties,
 } from '../../js'
 
 export interface LoadPipetteCreateCommand extends CommonCommandCreateInfo {
@@ -29,6 +32,24 @@ export interface LoadLabwareRunTimeCommand
     LoadLabwareCreateCommand {
   result?: LoadLabwareResult
 }
+export interface LoadLidCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'loadLid'
+  params: LoadLidParams
+}
+export interface LoadLidRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    LoadLidCreateCommand {
+  result?: LoadLidResult
+}
+export interface LoadLidStackCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'loadLidStack'
+  params: LoadLidStackParams
+}
+export interface LoadLidStackRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    LoadLidStackCreateCommand {
+  result?: LoadLidStackResult
+}
 export interface ReloadLabwareCreateCommand extends CommonCommandCreateInfo {
   commandType: 'reloadLabware'
   params: { labwareId: string }
@@ -69,6 +90,16 @@ export interface LoadLiquidRunTimeCommand
   result?: LoadLiquidResult
 }
 
+export interface LoadLiquidClassCreateCommand extends CommonCommandCreateInfo {
+  commandType: 'loadLiquidClass'
+  params: LoadLiquidClassParams
+}
+export interface LoadLiquidClassRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    LoadLiquidClassCreateCommand {
+  result?: LoadLiquidClassResult
+}
+
 export interface ConfigureNozzleLayoutCreateCommand
   extends CommonCommandCreateInfo {
   commandType: 'configureNozzleLayout'
@@ -88,7 +119,10 @@ export type SetupRunTimeCommand =
   | ReloadLabwareRunTimeCommand
   | LoadModuleRunTimeCommand
   | LoadLiquidRunTimeCommand
+  | LoadLiquidClassRunTimeCommand
   | MoveLabwareRunTimeCommand
+  | LoadLidRunTimeCommand
+  | LoadLidStackRunTimeCommand
 
 export type SetupCreateCommand =
   | ConfigureNozzleLayoutCreateCommand
@@ -97,15 +131,21 @@ export type SetupCreateCommand =
   | ReloadLabwareCreateCommand
   | LoadModuleCreateCommand
   | LoadLiquidCreateCommand
+  | LoadLiquidClassCreateCommand
   | MoveLabwareCreateCommand
+  | LoadLidCreateCommand
+  | LoadLidStackCreateCommand
 
 export type LabwareLocation =
   | 'offDeck'
+  | 'systemLocation'
   | { slotName: string }
   | { moduleId: string }
   | { labwareId: string }
   | { addressableAreaName: AddressableAreaName }
 
+export type LoadedLabwareLocation = LabwareLocation | InStackerHopperLocation
+
 export type OnDeckLabwareLocation =
   | { slotName: string }
   | { moduleId: string }
@@ -121,6 +161,49 @@ export type NonStackedLocation =
 export interface ModuleLocation {
   slotName: string
 }
+
+export interface InStackerHopperLocation {
+  kind: 'inStackerHopper'
+  moduleId: string
+}
+
+export interface OnLabwareLocationSequenceComponent {
+  kind: 'onLabware'
+  labwareId: string
+  lidId: string | null
+}
+
+export interface OnModuleLocationSequenceComponent {
+  kind: 'onModule'
+  moduleId: string
+}
+
+export interface OnAddressableAreaLocationSequenceComponent {
+  kind: 'onAddressableArea'
+  addressableAreaName: AddressableAreaName
+}
+
+export interface NotOnDeckLocationSequenceComponent {
+  kind: 'notOnDeck'
+  logicalLocationName: 'offDeck' | 'systemLocation'
+}
+
+export interface OnCutoutFixtureLocationSequenceComponent {
+  kind: 'onCutoutFixture'
+  cutoutId: string
+  possibleCutoutFixtureIds: string[]
+}
+
+export type LocationSequenceComponent =
+  | OnLabwareLocationSequenceComponent
+  | OnModuleLocationSequenceComponent
+  | OnAddressableAreaLocationSequenceComponent
+  | NotOnDeckLocationSequenceComponent
+  | OnCutoutFixtureLocationSequenceComponent
+  | InStackerHopperLocation
+
+export type LabwareLocationSequence = LocationSequenceComponent[]
+
 export interface LoadPipetteParams {
   pipetteName: string
   pipetteId: string
@@ -143,10 +226,12 @@ interface LoadLabwareResult {
   // todo(mm, 2024-08-19): This does not match the server-returned offsetId field.
   // Confirm nothing client-side is trying to use this, then replace it with offsetId.
   offset: LabwareOffset
+  locationSequence?: LabwareLocationSequence
 }
 interface ReloadLabwareResult {
   labwareId: string
   offsetId?: string | null
+  locationSequence?: LabwareLocationSequence
 }
 
 export type LabwareMovementStrategy =
@@ -161,8 +246,10 @@ export interface MoveLabwareParams {
 }
 interface MoveLabwareResult {
   offsetId: string
+  eventualDestinationLocationSequence?: LabwareLocationSequence
+  immediateDestinationLocationSequence?: LabwareLocationSequence
+  originLocationSequence?: LabwareLocationSequence
 }
-
 interface LoadModuleParams {
   moduleId?: string
   location: ModuleLocation
@@ -179,6 +266,23 @@ interface LoadLiquidParams {
 interface LoadLiquidResult {
   liquidId: string
 }
+interface LoadLiquidClassParams {
+  liquidClassId?: string
+  liquidClassRecord: LiquidClassRecord
+}
+
+interface LiquidClassRecord {
+  aspirate: AspirateProperties
+  liquidClassName: string
+  multiDispense?: MultiDispenseProperties
+  pipetteModel: string
+  singleDispense: SingleDispenseProperties
+  tiprack: string
+}
+
+interface LoadLiquidClassResult {
+  liquidClassId: string
+}
 
 export const COLUMN = 'COLUMN'
 export const SINGLE = 'SINGLE'
@@ -198,7 +302,38 @@ interface NozzleConfigurationParams {
   style: NozzleConfigurationStyle
 }
 
-interface ConfigureNozzleLayoutParams {
+export interface ConfigureNozzleLayoutParams {
   pipetteId: string
   configurationParams: NozzleConfigurationParams
 }
+
+interface LoadLidStackParams {
+  location: LabwareLocation
+  loadName: string
+  namespace: string
+  version: number
+  quantity: number
+}
+
+interface LoadLidStackResult {
+  stackLabwareId: string
+  labwareIds: string[]
+  definition?: LabwareDefinition2
+  lidStackDefinition: LabwareDefinition2
+  location: LabwareLocation
+  stackLocationSequence?: LabwareLocationSequence
+  locationSequences?: LabwareLocationSequence[]
+}
+
+export interface LoadLidParams {
+  location: LabwareLocation
+  loadName: string
+  namespace: string
+  version: number
+}
+
+interface LoadLidResult {
+  labwareId: string
+  definition: LabwareDefinition2
+  locationSequence?: LabwareLocationSequence
+}

package/command/types/timing.ts

@@ -22,7 +22,7 @@ export interface WaitForResumeRunTimeCommand
   result?: any
 }
 
-interface WaitForResumeParams {
+export interface WaitForResumeParams {
   message?: string
 }
 
@@ -37,7 +37,7 @@ export interface WaitForDurationRunTimeCommand
   result?: any
 }
 
-interface WaitForDurationParams {
+export interface WaitForDurationParams {
   seconds: number
   message?: string
 }

package/command/types/unsafe.ts

@@ -92,7 +92,7 @@ export interface UnsafeUngripLabwareRunTimeCommand
   result?: any
 }
 export interface UnsafePlaceLabwareParams {
-  labwareId: string
+  labwareURI: string
   location: OnDeckLabwareLocation
 }
 export interface UnsafePlaceLabwareCreateCommand