pylabrobot.liquid_handling.backends.hamilton.vantage.Vantage.aspirate

pylabrobot.liquid_handling.backends.hamilton.vantage.Vantage.aspirate#

async Vantage.aspirate(ops: List[Aspiration], use_channels: List[int], jet: List[bool] | None = None, blow_out: List[bool] | None = None, hlcs: List[HamiltonLiquidClass | None] | None = None, type_of_aspiration: List[int] | None = None, minimal_traverse_height_at_begin_of_command: List[int] | None = None, minimal_height_at_command_end: List[int] | None = None, lld_search_height: List[int] | None = None, clot_detection_height: List[int] | None = None, liquid_surface_at_function_without_lld: List[int] | None = None, pull_out_distance_to_take_transport_air_in_function_without_lld: List[int] | None = None, tube_2nd_section_height_measured_from_zm: List[int] | None = None, tube_2nd_section_ratio: List[int] | None = None, minimum_height: List[int] | None = None, immersion_depth: List[int] | None = None, surface_following_distance: List[int] | None = None, transport_air_volume: List[int] | None = None, pre_wetting_volume: List[int] | None = None, lld_mode: List[int] | None = None, lld_sensitivity: List[int] | None = None, pressure_lld_sensitivity: List[int] | None = None, aspirate_position_above_z_touch_off: List[int] | None = None, swap_speed: List[int] | None = None, settling_time: List[int] | None = None, mix_volume: List[int] | None = None, mix_cycles: List[int] | None = None, mix_position_in_z_direction_from_liquid_surface: List[int] | None = None, mix_speed: List[int] | None = None, surface_following_distance_during_mixing: List[int] | None = None, TODO_DA_5: List[int] | None = None, capacitive_mad_supervision_on_off: List[int] | None = None, pressure_mad_supervision_on_off: List[int] | None = None, tadm_algorithm_on_off: int = 0, limit_curve_index: List[int] | None = None, recording_mode: int = 0)#

Aspirate from (a) resource(s).

See pip_aspirate() (the firmware command) for parameter documentation. This method serves as a wrapper for that command, and will convert operations into the appropriate format. This method additionally provides default values based on firmware instructions sent by Venus on Vantage, rather than machine default values (which are often not what you want).

Parameters:
  • ops (List[Aspiration]) – The aspiration operations.

  • use_channels (List[int]) – The channels to use.

  • blow_out (List[bool] | None) – Whether to search for a “blow out” liquid class. This is only used on dispense. Note that in the VENUS liquid editor, the term “empty” is used for this, but in the firmware documentation, “empty” is used for a different mode (dm4).

  • hlcs (List[HamiltonLiquidClass | None] | None) – The Hamiltonian liquid classes to use. If None, the liquid classes will be determined automatically based on the tip and liquid used.

  • jet (List[bool] | None)

  • type_of_aspiration (List[int] | None)

  • minimal_traverse_height_at_begin_of_command (List[int] | None)

  • minimal_height_at_command_end (List[int] | None)

  • lld_search_height (List[int] | None)

  • clot_detection_height (List[int] | None)

  • liquid_surface_at_function_without_lld (List[int] | None)

  • pull_out_distance_to_take_transport_air_in_function_without_lld (List[int] | None)

  • tube_2nd_section_height_measured_from_zm (List[int] | None)

  • tube_2nd_section_ratio (List[int] | None)

  • minimum_height (List[int] | None)

  • immersion_depth (List[int] | None)

  • surface_following_distance (List[int] | None)

  • transport_air_volume (List[int] | None)

  • pre_wetting_volume (List[int] | None)

  • lld_mode (List[int] | None)

  • lld_sensitivity (List[int] | None)

  • pressure_lld_sensitivity (List[int] | None)

  • aspirate_position_above_z_touch_off (List[int] | None)

  • swap_speed (List[int] | None)

  • settling_time (List[int] | None)

  • mix_volume (List[int] | None)

  • mix_cycles (List[int] | None)

  • mix_position_in_z_direction_from_liquid_surface (List[int] | None)

  • mix_speed (List[int] | None)

  • surface_following_distance_during_mixing (List[int] | None)

  • TODO_DA_5 (List[int] | None)

  • capacitive_mad_supervision_on_off (List[int] | None)

  • pressure_mad_supervision_on_off (List[int] | None)

  • tadm_algorithm_on_off (int)

  • limit_curve_index (List[int] | None)

  • recording_mode (int)