Skip to content

Commit 880a5de

Browse files
docs(api,robot-server): Update readmes to avoid overspecifying as "OT-2" (#13357)
1 parent 39b3efc commit 880a5de

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

api/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Opentrons
1616
Introduction
1717
------------
1818

19-
This is the Opentrons library, the Python module that runs the Opentrons OT-2. It contains the code that interprets and executes protocols; code that controls the hardware both during and outside of protocols; and all the other small tasks and capabilities that the robot fulfills.
19+
This is the Opentrons library, the Python module that runs Opentrons robots. It contains the code that interprets and executes protocols; code that controls the hardware both during and outside of protocols; and all the other small tasks and capabilities that the robot fulfills.
2020

2121
This document is about the structure and purpose of the source code. For information on how to use the Opentrons library or the robot in general, please refer to our `Full API Documentation`_ for detailed instructions.
2222

2323
The Opentrons library has two purposes:
2424

25-
1. **Control an Opentrons OT-2 robot.** The API server uses the Opentrons library when controlling a robot. We boot up a server for the robot’s HTTP endpoints, and a server for its WebSockets-based RPC system for control during protocols. We are configured by files in the robot’s filesystem in ``/data``.
25+
1. **Control an Opentrons robot.** The API server uses the Opentrons library when controlling a robot. We boot up a server for the robot’s HTTP endpoints, and a server for its WebSockets-based RPC system for control during protocols. We are configured by files in the robot’s filesystem in ``/data``.
2626

2727
2. **Simulate protocols on users’ computers.** When simulating a protocol on a user’s computer, we use the entry point in `opentrons.simulate <https://github.com/Opentrons/opentrons/blob/edge/api/src/opentrons/simulate.py>`_. We set up simulators for the protocol, but do not run any kind of web servers. We are configured by files in the user’s home directory (for more information see configuration_).
2828

@@ -85,4 +85,4 @@ The module has a lot of configuration, some of which is only relevant when runni
8585
Dealing With Robot Versions
8686
---------------------------
8787

88-
The OT2 does not use the ``hardware`` subdirectory or the ``opentrons_hardware`` package. This can be a problem to work around. Please keep imports of ``opentrons_hardware`` to limited places inside the hardware_control submodule and tests of that submodule, and ensure that anything outside these safe areas conditionally imports ``opentrons_hardware`` or imports it inside a non-file scope in a place used only outside an OT2. In tests, any test that uses the OT3 hardware controller will be skipped in the ``test-ot2`` Makefile recipe.
88+
The OT-2 does not use the ``hardware`` subdirectory or the ``opentrons_hardware`` package. This can be a problem to work around. Please keep imports of ``opentrons_hardware`` to limited places inside the hardware_control submodule and tests of that submodule, and ensure that anything outside these safe areas conditionally imports ``opentrons_hardware`` or imports it inside a non-file scope in a place used only outside an OT2. In tests, any test that uses the OT3 hardware controller will be skipped in the ``test-ot2`` Makefile recipe.

api/pypi-readme.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
.. _Full API Documentation: http://docs.opentrons.com
22

3-
The Opentrons API is a simple framework designed to make writing automated biology lab protocols for the Opentrons OT-2 easy.
3+
The Opentrons API is a simple framework designed to make it easy to write automated biology lab protocols for Opentrons robots.
44

55
This package can be used to simulate protocols on your computer without connecting to a robot. Please refer to our `Full API Documentation`_ for detailed instructions on how to write and simulate your first protocol.
66

7-
This package is now for use with the Opentrons OT-2 only. For the software needed to run an Opentrons OT-1, please see versions_.
7+
This package is now for use with the Opentrons Flex and Opentrons OT-2 only. For the software needed to run an Opentrons OT-One, please see versions_.
88

99
.. _simulating:
1010

@@ -40,9 +40,9 @@ The module has a lot of configuration, some of which is only relevant when runni
4040
Note On Versions
4141
----------------
4242

43-
This API is for locally simulating protocols for the OT 2 without connecting to a robot. It no longer controls an OT 1.
43+
This API is for locally simulating protocols for the Flex or OT-2 without connecting to a robot. It no longer controls an OT-One.
4444

45-
`Version 2.5.2 <https://pypi.org/project/opentrons/2.5.2/>`_ was the final release of this API for the OT 1. If you want to download this API to use the OT 1, you should download it with
45+
`Version 2.5.2 <https://pypi.org/project/opentrons/2.5.2/>`_ was the final release of this API for the OT-One. If you want to download this API to use the OT-One, you should download it with
4646

4747
.. code-block:: shell
4848

robot-server/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Opentrons OT-2 HTTP API
1010
Introduction
1111
------------
1212

13-
This is the Opentrons HTTP Server, the webservice that runs the Opentrons OT-2. It contains endpoints for executing protocols, controlling the hardware, and various other small tasks and capabilities that the robot fulfills.
13+
This is the Opentrons HTTP Server, the webservice that runs the Opentrons Flex and Opentrons OT-2. It contains endpoints for executing protocols, controlling the hardware, and various other small tasks and capabilities that the robot fulfills.
1414

1515
This document is about the structure and purpose of the source code of the HTTP Server.
1616

@@ -54,7 +54,7 @@ Developer Modes
5454

5555
The robot server can be run on a PC in one of two development modes.
5656

57-
These can be useful when an OT-2 and modules are not available.
57+
These can be useful when a physical robot and modules are not available.
5858

5959
The **Opentrons** application will automatically discover a locally running robot server as **dev**.
6060

0 commit comments

Comments
 (0)