Skip to content

Commit 818d21e

Browse files
authored
Merge pull request #370 from srobo/kjk/wifi
Update WiFi docs
2 parents e678a0a + 8268379 commit 818d21e

File tree

6 files changed

+32
-43
lines changed

6 files changed

+32
-43
lines changed

_data/sidebar_tree.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ tree:
3030
title: Servo Board
3131
- url: /kit/safety-regulations
3232
title: Safety Regulations
33+
- url: /kit/wifi
34+
title: WiFi
3335
- url: /programming/
3436
title: Programming
3537
tree:
Binary file not shown.
Binary file not shown.

images/content/kit/wifi_interface.png

737 KB
Loading

kit/wifi.md

Lines changed: 28 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -6,69 +6,56 @@ title: WiFi
66
WiFi
77
====
88

9-
The WiFi dongles provided with your kit allow you to interface with and debug your robot.
9+
The Raspberry Pi that makes up your kit's brain board contains a WiFi radio which allows you to interface with and debug your robot.
1010
You can connect to your robot using any WiFi capable device (laptop, tablet, phone, etc.)
1111

1212
Connecting to Your Robot
1313
------------------------
1414

15-
First, ensure that the WiFi dongles supplied with your kit are plugged into your robot.
16-
Once you have the WiFi dongles connected, plug in a USB memory stick and turn your robot on.
17-
18-
During the boot process you should notice a green LED begin to flash on one of the WiFi dongles.
19-
Your robot has now set up its very own WiFi network! It'll be called `robot-XXX`, where `XXX` is
20-
your team's TLA.
15+
During the boot process you should notice the green LED on the KCH (the board on top of the Pi) labelled "WiFi" turn on.
16+
Your robot has now set up its very own WiFi network! It will initially have a name starting with `robot-ZZZ` followed by some random numbers.
2117

2218
You can now connect to your robot in the same way you normally connect to a WiFi network.
23-
You will need a WiFi key to be able to connect and you can find this inside any robot.zip
24-
that you have exported from the IDE. Just unzip the robot.zip and have a look inside `wifi.yaml`.
19+
You will need a WiFi key to be able to connect and you can find this inside `robot-settings.toml` on the USB drive containing your code.
2520

26-
Note that, because the information for your robot's WiFi network is stored inside the robot.zip,
27-
the WiFi network will disappear when you unplug the USB memory stick. It will reappear a few moments
28-
after you plug the USB memory stick into your robot.
21+
These details can also be printed using:
22+
~~~~ python
23+
R.print_wifi_details()
24+
~~~~
2925

30-
If you are having any problems connecting to your robot, just head on over to the [forum]({{ site.url }}/forum)
26+
If you are having any problems connecting to your robot, just head on over to the Discord
3127
and ask for help.
3228

33-
Interacting With Your Robot
34-
---------------------------
29+
Using the robot interface
30+
-------------------------
3531

36-
Once you have a WiFi connection, visit `http://robot.sr` in a web browser to see the robot interface.
32+
Once you have a WiFi connection, visit `http://robot.lan` in a web browser to see the robot interface.
3733

3834
The robot interface gives you the ability to remotely start the code on your robot,
3935
as well as view the logs.
4036

41-
<div class="info" markdown="1">
42-
The stop button that appears after starting your code is currently not functional.
43-
</div>
37+
![The robot interface on desktop]({{ site.baseurl }}/images/content/kit/wifi_interface.png)
4438

45-
### Setting up the Robot's Environment
39+
### Viewing logs
4640

47-
![The robot interface's set up screen]({{ site.baseurl }}/images/content/kit/remote-interface/set-up-screen.png)
41+
The robot interface allows you to see all messages from your code sent by `print(...)`
42+
statements (and anything else that outputs to standard output or standard
43+
error). It will also show messages from the initialisation of the robot's
44+
hardware, as well as any errors that occurred when running your code.
4845

49-
When you first navigate to the robot interface you are presented with the Set up page.
50-
This page allows you to select the starting zone of your robot, as well as
51-
whether it is running in development mode or competition mode. Changing the
52-
starting zone allows you to test how your robot handles being started in a
46+
You can also see your robot's logs on the USB stick, in a file called
47+
`log.txt`.
48+
49+
### Setting up the Robot's Environment
50+
51+
The toolbar present at the top of the page, or bottom of the page on mobile, allows you to change the robot's starting zone and mode.
52+
Changing the starting zone allows you to test how your robot handles being started in a
5353
different zone.
5454

55+
The WiFi interface will only be fully accessible when your robot is started in dev mode and will be restricted in competition mode.
56+
5557
Changing to competition mode causes the development markers to be unreadable,
5658
and instead reads the competition markers, which are different. Therefore, you
5759
should keep your robot in development mode.
5860

59-
You cannot use this screen when code is running.
60-
61-
### Logs Screen
62-
63-
![The robot interface's logs screen]({{ site.baseurl }}/images/content/kit/remote-interface/logs-screen.png)
64-
65-
This screen allows you to see all messages from your code sent by `print(...)`
66-
statements (and anything else that outputs to standard output or standard
67-
error). It will also show messages from the initialisation of the robot's
68-
hardware, as well as any errors that occurred when running your code.
69-
70-
You can press the "Jump to bottom" button to scroll right to the bottom of the
71-
logs, to see the most recent entries in a long file.
72-
73-
You can also see your robot's logs on the USB stick, in a file called
74-
`log.txt`.
61+
Changing this applies from the next time your code runs.

resources/troubleshooter/data.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@
337337
]
338338
},
339339
"motor-programming": {
340-
"question": "Please test the Motor with the <a href=\"ROOT_URL/kit/wifi\" target=\"_blank\">WiFi</a> interface. Does the Motor respond to the interface?",
340+
"question": "Please try replacing your code with sample code from the <a href=\"ROOT_URL/kit/motor_board\" target=\"_blank\">Motor Board documentation</a>. Does the motor respond?",
341341
"answers": [
342342
{
343343
"answer": "Yes",
@@ -408,7 +408,7 @@
408408
]
409409
},
410410
"servo-programming": {
411-
"question": "Please test the Servo with the <a href=\"ROOT_URL/kit/wifi\" target=\"_blank\">WiFi</a> interface. Does the Servo respond to the robot interface?",
411+
"question": "Please try replacing your code with sample code from the <a href=\"ROOT_URL/kit/servo_board\" target=\"_blank\">Servo Board documentation</a>. Does the servo respond?",
412412
"answers": [
413413
{
414414
"answer": "Yes",

0 commit comments

Comments
 (0)