You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(api): Flex revisions for Advanced Control (#13346)
* Make robot references generic for both models
Say either "Flex and OT-2" or just "the robots".
* Apply suggestions from code review
Co-authored-by: Ed Cormany <[email protected]>
* Fixing examples and quote marks
Changed the protocol example to OT-2 to match the API level 2.13. Remove ' ' in favor of " "
---------
Co-authored-by: Ed Cormany <[email protected]>
Copy file name to clipboardExpand all lines: api/docs/v2/new_advanced_running.rst
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,22 +7,22 @@ Advanced Control
7
7
8
8
As its name implies, the Python Protocol API is primarily designed for creating protocols that you upload via the Opentrons App and execute on the robot as a unit. But sometimes it's more convenient to control the robot outside of the app. For example, you might want to have variables in your code that change based on user input or the contents of a CSV file. Or you might want to only execute part of your protocol at a time, especially when developing or debugging a new protocol.
9
9
10
-
The OT-2 offers two ways of issuing Python API commands to the robot outside of the app: through Jupyter Notebook or on the command line with ``opentrons_execute``.
10
+
The Python API offers two ways of issuing commands to the robot outside of the app: through Jupyter Notebook or on the command line with ``opentrons_execute``.
11
11
12
12
Jupyter Notebook
13
13
----------------
14
14
15
-
The OT-2 runs a `Jupyter Notebook <https://jupyter.org>`_ server on port 48888, which you can connect to with your web browser. This is a convenient environment for writing and debugging protocols, since you can define different parts of your protocol in different notebook cells and run a single cell at a time.
15
+
The Flex and OT-2 run `Jupyter Notebook <https://jupyter.org>`_ servers on port 48888, which you can connect to with your web browser. This is a convenient environment for writing and debugging protocols, since you can define different parts of your protocol in different notebook cells and run a single cell at a time.
16
16
17
17
.. note::
18
-
The Jupyter Notebook server only supports Python Protocol API versions 2.13 and earlier. Use the Opentrons App to run protocols that require functionality added in newer versions.
18
+
Currently, the Jupyter Notebook server does not work with Python Protocol API versions 2.14 and 2.15. It does work with API versions 2.13 and earlier. Use the Opentrons App to run protocols that require functionality added in newer versions.
19
19
20
-
Access the OT-2’s Jupyter Notebook by either:
20
+
Access your robot's Jupyter Notebook by either:
21
21
22
22
- Going to the **Advanced** tab of Robot Settings and clicking **Launch Jupyter Notebook**.
23
23
- Going directly to ``http://<robot-ip>:48888`` in your web browser (if you know your robot's IP address).
24
24
25
-
Once you've launched Jupyter Notebook, you can create a notebook file or edit an existing one. These notebook files are stored on the OT-2 itself. If you want to save code from a notebook to your computer, go to **File > Download As** in the notebook interface.
25
+
Once you've launched Jupyter Notebook, you can create a notebook file or edit an existing one. These notebook files are stored on the the robot. If you want to save code from a notebook to your computer, go to **File > Download As** in the notebook interface.
26
26
27
27
Protocol Structure
28
28
^^^^^^^^^^^^^^^^^^
@@ -34,7 +34,7 @@ Rather than writing a ``run`` function and embedding commands within it, start
The first command you execute should always be :py:meth:`~opentrons.protocol_api.ProtocolContext.home`. If you try to execute other commands first, you will get a ``MustHomeError``. (When running protocols through the Opentrons App, the robot homes automatically.)
@@ -54,11 +54,11 @@ You can also use Jupyter to run a protocol that you have already written. To do
54
54
# the contents of your previously written protocol go here
55
55
56
56
57
-
Since a typical protocol only `defines` the ``run`` function but doesn't `call` it, this won't immediately cause the OT-2 to move. To begin the run, instantiate a :py:class:`.ProtocolContext` and pass it to the ``run`` function you just defined:
57
+
Since a typical protocol only `defines` the ``run`` function but doesn't `call` it, this won't immediately cause the robot to move. To begin the run, instantiate a :py:class:`.ProtocolContext` and pass it to the ``run`` function you just defined:
@@ -81,38 +81,38 @@ Creating the dummy protocol requires you to:
81
81
4. Load your smallest capacity pipette and specify its ``tipracks``.
82
82
5. Call ``pick_up_tip()``. Labware Position Check can't run if you don't pick up a tip.
83
83
84
-
For example, the following dummy protocol will use a Flex 50 µL pipette to enable Labware Position Check for a Flex tip rack, NEST reservoir, and NEST flat well plate.
84
+
For example, the following dummy protocol will use a P300 Single-Channel GEN2 pipette to enable Labware Position Check for an OT-2 tip rack, NEST reservoir, and NEST flat well plate.
After importing this protocol to the Opentrons App, run Labware Position Check to get the x, y, and z offsets for the tip rack and labware. When complete, you can click **Get Labware Offset Data** to view automatically generated code that uses :py:meth:`.set_offset` to apply the offsets to each piece of labware.
This automatically generated code uses generic names for the loaded labware. If you want to match the labware names already in your protocol, change the labware names to match your original code:
@@ -145,7 +145,7 @@ To disable the robot server, open a Jupyter terminal session by going to **New >
145
145
Command Line
146
146
------------
147
147
148
-
The OT-2's command line is accessible either by going to **New > Terminal** in Jupyter or `via SSH <https://support.opentrons.com/s/article/Connecting-to-your-OT-2-with-SSH>`_.
148
+
The robot's command line is accessible either by going to **New > Terminal** in Jupyter or `via SSH <https://support.opentrons.com/s/article/Connecting-to-your-OT-2-with-SSH>`_.
149
149
150
150
To execute a protocol from the robot's command line, copy the protocol file to the robot with ``scp`` and then run the protocol with ``opentrons_execute``:
151
151
@@ -154,4 +154,4 @@ To execute a protocol from the robot's command line, copy the protocol file to t
154
154
opentrons_execute /data/my_protocol.py
155
155
156
156
157
-
By default, ``opentrons_execute`` will print out the same run log shown in the Opentrons App, as the protocol executes. It also prints out internal logs at the level ``warning`` or above. Both of these behaviors can be changed; for further details, run ``opentrons_execute --help``.
157
+
By default, ``opentrons_execute`` will print out the same run log shown in the Opentrons App, as the protocol executes. It also prints out internal logs at the level ``warning`` or above. Both of these behaviors can be changed. Run ``opentrons_execute --help`` for more information.
0 commit comments