Skip to content

Commit 5b6e8a3

Browse files
authored
Merge pull request #167 from sourcebots/docs-update
Update API index
2 parents d220a0c + 596d2b9 commit 5b6e8a3

File tree

1 file changed

+6
-29
lines changed

1 file changed

+6
-29
lines changed

content/api/_index.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -26,41 +26,19 @@ defined as `r`.
2626

2727
## Running your code
2828

29-
Your code needs to be put on a USB drive in a file called `main.py`. On
30-
insertion into the robot, this file will be executed. The file is
31-
directly executed off your USB drive, with your drive as the working
32-
directory.
33-
34-
To stop your code running, you can just remove the USB drive. This will
35-
also stop the motors and any other peripherals connected to the kit.
36-
37-
You can then reinsert the USB drive into the robot and it will run your
38-
`main.py` again (from the start). This allows you to make changes and
39-
test them quickly.
29+
Your code needs to be put in the `zone-0` or `zone-1` folder in a file called
30+
`forklift.py` or `crane.py` for the forklift and crane robots respectively.
4031

4132
{{% notice tip %}}
4233
If this file is missing or incorrectly named, your robot won't do
4334
anything. No log file will be created.
4435
{{% /notice %}}
4536

46-
{{% notice warning %}}
47-
The previous log file is deleted at the start of each run, so copy it
48-
elsewhere if you need to keep hold of it!
49-
{{% /notice %}}
50-
51-
## Serial number
37+
## Logs
5238

53-
All kit boards have a serial number, unique to that specific board,
54-
which can be read using the `serial` property:
55-
56-
``` python
57-
r.power_board.serial
58-
>>> 'SRO-AA2-7XS'
59-
r.servo_board.serial
60-
>>> 'SRO-AA4-LG2'
61-
r.motor_board.serial
62-
>>> 'SRO-AAO-RV2'
63-
```
39+
A log file is saved in the `output/` folder so you can see what your robot did,
40+
what it didn't do, and any errors it raised. Each log file is in a folder based on its
41+
date and time, so you can look back at your previous runs.
6442

6543
## Included Libraries
6644

@@ -74,7 +52,6 @@ install some extra ones which may be of use:
7452
- [scikit-learn 0.23.2](https://pypi.org/project/scikit-learn/0.23.2/)
7553
- [scipy 1.5.4](https://pypi.org/project/scipy/1.5.4/)
7654

77-
7855
{{% notice tip %}}
7956
If you would like an extra library installed, go and ask a volunteer to
8057
see if we can help.

0 commit comments

Comments
 (0)