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.

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

Jump to bottom

docs(api): Python API 2.21 versioning page #16951

Merged
merged 2 commits into from
Nov 25, 2024
Merged

docs(api): Python API 2.21 versioning page #16951

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
998dbef
version bullets and bump apiLevel to 2.21
ecormany Nov 22, 2024
3a403a6
fix silly copy/paste error
ecormany Nov 22, 2024
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
2 changes: 1 addition & 1 deletion api/docs/v2/conf.py
View file
Open in desktop
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.20
.. |apiLevel| replace:: 2.21
.. |release| replace:: {release}
"""

Expand Down
8 changes: 6 additions & 2 deletions api/docs/v2/versioning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ 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 (8.0.0) support the following version ranges:
Opentrons robots running the latest software (8.2.0) support the following version ranges:

* **Flex:** version 2.15–|apiLevel|.
* **OT-2:** versions 2.0–|apiLevel|.
Expand All @@ -84,6 +84,8 @@ This table lists the correspondence between Protocol API versions and robot soft
+-------------+------------------------------+
| API Version | Introduced in Robot Software |
+=============+==============================+
| 2.21 | 8.2.0 |
+-------------+------------------------------+
| 2.20 | 8.0.0 |
+-------------+------------------------------+
| 2.19 | 7.3.1 |
Expand Down Expand Up @@ -136,7 +138,9 @@ Changes in API Versions

Version 2.21
------------
- :ref:`Liquid presence detection <lpd>` now only checks on the first aspiration of the :py:meth:`.mix` cycle.
- Adds :py:class:`.AbsorbanceReaderContext` to support the :ref:`Absorbance Plate Reader Module <absorbance-plate-reader-module>`. Use the load name ``absorbanceReaderV1`` with :py:meth:`.ProtocolContext.load_module` to add a Heater-Shaker to a protocol.
- :ref:`Liquid presence detection <lpd>` now only checks on the first aspiration of the :py:meth:`.mix` cycle.
- Improved the run log output of :py:meth:`.ThermocyclerContext.execute_profile`.

Version 2.20
------------
Expand Down
Loading