Skip to content

docs(api): deprecate combination adapters #18181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ecormany merged 1 commit into from
Apr 25, 2025
Merged

docs(api): deprecate combination adapters #18181

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions api/docs/v2/new_labware.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,13 +156,17 @@ Use the ``adapter`` argument of ``load_labware()`` to load an adapter at the sam
.. versionadded:: 2.15
The ``adapter`` parameter.

The API also has some "combination" labware definitions, which treat the adapter and labware as a unit::
.. note::

hs_combo = hs_mod.load_labware(
"opentrons_96_flat_bottom_adapter_nest_wellplate_200ul_flat"
)
The API also has some "combination" labware definitions, which treat the adapter and labware as a unit::

hs_combo = hs_mod.load_labware(
"opentrons_96_flat_bottom_adapter_nest_wellplate_200ul_flat"
)

.. deprecated:: 2.15

Loading labware this way prevents you from :ref:`moving the labware <moving-labware>` onto or off of the adapter, so it's less flexible than loading the two separately. Avoid using combination definitions unless your protocol specifies an ``apiLevel`` of 2.14 or lower.
Labware loaded with combination adapters no longer support all API features, such as moving the top labware or pipetting relative to liquid meniscus. These definitions are marked as "Retired" in version 8.5.0 of the Opentrons App and later. Avoid using combination definitions unless your protocol specifies an ``apiLevel`` of 2.14 or lower, in which case they are required.

.. _new-well-access:

Expand Down