Skip to content

Commit e66d350

Browse files
authored
Merge pull request #129 from OpenTrons/update_linux_permissions_docs
add explanatory note about USER and sudo
2 parents 0be966a + eb4ad30 commit e66d350

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

docs/source/running_app.rst

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,31 @@ You can download the latest version of the app from `our website`_.
1414
.. note::
1515

1616
If running on Linux:
17-
The user will need to be given permissions to open the robot's serial port. In a terminal window, run the following command.
17+
The user will need to be given permissions to open the robot's serial port. This requires `sudo` privileges.
18+
In a terminal window, run the following command
1819

1920
.. code-block:: bash
2021
2122
sudo usermod -a -G dialout $USER
2223
23-
Then logout and log back in as the user to activate the change.
24+
If you are running this command from an administrative account that will not be running the app (in order to get `sudo` privileges),
25+
replace $USER with the username of the account that will be running the app (this username can be found by typing
26+
27+
.. code-block:: bash
28+
29+
echo $USER
30+
31+
in the account that will be running the app.
32+
33+
Finally, logout and log back in as the user to activate the change.
2434

2535

2636
Connect to Robot
2737
--------------------
2838

2939
Make sure your robot is turned on, and your laptop is connected via USB cable.
3040

31-
Go to the select port drop down, and refresh if no ports are shown. Once the port shows up, click it and the robot will jog up and down.
41+
Go to the select port drop down, and refresh if no ports are shown. Once the port shows up, click it and the robot will jog up and down.
3242

3343
.. screenshot button with port drop down
3444
@@ -63,7 +73,7 @@ New to 2.0, the slot button moves exactly one slot over in either X or Y, depend
6373
AB Plungers
6474
^^^^^^^^^^^^^^^^^^^^
6575

66-
Use the plunger jog to move the plunger up and down. If you have selected a container or the pipette for the B axis, then the B axis will move, and if you have selected a container or the pipette for the A axis, it will move.
76+
Use the plunger jog to move the plunger up and down. If you have selected a container or the pipette for the B axis, then the B axis will move, and if you have selected a container or the pipette for the A axis, it will move.
6777

6878
.. screenshot plunger jog
6979
@@ -101,7 +111,7 @@ With a tip on the pipette, calibrate to the bottom of the first well or tube in
101111
Pipettes
102112
^^^^^^^^^^^^^^^^^^^^
103113

104-
Four calibrations positions need to be set for each pipette: Top, Bottom, Blow Out and Drop Tip. Make sure your pipette is manually set to its highest volume (or ~5 uL higher) for accurate calibration.
114+
Four calibrations positions need to be set for each pipette: Top, Bottom, Blow Out and Drop Tip. Make sure your pipette is manually set to its highest volume (or ~5 uL higher) for accurate calibration.
105115

106116
.. image:: img/app/pipette-calibration.png
107117

@@ -114,4 +124,4 @@ Run Protocol
114124

115125
Once all your positions are saved, you can run your protocol. A progress will keep track of what percentage of your protocol has been done. Protocols can be paused, or they can be stopped entirely. We recommend homing after all protocols have been completed or stopped.
116126

117-
.. image:: img/app/running-protocol.png
127+
.. image:: img/app/running-protocol.png

0 commit comments

Comments
 (0)