Python API
Labware Library
Protocol Library
Protocol Designer
Contact sales
About
Mission
Our Team
Blog
Products
OT-2 Robot
OT-2 Add-ons
OT-2 Pipettes
Pipette Tips
Racks & Adapters
Reagents
Shop all products ›
Applications
PCR Sample Prep
Nucelic Acid Purification
qPCR/RT-PCR
ELISA
NGS Library Prep
Basic Pipetting
Protocols
Protocol Options
Gain an overview of our protocol creation options
Protocol Designer
Use our graphical user interface to design protocols
Protocol Library
Explore our open source database of protocols
Python API
Maximum customization for anyone with python and basic wetlab skills
Github
Contribute to open source protocol repository
Request a free custom protocol ›
Support & Sales
SUPPORT
OT-2 Start Guide
You recieved your robot, here's what's next
Product Help
Answer common technical questions
Github
Contribute to open source protocol repository
Labware Library
Understand what labware is compatible with the OT-2
Install the app
Contact support ›
SALES
Order online
Contact sales ›
Schedule a demo ›
Contact Sales
About
Products
Applications
Protocols
Support & Sales
Contact Sales
About
Mission ›
Our Team ›
Blog ›
Products
OT-2 Robot ›
OT-2 Add-ons ›
OT-2 Pipettes ›
Pipette Tips ›
Racks & Adapters ›
Reagents ›
Shop all products ›
Applications
PCR Sample Prep ›
Nucelic Acid Purification ›
qPCR/RT-PCR ›
ELISA ›
NGS Library Prep ›
Basic Pipetting ›
Protocols
Protocol Options ›
Gain an overview of our protocol creation options
Protocol Designer ›
Use our graphical user interface to design protocols
Protocol Library ›
Explore our open source database of protocols
Python API ›
Maximum customization for anyone with python and basic weblab skills
Github ›
Contribute to open source protocol repository
Request a free custom protocol ›
Support & Sales
SALES
Order online ›
Contact sales ›
SUPPORT
OT-2 Start Guide ›
You received your robot, here's what's next
Product Help ›
Answer common technical questions
Github ›
Contribute to open source protocol repository
Labware Library ›
Understand what labware is compatible with the OT-2
Install the app ›
Contact support ›
Python Protocol API v2
Python Protocol API
Table of Contents
Welcome
Tutorial
Versioning
Labware
Moving Labware
Hardware Modules
Deck Slots
Pipettes
Building Block Commands
Complex Commands
Labware and Deck Positions
Advanced Control
Protocol Examples
Adapting OT-2 Protocols for Flex
API Version 2 Reference
OT-2 Python API v1
OT-1 Python API
Related Topics
Documentation overview
Quick search
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
X
|
Y
|
Z
A
active_channels (opentrons.protocol_api.InstrumentContext property)
air_gap() (opentrons.protocol_api.InstrumentContext method)
allow_bundle() (in module opentrons.simulate)
api_version (opentrons.protocol_api.HeaterShakerContext property)
(opentrons.protocol_api.InstrumentContext property)
(opentrons.protocol_api.Labware property)
(opentrons.protocol_api.MagneticBlockContext property)
(opentrons.protocol_api.MagneticModuleContext property)
(opentrons.protocol_api.ProtocolContext property)
(opentrons.protocol_api.TemperatureModuleContext property)
(opentrons.protocol_api.ThermocyclerContext property)
(opentrons.protocol_api.Well property)
aspirate() (opentrons.protocol_api.InstrumentContext method)
B
block_target_temperature (opentrons.protocol_api.ThermocyclerContext property)
block_temperature (opentrons.protocol_api.ThermocyclerContext property)
block_temperature_status (opentrons.protocol_api.ThermocyclerContext property)
blow_out() (opentrons.protocol_api.InstrumentContext method)
bottom() (opentrons.protocol_api.Well method)
bundle_from_sim() (in module opentrons.simulate)
bundled_data (opentrons.protocol_api.ProtocolContext property)
C
calibrated_offset (opentrons.protocol_api.Labware property)
center() (opentrons.protocol_api.Well method)
channels (opentrons.protocol_api.InstrumentContext property)
child (opentrons.protocol_api.Labware property)
close_labware_latch() (opentrons.protocol_api.HeaterShakerContext method)
close_lid() (opentrons.protocol_api.ThermocyclerContext method)
columns() (opentrons.protocol_api.Labware method)
columns_by_index() (opentrons.protocol_api.Labware method)
columns_by_name() (opentrons.protocol_api.Labware method)
commands() (opentrons.protocol_api.ProtocolContext method)
comment() (opentrons.protocol_api.ProtocolContext method)
configure_for_volume() (opentrons.protocol_api.InstrumentContext method)
configure_nozzle_layout() (opentrons.protocol_api.InstrumentContext method)
consolidate() (opentrons.protocol_api.InstrumentContext method)
current_speed (opentrons.protocol_api.HeaterShakerContext property)
current_temperature (opentrons.protocol_api.HeaterShakerContext property)
current_volume (opentrons.protocol_api.InstrumentContext property)
D
deactivate() (opentrons.protocol_api.TemperatureModuleContext method)
(opentrons.protocol_api.ThermocyclerContext method)
deactivate_block() (opentrons.protocol_api.ThermocyclerContext method)
deactivate_heater() (opentrons.protocol_api.HeaterShakerContext method)
deactivate_lid() (opentrons.protocol_api.ThermocyclerContext method)
deactivate_shaker() (opentrons.protocol_api.HeaterShakerContext method)
deck (opentrons.protocol_api.ProtocolContext property)
default_speed (opentrons.protocol_api.InstrumentContext property)
define_liquid() (opentrons.protocol_api.ProtocolContext method)
delay() (opentrons.protocol_api.ProtocolContext method)
depth (opentrons.protocol_api.Well property)
description (opentrons.protocol_api.Liquid attribute)
diameter (opentrons.protocol_api.Well property)
disengage() (opentrons.protocol_api.MagneticModuleContext method)
dispense() (opentrons.protocol_api.InstrumentContext method)
display_color (opentrons.protocol_api.Liquid attribute)
display_name (opentrons.protocol_api.Well property)
distribute() (opentrons.protocol_api.InstrumentContext method)
door_closed (opentrons.protocol_api.ProtocolContext property)
drop_tip() (opentrons.protocol_api.InstrumentContext method)
E
engage() (opentrons.protocol_api.MagneticModuleContext method)
execute() (in module opentrons.execute)
execute_profile() (opentrons.protocol_api.ThermocyclerContext method)
F
fixed_trash (opentrons.protocol_api.ProtocolContext property)
flow_rate (opentrons.protocol_api.InstrumentContext property)
format_runlog() (in module opentrons.simulate)
from_center_cartesian() (opentrons.protocol_api.Well method)
G
get_arguments() (in module opentrons.execute)
(in module opentrons.simulate)
get_protocol_api() (in module opentrons.execute)
(in module opentrons.simulate)
H
has_tip (opentrons.protocol_api.InstrumentContext property)
(opentrons.protocol_api.Well property)
HeaterShakerContext (class in opentrons.protocol_api)
highest_z (opentrons.protocol_api.Labware property)
home() (opentrons.protocol_api.InstrumentContext method)
(opentrons.protocol_api.ProtocolContext method)
home_plunger() (opentrons.protocol_api.InstrumentContext method)
hw_pipette (opentrons.protocol_api.InstrumentContext property)
I
InstrumentContext (class in opentrons.protocol_api)
is_adapter (opentrons.protocol_api.Labware property)
is_simulating() (opentrons.protocol_api.ProtocolContext method)
is_tiprack (opentrons.protocol_api.Labware property)
L
Labware (class in opentrons.protocol_api)
labware (opentrons.protocol_api.HeaterShakerContext property)
(opentrons.protocol_api.MagneticBlockContext property)
(opentrons.protocol_api.MagneticModuleContext property)
(opentrons.protocol_api.TemperatureModuleContext property)
(opentrons.protocol_api.ThermocyclerContext property)
labware_latch_status (opentrons.protocol_api.HeaterShakerContext property)
length (opentrons.protocol_api.Well property)
lid_position (opentrons.protocol_api.ThermocyclerContext property)
lid_target_temperature (opentrons.protocol_api.ThermocyclerContext property)
lid_temperature (opentrons.protocol_api.ThermocyclerContext property)
lid_temperature_status (opentrons.protocol_api.ThermocyclerContext property)
Liquid (class in opentrons.protocol_api)
load_adapter() (opentrons.protocol_api.HeaterShakerContext method)
(opentrons.protocol_api.MagneticBlockContext method)
(opentrons.protocol_api.MagneticModuleContext method)
(opentrons.protocol_api.ProtocolContext method)
(opentrons.protocol_api.TemperatureModuleContext method)
(opentrons.protocol_api.ThermocyclerContext method)
load_adapter_from_definition() (opentrons.protocol_api.HeaterShakerContext method)
(opentrons.protocol_api.MagneticBlockContext method)
(opentrons.protocol_api.MagneticModuleContext method)
(opentrons.protocol_api.ProtocolContext method)
(opentrons.protocol_api.TemperatureModuleContext method)
(opentrons.protocol_api.ThermocyclerContext method)
load_instrument() (opentrons.protocol_api.ProtocolContext method)
load_labware() (opentrons.protocol_api.HeaterShakerContext method)
(opentrons.protocol_api.Labware method)
(opentrons.protocol_api.MagneticBlockContext method)
(opentrons.protocol_api.MagneticModuleContext method)
(opentrons.protocol_api.ProtocolContext method)
(opentrons.protocol_api.TemperatureModuleContext method)
(opentrons.protocol_api.ThermocyclerContext method)
load_labware_by_name() (opentrons.protocol_api.HeaterShakerContext method)
(opentrons.protocol_api.MagneticBlockContext method)
(opentrons.protocol_api.MagneticModuleContext method)
(opentrons.protocol_api.ProtocolContext method)
(opentrons.protocol_api.TemperatureModuleContext method)
(opentrons.protocol_api.ThermocyclerContext method)
load_labware_from_definition() (opentrons.protocol_api.HeaterShakerContext method)
(opentrons.protocol_api.Labware method)
(opentrons.protocol_api.MagneticBlockContext method)
(opentrons.protocol_api.MagneticModuleContext method)
(opentrons.protocol_api.ProtocolContext method)
(opentrons.protocol_api.TemperatureModuleContext method)
(opentrons.protocol_api.ThermocyclerContext method)
load_liquid() (opentrons.protocol_api.Well method)
load_module() (opentrons.protocol_api.ProtocolContext method)
load_name (opentrons.protocol_api.Labware property)
load_trash_bin() (opentrons.protocol_api.ProtocolContext method)
load_waste_chute() (opentrons.protocol_api.ProtocolContext method)
loaded_instruments (opentrons.protocol_api.ProtocolContext property)
loaded_labwares (opentrons.protocol_api.ProtocolContext property)
loaded_modules (opentrons.protocol_api.ProtocolContext property)
Location (class in opentrons.types)
M
magdeck_engage_height (opentrons.protocol_api.Labware property)
MagneticBlockContext (class in opentrons.protocol_api)
MagneticModuleContext (class in opentrons.protocol_api)
main() (in module opentrons.execute)
(in module opentrons.simulate)
max_speeds (opentrons.protocol_api.ProtocolContext property)
max_volume (opentrons.protocol_api.InstrumentContext property)
(opentrons.protocol_api.Well property)
min_volume (opentrons.protocol_api.InstrumentContext property)
mix() (opentrons.protocol_api.InstrumentContext method)
model (opentrons.protocol_api.HeaterShakerContext property)
(opentrons.protocol_api.InstrumentContext property)
(opentrons.protocol_api.MagneticBlockContext property)
(opentrons.protocol_api.MagneticModuleContext property)
(opentrons.protocol_api.TemperatureModuleContext property)
(opentrons.protocol_api.ThermocyclerContext property)
module
opentrons.execute
opentrons.protocol_api
opentrons.simulate
opentrons.types
Mount (class in opentrons.types)
mount (opentrons.protocol_api.InstrumentContext property)
move() (opentrons.types.Location method)
move_labware() (opentrons.protocol_api.ProtocolContext method)
move_to() (opentrons.protocol_api.InstrumentContext method)
N
name (opentrons.protocol_api.InstrumentContext property)
(opentrons.protocol_api.Labware property)
(opentrons.protocol_api.Liquid attribute)
O
OFF_DECK (in module opentrons.protocol_api)
open_labware_latch() (opentrons.protocol_api.HeaterShakerContext method)
open_lid() (opentrons.protocol_api.ThermocyclerContext method)
opentrons.execute
module
opentrons.protocol_api
module
opentrons.simulate
module
opentrons.types
module
P
parameters (opentrons.protocol_api.Labware property)
parent (opentrons.protocol_api.HeaterShakerContext property)
(opentrons.protocol_api.Labware property)
(opentrons.protocol_api.MagneticBlockContext property)
(opentrons.protocol_api.MagneticModuleContext property)
(opentrons.protocol_api.TemperatureModuleContext property)
(opentrons.protocol_api.ThermocyclerContext property)
(opentrons.protocol_api.Well property)
pause() (opentrons.protocol_api.ProtocolContext method)
pick_up_tip() (opentrons.protocol_api.InstrumentContext method)
PipetteNotAttachedError
Point (class in opentrons.types)
prepare_to_aspirate() (opentrons.protocol_api.InstrumentContext method)
ProtocolContext (class in opentrons.protocol_api)
Q
quirks (opentrons.protocol_api.Labware property)
R
rail_lights_on (opentrons.protocol_api.ProtocolContext property)
reset() (opentrons.protocol_api.Labware method)
reset_tipracks() (opentrons.protocol_api.InstrumentContext method)
resume() (opentrons.protocol_api.ProtocolContext method)
return_height (opentrons.protocol_api.InstrumentContext property)
return_tip() (opentrons.protocol_api.InstrumentContext method)
rows() (opentrons.protocol_api.Labware method)
rows_by_index() (opentrons.protocol_api.Labware method)
rows_by_name() (opentrons.protocol_api.Labware method)
S
serial_number (opentrons.protocol_api.HeaterShakerContext property)
(opentrons.protocol_api.MagneticModuleContext property)
(opentrons.protocol_api.TemperatureModuleContext property)
(opentrons.protocol_api.ThermocyclerContext property)
set_and_wait_for_shake_speed() (opentrons.protocol_api.HeaterShakerContext method)
set_and_wait_for_temperature() (opentrons.protocol_api.HeaterShakerContext method)
set_block_temperature() (opentrons.protocol_api.ThermocyclerContext method)
set_calibration() (opentrons.protocol_api.Labware method)
set_lid_temperature() (opentrons.protocol_api.ThermocyclerContext method)
set_offset() (opentrons.protocol_api.Labware method)
set_rail_lights() (opentrons.protocol_api.ProtocolContext method)
set_target_temperature() (opentrons.protocol_api.HeaterShakerContext method)
set_temperature() (opentrons.protocol_api.TemperatureModuleContext method)
simulate() (in module opentrons.simulate)
speed (opentrons.protocol_api.InstrumentContext property)
speed_status (opentrons.protocol_api.HeaterShakerContext property)
starting_tip (opentrons.protocol_api.InstrumentContext property)
status (opentrons.protocol_api.MagneticModuleContext property)
(opentrons.protocol_api.TemperatureModuleContext property)
T
target (opentrons.protocol_api.TemperatureModuleContext property)
target_speed (opentrons.protocol_api.HeaterShakerContext property)
target_temperature (opentrons.protocol_api.HeaterShakerContext property)
temperature (opentrons.protocol_api.TemperatureModuleContext property)
temperature_status (opentrons.protocol_api.HeaterShakerContext property)
TemperatureModuleContext (class in opentrons.protocol_api)
ThermocyclerContext (class in opentrons.protocol_api)
tip_length (opentrons.protocol_api.Labware property)
tip_racks (opentrons.protocol_api.InstrumentContext property)
top() (opentrons.protocol_api.TrashBin method)
(opentrons.protocol_api.WasteChute method)
(opentrons.protocol_api.Well method)
touch_tip() (opentrons.protocol_api.InstrumentContext method)
transfer() (opentrons.protocol_api.InstrumentContext method)
trash_container (opentrons.protocol_api.InstrumentContext property)
TrashBin (class in opentrons.protocol_api)
type (opentrons.protocol_api.HeaterShakerContext property)
(opentrons.protocol_api.InstrumentContext property)
(opentrons.protocol_api.MagneticBlockContext property)
(opentrons.protocol_api.MagneticModuleContext property)
(opentrons.protocol_api.TemperatureModuleContext property)
(opentrons.protocol_api.ThermocyclerContext property)
U
uri (opentrons.protocol_api.Labware property)
W
wait_for_temperature() (opentrons.protocol_api.HeaterShakerContext method)
WasteChute (class in opentrons.protocol_api)
Well (class in opentrons.protocol_api)
well() (opentrons.protocol_api.Labware method)
well_bottom_clearance (opentrons.protocol_api.InstrumentContext property)
well_name (opentrons.protocol_api.Well property)
wells() (opentrons.protocol_api.Labware method)
wells_by_index() (opentrons.protocol_api.Labware method)
wells_by_name() (opentrons.protocol_api.Labware method)
width (opentrons.protocol_api.Well property)
X
x (opentrons.types.Point attribute)
Y
y (opentrons.types.Point attribute)
Z
z (opentrons.types.Point attribute)