Skip to content

Commit 5268a4e

Browse files
authored
docs(api): Versioning page for API level 2.24 (#18805)
1 parent 6569b31 commit 5268a4e

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

api/docs/v2/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
# use rst_prolog to hold the subsitution
100100
# update the apiLevel value whenever a new minor version is released
101101
rst_prolog = f"""
102-
.. |apiLevel| replace:: 2.23
102+
.. |apiLevel| replace:: 2.24
103103
.. |release| replace:: {release}
104104
"""
105105

api/docs/v2/versioning.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The maximum supported API version for your robot is listed in the Opentrons App
6868

6969
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.
7070

71-
Opentrons robots running the latest software (8.4.0) support the following version ranges:
71+
Opentrons robots running the latest software (8.5.0) support the following version ranges:
7272

7373
* **Flex:** version 2.15–|apiLevel|.
7474
* **OT-2:** versions 2.0–|apiLevel|.
@@ -84,6 +84,8 @@ This table lists the correspondence between Protocol API versions and robot soft
8484
+-------------+------------------------------+
8585
| API Version | Introduced in Robot Software |
8686
+=============+==============================+
87+
| 2.24 | 8.5.0 |
88+
+-------------+------------------------------+
8789
| 2.23 | 8.4.0 |
8890
+-------------+------------------------------+
8991
| 2.22 | 8.3.0 |
@@ -140,6 +142,15 @@ This table lists the correspondence between Protocol API versions and robot soft
140142
Changes in API Versions
141143
=======================
142144

145+
Version 2.24
146+
-------------
147+
- Adds the ability to perform liquid handling actions using :ref:`liquid classes <liquid-classes>`.
148+
149+
- :py:meth:`.ProtocolContext.get_liquid_class` accesses :ref:`Opentrons-verified liquid class definitions <liquid-class-definitions>` for aqueous, volatile, and viscous liquids.
150+
- :py:meth:`.ProtocolContext.define_liquid_class` lets you create your own liquid classes from verified classes or from scratch.
151+
- New :py:class:`.InstrumentContext` methods — :py:meth:`.transfer_with_liquid_class`, :py:meth:`.distribute_with_liquid_class`, and :py:meth:`.consolidate_with_liquid_class` — move liquids according to their properties.
152+
- :py:meth:`.air_gap`, :py:meth:`.blow_out`, :py:meth:`.dispense`, :py:meth:`.mix`, and :py:meth:`.touch_tip` have new parameters for advanced settings that are also available in Protocol Designer.
153+
143154
Version 2.23
144155
-------------
145156
- Wells now have a :py:meth:`~.Well.meniscus` location that corresponds to the top of the liquid, either as set in the protocol or measured by probing with a pipette tip. See :ref:`well-meniscus`.

0 commit comments

Comments
 (0)