Skip to content

Commit 768332e

Browse files
committed
Add an advanced page for the Brain Board
This page is intentionally hidden from the sidebar menu. We will send a link to Students if they need the information. This is to avoid confusing students who don't want to hack around with the kit.
1 parent 2e2e6ee commit 768332e

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

.spelling

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ piezo
1515
Plazma
1616
PULLUP
1717
Quarternion
18+
rtui
1819
Ruggeduino
1920
Ruggeduinos
2021
Scarzy

kit/brain_board/advanced.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: Brain Board - Advanced
4+
---
5+
6+
# Brain Board - Advanced
7+
8+
When connected to your Brain Board WiFi network, it is possible to access the brain board via a terminal interface. The Brain Board is running Student Robotics OS, a purpose-built Linux distribution that does not have all of the conveniences of a usual Linux system.
9+
10+
<div class="warning">
11+
The following information is about advanced features for which we only provide limited support. Proceed at your own risk.
12+
</div>
13+
14+
Please bear in mind the following:
15+
16+
- Student Robotics does not guarantee support for the modification of the OS.
17+
- We may need you to upgrade the OS which will overwrite any changes.
18+
- Any modifications you make must be in line with [the rules]({{ site.baseurl }}/rules).
19+
- We reserve the right to inspect your Brain Board at any time.
20+
- Feel free to tinker. If you are stuck, ask in [Discord]({{ site.baseurl }}/team_admin/discord), although we may be unable to help.
21+
22+
## SSH Access
23+
24+
You can access the robot over SSH:
25+
26+
```shell
27+
ssh robot@robot
28+
```
29+
30+
Your SSH client will prompt you for a password, which is `robot`.
31+
32+
## Terminal Interface
33+
34+
A terminal interface with similar functionality to the web interface is available as `rtui`.
35+
36+
```shell
37+
$ rtui
38+
39+
Student Robotics OS
40+
41+
Available commands:
42+
arena: Get or set the current arena
43+
exit: Leave the terminal session.
44+
help: Show available commands
45+
kill: Kill running code
46+
metadata: Show all robot metadata
47+
mode: Get or set the current robot mode (COMP or DEV)
48+
quit: Leave the terminal session.
49+
restart: Restart running code
50+
start: Trigger the virtual start button.
51+
trigger: Trigger the virtual start button.
52+
zone: Get or set the current zone
53+
```
54+
55+
Some commands let you set data as well as get it:
56+
57+
- `arena B` - Set the arena to `B`
58+
- `mode COMP` - Set the mode to `COMP`
59+
- `zone 2` - Set the zone to `2`

0 commit comments

Comments
 (0)