Skip to content
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.

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

docs(api): Versioning page updates for Python API 2.16 #14073

Merged
merged 12 commits into from
Dec 18, 2023
2 changes: 1 addition & 1 deletion api/docs/v2/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
# use rst_prolog to hold the subsitution
# update the apiLevel value whenever a new minor version is released
rst_prolog = f"""
.. |apiLevel| replace:: 2.15
.. |apiLevel| replace:: 2.16
.. |release| replace:: {release}
"""

Expand Down
32 changes: 30 additions & 2 deletions api/docs/v2/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ The maximum supported API version for your robot is listed in the Opentrons App

If you upload a protocol that specifies a higher API level than the maximum supported, your robot won't be able to analyze or run your protocol. You can increase the maximum supported version by updating your robot software and Opentrons App.

Opentrons robots running the latest software (7.0.0) support the following version ranges:
Opentrons robots running the latest software (7.1.0) support the following version ranges:

* **Flex:** version 2.15.
* **Flex:** version 2.15–|apiLevel|.
* **OT-2:** versions 2.0–|apiLevel|.


Expand All @@ -82,6 +82,8 @@ This table lists the correspondence between Protocol API versions and robot soft
+-------------+------------------------------+
| API Version | Introduced in Robot Software |
+=============+==============================+
| 2.16 | 7.1.0 |
+-------------+------------------------------+
| 2.15 | 7.0.0 |
+-------------+------------------------------+
| 2.14 | 6.3.0 |
Expand Down Expand Up @@ -122,6 +124,32 @@ This table lists the correspondence between Protocol API versions and robot soft
Changes in API Versions
=======================

Version 2.16
------------

This version introduces new features for Flex and adds and improves methods for aspirating and dispensing. Note that when updating Flex protocols to version 2.16, you *must* load a trash container before dropping tips.

- New features

- Use :py:meth:`.configure_nozzle_layout` to pick up a single column of tips with the 96-channel pipette. See :ref:`Partial Tip Pickup <partial-tip-pickup>`.
- Specify the trash containers attached to your Flex with :py:meth:`.load_waste_chute` and :py:meth:`.load_trash_bin`.
- Dispense, blow out, drop tips, and dispose labware in the waste chute. Disposing labware requires the gripper and calling :py:meth:`.move_labware` with ``use_gripper=True``.
- Perform actions in staging area slots by referencing slots A4 through D4. See :ref:`deck-slots`.
- Explicitly command a pipette to :py:meth:`.prepare_to_aspirate`. The API usually prepares pipettes to aspirate automatically, but this is useful for certain applications, like pre-wetting routines.

- Improved features

- :py:meth:`.aspirate`, :py:meth:`.dispense`, and :py:meth:`.mix` will not move any liquid when called with ``volume=0``.
- ``opentrons_simulate`` now works for all API versions.
ecormany marked this conversation as resolved.
Show resolved Hide resolved

- Other changes

- :py:obj:`.ProtocolContext.fixed_trash` and :py:obj:`.InstrumentContext.trash_container` now return :py:class:`.TrashBin` objects instead of :py:class:`.Labware` objects.

- Known issues

- It's possible to load a Thermocycler and then load another item in slot A1. It's also possible to load any labware or adapter on in the same slot as a trash bin. Don't do either of these things, as it could lead to unexpected pipetting behavior and crashes.
ecormany marked this conversation as resolved.
Show resolved Hide resolved

Version 2.15
------------

Expand Down
Loading