AFL.automation.prepare.OT2HTTPDriver#

Functions

ceil(x, /)

Return the ceiling of x as an Integral.

listify(obj)

Classes

Driver(name[, defaults, overrides, useful_links])

OT2HTTPDriver([overrides])

class AFL.automation.prepare.OT2HTTPDriver.OT2HTTPDriver(overrides=None)[source]#
defaults = {'robot_ip': '127.0.0.1', 'robot_port': '31950'}#
__init__(overrides=None)[source]#
log_info(message)[source]#

Log info message safely

log_error(message)[source]#

Log error message safely

log_debug(message)[source]#

Log debug message safely

log_warning(message)[source]#

Log warning message safely

reset_prep_targets()[source]#
add_prep_targets(targets, reset=False)[source]#
get_prep_target()[source]#
status()[source]#
reset_tipracks(mount='both')[source]#

Reset the available tips for the specified mount(s)

reset()[source]#
home(**kwargs)[source]#

Home the robot’s axes using the dedicated /robot/home endpoint.

This endpoint is a direct control endpoint and doesn’t require creating a run. It can be used to home all axes at once or specific axes as needed.

parse_well(loc)[source]#

Parse a well location string into slot and well components

get_wells(locs)[source]#

Convert location strings to well objects with proper labware IDs, and check that wells are valid.

Parameters:

locs – Single location string or list of location strings in format “slotwell” (e.g. “1A1”)

Returns:

List of well objects with labwareId and wellName

Raises:

ValueError – If labware is not found in the specified slot

load_labware(name, slot, module=None, **kwargs)[source]#

Load labware (containers, tipracks) into the protocol using HTTP API

load_module(name, slot, **kwargs)[source]#

Load modules (heater-shaker, tempdeck) into the protocol using HTTP API

load_instrument(name, mount, tip_rack_slots, **kwargs)[source]#

Load pipette and store tiprack information using HTTP API.

mix(volume, location, repetitions=1, **kwargs)[source]#
transfer(source, dest, volume, mix_before=None, mix_after=None, air_gap=0, aspirate_rate=None, dispense_rate=None, mix_aspirate_rate=None, mix_dispense_rate=None, blow_out=False, post_aspirate_delay=0.0, aspirate_equilibration_delay=0.0, post_dispense_delay=0.0, drop_tip=True, force_new_tip=False, to_top=True, to_center=False, to_top_z_offset=0, fast_mixing=False, **kwargs)[source]#

Transfer fluid from one location to another using atomic HTTP API commands

set_aspirate_rate(rate=150, pipette=None)[source]#

Set aspirate rate in uL/s. Default is 150 uL/s

set_dispense_rate(rate=300, pipette=None)[source]#

Set dispense rate in uL/s. Default is 300 uL/s

set_gantry_speed(speed=400)[source]#

Set movement speed of gantry. Default is 400 mm/s

get_pipette(volume, method='min_transfers')[source]#
get_aspirate_rate(pipette=None)[source]#

Get current aspirate rate for a pipette

get_dispense_rate(pipette=None)[source]#

Get current dispense rate for a pipette

set_shake(rpm, module_id=None)[source]#
stop_shake(module_id=None)[source]#
set_shaker_temp(temp, module_id=None)[source]#
stop_shaker_heat(module_id=None)[source]#
unlatch_shaker(module_id=None)[source]#
latch_shaker(module_id=None)[source]#
get_shaker_temp()[source]#
get_shake_rpm()[source]#
get_shake_latch_status()[source]#
get_tip(mount)[source]#
get_tip_status(mount=None)[source]#

Get the current tip usage status

visualize_deck(**kwargs)[source]#

Generate HTML visualization of OT-2 deck layout with detailed well layouts.

Returns:

HTML string for deck visualization

Return type:

str

visualize_deck_simple(**kwargs)[source]#

Generate a simple HTML snippet for OT-2 deck visualization with well layouts.

Returns:

HTML snippet for deck visualization

Return type:

str