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

package/lib/types.d.ts

@@ -836,4 +836,178 @@ 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 LiquidProbeStepGenArgs {
+    pipetteId: string;
+    labwareId: string;
+    wellName: string;
+    wellLocation?: RuntimeWellLocation;
+}
+export type TryLiquidProbeStepGenArgs = LiquidProbeStepGenArgs;
+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 interface MoveRelativeStepGenArgs {
+    pipetteId: string;
+    axis: string;
+    distance: number | string;
+}
+export interface MoveToCoordinatesStepGenArgs {
+    pipetteId: string;
+    coordinates: {
+        x: number | string;
+        y: number | string;
+        z: number | string;
+    };
+    minimumZHeight?: number | string;
+    forceDirect?: boolean | string;
+}
+export interface MoveToWellStepGenArgs {
+    pipetteId: string;
+    labwareId: string;
+    wellName: string;
+    wellLocation?: RuntimeWellLocation;
+    minimumZHeight?: number | string;
+    forceDirect?: boolean | string;
+    speed?: number | string;
+}
+export interface MoveLabwareStepGenArgs {
+    labwareId: string;
+    strategy: string;
+    newLocation: string | {
+        slotName: string;
+    } | {
+        moduleId: string;
+    } | {
+        labwareId: string;
+    } | {
+        addressableAreaName: string;
+    };
+}
 export {};

package/lib/utils/misc.d.ts

@@ -5,6 +5,17 @@ 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;
@@ -203,4 +214,24 @@ export declare function resolveStringRuntimeValue(value: string, runtimeParamete
  * 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/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.21-alpha.0",
+  "version": "0.3.23-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.21-alpha.0"
+    "@opentrons/shared-data": "0.3.23-alpha.0"
   },
   "devDependencies": {
     "@types/lodash": "4.17.24"