Skip to content

Commit f48272b

Browse files
authored
Merge branch 'master' into sim-docs
2 parents 6e1a212 + ceb5422 commit f48272b

File tree

9 files changed

+53
-13
lines changed

9 files changed

+53
-13
lines changed

_data/sidebar_tree.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ tree:
3232
- url: /programming/
3333
title: Programming
3434
tree:
35+
- url: /programming/getting_code_on_the_robot
36+
title: Getting Code on the Robot
3537
- url: /programming/python/
3638
title: Python
3739
tree:

_includes/footer.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
<h4>For Competitors</h4>
55
<ul class="sitemap">
66
<li><a href="{{ site.url }}/teams/">Teams Dashboard</a></li>
7-
<li><a href="{{ site.url }}/ide/">IDE</a></li>
87
<li><a href="{{ site.url }}/docs/">Documentation</a></li>
98
</ul>
109
</div>

images/content/kit/zip_macOS.png

51.7 KB
Loading

images/content/kit/zip_win10.jpg

51 KB
Loading

images/content/kit/zip_win11.png

9.4 KB
Loading

kit/brain_board.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,23 @@ The SD card is located on the underside of the board. Carefully open the Brain B
1717

1818
To fully update your Brain Board's software, or refresh it if you think it's not working correctly, you can flash our SD card image onto the microSD card in your Brain Board.
1919

20-
To update the SD card, you'll need to download our image, `robot-image.img.xz`. The flashing procedure is identical to flashing Raspberry Pi images.
20+
To update the SD card, you'll need to download our image, [`srobo-robot-2022.0.0.img.xz`][robot-image].
21+
The flashing procedure is identical to flashing Raspberry Pi images.
22+
23+
[robot-image]: https://kit-downloads.studentrobotics.org/kit-software/2022.0.0/srobo-robot-2022.0.0.img.xz
2124

2225
## Etcher
26+
2327
We recommend using [etcher](https://etcher.io), as it's simple to use, and available on Windows, macOS and Linux. If you're familiar with Raspberry Pis or other similar boards and have flashed images before with a different tool, that will also work.
2428

2529
![Etcher example]({{ site.baseurl }}/images/content/kit/etcher.png)
2630

2731
<div class="info">
28-
If you choose to use a tool other than Etcher, you may need to extract the `robot-image.img.xz` to `robot-image.img`. There are many tools available for this, e.g. [7-zip](http://www.7-zip.org/).
32+
If you choose to use a tool other than Etcher, you may need to extract the `srobo-robot-2022.0.0.img.xz` to `srobo-robot-2022.0.0.img`. There are many tools available for this, e.g. [7-zip](http://www.7-zip.org/).
2933
</div>
3034

3135
### Flashing
3236

33-
1. Open Etcher and select the `robot-image.img.xz` file you downloaded
37+
1. Open Etcher and select the `srobo-robot-2022.0.0.img.xz` file you downloaded
3438
2. Select your SD card from the devices window
3539
3. Click 'Flash!'

programming/editors/index.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,9 @@ title: Code Editors
55

66
# Code Editors
77

8-
When developing code to run on our robotics kit, we recommend that you start by
9-
using our hosted IDE. The hosted IDE provides an easy way to get going, as well
10-
as ensuring that you have a history of your code which is available from
11-
anywhere and your mentor can access. We appreciate that you may wish to use your
12-
own editor instead, which you are free to do.
13-
14-
When developing code to run in the simulator, you will need to have both the
15-
simulator and your own editor set up.
8+
In order to develop the code for your robot, we recommend that you use a code
9+
editor. A code editor (rather than a plain text editor) will make it easier to
10+
develop your code and help you catch errors sooner.
1611

1712
<div class="info">
1813
However you are working on your code, you are encouraged to ensure you have a backup!
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: page
3+
title: Getting Code on the Robot
4+
---
5+
6+
# Getting Code on the Robot
7+
8+
Getting your code on to the robot is quite simple.
9+
You will need to put your code on a USB drive
10+
Which will need to be formatted with either FAT32, exFAT, NTFS or ext2/3/4.
11+
Upon plugging in the drive or starting up, the robot will run the `robot.py` file found in the `robot.zip` in the root of the drive.
12+
13+
## Windows
14+
15+
1. Open your code in File Explorer
16+
2. Select all of your code files (<kbd>Ctrl</kbd><kbd>A</kbd> to select all files)
17+
3. Right-click the files
18+
4. Click Compress to Zip file
19+
5. Name the newly created file `robot` (or `robot.zip` if you have file extentions shown)
20+
21+
<img src="{{ site.baseurl }}/images/content/kit/zip_win10.jpg" alt="Screenshot for Windows 10" class="column half" />
22+
<img src="{{ site.baseurl }}/images/content/kit/zip_win11.png" alt="Screenshot for Windows 11" class="column half" />
23+
24+
If you are on Windows 10 or older, you will need to use Send to &rarr; Compressed (zipped) folder.
25+
26+
## macOS
27+
28+
1. Open your code in Finder
29+
2. Select all of your code files (<kbd>⌘</kbd><kbd>A</kbd> to select all files)
30+
3. Right-click (or Control-click) the files and click Compress
31+
4. Name the newly created file `robot.zip`
32+
33+
![Screenshot]({{ site.baseurl }}/images/content/kit/zip_macOS.png)
34+
35+
To re-run your program, simply remove the USB stick and plug it back in again and it will restart automatically.
36+
37+
## Robot Logs
38+
39+
When your program runs on the robot, the output of `print(...)` calls and any
40+
errors which occur are written to a log file on the USB stick as `log.txt`.

0 commit comments

Comments
 (0)