Skip to content

Commit 68c7d27

Browse files
authored
Update RPYC tutorial based on @ndward's input (#268)
1 parent 29eb6d1 commit 68c7d27

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

docs/rpyc.rst

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,24 @@ processes and computers, so that remote objects can be manipulated as if they
99
were local. Here are simple steps you need to follow in order to install and
1010
use RPyC with ev3dev:
1111

12-
1. Install RPyC both on the EV3 and on your desktop PC with the following
13-
command (depending on your operating system, you may need to use ``pip3`` or
14-
``pip`` on the PC instead of ``easy_install3``):
12+
1. Install RPyC both on the EV3 and on your desktop PC. For the EV3, enter the
13+
following command at the command prompt (after you `connect with SSH`_):
1514

1615
.. code-block:: shell
1716
1817
sudo easy_install3 rpyc
1918
19+
On the desktop PC, it really depends on your operating system. In case it is
20+
some flavor of linux, you should be able to do
21+
22+
.. code-block:: shell
23+
24+
sudo pip3 install rpyc
25+
26+
In case it is Windows, there is a win32 installer on the project's
27+
`sourceforge page`_. Also, have a look at the `Download and Install`_ page
28+
on their site.
29+
2030
2. Create file ``rpyc_server.sh`` with the following contents on the EV3:
2131

2232
.. code-block:: shell
@@ -30,9 +40,19 @@ use RPyC with ev3dev:
3040
3141
chmod +x rpyc_server.sh
3242
33-
Launch the created file either from ssh session, or from brickman.
43+
Launch the created file either from SSH session (with
44+
``./rpyc_server.sh`` command), or from brickman. It should output something
45+
like
46+
47+
.. code-block:: none
48+
49+
INFO:SLAVE/18812:server started on [0.0.0.0]:18812
50+
51+
and keep running.
3452

35-
3. Now you are ready to connect to the RPyC server from your desktop PC:
53+
3. Now you are ready to connect to the RPyC server from your desktop PC. The
54+
following python script should make a large motor connected to output port
55+
``A`` spin for a second.
3656

3757
.. code-block:: py
3858
@@ -62,3 +82,6 @@ The most obvious *disadvantage* is latency introduced by network connection.
6282
This may be a show stopper for robots where reaction speed is essential.
6383

6484
.. _RPyC: http://rpyc.readthedocs.io/
85+
.. _sourceforge page: http://sourceforge.net/projects/rpyc/files/main
86+
.. _Download and Install: http://rpyc.readthedocs.io/en/latest/install.html
87+
.. _connect with SSH: http://www.ev3dev.org/docs/tutorials/connecting-to-ev3dev-with-ssh/

0 commit comments

Comments
 (0)