You are currently viewing the documentation for the OT-2 hardware control API. To view documentation for the Opentrons OT-2 Python Protocol API, click here.

Index

A

AbstractModule (class in opentrons.hardware_control.modules.mod_abc) API (class in opentrons.hardware_control.api) aspirate() (opentrons.hardware_control.api.API method)

attached_modules (opentrons.hardware_control.api.API property) attached_subsystems (opentrons.hardware_control.api.API property) await_temperature() (opentrons.hardware_control.modules.tempdeck.TempDeck method) axis_is_present() (opentrons.hardware_control.api.API method)

B

blow_out() (opentrons.hardware_control.api.API method) board_revision (opentrons.hardware_control.api.API property) bootloader() (opentrons.hardware_control.modules.magdeck.MagDeck method) (opentrons.hardware_control.modules.mod_abc.AbstractModule method) (opentrons.hardware_control.modules.tempdeck.TempDeck method) (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

build() (opentrons.hardware_control.modules.magdeck.MagDeck class method) (opentrons.hardware_control.modules.mod_abc.AbstractModule class method) (opentrons.hardware_control.modules.tempdeck.TempDeck class method) (opentrons.hardware_control.modules.thermocycler.Thermocycler class method) build_hardware_controller() (opentrons.hardware_control.api.API class method) build_hardware_simulator() (opentrons.hardware_control.api.API class method)

C

cache_instruments() (opentrons.hardware_control.api.API method) calibrate() (opentrons.hardware_control.modules.magdeck.MagDeck method) cancel_execution_and_running_tasks() (opentrons.hardware_control.api.API method) clean_up() (opentrons.hardware_control.api.API method) cleanup() (opentrons.hardware_control.modules.magdeck.MagDeck method) (opentrons.hardware_control.modules.mod_abc.AbstractModule method) (opentrons.hardware_control.modules.tempdeck.TempDeck method) (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

cleanup_persistent() (opentrons.hardware_control.modules.mod_abc.AbstractModule method) close() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) config (opentrons.hardware_control.api.API property) create_simulating_module() (opentrons.hardware_control.api.API method) current_height (opentrons.hardware_control.modules.magdeck.MagDeck property) current_position() (opentrons.hardware_control.api.API method) cycle_temperatures() (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

D

deactivate() (opentrons.hardware_control.modules.magdeck.MagDeck method) (opentrons.hardware_control.modules.mod_abc.AbstractModule method) (opentrons.hardware_control.modules.tempdeck.TempDeck method) (opentrons.hardware_control.modules.thermocycler.Thermocycler method) deactivate_block() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) deactivate_lid() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) delay() (opentrons.hardware_control.api.API method) device_info (opentrons.hardware_control.modules.magdeck.MagDeck property) (opentrons.hardware_control.modules.mod_abc.AbstractModule property) (opentrons.hardware_control.modules.tempdeck.TempDeck property) (opentrons.hardware_control.modules.thermocycler.Thermocycler property)

disconnected_callback() (opentrons.hardware_control.modules.mod_abc.AbstractModule method) disengage_axes() (opentrons.hardware_control.api.API method) dispense() (opentrons.hardware_control.api.API method) door_state (opentrons.hardware_control.api.API property) drop_tip() (opentrons.hardware_control.api.API method)

E

engage() (opentrons.hardware_control.modules.magdeck.MagDeck method) engaged_axes (opentrons.hardware_control.api.API property)

event_listener() (opentrons.hardware_control.modules.mod_abc.AbstractModule method) execute_profile() (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

F

firmware_prefix() (opentrons.hardware_control.modules.magdeck.MagDeck method) (opentrons.hardware_control.modules.mod_abc.AbstractModule method) (opentrons.hardware_control.modules.tempdeck.TempDeck method) (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

fw_version (opentrons.hardware_control.api.API property)

G

gantry_position() (opentrons.hardware_control.api.API method) get_bundled_fw() (opentrons.hardware_control.modules.mod_abc.AbstractModule method) get_config() (opentrons.hardware_control.api.API method) get_deck_from_machine() (opentrons.hardware_control.api.API method) get_engaged_axes() (opentrons.hardware_control.api.API method) get_estop_state() (opentrons.hardware_control.api.API method)

get_fw_version() (opentrons.hardware_control.api.API method) get_instrument_max_height() (opentrons.hardware_control.api.API method) get_lights() (opentrons.hardware_control.api.API method) get_serial_number() (opentrons.hardware_control.api.API method) get_status_bar_enabled() (opentrons.hardware_control.api.API method) get_status_bar_state() (opentrons.hardware_control.api.API method)

H

halt() (opentrons.hardware_control.api.API method) has_available_update() (opentrons.hardware_control.modules.mod_abc.AbstractModule method) (opentrons.hardware_control.modules.tempdeck.TempDeck method) has_gripper() (opentrons.hardware_control.api.API method)

home() (opentrons.hardware_control.api.API method) home_plunger() (opentrons.hardware_control.api.API method) home_z() (opentrons.hardware_control.api.API method) hopper_door_state (opentrons.hardware_control.modules.mod_abc.AbstractModule property)

I

identify() (opentrons.hardware_control.api.API method) (opentrons.hardware_control.modules.mod_abc.AbstractModule method) is_movement_execution_taskified() (opentrons.hardware_control.api.API method) is_simulated (opentrons.hardware_control.modules.magdeck.MagDeck property) (opentrons.hardware_control.modules.mod_abc.AbstractModule property) (opentrons.hardware_control.modules.tempdeck.TempDeck property) (opentrons.hardware_control.modules.thermocycler.Thermocycler property)

is_simulator (opentrons.hardware_control.api.API property)

L

lift_plate() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) live_data (opentrons.hardware_control.modules.magdeck.MagDeck property) (opentrons.hardware_control.modules.mod_abc.AbstractModule property) (opentrons.hardware_control.modules.tempdeck.TempDeck property) (opentrons.hardware_control.modules.thermocycler.Thermocycler property)

loop (opentrons.hardware_control.api.API property)

M

MagDeck (class in opentrons.hardware_control.modules.magdeck) model() (opentrons.hardware_control.modules.magdeck.MagDeck method) (opentrons.hardware_control.modules.mod_abc.AbstractModule method) (opentrons.hardware_control.modules.tempdeck.TempDeck method) (opentrons.hardware_control.modules.thermocycler.Thermocycler method) module opentrons.hardware_control opentrons.hardware_control.api opentrons.hardware_control.modules opentrons.hardware_control.modules.magdeck opentrons.hardware_control.modules.mod_abc opentrons.hardware_control.modules.tempdeck opentrons.hardware_control.modules.thermocycler opentrons.hardware_control.thread_manager

move_axes() (opentrons.hardware_control.api.API method) move_rel() (opentrons.hardware_control.api.API method) move_to() (opentrons.hardware_control.api.API method)

N

name() (opentrons.hardware_control.modules.magdeck.MagDeck class method) (opentrons.hardware_control.modules.mod_abc.AbstractModule class method) (opentrons.hardware_control.modules.tempdeck.TempDeck class method) (opentrons.hardware_control.modules.thermocycler.Thermocycler class method)

nonblocking_builder() (opentrons.hardware_control.thread_manager.ThreadManager static method)

O

open() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) opentrons.hardware_control module opentrons.hardware_control.api module opentrons.hardware_control.modules module opentrons.hardware_control.modules.magdeck module

opentrons.hardware_control.modules.mod_abc module opentrons.hardware_control.modules.tempdeck module opentrons.hardware_control.modules.thermocycler module opentrons.hardware_control.thread_manager module

P

pause() (opentrons.hardware_control.api.API method) pause_with_message() (opentrons.hardware_control.api.API method) pick_up_tip() (opentrons.hardware_control.api.API method) port (opentrons.hardware_control.modules.mod_abc.AbstractModule property) prep_for_update() (opentrons.hardware_control.modules.magdeck.MagDeck method) (opentrons.hardware_control.modules.mod_abc.AbstractModule method) (opentrons.hardware_control.modules.tempdeck.TempDeck method) (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

prepare_for_aspirate() (opentrons.hardware_control.api.API method) prepare_for_mount_movement() (opentrons.hardware_control.api.API method)

R

raise_plate() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) ramp_rate (opentrons.hardware_control.modules.thermocycler.Thermocycler property) register_callback() (opentrons.hardware_control.api.API method) reset() (opentrons.hardware_control.api.API method)

resume() (opentrons.hardware_control.api.API method) retract() (opentrons.hardware_control.api.API method) retract_axis() (opentrons.hardware_control.api.API method) return_from_raise_plate() (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

S

serial_number (opentrons.hardware_control.modules.magdeck.MagDeck property) (opentrons.hardware_control.modules.mod_abc.AbstractModule property) set_config() (opentrons.hardware_control.api.API method) set_lid_temperature() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) set_lights() (opentrons.hardware_control.api.API method) set_status_bar_enabled() (opentrons.hardware_control.api.API method) set_status_bar_state() (opentrons.hardware_control.api.API method) set_target_block_temperature() (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

set_target_lid_temperature() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) set_temperature() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) should_taskify_movement_execution() (opentrons.hardware_control.api.API method) start_set_temperature() (opentrons.hardware_control.modules.tempdeck.TempDeck method) status (opentrons.hardware_control.modules.magdeck.MagDeck property) (opentrons.hardware_control.modules.mod_abc.AbstractModule property) (opentrons.hardware_control.modules.tempdeck.TempDeck property) (opentrons.hardware_control.modules.thermocycler.Thermocycler property) stop() (opentrons.hardware_control.api.API method)

T

TempDeck (class in opentrons.hardware_control.modules.tempdeck)

Thermocycler (class in opentrons.hardware_control.modules.thermocycler) ThreadManager (class in opentrons.hardware_control.thread_manager)

U

update_config() (opentrons.hardware_control.api.API method) update_firmware() (opentrons.hardware_control.api.API method)

update_nozzle_configuration_for_mount() (opentrons.hardware_control.api.API method) updating (opentrons.hardware_control.modules.mod_abc.AbstractModule property) usb_port (opentrons.hardware_control.modules.mod_abc.AbstractModule property)

W

wait_for_block_target() (opentrons.hardware_control.modules.thermocycler.Thermocycler method) wait_for_lid_target() (opentrons.hardware_control.modules.thermocycler.Thermocycler method)

wrap_module() (opentrons.hardware_control.thread_manager.ThreadManager method) wrapped() (opentrons.hardware_control.thread_manager.ThreadManager method) wraps_instance() (opentrons.hardware_control.thread_manager.ThreadManager method)