@opentrons/step-generation 0.3.23-alpha.0 → 0.3.25-alpha.0

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { ABSORBANCE_READER_TYPE, AddressableArea, CommonArgs, CreateCommand, FLEX_STACKER_MODULE_TYPE, FlexStackerStoredLabwareGroup, HEATERSHAKER_MODULE_TYPE, Height, LabwareDefinition2, LabwareLocation, LabwareMovementStrategy, LoadedLabwareLocation, MAGNETIC_BLOCK_TYPE, MAGNETIC_MODULE_TYPE, ModuleModel, ModuleType, PipetteMount as Mount, NozzleConfigurationStyle, OpentronsAIArgs, PipetteName, PipetteV2Specs, PositionReference, PrimaryNozzleConfigurationStyle, ShakeSpeedParams, StackerStoredLabwareDefinitionURIs, TCExtendedProfileParams, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, VACUUM_MODULE_TYPE, VacuumRunProfileParams, Width } from '@opentrons/shared-data';
+import type { ABSORBANCE_READER_TYPE, AddressableArea, CommonArgs, CreateCommand, FLEX_STACKER_MODULE_TYPE, FlexStackerStoredLabwareGroup, HEATERSHAKER_MODULE_TYPE, Height, LabwareDefinition2, LabwareLocation, LabwareMovementStrategy, LoadedLabwareLocation, MAGNETIC_BLOCK_TYPE, MAGNETIC_MODULE_TYPE, ModuleModel, ModuleType, PipetteMount as Mount, NozzleConfigurationStyle, OpentronsAIArgs, PipetteName, PipetteV2Specs, PositionReference, PrimaryNozzleConfigurationStyle, ShakeSpeedParams, StackerStoredLabwareDefinitionURIs, TCExtendedProfileParams, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, VACUUM_MODULE_TYPE, VacuumRunProfileParams, Width, WithRuntimeParameterStrings } from '@opentrons/shared-data';
 import type { AUTOMATIC, CLEAN, DIRTY, EMPTY, MANUAL, TEMPERATURE_APPROACHING_TARGET, TEMPERATURE_AT_TARGET, TEMPERATURE_DEACTIVATED, VACUUM_MODE_POWER, VACUUM_MODE_PRESSURE, VACUUM_VENT_CLOSED, VACUUM_VENT_OPEN } from './constants';
 export type DeckSlot = string;
 type THERMOCYCLER_STATE = 'thermocyclerState';
@@ -443,7 +443,7 @@ export type MixArgs = CommonArgs & {
     tiprackSelected: string | null;
     primaryNozzle: PrimaryNozzleConfigurationStyle;
 };
-export type PauseArgs = CommonArgs & {
+export type PauseArgs = WithRuntimeParameterStrings<CommonArgs & {
     commandCreatorFnName: 'delay';
     message?: string;
     seconds?: number;
@@ -453,41 +453,41 @@ export type PauseArgs = CommonArgs & {
         minutes?: number;
         seconds?: number;
     } | null | undefined;
-};
-export interface WaitForTemperatureArgs extends CommonArgs {
+}>;
+export type WaitForTemperatureArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'waitForTemperature';
     celsius: number;
     message?: string;
-}
+}>;
 export interface WaitForModuleTaskArgs extends CommonArgs {
     commandCreatorFnName: 'waitForModuleTask';
     /** This step will wait for this to happen before moving on. */
     waitCondition: 'thermocyclerProfileComplete' | 'vacuumProfileComplete' | 'vacuumStateComplete';
     moduleId: string;
 }
-export type EngageMagnetArgs = CommonArgs & {
+export type EngageMagnetArgs = WithRuntimeParameterStrings<CommonArgs & {
     height: number;
     moduleId: string;
     commandCreatorFnName: 'engageMagnet';
     message?: string;
-};
-export type DisengageMagnetArgs = CommonArgs & {
+}>;
+export type DisengageMagnetArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'disengageMagnet';
     message?: string;
-};
-export interface SetTemperatureArgs extends CommonArgs {
+}>;
+export type SetTemperatureArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'setTemperature';
     celsius: number;
     message?: string;
-}
-export interface DeactivateTemperatureArgs extends CommonArgs {
+}>;
+export type DeactivateTemperatureArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'deactivateTemperature';
     message?: string;
-}
+}>;
 export type SetShakeSpeedArgs = ShakeSpeedParams & {
     moduleId: string;
     commandCreatorFnName: 'setShakeSpeed';
@@ -558,66 +558,66 @@ export interface ThermocyclerStateStepArgs extends CommonArgs {
     lidOpen: boolean;
     message?: string;
 }
-export interface AbsorbanceReaderInitializeArgs extends CommonArgs {
+export type AbsorbanceReaderInitializeArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'absorbanceReaderInitialize';
     measureMode: 'single' | 'multi';
     sampleWavelengths: number[];
     referenceWavelength?: number | null;
     message?: string;
-}
-export interface AbsorbanceReaderReadArgs extends CommonArgs {
+}>;
+export type AbsorbanceReaderReadArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'absorbanceReaderRead';
     fileName: string | null;
     message?: string;
-}
-export interface AbsorbanceReaderLidArgs extends CommonArgs {
+}>;
+export type AbsorbanceReaderLidArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'absorbanceReaderOpenLid' | 'absorbanceReaderCloseLid';
     message?: string;
-}
+}>;
 export type AbsorbanceReaderArgs = AbsorbanceReaderInitializeArgs | AbsorbanceReaderReadArgs | AbsorbanceReaderLidArgs;
-export interface MoveLabwareArgs extends CommonArgs {
+export type MoveLabwareArgs = WithRuntimeParameterStrings<CommonArgs & {
     commandCreatorFnName: 'moveLabware';
     labwareId: string;
     newLocation: LabwareLocation;
     strategy: LabwareMovementStrategy;
-}
-export interface CommentArgs extends CommonArgs {
+}>;
+export type CommentArgs = WithRuntimeParameterStrings<CommonArgs & {
     commandCreatorFnName: 'comment';
     message: string;
-}
-export interface CaptureImageArgs extends CommonArgs {
+}>;
+export type CaptureImageArgs = WithRuntimeParameterStrings<CommonArgs & {
     commandCreatorFnName: 'captureImage';
-    homeBefore: boolean;
+    homeBefore: boolean | string;
     fileName: string;
-    resolution: [Width, Height];
-    zoom: number;
-    contrast: number;
-    brightness: number;
-    saturation: number;
-}
-export interface FlexStackerEmptyArgs extends CommonArgs {
+    resolution: [Width | string, Height | string];
+    zoom: number | string;
+    contrast: number | string;
+    brightness: number | string;
+    saturation: number | string;
+}>;
+export type FlexStackerEmptyArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'flexStackerEmpty';
     interventionMessage: string | null;
-}
-export interface FlexStackerFillItemsArgs extends CommonArgs {
+}>;
+export type FlexStackerFillItemsArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'flexStackerFillItems';
     fillLabwareUri: string | null;
     fillLabwareIds: string[];
     interventionMessage: string | null;
-}
-export interface FlexStackerStoreArgs extends CommonArgs {
+}>;
+export type FlexStackerStoreArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'flexStackerStore';
-}
-export interface FlexStackerRetrieveArgs extends CommonArgs {
+}>;
+export type FlexStackerRetrieveArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'flexStackerRetrieve';
-}
+}>;
 export interface VacuumPumpAdvancedArgs {
     duration?: number;
     ventAfter?: boolean;
@@ -632,28 +632,28 @@ export interface VacuumPumpPowerArgs extends CommonArgs, VacuumPumpAdvancedArgs
     commandCreatorFnName: 'vacuumSetPumpPower';
     percentPower: number;
 }
-export interface VacuumCloseVentSetPumpPressureArgs extends CommonArgs, VacuumPumpAdvancedArgs {
+export type VacuumCloseVentSetPumpPressureArgs = WithRuntimeParameterStrings<CommonArgs & VacuumPumpAdvancedArgs & {
     moduleId: string;
     commandCreatorFnName: 'vacuumCloseVentSetPumpPressure';
     gaugePressure: number;
-}
-export interface VacuumCloseVentSetPumpPowerArgs extends CommonArgs, VacuumPumpAdvancedArgs {
+}>;
+export type VacuumCloseVentSetPumpPowerArgs = WithRuntimeParameterStrings<CommonArgs & VacuumPumpAdvancedArgs & {
     moduleId: string;
     commandCreatorFnName: 'vacuumCloseVentSetPumpPower';
     percentPower: number;
-}
-export interface VacuumOpenVentArgs extends CommonArgs {
+}>;
+export type VacuumOpenVentArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'vacuumOpenVent';
-}
-export interface VacuumCloseVentArgs extends CommonArgs {
+}>;
+export type VacuumCloseVentArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'vacuumCloseVent';
-}
-export interface VacuumStopPumpArgs extends CommonArgs {
+}>;
+export type VacuumStopPumpArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'vacuumStopPump';
-}
+}>;
 export interface VacuumPressureData {
     mode: typeof VACUUM_MODE_PRESSURE;
     pressureMbar: string | null;
@@ -680,12 +680,12 @@ export interface VacuumStartRunProfileArgs extends CommonArgs {
     profile: VacuumRunProfileParams['steps'];
     ventAfter: boolean;
 }
-export interface VacuumCloseVentStartProfileArgs extends CommonArgs {
+export type VacuumCloseVentStartProfileArgs = WithRuntimeParameterStrings<CommonArgs & {
     moduleId: string;
     commandCreatorFnName: 'vacuumCloseVentStartProfile';
     profile: VacuumRunProfileParams['steps'];
     ventAfter: boolean;
-}
+}>;
 export type VacuumArgs = VacuumPumpArgs | VacuumStartRunProfileArgs | VacuumOpenVentArgs | VacuumCloseVentArgs | VacuumStopPumpArgs;
 export type FlexStackerArgs = FlexStackerEmptyArgs | FlexStackerFillItemsArgs | FlexStackerRetrieveArgs | FlexStackerStoreArgs;
 export type CommandCreatorArgs = AbsorbanceReaderInitializeArgs | AbsorbanceReaderReadArgs | AbsorbanceReaderLidArgs | ConsolidateArgs | CaptureImageArgs | DistributeArgs | MixArgs | PauseArgs | WaitForModuleTaskArgs | TransferArgs | EngageMagnetArgs | DisengageMagnetArgs | SetTemperatureArgs | WaitForTemperatureArgs | DeactivateTemperatureArgs | ThermocyclerProfileStepArgs | ThermocyclerStateStepArgs | HeaterShakerArgs | MoveLabwareArgs | CommentArgs | FlexStackerArgs | VacuumArgs | OpentronsAIArgs;
@@ -849,6 +849,28 @@ export interface AbsorbanceReaderReadStepGenArgs {
     moduleId: string;
     fileName?: string | null;
 }
+export interface ThermocyclerSetTargetBlockTemperatureStepGenArgs {
+    moduleId: string;
+    celsius: number | string;
+}
+export interface ThermocyclerSetTargetLidTemperatureStepGenArgs {
+    moduleId: string;
+    celsius: number | string;
+}
+export interface ThermocyclerProfileStepStepGenArgs {
+    celsius: number | string;
+    holdSeconds: number | string;
+}
+export interface ThermocyclerProfileCycleStepGenArgs {
+    steps: ThermocyclerProfileStepStepGenArgs[];
+    repetitions: number | string;
+}
+export interface ThermocyclerStartRunExtendedProfileStepGenArgs {
+    moduleId: string;
+    profileElements: Array<ThermocyclerProfileCycleStepGenArgs | ThermocyclerProfileStepStepGenArgs>;
+    blockMaxVolumeUl?: number | string;
+    taskId?: string | null;
+}
 export interface ConfigureForVolumeStepGenArgs {
     pipetteId: string;
     volume: number | string;
@@ -882,6 +904,9 @@ export interface WaitForTemperatureStepGenArgs {
     moduleId: string;
     celsius: number | string;
 }
+export interface EngageMagnetStepGenArgs extends ModuleStepGenArgs {
+    height: number | string;
+}
 export interface HeaterShakerSetTargetShakeSpeedStepGenArgs {
     moduleId: string;
     rpm: number | string;
@@ -916,15 +941,15 @@ export interface PickUpTipStepGenArgs {
     pipetteId: string;
     labwareId: string;
     wellName: string;
-    primaryNozzle: PrimaryNozzleConfigurationStyle;
-    nozzles: NozzleConfigurationStyle;
-    tipTrackingOption?: TipTrackingOption;
+    primaryNozzle: string;
+    nozzles: string;
+    tipTrackingOption?: string;
 }
 export interface DropTipStepGenArgs {
     pipette: string;
     wellName?: string;
     dropTipLocation?: string;
-    isReturnTip?: boolean;
+    isReturnTip?: boolean | string;
 }
 export interface DispenseWhileTrackingStepGenArgs {
     pipetteId: string;
@@ -942,7 +967,7 @@ export interface DispenseInPlaceStepGenArgs {
     flowRate: number | string;
     pushOut?: number | string;
     correctionVolume?: number | string;
-    isAirGap?: boolean;
+    isAirGap?: boolean | string;
 }
 export interface BlowOutInWellStepGenArgs {
     pipetteId: string;
@@ -955,6 +980,10 @@ export interface BlowOutInPlaceStepGenArgs {
     pipetteId: string;
     flowRate: number | string;
 }
+export interface DropTipInPlaceStepGenArgs {
+    pipetteId: string;
+    homeAfter?: boolean | string;
+}
 export interface AspirateWhileTrackingStepGenArgs {
     pipetteId: string;
     volume: number | string;
@@ -988,6 +1017,20 @@ export interface MoveToCoordinatesStepGenArgs {
     minimumZHeight?: number | string;
     forceDirect?: boolean | string;
 }
+export interface MoveToAddressableAreaForDropTipStepGenArgs {
+    pipetteId: string;
+    addressableAreaName: string;
+    offset?: {
+        x: number | string;
+        y: number | string;
+        z: number | string;
+    };
+    alternateDropLocation?: boolean | string;
+    speed?: number | string;
+    minimumZHeight?: number | string;
+    forceDirect?: boolean | string;
+    ignoreTipConfiguration?: boolean | string;
+}
 export interface MoveToWellStepGenArgs {
     pipetteId: string;
     labwareId: string;

package/package.json

@@ -9,7 +9,7 @@
   },
   "name": "@opentrons/step-generation",
   "productName": "Opentrons Step Generation",
-  "version": "0.3.23-alpha.0",
+  "version": "0.3.25-alpha.0",
   "description": "Step generation",
   "main": "lib/index.cjs",
   "types": "lib/index.d.ts",
@@ -37,7 +37,7 @@
     "immer": "^10.1.3",
     "lodash": "4.18.1",
     "uuid": "14.0.0",
-    "@opentrons/shared-data": "0.3.23-alpha.0"
+    "@opentrons/shared-data": "0.3.25-alpha.0"
   },
   "devDependencies": {
     "@types/lodash": "4.17.24"