@opentrons/step-generation 0.3.20-alpha.0 → 0.3.22-alpha.0

package/lib/types.d.ts

@@ -184,18 +184,33 @@ export type Ingredient = Omit<LiquidEntity, 'pythonName'>;
 export interface Ingredients {
     [liquidId: string]: Ingredient;
 }
-export type Choices = number[] | string[];
-export interface RuntimeParameter {
+interface RuntimeParameterBase {
     variableName: string;
     displayName: string;
-    type: 'boolean' | 'string' | 'float' | 'int' | 'csv';
-    default: string | number | boolean;
+    description?: string;
+}
+export interface NumericRuntimeParameter extends RuntimeParameterBase {
+    type: 'float' | 'int';
+    default: number;
     minimum?: number;
     maximum?: number;
-    choices?: Choices;
+    choices?: number[];
     unit?: string;
-    description?: string;
 }
+export interface BooleanRuntimeParameter extends RuntimeParameterBase {
+    type: 'boolean';
+    default: boolean;
+}
+export interface StringRuntimeParameter extends RuntimeParameterBase {
+    type: 'string';
+    default: string;
+    choices?: string[];
+}
+export interface CsvRuntimeParameter extends RuntimeParameterBase {
+    type: 'csv';
+    default: string;
+}
+export type RuntimeParameter = NumericRuntimeParameter | BooleanRuntimeParameter | StringRuntimeParameter | CsvRuntimeParameter;
 export interface RuntimeParameters {
     [variableName: string]: RuntimeParameter;
 }
@@ -752,7 +767,7 @@ export interface TimelineFrame {
     };
 }
 export type RobotState = TimelineFrame;
-export type ErrorType = 'ABSORBANCE_READER_LID_CLOSED' | 'ABSORBANCE_READER_NO_GRIPPER' | 'ABSORBANCE_READER_NO_INITIALIZATION' | 'CANNOT_MOVE_WITH_GRIPPER' | 'CLOSING_THERMOCYCLER_WITH_INVALID_LABWARE_LID' | 'DROP_TIP_LOCATION_DOES_NOT_EXIST' | 'EQUIPMENT_DOES_NOT_EXIST' | 'FLEX_STACKER_NO_GRIPPER' | 'GRIPPER_REQUIRED' | 'HEATER_SHAKER_EAST_WEST_LATCH_OPEN' | 'HEATER_SHAKER_EAST_WEST_MULTI_CHANNEL' | 'HEATER_SHAKER_IS_SHAKING' | 'HEATER_SHAKER_LATCH_CLOSED' | 'HEATER_SHAKER_LATCH_OPEN' | 'HEATER_SHAKER_NORTH_SOUTH__OF_NON_TIPRACK_WITH_MULTI_CHANNEL' | 'HEATER_SHAKER_NORTH_SOUTH_EAST_WEST_SHAKING' | 'HOPPER_EMPTY' | 'HOPPER_FULL' | 'INCOMPLETE_PICKUP' | 'INSUFFICIENT_TIPS' | 'INVALID_SLOT' | 'INVALID_WAIT_CONDITION' | 'LABWARE_DISCARDED_IN_TRASH' | 'LABWARE_DOES_NOT_EXIST' | 'LABWARE_OFF_DECK' | 'LABWARE_ON_ANOTHER_ENTITY' | 'LABWARE_ON_HOPPER' | 'LIVE_TASK_ERROR' | 'MISMATCHED_SOURCE_DEST_WELLS' | 'MISMATCHED_STACKER_LABWARE_TYPE' | 'MISSING_96_CHANNEL_TIPRACK_ADAPTER' | 'MISSING_MODULE' | 'MISSING_PROFILE_STEP' | 'MISSING_PUMP_ACTIVITY' | 'MISSING_STACKER_LABWARE_TYPE' | 'MISSING_TEMPERATURE_STEP' | 'MOVE_LOCATION_NOT_SPECIFIED' | 'MODULE_PIPETTE_COLLISION_DANGER' | 'MULTI_ASPIRATE_VOLUME_TOO_HIGH' | 'MULTI_DISPENSE_VOLUME_TOO_HIGH' | 'NEXT_TIPRACK_HAS_LID' | 'NO_TIP_ON_PIPETTE' | 'NO_TIP_SELECTED' | 'PIPETTE_DOES_NOT_EXIST' | 'PIPETTE_HAS_TIP' | 'PIPETTE_VOLUME_EXCEEDED' | 'PIPETTING_INTO_COLUMN_4' | 'POSSIBLE_PIPETTE_COLLISION_THERMOCYCLER_LID' | 'POSSIBLE_PIPETTE_COLLISION_OUTSIDE_DECK_EXTENTS' | 'POSSIBLE_PIPETTE_COLLISION_ADJACENT_ADDRESSABLE_AREA' | 'REMOVE_96_CHANNEL_TIPRACK_ADAPTER' | 'RETRACT_BELOW_ASPIRATE' | 'RETRACT_BELOW_DISPENSE' | 'RETURN_TIP_UNAVAILABLE' | 'SHUTTLE_FULL' | 'SHUTTLE_EMPTY' | 'STACK_TOO_HIGH' | 'SUBMERGE_BELOW_ASPIRATE' | 'SUBMERGE_BELOW_DISPENSE' | 'TALL_LABWARE_EAST_WEST_OF_HEATER_SHAKER' | 'THERMOCYCLER_BUSY_WITH_PROFILE' | 'THERMOCYCLER_LID_CLOSED' | 'TIP_VOLUME_EXCEEDED' | 'TIPRACK_LID_NOT_ALLOWED_ON_DECK' | 'TOO_MANY_TIPS' | 'VACUUM_UNDER_PRESSURE';
+export type ErrorType = 'ABSORBANCE_READER_LID_CLOSED' | 'ABSORBANCE_READER_NO_GRIPPER' | 'ABSORBANCE_READER_NO_INITIALIZATION' | 'CANNOT_MOVE_WITH_GRIPPER' | 'CLOSING_THERMOCYCLER_WITH_INVALID_LABWARE_LID' | 'DROP_TIP_LOCATION_DOES_NOT_EXIST' | 'EQUIPMENT_DOES_NOT_EXIST' | 'FLEX_STACKER_NO_GRIPPER' | 'GRIPPER_REQUIRED' | 'HEATER_SHAKER_EAST_WEST_LATCH_OPEN' | 'HEATER_SHAKER_EAST_WEST_MULTI_CHANNEL' | 'HEATER_SHAKER_IS_SHAKING' | 'HEATER_SHAKER_LATCH_CLOSED' | 'HEATER_SHAKER_LATCH_OPEN' | 'HEATER_SHAKER_NORTH_SOUTH__OF_NON_TIPRACK_WITH_MULTI_CHANNEL' | 'HEATER_SHAKER_NORTH_SOUTH_EAST_WEST_SHAKING' | 'HOPPER_EMPTY' | 'HOPPER_FULL' | 'INCOMPLETE_PICKUP' | 'INSUFFICIENT_TIPS' | 'INVALID_RUNTIME_PARAMETER' | 'INVALID_SLOT' | 'INVALID_WAIT_CONDITION' | 'LABWARE_DISCARDED_IN_TRASH' | 'LABWARE_DOES_NOT_EXIST' | 'LABWARE_OFF_DECK' | 'LABWARE_ON_ANOTHER_ENTITY' | 'LABWARE_ON_HOPPER' | 'LIVE_TASK_ERROR' | 'MISMATCHED_SOURCE_DEST_WELLS' | 'MISMATCHED_STACKER_LABWARE_TYPE' | 'MISSING_96_CHANNEL_TIPRACK_ADAPTER' | 'MISSING_MODULE' | 'MISSING_PROFILE_STEP' | 'MISSING_PUMP_ACTIVITY' | 'MISSING_STACKER_LABWARE_TYPE' | 'MISSING_TEMPERATURE_STEP' | 'MOVE_LOCATION_NOT_SPECIFIED' | 'MODULE_PIPETTE_COLLISION_DANGER' | 'MULTI_ASPIRATE_VOLUME_TOO_HIGH' | 'MULTI_DISPENSE_VOLUME_TOO_HIGH' | 'NEXT_TIPRACK_HAS_LID' | 'NO_TIP_ON_PIPETTE' | 'NO_TIP_SELECTED' | 'PIPETTE_DOES_NOT_EXIST' | 'PIPETTE_HAS_TIP' | 'PIPETTE_VOLUME_EXCEEDED' | 'PIPETTING_INTO_COLUMN_4' | 'POSSIBLE_PIPETTE_COLLISION_THERMOCYCLER_LID' | 'POSSIBLE_PIPETTE_COLLISION_OUTSIDE_DECK_EXTENTS' | 'POSSIBLE_PIPETTE_COLLISION_ADJACENT_ADDRESSABLE_AREA' | 'REMOVE_96_CHANNEL_TIPRACK_ADAPTER' | 'RETRACT_BELOW_ASPIRATE' | 'RETRACT_BELOW_DISPENSE' | 'RETURN_TIP_UNAVAILABLE' | 'SHUTTLE_FULL' | 'SHUTTLE_EMPTY' | 'STACK_TOO_HIGH' | 'SUBMERGE_BELOW_ASPIRATE' | 'SUBMERGE_BELOW_DISPENSE' | 'TALL_LABWARE_EAST_WEST_OF_HEATER_SHAKER' | 'THERMOCYCLER_BUSY_WITH_PROFILE' | 'THERMOCYCLER_LID_CLOSED' | 'TIP_VOLUME_EXCEEDED' | 'TIPRACK_LID_NOT_ALLOWED_ON_DECK' | 'TOO_MANY_TIPS' | 'VACUUM_UNDER_PRESSURE';
 export interface CommandCreatorError {
     message: string;
     type: ErrorType;
@@ -821,4 +836,134 @@ export type PipetteMovementSafetyStatus = {
     isSafe: false;
     reason: UnsafePipetteMovementReason;
 };
+export interface ModuleStepGenArgs {
+    moduleId: string;
+}
+export interface AbsorbanceReaderInitializeStepGenArgs {
+    moduleId: string;
+    measureMode: string;
+    sampleWavelengths: Array<number | string>;
+    referenceWavelength?: number | string;
+}
+export interface AbsorbanceReaderReadStepGenArgs {
+    moduleId: string;
+    fileName?: string | null;
+}
+export interface ConfigureForVolumeStepGenArgs {
+    pipetteId: string;
+    volume: number | string;
+}
+export interface ConfigureNozzleLayoutStepGenArgs {
+    pipetteId: string;
+    configurationParams: {
+        style: string;
+        primaryNozzle?: string;
+        backLeftNozzle?: string;
+    };
+}
+export interface VacuumSetPumpPowerStepGenArgs {
+    moduleId: string;
+    percentPower: number | string;
+    duration?: number | string;
+    ventAfter?: boolean | string;
+}
+export interface VacuumSetPumpPressureStepGenArgs {
+    moduleId: string;
+    gaugePressure: number | string;
+    duration?: number | string;
+    ventAfter?: boolean | string;
+}
+export interface VacuumStartRunProfileStepGenArgs {
+    moduleId: string;
+    profile: VacuumRunProfileParams['steps'];
+    ventAfter: boolean | string;
+}
+export interface WaitForTemperatureStepGenArgs {
+    moduleId: string;
+    celsius: number | string;
+}
+export interface HeaterShakerSetTargetShakeSpeedStepGenArgs {
+    moduleId: string;
+    rpm: number | string;
+}
+interface RuntimeWellLocation {
+    origin?: string;
+    offset?: {
+        x?: number | string;
+        y?: number | string;
+        z?: number | string;
+    };
+}
+export interface TouchTipStepGenArgs {
+    pipetteId: string;
+    labwareId: string;
+    wellName: string;
+    zOffsetFromTop: number | string;
+    speed?: number | string;
+    mmFromEdge?: number | string;
+}
+export interface PrepareToAspirateStepGenArgs {
+    pipetteId: string;
+}
+export interface PickUpTipStepGenArgs {
+    pipetteId: string;
+    labwareId: string;
+    wellName: string;
+    primaryNozzle: PrimaryNozzleConfigurationStyle;
+    nozzles: NozzleConfigurationStyle;
+    tipTrackingOption?: TipTrackingOption;
+}
+export interface DropTipStepGenArgs {
+    pipette: string;
+    wellName?: string;
+    dropTipLocation?: string;
+    isReturnTip?: boolean;
+}
+export interface DispenseWhileTrackingStepGenArgs {
+    pipetteId: string;
+    volume: number | string;
+    flowRate: number | string;
+    labwareId: string;
+    wellName: string;
+    trackFromLocation: RuntimeWellLocation;
+    trackToLocation: RuntimeWellLocation;
+    pushOut?: number | string;
+}
+export interface DispenseInPlaceStepGenArgs {
+    pipetteId: string;
+    volume: number | string;
+    flowRate: number | string;
+    pushOut?: number | string;
+    correctionVolume?: number | string;
+    isAirGap?: boolean;
+}
+export interface BlowOutInWellStepGenArgs {
+    pipetteId: string;
+    labwareId: string;
+    wellName: string;
+    flowRate: number | string;
+    wellLocation?: RuntimeWellLocation;
+}
+export interface BlowOutInPlaceStepGenArgs {
+    pipetteId: string;
+    flowRate: number | string;
+}
+export interface AspirateWhileTrackingStepGenArgs {
+    pipetteId: string;
+    volume: number | string;
+    flowRate: number | string;
+    labwareId: string;
+    wellName: string;
+    trackFromLocation: RuntimeWellLocation;
+    trackToLocation: RuntimeWellLocation;
+}
+export interface AspirateInPlaceStepGenArgs {
+    pipetteId: string;
+    volume: number | string;
+    flowRate: number | string;
+    correctionVolume?: number | string;
+}
+export interface SetTemperatureStepGenArgs extends ModuleStepGenArgs {
+    celsius: number | string;
+}
 export {};

package/lib/utils/misc.d.ts

@@ -1,10 +1,21 @@
 import { COLUMN_4_SLOTS } from '../constants';
 import type { ActiveNozzleNumber, AddressableAreaName, BlowoutParams, CutoutFixtureId, CutoutId, LabwareDefinition2, LabwareLocationSequence, LoadLabwareRunTimeCommand, LoadLidParams, LoadLidStackRunTimeCommand, NozzleConfigurationStyle, PipetteChannels, PipetteV2Specs, PositionReference, PrimaryNozzleConfigurationStyle, RobotType } from '@opentrons/shared-data';
-import type { CommandCreator, CurriedCommandCreator, FlexStackerModuleState, InvariantContext, LabwareEntities, LabwareTemporalProperties, LocationLiquidState, ModuleEntities, PathOption, RobotState, SourceAndDest, StagingAreaEntities, TrashBinEntities, WasteChuteEntities } from '../types';
+import type { CommandCreator, CurriedCommandCreator, FlexStackerModuleState, InvariantContext, LabwareEntities, LabwareTemporalProperties, LocationLiquidState, ModuleEntities, PathOption, RobotState, RuntimeParameters, SourceAndDest, StagingAreaEntities, TrashBinEntities, WasteChuteEntities } from '../types';
 export declare const AIR: '__air__';
 export declare const SOURCE_WELL_BLOWOUT_DESTINATION: 'source_well';
 export declare const DEST_WELL_BLOWOUT_DESTINATION: 'dest_well';
 export declare function getIsVacuumSpacer(def: LabwareDefinition2): boolean;
+export declare function getIsStackableVacuumSpacer(def: LabwareDefinition2): boolean;
+export declare function getIsVacuumSpacerSeat(def: LabwareDefinition2): boolean;
+export declare const getStackableVacuumSpacerLoadNamesInStack: (stack: string[], labwareById: Record<string, {
+    def: LabwareDefinition2;
+}>) => string[];
+export declare const getCanPlaceStackableVacuumSpacer: (movingDef: LabwareDefinition2, stack: string[], labwareById: Record<string, {
+    def: LabwareDefinition2;
+}>) => {
+    isCompatible: boolean;
+    isAboveStackLimit: boolean;
+};
 type trashOrLabware = 'wasteChute' | 'trashBin' | 'labware' | null;
 export declare const getCutoutIdByAddressableArea: (addressableAreaName: AddressableAreaName, cutoutFixtureId: CutoutFixtureId, robotType: RobotType) => CutoutId;
 export declare function getWasteChuteAddressableAreaNamePip(channels: PipetteChannels): AddressableAreaName;
@@ -187,4 +198,40 @@ export declare const getLabwareHasLid: (args: {
     labwareEntities: LabwareEntities;
 }) => boolean;
 export declare const getIsInPipettableLocation: (location: string) => boolean;
+/**
+ * Numbers pass through. Strings are runtime parameter variable names, and only
+ * float/int parameters resolve — `type` narrows `default` to `number`.
+ */
+export declare function resolveNumericRuntimeValue(value: number | string, runtimeParameters: RuntimeParameters): number | null;
+/**
+ * A string id is literal unless it names a runtime parameter. Only string
+ * parameters resolve — `type` narrows `default` to `string`. Any other
+ * parameter type is invalid.
+ */
+export declare function resolveStringRuntimeValue(value: string, runtimeParameters: RuntimeParameters): string | null;
+/**
+ * Booleans pass through. Strings are runtime parameter variable names, and only
+ * boolean parameters resolve — `type` narrows `default` to `boolean`.
+ */
+export declare function resolveBooleanRuntimeValue(value: boolean | string, runtimeParameters: RuntimeParameters): boolean | null;
+export declare function resolveAllowedRuntimeValue(value: string, allowed: readonly string[], runtimeParameters: RuntimeParameters): string | null;
+export declare function pythonRuntimeString(raw: string, resolved: string, runtimeParameters: RuntimeParameters): string;
+export declare function resolveRuntimeWellLocation(location: {
+    origin?: string;
+    offset?: {
+        x?: number | string;
+        y?: number | string;
+        z?: number | string;
+    };
+} | undefined, runtimeParameters: RuntimeParameters): {
+    location: {
+        origin?: string;
+        offset?: {
+            x?: number;
+            y?: number;
+            z?: number;
+        };
+    } | undefined;
+    invalidParameterNames: string[];
+};
 export {};

package/lib/utils/pythonFileUtils.d.ts

@@ -1,5 +1,5 @@
 import type { ProtocolFile, RobotType } from '@opentrons/shared-data';
-import type { ChangeTipOptions, InvariantContext, LabwareEntities, LabwareLiquidState, LabwareTemporalProperties, LiquidEntities, ModuleEntities, ModuleTemporalProperties, PipetteEntities, Timeline, TimelineFrame, TrashBinEntities, WasteChuteEntities } from '../types';
+import type { ChangeTipOptions, InvariantContext, LabwareEntities, LabwareLiquidState, LabwareTemporalProperties, LiquidEntities, ModuleEntities, ModuleTemporalProperties, PipetteEntities, RuntimeParameters, Timeline, TimelineFrame, TrashBinEntities, WasteChuteEntities } from '../types';
 export declare const PAPI_VERSION = "2.31";
 export declare const PD_APPLICATION_VERSION = "9.0.1";
 export declare function pythonImports(): string;
@@ -28,3 +28,4 @@ export declare const getSetStoredLabware: (moduleEntities: ModuleEntities, labwa
 }, modules: {
     [moduleId: string]: ModuleTemporalProperties;
 }, robotStateTimeline: Timeline) => string;
+export declare function getRunTimeParameters(runtimeParameters: RuntimeParameters): string;

package/lib/utils/pythonFormat.d.ts

@@ -1,5 +1,4 @@
 /** Utility functions for Python code generation. */
-import type { WellLocation } from '@opentrons/shared-data/command/types/support';
 /** The variable name for the ProtocolContext object in the run() function.
  * Our docs call it `protocol`, which is slightly misleading since the object is not
  * the protocol itself, but we'll try to stay consistent with the docs.
@@ -14,6 +13,7 @@ export declare const INDENT = "    ";
 export declare function indentPyLines(text: string): string;
 /** Render an arbitrary JavaScript value to Python. */
 export declare function formatPyValue(value: any): string;
+export declare function formatPyRuntimeValue(value: number | boolean | string): string;
 /** Render the string value to Python. */
 export declare function formatPyStr(str: string): string;
 /** Render an array value as a Python tuple. */
@@ -25,5 +25,12 @@ export declare function formatPyDict(dict: Record<string, any>): string;
 /** Render a WellLocation to Python.
  * Append the returned string to a Python well reference to get the wellLocation relative to the well.
  */
-export declare function formatPyWellLocation(wellLocation?: WellLocation): string;
+export declare function formatPyWellLocation(wellLocation?: {
+    origin?: string;
+    offset?: {
+        x?: number | string;
+        y?: number | string;
+        z?: number | string;
+    };
+}): string;
 export declare function getChunkForIndentingLists(lists: string[], size: number): string[][];

package/lib/utils/vacuumPythonArgs/getVacuumPumpHoldArgsPython.d.ts

@@ -1 +1 @@
-export declare const getVacuumPumpHoldArgsPython: (duration: number, ventAfter?: boolean) => string[];
+export declare const getVacuumPumpHoldArgsPython: (duration: number | string, ventAfter?: boolean | string) => string[];

package/package.json

@@ -9,7 +9,7 @@
   },
   "name": "@opentrons/step-generation",
   "productName": "Opentrons Step Generation",
-  "version": "0.3.20-alpha.0",
+  "version": "0.3.22-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.20-alpha.0"
+    "@opentrons/shared-data": "0.3.22-alpha.0"
   },
   "devDependencies": {
     "@types/lodash": "4.17.24"