pylabrobot.liquid_handling.backends.hamilton.vantage.Vantage

class pylabrobot.liquid_handling.backends.hamilton.vantage.Vantage(device_address: int | None = None, serial_number: str | None = None, packet_read_timeout: int = 3, read_timeout: int = 60, write_timeout: int = 30)

Bases: HamiltonLiquidHandler

A Hamilton Vantage liquid handler.

Attributes

deck
module_id_length	The length of the module identifier in firmware commands.
num_channels	The number of channels on the robot.

Methods

__init__([device_address, serial_number, ...])	Create a new STAR interface.
arm_pre_initialize()	Initialize the arm module.
arm_request_instrument_initialization_status()	Request the instrument initialization status.
aspirate(ops, use_channels[, jet, blow_out, ...])	Aspirate from (a) resource(s).
aspirate96(aspiration[, jet, blow_out, hlc, ...])	Aspirate from a plate.
assigned_resource_callback(resource)	Called when a new resource was assigned to the robot.
calculates_check_sums_and_compares_them_with_the_value_saved_in_flash_eprom([...])	Calculates check sums and compares them with the value saved in Flash EPROM
check_fw_string_error(resp)	Raise an error if the firmware response is an error response.
core96_aspiration_of_liquid([...])	Aspiration of liquid using the 96 head.
core96_dispensing_of_liquid([...])	Dispensing of liquid using the 96 head.
core96_empty_washed_tips([...])	Empty washed tips (end of wash procedure only) on the 96 head.
core96_initialize([x_position, y_position, ...])	Initialize 96 head.
core96_move_to_defined_position([...])	Move to defined position using the 96 head.
core96_query_tip_presence()	Query Tip presence on the 96 head.
core96_request_initialization_status()	Request CoRe96 initialization status
core96_request_position()	Request position of the 96 head.
core96_request_tadm_error_status([...])	Request TADM error status on the 96 head.
core96_search_for_teach_in_signal_in_x_direction([...])	Search for Teach in signal in X direction on the 96 head.
core96_set_any_parameter()	Set any parameter within the 96 head module.
core96_tip_discard([x_position, y_position, ...])	Tip Discard using the 96 head.
core96_tip_pick_up([x_position, y_position, ...])	Tip Pick up using the 96 head.
core96_wash_tips([x_position, y_position, ...])	Wash tips on the 96 head.
define_tip_needle(tip_type_table_index, ...)	Tip/needle definition.
deserialize(data)
discard_core_gripper_tool([...])	Discard CoRe gripper tool
disco_mode()	Easter egg.
dispense(ops, use_channels[, jet, blow_out, ...])	Dispense to (a) resource(s).
dispense96(dispense[, jet, blow_out, empty, ...])	Dispense to a plate using the 96 head.
dispense_on_fly(y_position[, tip_pattern, ...])	Dispense on fly
drop_resource(drop[, z_clearance_height, ...])	Release a resource picked up with the IPG.
drop_tips(ops, use_channels[, ...])	Drop tips to a resource.
drop_tips96(drop[, z_deposit_position, ...])	Drop tips to the specified resource using CoRe 96.
expose_channel_n([channel_index])	Expose channel n
get_available_devices()	Get a list of available devices that match the specified vendor and product IDs, and serial number and device_address if specified.
get_id_from_fw_response(resp)	Get the id from a firmware response.
get_or_assign_tip_type_index(tip)	Get a tip type table index for the tip.
get_ttti(tips)	Get tip type table index for a list of tips.
grip_plate([plate_center_x_direction, ...])	Grip plate
ipg_expose_channel_n()	Expose channel n
ipg_get_parking_status()	Get parking status.
ipg_grip_plate([x_position, y_position, ...])	Grip plate
ipg_initialize()	Initialize IPG
ipg_move_to_defined_position([x_position, ...])	Move to defined position
ipg_park()	Park IPG
ipg_prepare_gripper_orientation([...])	Prepare gripper orientation
ipg_put_plate([x_position, y_position, ...])	Put plate
ipg_query_tip_presence()	Query Tip presence
ipg_release_object()	Release object
ipg_request_access_range([grip_orientation])	Request access range
ipg_request_actual_angular_dimensions()	Request actual angular dimensions
ipg_request_configuration()	Request configuration
ipg_request_initialization_status()	Request initialization status of IPG.
ipg_request_position([grip_orientation])	Request position
ipg_search_for_teach_in_signal_in_x_direction([...])	Search for Teach in signal in X direction
ipg_set_any_parameter_within_this_module()	Set any parameter within this module
list_available_devices()	Utility to list all devices that match the specified vendor and product IDs, and serial number and address if specified.
loading_cover_initialize()	Initialize the loading cover.
loading_cover_request_initialization_status()	Request the loading cover initialization status.
move_channel_x(channel, x)	Move the specified channel to the specified x coordinate.
move_channel_y(channel, y)	Move the specified channel to the specified y coordinate.
move_channel_z(channel, z)	Move the specified channel to the specified z coordinate.
move_picked_up_resource(move)	Move a resource picked up with the IPG.
move_to_defined_position(x_position, y_position)	Move to defined position
move_to_position([plate_center_x_direction, ...])	Move to position
nano_pulse_dispense(x_position, y_position)	Nano pulse dispense
pick_up_resource(pickup[, grip_strength, ...])	Pick up a resource with the IPG.
pick_up_tips(ops, use_channels[, ...])	Pick up tips from the specified resource.
pick_up_tips96(pickup[, ...])	Pick up tips from the specified resource using CoRe 96.
pip_aspirate(x_position, y_position[, ...])	Aspiration of liquid
pip_dispense(x_position, y_position[, ...])	Dispensing of liquid
pip_initialize(x_position, y_position[, ...])	Initialize
pip_request_initialization_status()	Request the pip initialization status.
pip_tip_discard(x_position, y_position[, ...])	Tip Discard
pip_tip_pick_up(x_position, y_position[, ...])	Tip Pick up
position_all_channels_in_y_direction(y_position)	Position all channels in Y direction
position_all_channels_in_z_direction([...])	Position all channels in Z direction
position_single_channel_in_y_direction([...])	Position single channel in Y direction
position_single_channel_in_z_direction([...])	Position single channel in Z direction
prepare_for_manual_channel_operation(channel)	Prepare the robot for manual operation.
put_plate([plate_center_x_direction, ...])	Put plate
query_tip_presence()	Query Tip presence
read([timeout])	Read a response from the device.
release_object([first_pip_channel_node_no])	Release object
request_channel_dispense_on_fly_status()	Request channel dispense on fly status
request_height_of_last_lld()	Request height of last LLD
request_y_position_of_channel_n([channel_index])	Request Y Position of channel n
request_y_positions_of_all_channels()	Request Y Positions of all channels
request_z_position_of_channel_n([channel_index])	Request Z Position of channel n
request_z_positions_of_all_channels()	Request Z Positions of all channels
russian_roulette()	Dangerous easter egg.
search_for_teach_in_signal_in_x_direction([...])	Search for Teach in signal in X direction
send_command(module, command[, auto_id, ...])	Send a firmware command to the Hamilton machine.
send_raw_command(command[, write_timeout, ...])	Send a raw command to the machine.
serialize()	Serialize the backend to a dictionary.
set_any_parameter_within_this_module()	Set any parameter within this module
set_deck(deck)	Set the deck for the robot.
set_led_color(mode, intensity, white, red, ...)	Set the LED color.
set_loading_cover(cover_open)	Set the loading cover.
set_minimum_traversal_height(traversal_height)	Set the minimum traversal height for the robot.
setup([skip_loading_cover, skip_core96, ...])	Creates a USB connection and finds read/write interfaces.
simultaneous_aspiration_dispensation_of_liquid(...)	Simultaneous aspiration & dispensation of liquid
stop()	Close the USB connection to the machine.
teach_rack_using_channel_n([channel_index, ...])	Teach rack using channel n
unassigned_resource_callback(name)	Called when a resource is unassigned from the robot.
wash_tips(x_position, y_position[, ...])	Wash tips
write(data[, timeout])	Write data to the device.
x_arm_initialize()	Initialize the x arm
x_arm_move_arm_relatively_in_x([...])	Move arm relatively in X
x_arm_move_to_x_position([x_position, ...])	Move arm to X position
x_arm_move_to_x_position_with_all_attached_components_in_z_safety_position([...])	Move arm to X position with all attached components in Z safety position
x_arm_request_arm_x_position()	Request arm X position.
x_arm_request_error_code()	X arm request error code
x_arm_request_x_drive_recorded_data([...])	Request X drive recorded data
x_arm_search_x_for_teach_signal([...])	Search X for teach signal
x_arm_send_message_to_motion_controller([...])	Send message to motion controller
x_arm_set_any_parameter_within_this_module([...])	Set any parameter within this module
x_arm_set_x_drive_angle_of_alignment([TODO_XL_1])	Set X drive angle of alignment
x_arm_turn_x_drive_off()

Parameters:

• device_address (int | None)

• serial_number (str | None)

• packet_read_timeout (int)

• read_timeout (int)

• write_timeout (int)