opentrons 8.6.0__py3-none-any.whl

opentrons/protocol_engine/commands/__init__.py

@@ -0,0 +1,757 @@
+"""Protocol engine command models.
+
+The `protocol_engine.commands` module contains the data models of all
+command requests and results the engine is able to handle. It also contains
+models and type definitions for command resources, where a command:
+
+- May be pending, running, completed, or failed
+- Contains request and, if applicable, result data
+- Has timestamps for when it was created, started, completed, and/or failed
+
+Request and result models in the module are defined using Pydantic, because
+they are part of the public input / output of the engine, and need validation
+and/or schema generation.
+"""
+
+from . import absorbance_reader
+from . import flex_stacker
+from . import heater_shaker
+from . import magnetic_module
+from . import temperature_module
+from . import thermocycler
+from . import calibration
+from . import unsafe
+from . import robot
+
+from .hash_command_params import hash_protocol_command_params
+from .generate_command_schema import generate_command_schema
+
+from .command import (
+    AbstractCommandImpl,
+    BaseCommand,
+    BaseCommandCreate,
+    CommandStatus,
+    CommandIntent,
+)
+
+from .command_unions import (
+    Command,
+    CommandAdapter,
+    CommandParams,
+    CommandCreate,
+    CommandCreateAdapter,
+    CommandResult,
+    CommandType,
+    CommandDefinedErrorData,
+)
+
+from .air_gap_in_place import (
+    AirGapInPlace,
+    AirGapInPlaceParams,
+    AirGapInPlaceCreate,
+    AirGapInPlaceResult,
+    AirGapInPlaceCommandType,
+)
+
+from .aspirate import (
+    Aspirate,
+    AspirateParams,
+    AspirateCreate,
+    AspirateResult,
+    AspirateCommandType,
+)
+
+from .aspirate_while_tracking import (
+    AspirateWhileTracking,
+    AspirateWhileTrackingParams,
+    AspirateWhileTrackingCreate,
+    AspirateWhileTrackingResult,
+    AspirateWhileTrackingCommandType,
+)
+
+from .aspirate_in_place import (
+    AspirateInPlace,
+    AspirateInPlaceParams,
+    AspirateInPlaceCreate,
+    AspirateInPlaceResult,
+    AspirateInPlaceCommandType,
+)
+
+from .comment import (
+    Comment,
+    CommentParams,
+    CommentCreate,
+    CommentResult,
+    CommentCommandType,
+)
+
+from .custom import (
+    Custom,
+    CustomParams,
+    CustomCreate,
+    CustomResult,
+    CustomCommandType,
+)
+
+from .dispense import (
+    Dispense,
+    DispenseParams,
+    DispenseCreate,
+    DispenseResult,
+    DispenseCommandType,
+)
+
+from .dispense_while_tracking import (
+    DispenseWhileTracking,
+    DispenseWhileTrackingParams,
+    DispenseWhileTrackingCreate,
+    DispenseWhileTrackingResult,
+    DispenseWhileTrackingCommandType,
+)
+
+from .dispense_in_place import (
+    DispenseInPlace,
+    DispenseInPlaceParams,
+    DispenseInPlaceCreate,
+    DispenseInPlaceResult,
+    DispenseInPlaceCommandType,
+)
+
+from .drop_tip import (
+    DropTip,
+    DropTipParams,
+    DropTipCreate,
+    DropTipResult,
+    DropTipCommandType,
+)
+
+from .drop_tip_in_place import (
+    DropTipInPlace,
+    DropTipInPlaceParams,
+    DropTipInPlaceCreate,
+    DropTipInPlaceResult,
+    DropTipInPlaceCommandType,
+)
+
+from .home import (
+    Home,
+    HomeParams,
+    HomeCreate,
+    HomeResult,
+    HomeCommandType,
+)
+
+from .load_labware import (
+    LoadLabware,
+    LoadLabwareParams,
+    LoadLabwareCreate,
+    LoadLabwareResult,
+    LoadLabwareCommandType,
+)
+
+from .reload_labware import (
+    ReloadLabware,
+    ReloadLabwareParams,
+    ReloadLabwareCreate,
+    ReloadLabwareResult,
+    ReloadLabwareCommandType,
+)
+
+from .load_liquid import (
+    LoadLiquid,
+    LoadLiquidParams,
+    LoadLiquidResult,
+    LoadLiquidCreate,
+    LoadLiquidCommandType,
+    LoadLiquidImplementation,
+)
+
+from .load_liquid_class import (
+    LoadLiquidClass,
+    LoadLiquidClassParams,
+    LoadLiquidClassCreate,
+    LoadLiquidClassResult,
+    LoadLiquidClassCommandType,
+    LoadLiquidClassImplementation,
+)
+
+from .load_module import (
+    LoadModule,
+    LoadModuleParams,
+    LoadModuleCreate,
+    LoadModuleResult,
+    LoadModuleCommandType,
+)
+
+from .load_pipette import (
+    LoadPipette,
+    LoadPipetteParams,
+    LoadPipetteCreate,
+    LoadPipetteResult,
+    LoadPipetteCommandType,
+)
+
+from .load_lid_stack import (
+    LoadLidStack,
+    LoadLidStackParams,
+    LoadLidStackCreate,
+    LoadLidStackResult,
+    LoadLidStackCommandType,
+)
+
+from .load_lid import (
+    LoadLid,
+    LoadLidParams,
+    LoadLidCreate,
+    LoadLidResult,
+    LoadLidCommandType,
+)
+
+from .move_labware import (
+    MoveLabware,
+    MoveLabwareParams,
+    MoveLabwareCreate,
+    MoveLabwareResult,
+    MoveLabwareCommandType,
+)
+
+from .move_relative import (
+    MoveRelative,
+    MoveRelativeParams,
+    MoveRelativeCreate,
+    MoveRelativeResult,
+    MoveRelativeCommandType,
+)
+
+from .move_to_coordinates import (
+    MoveToCoordinates,
+    MoveToCoordinatesParams,
+    MoveToCoordinatesCreate,
+    MoveToCoordinatesResult,
+    MoveToCoordinatesCommandType,
+)
+
+from .move_to_well import (
+    MoveToWell,
+    MoveToWellParams,
+    MoveToWellCreate,
+    MoveToWellResult,
+    MoveToWellCommandType,
+)
+
+from .move_to_addressable_area import (
+    MoveToAddressableArea,
+    MoveToAddressableAreaParams,
+    MoveToAddressableAreaCreate,
+    MoveToAddressableAreaResult,
+    MoveToAddressableAreaCommandType,
+)
+
+from .move_to_addressable_area_for_drop_tip import (
+    MoveToAddressableAreaForDropTip,
+    MoveToAddressableAreaForDropTipParams,
+    MoveToAddressableAreaForDropTipCreate,
+    MoveToAddressableAreaForDropTipResult,
+    MoveToAddressableAreaForDropTipCommandType,
+)
+
+from .wait_for_resume import (
+    WaitForResume,
+    WaitForResumeParams,
+    WaitForResumeCreate,
+    WaitForResumeResult,
+    WaitForResumeCommandType,
+)
+
+from .wait_for_duration import (
+    WaitForDuration,
+    WaitForDurationParams,
+    WaitForDurationCreate,
+    WaitForDurationResult,
+    WaitForDurationCommandType,
+)
+
+from .pick_up_tip import (
+    PickUpTip,
+    PickUpTipParams,
+    PickUpTipCreate,
+    PickUpTipResult,
+    PickUpTipCommandType,
+)
+
+from .save_position import (
+    SavePosition,
+    SavePositionParams,
+    SavePositionCreate,
+    SavePositionResult,
+    SavePositionCommandType,
+)
+
+from .set_rail_lights import (
+    SetRailLights,
+    SetRailLightsParams,
+    SetRailLightsCreate,
+    SetRailLightsResult,
+    SetRailLightsCommandType,
+)
+
+from .touch_tip import (
+    TouchTip,
+    TouchTipParams,
+    TouchTipCreate,
+    TouchTipResult,
+    TouchTipCommandType,
+)
+
+from .blow_out import (
+    BlowOutParams,
+    BlowOutResult,
+    BlowOutCreate,
+    BlowOutImplementation,
+    BlowOut,
+)
+
+from .blow_out_in_place import (
+    BlowOutInPlaceParams,
+    BlowOutInPlaceResult,
+    BlowOutInPlaceCreate,
+    BlowOutInPlaceImplementation,
+    BlowOutInPlace,
+)
+
+from .set_status_bar import (
+    SetStatusBar,
+    SetStatusBarParams,
+    SetStatusBarCreate,
+    SetStatusBarResult,
+    SetStatusBarImplementation,
+    SetStatusBarCommandType,
+)
+
+from .retract_axis import (
+    RetractAxis,
+    RetractAxisParams,
+    RetractAxisCreate,
+    RetractAxisResult,
+    RetractAxisCommandType,
+)
+
+from .configure_for_volume import (
+    ConfigureForVolume,
+    ConfigureForVolumeCreate,
+    ConfigureForVolumeParams,
+    ConfigureForVolumeResult,
+    ConfigureForVolumeCommandType,
+)
+
+from .prepare_to_aspirate import (
+    PrepareToAspirate,
+    PrepareToAspirateCreate,
+    PrepareToAspirateParams,
+    PrepareToAspirateResult,
+    PrepareToAspirateCommandType,
+)
+
+from .configure_nozzle_layout import (
+    ConfigureNozzleLayout,
+    ConfigureNozzleLayoutCreate,
+    ConfigureNozzleLayoutParams,
+    ConfigureNozzleLayoutResult,
+    ConfigureNozzleLayoutCommandType,
+)
+
+from .get_tip_presence import (
+    GetTipPresence,
+    GetTipPresenceCreate,
+    GetTipPresenceParams,
+    GetTipPresenceResult,
+    GetTipPresenceCommandType,
+)
+
+from .verify_tip_presence import (
+    VerifyTipPresence,
+    VerifyTipPresenceCreate,
+    VerifyTipPresenceParams,
+    VerifyTipPresenceResult,
+    VerifyTipPresenceCommandType,
+)
+
+from .get_next_tip import (
+    GetNextTip,
+    GetNextTipCreate,
+    GetNextTipParams,
+    GetNextTipResult,
+    GetNextTipCommandType,
+)
+
+from .liquid_probe import (
+    LiquidProbe,
+    LiquidProbeParams,
+    LiquidProbeCreate,
+    LiquidProbeResult,
+    LiquidProbeCommandType,
+    TryLiquidProbe,
+    TryLiquidProbeParams,
+    TryLiquidProbeCreate,
+    TryLiquidProbeResult,
+    TryLiquidProbeCommandType,
+)
+
+from .seal_pipette_to_tip import (
+    SealPipetteToTip,
+    SealPipetteToTipParams,
+    SealPipetteToTipCreate,
+    SealPipetteToTipResult,
+    SealPipetteToTipCommandType,
+)
+from .unseal_pipette_from_tip import (
+    UnsealPipetteFromTip,
+    UnsealPipetteFromTipParams,
+    UnsealPipetteFromTipCreate,
+    UnsealPipetteFromTipResult,
+    UnsealPipetteFromTipCommandType,
+)
+from .pressure_dispense import (
+    PressureDispense,
+    PressureDispenseParams,
+    PressureDispenseCreate,
+    PressureDispenseResult,
+    PressureDispenseCommandType,
+)
+
+from .identify_module import (
+    IdentifyModule,
+    IdentifyModuleParams,
+    IdentifyModuleCreate,
+    IdentifyModuleResult,
+    IdentifyModuleCommandType,
+)
+
+__all__ = [
+    # command type unions
+    "Command",
+    "CommandAdapter",
+    "CommandParams",
+    "CommandCreate",
+    "CommandCreateAdapter",
+    "CommandResult",
+    "CommandType",
+    "CommandPrivateResult",
+    "CommandDefinedErrorData",
+    # base interfaces
+    "AbstractCommandImpl",
+    "BaseCommand",
+    "BaseCommandCreate",
+    "CommandStatus",
+    "CommandIntent",
+    # command parameter hashing
+    "hash_protocol_command_params",
+    # command schema generation
+    "generate_command_schema",
+    # air gap command models
+    "AirGapInPlace",
+    "AirGapInPlaceCreate",
+    "AirGapInPlaceParams",
+    "AirGapInPlaceResult",
+    "AirGapInPlaceCommandType",
+    # aspirate command models
+    "Aspirate",
+    "AspirateCreate",
+    "AspirateParams",
+    "AspirateResult",
+    "AspirateCommandType",
+    # aspirate while tracking command models
+    "AspirateWhileTracking",
+    "AspirateWhileTrackingCreate",
+    "AspirateWhileTrackingParams",
+    "AspirateWhileTrackingResult",
+    "AspirateWhileTrackingCommandType",
+    # aspirate in place command models
+    "AspirateInPlace",
+    "AspirateInPlaceCreate",
+    "AspirateInPlaceParams",
+    "AspirateInPlaceResult",
+    "AspirateInPlaceCommandType",
+    # comment command models
+    "Comment",
+    "CommentParams",
+    "CommentCreate",
+    "CommentResult",
+    "CommentCommandType",
+    # custom command models
+    "Custom",
+    "CustomCreate",
+    "CustomParams",
+    "CustomResult",
+    "CustomCommandType",
+    # dispense command models
+    "Dispense",
+    "DispenseCreate",
+    "DispenseParams",
+    "DispenseResult",
+    "DispenseCommandType",
+    # dispense while tracking command models
+    "DispenseWhileTracking",
+    "DispenseWhileTrackingCreate",
+    "DispenseWhileTrackingParams",
+    "DispenseWhileTrackingResult",
+    "DispenseWhileTrackingCommandType",
+    # dispense in place command models
+    "DispenseInPlace",
+    "DispenseInPlaceCreate",
+    "DispenseInPlaceParams",
+    "DispenseInPlaceResult",
+    "DispenseInPlaceCommandType",
+    # drop tip command models
+    "DropTip",
+    "DropTipCreate",
+    "DropTipParams",
+    "DropTipResult",
+    "DropTipCommandType",
+    # drop tip in place command models
+    "DropTipInPlace",
+    "DropTipInPlaceCreate",
+    "DropTipInPlaceParams",
+    "DropTipInPlaceResult",
+    "DropTipInPlaceCommandType",
+    # home command models
+    "Home",
+    "HomeParams",
+    "HomeCreate",
+    "HomeResult",
+    "HomeCommandType",
+    # retract axis command models
+    "RetractAxis",
+    "RetractAxisCreate",
+    "RetractAxisParams",
+    "RetractAxisResult",
+    "RetractAxisCommandType",
+    # load labware command models
+    "LoadLabware",
+    "LoadLabwareCreate",
+    "LoadLabwareParams",
+    "LoadLabwareResult",
+    "LoadLabwareCommandType",
+    # reload labware command models
+    "ReloadLabware",
+    "ReloadLabwareCreate",
+    "ReloadLabwareParams",
+    "ReloadLabwareResult",
+    "ReloadLabwareCommandType",
+    # load module command models
+    "LoadModule",
+    "LoadModuleCreate",
+    "LoadModuleParams",
+    "LoadModuleResult",
+    "LoadModuleCommandType",
+    # identify module command models
+    "IdentifyModule",
+    "IdentifyModuleParams",
+    "IdentifyModuleCreate",
+    "IdentifyModuleResult",
+    "IdentifyModuleCommandType",
+    # load pipette command models
+    "LoadPipette",
+    "LoadPipetteCreate",
+    "LoadPipetteParams",
+    "LoadPipetteResult",
+    "LoadPipetteCommandType",
+    "LoadPipettePrivateResult",
+    # load lid stack command models
+    "LoadLidStack",
+    "LoadLidStackCreate",
+    "LoadLidStackParams",
+    "LoadLidStackResult",
+    "LoadLidStackCommandType",
+    "LoadLidStackPrivateResult",
+    # load lid command models
+    "LoadLid",
+    "LoadLidCreate",
+    "LoadLidParams",
+    "LoadLidResult",
+    "LoadLidCommandType",
+    "LoadLidPrivateResult",
+    # move labware command models
+    "MoveLabware",
+    "MoveLabwareCreate",
+    "MoveLabwareParams",
+    "MoveLabwareResult",
+    "MoveLabwareCommandType",
+    # move relative command models
+    "MoveRelative",
+    "MoveRelativeParams",
+    "MoveRelativeCreate",
+    "MoveRelativeResult",
+    "MoveRelativeCommandType",
+    # move to coordinates command models
+    "MoveToCoordinates",
+    "MoveToCoordinatesParams",
+    "MoveToCoordinatesCreate",
+    "MoveToCoordinatesResult",
+    "MoveToCoordinatesCommandType",
+    # move to well command models
+    "MoveToWell",
+    "MoveToWellCreate",
+    "MoveToWellParams",
+    "MoveToWellResult",
+    "MoveToWellCommandType",
+    # move to addressable area command models
+    "MoveToAddressableArea",
+    "MoveToAddressableAreaParams",
+    "MoveToAddressableAreaCreate",
+    "MoveToAddressableAreaResult",
+    "MoveToAddressableAreaCommandType",
+    # move to addressable area for drop tip command models
+    "MoveToAddressableAreaForDropTip",
+    "MoveToAddressableAreaForDropTipParams",
+    "MoveToAddressableAreaForDropTipCreate",
+    "MoveToAddressableAreaForDropTipResult",
+    "MoveToAddressableAreaForDropTipCommandType",
+    # wait for resume command models
+    "WaitForResume",
+    "WaitForResumeParams",
+    "WaitForResumeCreate",
+    "WaitForResumeResult",
+    "WaitForResumeCommandType",
+    # wait for duration command models
+    "WaitForDuration",
+    "WaitForDurationParams",
+    "WaitForDurationCreate",
+    "WaitForDurationResult",
+    "WaitForDurationCommandType",
+    # pick up tip command models
+    "PickUpTip",
+    "PickUpTipCreate",
+    "PickUpTipParams",
+    "PickUpTipResult",
+    "PickUpTipCommandType",
+    # save position command models
+    "SavePosition",
+    "SavePositionParams",
+    "SavePositionCreate",
+    "SavePositionResult",
+    "SavePositionCommandType",
+    # set rail lights command models
+    "SetRailLights",
+    "SetRailLightsParams",
+    "SetRailLightsCreate",
+    "SetRailLightsResult",
+    "SetRailLightsCommandType",
+    # touch tip command models
+    "TouchTip",
+    "TouchTipParams",
+    "TouchTipCreate",
+    "TouchTipResult",
+    "TouchTipCommandType",
+    # blow out command models
+    "BlowOutResult",
+    "BlowOutCreate",
+    "BlowOutImplementation",
+    "BlowOutParams",
+    "BlowOut",
+    # blow out in place command models
+    "BlowOutInPlaceParams",
+    "BlowOutInPlaceResult",
+    "BlowOutInPlaceCreate",
+    "BlowOutInPlaceImplementation",
+    "BlowOutInPlace",
+    # set status bar command models
+    "SetStatusBar",
+    "SetStatusBarParams",
+    "SetStatusBarCreate",
+    "SetStatusBarResult",
+    "SetStatusBarImplementation",
+    "SetStatusBarCommandType",
+    # load liquid command models
+    "LoadLiquid",
+    "LoadLiquidCreate",
+    "LoadLiquidImplementation",
+    "LoadLiquidParams",
+    "LoadLiquidResult",
+    "LoadLiquidCommandType",
+    # load liquid class command models
+    "LoadLiquidClass",
+    "LoadLiquidClassParams",
+    "LoadLiquidClassCreate",
+    "LoadLiquidClassResult",
+    "LoadLiquidClassImplementation",
+    "LoadLiquidClassCommandType",
+    # hardware control command models
+    # hardware module command bundles
+    "absorbance_reader",
+    "flex_stacker",
+    "heater_shaker",
+    "magnetic_module",
+    "temperature_module",
+    "thermocycler",
+    # calibration command bundle
+    "calibration",
+    # unsafe command bundle
+    "unsafe",
+    "robot",
+    # configure pipette volume command bundle
+    "ConfigureForVolume",
+    "ConfigureForVolumeCreate",
+    "ConfigureForVolumeParams",
+    "ConfigureForVolumeResult",
+    "ConfigureForVolumeCommandType",
+    # prepare pipette for aspirate command bundle
+    "PrepareToAspirate",
+    "PrepareToAspirateCreate",
+    "PrepareToAspirateParams",
+    "PrepareToAspirateResult",
+    "PrepareToAspirateCommandType",
+    # configure nozzle layout command bundle
+    "ConfigureNozzleLayout",
+    "ConfigureNozzleLayoutCreate",
+    "ConfigureNozzleLayoutParams",
+    "ConfigureNozzleLayoutResult",
+    "ConfigureNozzleLayoutCommandType",
+    # get pipette tip presence bundle
+    "GetTipPresence",
+    "GetTipPresenceCreate",
+    "GetTipPresenceParams",
+    "GetTipPresenceResult",
+    "GetTipPresenceCommandType",
+    # verify pipette tip presence bundle
+    "VerifyTipPresence",
+    "VerifyTipPresenceCreate",
+    "VerifyTipPresenceParams",
+    "VerifyTipPresenceResult",
+    "VerifyTipPresenceCommandType",
+    # get next tip command bundle
+    "GetNextTip",
+    "GetNextTipCreate",
+    "GetNextTipParams",
+    "GetNextTipResult",
+    "GetNextTipCommandType",
+    # liquid probe command bundle
+    "LiquidProbe",
+    "LiquidProbeParams",
+    "LiquidProbeCreate",
+    "LiquidProbeResult",
+    "LiquidProbeCommandType",
+    "TryLiquidProbe",
+    "TryLiquidProbeParams",
+    "TryLiquidProbeCreate",
+    "TryLiquidProbeResult",
+    "TryLiquidProbeCommandType",
+    # seal command bundle
+    "SealPipetteToTip",
+    "SealPipetteToTipParams",
+    "SealPipetteToTipCreate",
+    "SealPipetteToTipResult",
+    "SealPipetteToTipCommandType",
+    # unseal command bundle
+    "UnsealPipetteFromTip",
+    "UnsealPipetteFromTipParams",
+    "UnsealPipetteFromTipCreate",
+    "UnsealPipetteFromTipResult",
+    "UnsealPipetteFromTipCommandType",
+    # pressure dispense command bundle
+    "PressureDispense",
+    "PressureDispenseParams",
+    "PressureDispenseCreate",
+    "PressureDispenseResult",
+    "PressureDispenseCommandType",
+]