Skip to content

Commit

Permalink
docs(robot-server): emulator and simulator notes. (#7830)
Browse files Browse the repository at this point in the history
  • Loading branch information
amitlissack authored May 25, 2021
1 parent e21b870 commit 586744c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions robot-server/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,29 @@ Tests should be organized similarly to the organization of the module itself.
We use `Flake8 <https://flake8.pycqa.org>`_ for lint checks, and `mypy <http://mypy-lang.org/>`_ for type-checking annotations. Both of these tools are run in the ``lint`` makefile target, and is run in CI; PRs will not be merged with failing lint. Usage of ``noqa`` to temporarily disable lint is discouraged, but if you need to please disable only a specific rule and leave a comment explaining exactly why. The same goes with ``type: ignore``.

New code should have appropriate type annotations, and refactors of old code should try to add type annotations. We’re flexible about the refactor part, though - if adding type annotations greatly expands the scope of a PR, it’s OK to not add them as long as you explain this in the PR message.

Developer Modes
-----------------

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

These can be useful when an OT-2 and modules are not available.

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

***************
Simulators
***************
Simulation mode will run the robot-server with simple software simulations of the Smoothie and magnetic, temperature, and thermocycler modules. This mode is ideal for rapid testing as the GCODE communication layer is bypassed.

- `make -C robot-server dev`

***************
Emulators
***************
Using the emulation mode will have the robot server send GCODE commands to a running emulation application. In this mode, the robot server is running exactly as it would on the OT-2.

This requires two steps. Enter these commands from the opentrons directory:

- `make -C api emulator`
- `make -C robot-server dev-with-emulator`

0 comments on commit 586744c

Please sign in to comment.