Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/_static/devices.json
Original file line number Diff line number Diff line change
Expand Up @@ -1713,9 +1713,10 @@
"liquid handling"
],
"status": "mostly",
"api": "pylabrobot.legacy.liquid_handling.backends.OpentronsOT2Backend",
"api_version": "v0",
"code_slug": "legacy/liquid_handling/backends",
"api": "pylabrobot.opentrons.OT2",
"api_version": "v1",
"code_slug": "opentrons/ot2",
"doc_slug": "opentrons/ot2/hello-world",
"manager": "https://discuss.pylabrobot.org/u/rickwierenga",
"oem": "https://opentrons.com/products/ot-2-robot"
},
Expand Down
31 changes: 31 additions & 0 deletions docs/api/pylabrobot.opentrons.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. currentmodule:: pylabrobot.opentrons

pylabrobot.opentrons package
=============================

``OT2`` owns the connection, active run, deck, and mounted pipettes. Use
``connect()`` for health and discovery queries without starting a run or moving
the robot; ``setup()`` also loads the pipettes into a run and optionally homes.
Queries return fresh values without changing the driver's session state.

``OpentronsAPI`` contains the named HTTP endpoints and response parsing.
``OpentronsRun`` provides command primitives and waits for their completion.
Both use the device's ``pylabrobot.io.HTTP`` transport. Pipette operations own
resource tracking and retraction to traversal height.

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

OT2
OT2Pipette
OpentronsAPI
OpentronsRun
RobotInfo
MountedPipette
ModuleInfo
OpentronsError
OpentronsCommandError
OpentronsCommandTimeout
OpentronsProtocolError
1 change: 1 addition & 0 deletions docs/api/pylabrobot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Manufacturers
pylabrobot.mettler_toledo
pylabrobot.micronic
pylabrobot.molecular_devices
pylabrobot.opentrons
pylabrobot.qinstruments
pylabrobot.revvity
pylabrobot.sartorius
Expand Down
1 change: 1 addition & 0 deletions docs/user_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ kbiosystems/index
mettler_toledo/index
micronic/index
molecular_devices/index
opentrons/index
qinstruments/index
revvity/index
sartorius/index
Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/opentrons/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Opentrons

```{toctree}
:maxdepth: 1

ot2/hello-world
```
Loading
Loading