Skip to content

Commit

Permalink
docs(api): adjust OT-2 apiLevel and other small fixes (#13389)
Browse files Browse the repository at this point in the history 
* flip versionadded on deck slots

* OT-2 on 2.14

* "latest" means 7.0.0

* fix hardcoded apiLevels in examples

* 2.13->2.14 on Modules
  • Loading branch information
@ecormany
ecormany authored Aug 28, 2023
1 parent ff0f26f commit 99f559c
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion api/docs/v2/adapting_ot2_flex.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You also need to specify ``'robotType': 'Flex'``. If you omit ``robotType`` in t
metadata = {
"protocolName": "My Protocol",
"description": "This protocol uses the OT-2",
"apiLevel": "|apiLevel|"
"apiLevel": "2.14"
}
.. tab:: Updated Flex code
Expand Down
4 changes: 2 additions & 2 deletions api/docs/v2/deck_slots.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ For example, these two ``load_labware()`` commands are equivalent:
protocol.load_labware("nest_96_wellplate_200ul_flat", "A1")
.. versionadded:: 2.0
.. versionadded:: 2.15

.. code-block:: python
protocol.load_labware("nest_96_wellplate_200ul_flat", 10)
.. versionadded:: 2.15
.. versionadded:: 2.0

Both of these commands would require you to load the well plate in the back left slot of the robot.

Expand Down
4 changes: 2 additions & 2 deletions api/docs/v2/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ For example, if we wanted to transfer liquid from well A1 to well B1 on a plate,
}
# requirements
requirements = {"robotType": "OT-2", "apiLevel": "|apiLevel|"}
requirements = {"robotType": "OT-2", "apiLevel": "2.14"}
# protocol run function
def run(protocol: protocol_api.ProtocolContext):
Expand All @@ -149,7 +149,7 @@ For example, if we wanted to transfer liquid from well A1 to well B1 on a plate,
This example proceeds completely linearly. Following it line-by-line, you can see that it has the following effects:

1. Gives the name, contact information, and a brief description for the protocol.
2. Indicates the protocol should run on an OT-2 robot, using API version |apiLevel|.
2. Indicates the protocol should run on an OT-2 robot, using API version 2.14.
3. Tells the robot that there is:
a. A 96-well flat plate in slot 1.
b. A rack of 300 µL tips in slot 2.
Expand Down
6 changes: 3 additions & 3 deletions api/docs/v2/modules/setup.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Use :py:meth:`.ProtocolContext.load_module` to load a module.
temperature_module = protocol.load_module(
module_name='temperature module gen2', location='D3')
After the ``load_module()`` method loads labware into your protocol, it returns the :py:class:`~opentrons.protocol_api.HeaterShakerContext` and :py:class:`~opentrons.protocol_api.TemperatureModuleContext` objects.
After the ``load_module()`` method loads the modules into your protocol, it returns the :py:class:`~opentrons.protocol_api.HeaterShakerContext` and :py:class:`~opentrons.protocol_api.TemperatureModuleContext` objects.

.. tab:: OT-2

Expand All @@ -40,7 +40,7 @@ Use :py:meth:`.ProtocolContext.load_module` to load a module.
from opentrons import protocol_api
metadata = {'apiLevel': '2.13'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
# Load a Magnetic Module GEN2 in deck slot 1.
Expand All @@ -51,7 +51,7 @@ Use :py:meth:`.ProtocolContext.load_module` to load a module.
temperature_module = protocol.load_module(
module_name='temperature module', location=3)
After the ``load_module()`` method loads labware into your protocol, it returns the :py:class:`~opentrons.protocol_api.MagneticModuleContext` and :py:class:`~opentrons.protocol_api.TemperatureModuleContext` objects.
After the ``load_module()`` method loads the modules into your protocol, it returns the :py:class:`~opentrons.protocol_api.MagneticModuleContext` and :py:class:`~opentrons.protocol_api.TemperatureModuleContext` objects.


.. versionadded:: 2.0
Expand Down
14 changes: 7 additions & 7 deletions api/docs/v2/new_atomic_commands.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The examples in this section would be added to the following:
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
tiprack = protocol.load_labware('corning_96_wellplate_360ul_flat', 2)
Expand Down Expand Up @@ -123,7 +123,7 @@ For this section, instead of using the protocol defined above, consider this set
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -212,7 +212,7 @@ The examples in this section should be inserted in the following:
.. code-block:: python
:substitutions:
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol):
plate = protocol.load_labware('corning_96_wellplate_360ul_flat', 2)
Expand Down Expand Up @@ -420,7 +420,7 @@ will be displayed in the Opentrons App when protocol execution pauses.
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
# The start of your protocol goes here...
Expand Down Expand Up @@ -452,7 +452,7 @@ None of these functions take any arguments:
from opentrons import protocol_api, types
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
pipette = protocol.load_instrument('p300_single', 'right')
Expand All @@ -474,7 +474,7 @@ The method :py:meth:`.ProtocolContext.comment` lets you display messages in the
from opentrons import protocol_api, types
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
protocol.comment('Hello, world!')
Expand All @@ -493,7 +493,7 @@ You can turn the robot rail lights on or off in the protocol using :py:meth:`.Pr
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
# turn on robot rail lights
Expand Down
2 changes: 1 addition & 1 deletion api/docs/v2/new_complex_commands.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The examples in this section will use the following set up:
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware('corning_96_wellplate_360ul_flat', 1)
Expand Down
16 changes: 8 additions & 8 deletions api/docs/v2/new_examples.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ This protocol uses some :ref:`basic commands <v2-atomic-commands>` to tell the r
from opentrons import protocol_api
metadata = {'apiLevel': '2.15'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -155,7 +155,7 @@ This protocol accomplishes the same thing as the previous example, but does it a
from opentrons import protocol_api
metadata = {'apiLevel': '2.15'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -219,7 +219,7 @@ When used in a protocol, loops automate repetitive steps such as aspirating and
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -259,7 +259,7 @@ Opentrons electronic pipettes can do some things that a human cannot do with a p
from opentrons import protocol_api
requirements = {'robotType': 'Flex', 'apiLevel':'2.15'}
requirements = {'robotType': 'Flex', 'apiLevel':'|apiLevel|'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -294,7 +294,7 @@ Opentrons electronic pipettes can do some things that a human cannot do with a p
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -338,7 +338,7 @@ This protocol dispenses diluent to all wells of a Corning 96-well plate. Next, i
from opentrons import protocol_api
requirements = {'robotType':'Flex', 'apiLevel': '2.15'}
requirements = {'robotType': 'Flex', 'apiLevel': '|apiLevel|'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -381,7 +381,7 @@ This protocol dispenses diluent to all wells of a Corning 96-well plate. Next, i
from opentrons import protocol_api
metadata = {'apiLevel': '2.15'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down Expand Up @@ -478,7 +478,7 @@ This protocol dispenses different volumes of liquids to a well plate and automat
:substitutions:
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
plate = protocol.load_labware(
Expand Down
2 changes: 1 addition & 1 deletion api/docs/v2/new_pipette.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ This code sample loads a P1000 Single-Channel GEN2 pipette in the left mount and
from opentrons import protocol_api
metadata = {'apiLevel': '|apiLevel|'}
metadata = {'apiLevel': '2.14'}
def run(protocol: protocol_api.ProtocolContext):
tiprack1 = protocol.load_labware(
Expand Down
2 changes: 1 addition & 1 deletion api/docs/v2/versioning.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,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 support the following version ranges:
Opentrons robots running the latest software (7.0.0) support the following version ranges:

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

0 comments on commit 99f559c

Please sign in to comment.