From f11b99d63361d9492a89906c4809e82976925735 Mon Sep 17 00:00:00 2001
From: Paul Beuchat <beuchatp@control.ee.ethz.ch>
Date: Tue, 17 Sep 2019 17:28:21 +0200
Subject: [PATCH] Changed the necessary occurances of references to teacher in
to the wiki documentation to correctlu refer to master, dfallmaster, or
System Config GUI
---
wiki/installation.md | 12 ++++++------
wiki/setup.md | 2 +-
wiki/workflow_for_students.md | 6 +++---
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/wiki/installation.md b/wiki/installation.md
index bc1d4805..6031a12b 100644
--- a/wiki/installation.md
+++ b/wiki/installation.md
@@ -64,9 +64,9 @@ The second command installs the python package management system ``python-pip``.
- Environment Setup: <br />
-Add a new line in the ``/etc/hosts`` file that links the teacher's IP with the domain name ``teacher``, create a file called ``/etc/dfall_default_agent_id`` that contains the agent id, and create a file called ``/etc/dfall_default_coord_id`` that contains the coordinator id.
+Add a new line in the ``/etc/hosts`` file that links the teacher's IP with the domain name ``dfallmaster``, create a file called ``/etc/dfall_default_agent_id`` that contains the agent id, and create a file called ``/etc/dfall_default_coord_id`` that contains the coordinator id.
```
-sudo sh -c "echo '10.42.0.10 teacher' >> /etc/hosts"
+sudo sh -c "echo '10.42.0.10 dfallmaster' >> /etc/hosts"
```
```
@@ -125,13 +125,13 @@ A Vicon motion capture system can be used to provide position and attitude measu
## Additional Steps for Teacher
### Removing Config.sh and replacing
-As the teacher must not source the script ``Config.sh``, the ``.bashrc`` must be edited and the last line
+The ``Config.sh`` on the teacher's computer must be edited as follows. Comment out the lines of the form (i.e., add a # at the start of the line):
```
-source ~/dfall_ws/src/dfall_pkg/launch/Config.sh
+export ROS_MASTER_URI=...
```
-must be replaced with
+And uncomment the line (i.e., remove the # at the start of the line):
```
-export ROS_HOSTNAME=teacher
+export ROS_HOSTNAME=dfallmaster
```
### IP-Addresses
diff --git a/wiki/setup.md b/wiki/setup.md
index 887bd01f..7ffdee37 100644
--- a/wiki/setup.md
+++ b/wiki/setup.md
@@ -94,7 +94,7 @@ Then go to the _IPv4 Settings_ and choose **Manual** as the _Method_ and then ad
<br>
### Vicon, teacher and students
-During installation process is the IP address of the teacher set to 10.42.0.10. (This value is written to the /etc/hosts file such that this IP address is accessible through the keyword _teacher_) <br>
+During installation process is the IP address of the teacher set to 10.42.0.10. (This value is written to the /etc/hosts file such that this IP address is accessible through the keyword _dfallmaster_) <br>
Have a look at `Config.sh` in `~/dfall_ws/src/dfall_pkg/launch/`
<br><img src="./pics/setup_pics/configsh2.png" style="width: 500px;"/> <br>
Here you see, that the ROS Master URI is set to be the teacher. This means that _roscore_ runs only on the teacher's computer. Your own IP address (_ROS IP_) is also set and taken from your Ethernet settings as defined in the section _Setting up the Vicon network_.
diff --git a/wiki/workflow_for_students.md b/wiki/workflow_for_students.md
index f0156d44..c0b01ce4 100644
--- a/wiki/workflow_for_students.md
+++ b/wiki/workflow_for_students.md
@@ -24,7 +24,7 @@ gyrosensor needs to initialize.
* Once all the prerequisites have been fulfilled, you can start the student's GUI by going to a terminal and typing:
`roslaunch dfall_pkg agent.launch`
- *Note: for this to work, the teacher's computer has to be connected to the network and the `teacher.launch` GUI has to be started before. Please wait until your teacher has already set up everything.*
+ *Note: for this to work, the teacher's computer has to be connected to the network and the `master.launch` GUI has to be started before. Please wait until your teacher has already set up everything.*
* Once started, you will see something like this:<br>
@@ -71,7 +71,7 @@ important files that should be taken into account.
* In `dfall_pkg/src`
* _StudentControllerService.cpp_ <br>
- The file where students can implement their own controller. It provides already the ros service with the teacher. It can be used as a template.
+ The file where students can implement their own controller. It provides already the ros service with the System Config. It can be used as a template.
* In `dfall_pkg/param`
@@ -127,7 +127,7 @@ important files that should be taken into account.
<!-- To start the whole thing type the following in a terminal whilst being in the launch directory.<br> -->
<!-- `roslaunch filename.launch` -->
-<!-- * _Teacher.launch_<br> -->
+<!-- * _Master.launch_<br> -->
<!-- This doesn't concern the students, nor will it work. This launches the GUI for the teacher and the services he needs. -->
<!-- * _Student.launch_<br> -->
<!-- This launches the nodes for the CrazyRadio, the PPSClient, SafeController and CustomController. Make sure that __ClientConfig__ is correctly set up. -->
--
GitLab