@opentrons/step-generation 0.3.0-alpha.1 → 0.3.2-alpha.0

package/README.md

@@ -8,7 +8,7 @@
 
 ## Version
 
-`0.3.0-alpha.1`
+`0.3.2-alpha.0`
 
 ## License
 

package/lib/commandCreators/atomic/__tests__/vacuumOpenVent.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/vacuumSetPumpPower.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/vacuumSetPumpPressure.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/vacuumStartRunProfile.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/__tests__/vacuumStopPump.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/commandCreators/atomic/index.d.ts

@@ -33,4 +33,10 @@ export { thermocyclerStartRunExtendedProfile } from './thermocyclerStartRunExten
 export { prepareToAspirate } from './prepareToAspirate';
 export { setTemperature } from './setTemperature';
 export { touchTip } from './touchTip';
+export { vacuumCloseVent } from './vacuumCloseVent';
+export { vacuumOpenVent } from './vacuumOpenVent';
+export { vacuumSetPumpPower } from './vacuumSetPumpPower';
+export { vacuumSetPumpPressure } from './vacuumSetPumpPressure';
+export { vacuumStartRunProfile } from './vacuumStartRunProfile';
+export { vacuumStopPump } from './vacuumStopPump';
 export { waitForTemperature } from './waitForTemperature';

package/lib/commandCreators/atomic/vacuumCloseVent.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreator, VacuumCloseVentArgs } from '../../types';
+export declare const vacuumCloseVent: CommandCreator<VacuumCloseVentArgs>;

package/lib/commandCreators/atomic/vacuumOpenVent.d.ts

@@ -0,0 +1,3 @@
+import type { VacuumModuleOpenVentCreateCommand } from '@opentrons/shared-data';
+import type { CommandCreator } from '../../types';
+export declare const vacuumOpenVent: CommandCreator<VacuumModuleOpenVentCreateCommand['params']>;

package/lib/commandCreators/atomic/vacuumSetPumpPower.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreator, VacuumPumpPowerArgs } from '../../types';
+export declare const vacuumSetPumpPower: CommandCreator<VacuumPumpPowerArgs>;

package/lib/commandCreators/atomic/vacuumSetPumpPressure.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreator, VacuumPumpPressureArgs } from '../../types';
+export declare const vacuumSetPumpPressure: CommandCreator<VacuumPumpPressureArgs>;

package/lib/commandCreators/atomic/vacuumStartRunProfile.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreator, VacuumStartRunProfileArgs } from '../../types';
+export declare const vacuumStartRunProfile: CommandCreator<VacuumStartRunProfileArgs>;

package/lib/commandCreators/atomic/vacuumStopPump.d.ts

@@ -0,0 +1,3 @@
+import type { VacuumModuleStopPumpCreateCommand } from '@opentrons/shared-data';
+import type { CommandCreator } from '../../types';
+export declare const vacuumStopPump: CommandCreator<VacuumModuleStopPumpCreateCommand['params']>;

package/lib/commandCreators/compound/index.d.ts

@@ -17,4 +17,7 @@ export { replaceTip } from './replaceTip';
 export { thermocyclerProfileStep } from './thermocyclerProfileStep';
 export { thermocyclerStateStep } from './thermocyclerStateStep';
 export { transfer } from './transfer';
+export { vacuumCloseVentSetPumpPower } from './vacuumCloseVentSetPumpPower';
+export { vacuumCloseVentSetPumpPressure } from './vacuumCloseVentSetPumpPressure';
+export { vacuumCloseVentStartProfile } from './vacuumCloseVentStartProfile';
 export { waitForModuleTask } from './waitForModuleTask';

package/lib/commandCreators/compound/vacuumCloseVentSetPumpPower.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreator, VacuumCloseVentSetPumpPowerArgs } from '../../types';
+export declare const vacuumCloseVentSetPumpPower: CommandCreator<VacuumCloseVentSetPumpPowerArgs>;

package/lib/commandCreators/compound/vacuumCloseVentSetPumpPressure.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreator, VacuumCloseVentSetPumpPressureArgs } from '../../types';
+export declare const vacuumCloseVentSetPumpPressure: CommandCreator<VacuumCloseVentSetPumpPressureArgs>;

package/lib/commandCreators/compound/vacuumCloseVentStartProfile.d.ts

@@ -0,0 +1,2 @@
+import type { CommandCreator, VacuumCloseVentStartProfileArgs } from '../../types';
+export declare const vacuumCloseVentStartProfile: CommandCreator<VacuumCloseVentStartProfileArgs>;

package/lib/commandCreators/index.d.ts

@@ -1,2 +1,2 @@
-export { absorbanceReaderCloseInitialize, absorbanceReaderCloseRead, consolidate, distribute, dropTipInTrash, dropTipInWasteChute, heaterShaker, mix, replaceTip, thermocyclerProfileStep, thermocyclerStateStep, transfer, waitForModuleTask, } from './compound';
-export { absorbanceReaderCloseLid, absorbanceReaderInitialize, absorbanceReaderOpenLid, absorbanceReaderRead, aspirate, blowOutInWell, captureImage, comment, deactivateTemperature, delay, disengageMagnet, dispense, dropTip, dropTipInPlace, engageMagnet, flexStackerEmpty, flexStackerFillItems, flexStackerRetrieve, flexStackerStore, moveLabware, moveToAddressableArea, moveToAddressableAreaForDropTip, setTemperature, touchTip, waitForTemperature, } from './atomic';
+export { absorbanceReaderCloseInitialize, absorbanceReaderCloseRead, consolidate, distribute, dropTipInTrash, dropTipInWasteChute, heaterShaker, mix, replaceTip, thermocyclerProfileStep, thermocyclerStateStep, transfer, vacuumCloseVentSetPumpPressure, vacuumCloseVentSetPumpPower, vacuumCloseVentStartProfile, waitForModuleTask, } from './compound';
+export { absorbanceReaderCloseLid, absorbanceReaderInitialize, absorbanceReaderOpenLid, absorbanceReaderRead, aspirate, blowOutInWell, captureImage, comment, deactivateTemperature, delay, disengageMagnet, dispense, dropTip, dropTipInPlace, engageMagnet, flexStackerEmpty, flexStackerFillItems, flexStackerRetrieve, flexStackerStore, moveLabware, moveToAddressableArea, moveToAddressableAreaForDropTip, setTemperature, touchTip, vacuumCloseVent, vacuumOpenVent, vacuumSetPumpPower, vacuumSetPumpPressure, vacuumStartRunProfile, vacuumStopPump, waitForTemperature, } from './atomic';

package/lib/constants.d.ts

@@ -41,15 +41,18 @@ export type HopperLocationMapKey = keyof typeof FAKE_HOPPER_LOCATION_MAP;
 export declare const BOTTOM_UP_LABWARE_POOL_KEYS: Array<keyof FlexStackerStoredLabwareGroup>;
 export declare const BOTTOM_UP_STORED_LABWARE_URI_KEYS: Array<keyof StackerStoredLabwareDefinitionURIs>;
 export declare const SLOT_LOCATIONS_TO_FAKE_HOPPER_LOCATIONS: Record<DeckSlotId, string>;
+export declare const VACUUM_DOCK_LOCATION = "vacuumDock";
+export declare const VACUUM_DOCK_ADDRESSABLE_AREA: "vacuumModuleV1DockA4";
 export declare const VACUUM_VENT_OPEN: 'open';
 export declare const VACUUM_VENT_CLOSED: 'closed';
 export declare const VACUUM_MODE_POWER: 'power';
 export declare const VACUUM_MODE_PRESSURE: 'pressure';
 export declare const VACUUM_PROGRAM_STATE: 'state';
 export declare const VACUUM_PROGRAM_PROFILE: 'profile';
-export declare const VACUUM_STATE_PUMP: 'pump';
+export declare const VACUUM_STATE_PUMP_OFF: 'pumpOff';
+export declare const VACUUM_STATE_PUMP_ON: 'pumpOn';
 export declare const VACUUM_STATE_VENT: 'vent';
 export declare const VACUUM_VENT_SET_OPEN: 'open';
 export declare const VACUUM_VENT_SET_CLOSED: 'closed';
-export declare const VACUUM_MIN_PRESSURE_MBAR = 0.1;
-export declare const VACUUM_MAX_PRESSURE_MBAR = 1000;
+export declare const VACUUM_DEACTIVATED: 'VACUUM_DEACTIVATED';
+export declare const VACUUM_AT_TARGET: 'VACUUM_AT_TARGET';

package/lib/errorCreators.d.ts

@@ -1,5 +1,5 @@
 /** Utility fns to create reusable CommandCreatorErrors */
-import type { CommandCreatorError } from './types';
+import type { CommandCreatorError, UnsafePipetteMovementReason } from './types';
 export declare function insufficientTips(): CommandCreatorError;
 export declare function missingAdapter(): CommandCreatorError;
 export declare function removeAdapter(): CommandCreatorError;
@@ -53,7 +53,9 @@ export declare const flexStackerLabwareTypeMissing: () => CommandCreatorError;
 export declare const flexStackerHopperFull: () => CommandCreatorError;
 export declare const heaterShakerIsShaking: () => CommandCreatorError;
 export declare const tallLabwareEastWestOfHeaterShaker: (position: 'left' | 'right') => CommandCreatorError;
-export declare const possiblePipetteCollision: () => CommandCreatorError;
+export declare const possiblePipetteCollision: (args: {
+    unsafePipetteMovementReason: UnsafePipetteMovementReason;
+}) => CommandCreatorError;
 export declare const heaterShakerEastWestWithLatchOpen: () => CommandCreatorError;
 export declare const heaterShakerNorthSouthEastWestShaking: () => CommandCreatorError;
 export declare const heaterShakerEastWestOfMultiChannelPipette: () => CommandCreatorError;
@@ -87,3 +89,6 @@ export declare const stackTooHigh: (args: {
 export declare const tooManyTips: () => CommandCreatorError;
 export declare const incompletePickup: () => CommandCreatorError;
 export declare const labwareOnHopper: () => CommandCreatorError;
+export declare const missingPumpActivity: () => CommandCreatorError;
+export declare const invalidWaitCondition: (waitCondition: string) => CommandCreatorError;
+export declare const liveTaskError: () => CommandCreatorError;

package/lib/getNextRobotStateAndWarnings/__tests__/forSetTipState.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/getNextRobotStateAndWarnings/__tests__/vacuumUpdates.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/getNextRobotStateAndWarnings/forSetTipState.d.ts

@@ -0,0 +1,3 @@
+import type { SetTipStateParams } from '@opentrons/shared-data';
+import type { InvariantContext, RobotStateAndWarnings } from '../types';
+export declare function forSetTipState(params: SetTipStateParams, _invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings): void;

package/lib/getNextRobotStateAndWarnings/forWaitForTasks.d.ts

@@ -1,3 +1,4 @@
-import type { WaitForTasksParams } from '@opentrons/shared-data';
+import type { ModuleType, WaitForTasksParams } from '@opentrons/shared-data';
 import type { InvariantContext, RobotStateAndWarnings } from '../types';
 export declare function forWaitForTasks(params: WaitForTasksParams, invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings): void;
+export declare const handleWaitForTaskForModules: (taskId: string, robotStateAndWarnings: RobotStateAndWarnings, moduleType?: ModuleType) => boolean;

package/lib/getNextRobotStateAndWarnings/thermocyclerUpdates.d.ts

@@ -1,6 +1,6 @@
 import type { TCExtendedProfileParams, TCStartExtendedProfileParams } from '@opentrons/shared-data';
 import type { ModuleOnlyParams, TCProfileParams, TemperatureParams, ThermocyclerSetTargetBlockTemperatureParams } from '@opentrons/shared-data/protocol/types/schemaV6/command/module';
-import type { InvariantContext, RobotStateAndWarnings } from '../types';
+import type { InvariantContext, RobotStateAndWarnings, ThermocyclerModuleState } from '../types';
 export declare const forThermocyclerSetTargetBlockTemperature: (params: ThermocyclerSetTargetBlockTemperatureParams, invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
 export declare const forThermocyclerSetTargetLidTemperature: (params: TemperatureParams, invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
 export declare const forThermocyclerAwaitBlockTemperature: (params: ModuleOnlyParams, invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
@@ -19,4 +19,4 @@ export declare const forThermocyclerStartRunExtendedProfile: (params: TCStartExt
  * This returns `true` if this task was found to be a Thermocycler-related task.
  * If it's not a Thermocycler-related task, this returns `false` and no-ops.
  */
-export declare const handleWaitForTaskForThermocyclers: (taskId: string, invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => boolean;
+export declare const handleWaitForTaskForThermocyclers: (thermocyclerModuleState: ThermocyclerModuleState) => boolean;

package/lib/getNextRobotStateAndWarnings/vacuumUpdates.d.ts

@@ -0,0 +1,9 @@
+import type { VacuumModuleOpenVentCreateCommand, VacuumModuleSetTargetPowerCreateCommand, VacuumModuleSetTargetPressureCreateCommand, VacuumModuleStartRunProfileCreateCommand, VacuumModuleStopPumpCreateCommand } from '@opentrons/shared-data';
+import type { InvariantContext, RobotStateAndWarnings, VacuumModuleState } from '../types';
+export declare const forVacuumOpenVent: (params: VacuumModuleOpenVentCreateCommand['params'], invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
+export declare const forVacuumCloseVent: (params: VacuumModuleOpenVentCreateCommand['params'], invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
+export declare const forVacuumSetPumpPressure: (params: VacuumModuleSetTargetPressureCreateCommand['params'], invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
+export declare const forVacuumSetPumpPower: (params: VacuumModuleSetTargetPowerCreateCommand['params'], invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
+export declare const forVacuumStopPump: (params: VacuumModuleStopPumpCreateCommand['params'], invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
+export declare const forVacuumStartRunProfile: (params: VacuumModuleStartRunProfileCreateCommand['params'], invariantContext: InvariantContext, robotStateAndWarnings: RobotStateAndWarnings) => void;
+export declare const handleWaitForTaskForVacuums: (vacuumModuleState: VacuumModuleState) => boolean;