Ctrl+K

pylabrobot.liquid_handling.backends.hamilton.STAR.STAR.dispense

Contents

pylabrobot.liquid_handling.backends.hamilton.STAR.STAR.dispense#

async STAR.dispense(ops: List[Dispense], use_channels: List[int], dispensing_mode: List[int] | None = None, pull_out_distance_transport_air: List[int] | None = None, second_section_height: List[int] | None = None, second_section_ratio: List[int] | None = None, minimum_height: List[int] | None = None, immersion_depth: List[int] | None = None, immersion_depth_direction: List[int] | None = None, surface_following_distance: List[int] | None = None, cut_off_speed: List[int] | None = None, stop_back_volume: List[int] | None = None, transport_air_volume: List[int] | None = None, lld_mode: List[LLDMode] | None = None, dispense_position_above_z_touch_off: List[int] | None = None, gamma_lld_sensitivity: List[int] | None = None, dp_lld_sensitivity: 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_from_liquid_surface: List[int] | None = None, mix_speed: List[int] | None = None, mix_surface_following_distance: List[int] | None = None, limit_curve_index: List[int] | None = None, minimum_traverse_height_at_beginning_of_a_command: int | None = None, min_z_endpos: int | None = None, side_touch_off_distance: int = 0, hamilton_liquid_classes: List[HamiltonLiquidClass | None] | None = None, jet: List[bool] | None = None, blow_out: List[bool] | None = None, empty: List[bool] | None = None)#

Dispense liquid from the specified channels.

For all parameters where None is the default value, STAR will use the default value, based on the dispenses. For all list parameters, the length of the list must be equal to the number of operations.

Warning

The parameters in this method, with the exception of ops and use_channels, expect units of tenths of ‘millimeters’ (i.e. 10 = 1 mm), or tenths of ‘microliters’ (i.e. 10 = 1 ul), or tenths of seconds. Speeds are in 0.1ul/s. This is a deviation from the rest of the API, which uses SI units. This is because the Hamilton API uses these units.

Parameters:

  • ops (List[Dispense]) – The dispense operations to perform.

  • use_channels (List[int]) – The channels to use for the dispense operations.

  • dispensing_mode (List[int] | None) – The dispensing mode to use for each operation.

  • pull_out_distance_transport_air (List[int] | None) – The distance to pull out the tip for aspirating transport air if LLD is disabled.

  • second_section_height (List[int] | None) – Unknown.

  • second_section_ratio (List[int] | None) – Unknown.

  • minimum_height (List[int] | None) – The minimum height at the end of the dispense.

  • immersion_depth (List[int] | None) – The distance above or below to liquid level to start dispensing. See the immersion_depth_direction parameter.

  • immersion_depth_direction (List[int] | None) – (0 = go deeper, 1 = go up out of liquid)

  • surface_following_distance (List[int] | None) – The distance to follow the liquid surface.

  • cut_off_speed (List[int] | None) – Unknown.

  • stop_back_volume (List[int] | None) – Unknown.

  • transport_air_volume (List[int] | None) – The volume of air to dispense before dispensing the liquid.

  • lld_mode (List[LLDMode] | None) – The liquid level detection mode to use.

  • dispense_position_above_z_touch_off (List[int] | None) – The height to move after LLD mode found the Z touch off position.

  • gamma_lld_sensitivity (List[int] | None) – The gamma LLD sensitivity. (1 = high, 4 = low)

  • dp_lld_sensitivity (List[int] | None) – The dp LLD sensitivity. (1 = high, 4 = low)

  • swap_speed (List[int] | None) – The homogenization speed.

  • settling_time (List[int] | None) – The settling time.

  • mix_volume (List[int] | None) – The volume to use for homogenization.

  • mix_cycles (List[int] | None) – The number of homogenization cycles.

  • mix_position_from_liquid_surface (List[int] | None) – The height to move above the liquid surface for homogenization.

  • mix_speed (List[int] | None) – The homogenization speed.

  • mix_surface_following_distance (List[int] | None) – The distance to follow the liquid surface for homogenization.

  • limit_curve_index (List[int] | None) – The limit curve to use for the dispense.

  • minimum_traverse_height_at_beginning_of_a_command (int | None) – The minimum height to move to before starting a dispense.

  • min_z_endpos (int | None) – The minimum height to move to after a dispense.

  • side_touch_off_distance (int) – The distance to move to the side from the well for a dispense.

  • hamilton_liquid_classes (List[HamiltonLiquidClass | None] | None) – Override the default liquid classes. See pylabrobot/liquid_handling/liquid_classes/hamilton/star.py

  • jet (List[bool] | None) – Whether to use jetting for each dispense. Defaults to False for all. Used for determining the dispense mode. True for dispense mode 0 or 1.

  • blow_out (List[bool] | None) – Whether to use “blow out” dispense mode for each dispense. Defaults to False for all. This is labelled as “empty” in the VENUS liquid editor, but “blow out” in the firmware documentation. True for dispense mode 1 or 3.

  • empty (List[bool] | None) – Whether to use “empty” dispense mode for each dispense. Defaults to False for all. Truly empty the tip, not available in the VENUS liquid editor, but is in the firmware documentation. Dispense mode 4.

On this page