diff --git a/robot-server/README.rst b/robot-server/README.rst index 42c20310da4..d68bc2a696e 100755 --- a/robot-server/README.rst +++ b/robot-server/README.rst @@ -52,3 +52,29 @@ Tests should be organized similarly to the organization of the module itself. We use `Flake8 `_ for lint checks, and `mypy `_ 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`