Skip to content

Commit 4f21cf4

Browse files
Merge pull request #209 from sourcebots/docs/kit-wb
Update info in kit docs
2 parents 082a4cb + 8389c8d commit 4f21cf4

File tree

4 files changed

+11
-8
lines changed

4 files changed

+11
-8
lines changed

docs/kit/arduino.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ isn't working. This isn't a guaranteed fix, but may solve some problems.
1515

1616
## GPIO Pins
1717

18-
The Arduino allows you to connect your kit to your own electronics. It has fourteen digital I/O pins, and six analogue input pins. The analogue pins can read an analogue signal from 0 to 5V. The board also has a couple of ground pins, as well as some pins fixed at 3.3V and 5V output.
18+
The Arduino allows you to connect your kit to your own electronics. It has fourteen digital I/O pins, and six analogue input pins. The analogue pins can read an analogue signal from 0 to 5V and the digital pins can receive or send digital signals at 0V & 5V. The board also has a couple of ground pins, as well as some pins fixed at 3.3V and 5V output to supply power to your sensors.
1919

2020
![Pin Map](../assets/img/kit/arduino_pinout.png)
2121

docs/kit/pi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
![Raspberry Pi 3B+](../assets/img/kit/pi.jpg){ width="50%" }
77

8-
The brain of your robot is a Raspberry Pi 3 / 3B+. This handles the running of your python code, recognition of markers and sends control commands to the other boards.
8+
The brain of your robot is a Raspberry Pi 3B+. This handles the running of your python code, recognition of markers and sends control commands to the other boards.
99

1010
## Power Hat
1111

@@ -31,6 +31,6 @@ All LEDs will turn on at boot. After the Pi detects a USB stick, the LEDs work a
3131

3232
Your robot is running a customised version of the [Raspberry Pi OS](https://www.raspberrypi.com/software/) operating system.
3333

34-
When a USB stick is inserted, the SourceBots software will look for a file named `main.py`, and then execute it.
34+
When a USB stick is inserted, the SourceBots software will look for a file named `robot.py`, and then execute it.
3535

3636
The output of your code is written to a file named `log.txt` on the USB stick.

docs/kit/power-board.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ They should be used to connect to the motor board power input, though can also
2222
be used to power other devices. These are enabled when your robot code is
2323
started and can also be turned on or off from your code.
2424

25-
There are two 5V connectors that can be used to connect low-current devices that take 5V inputs, such as the Raspberry Pi and the servo shield.
25+
There are two 5V connectors that can be used to connect low-current devices that take 5V inputs, such as the Raspberry Pi.
2626

27-
There is also a Micro USB B connector which should be used to connect the Raspberry Pi for control of the power board.
27+
There is also a Micro USB B connector which should be connected to the Raspberry Pi for control of the power board.
2828

2929
Finally, there are connectors for external Start and On|Off switches. You may connect any latching switch for the On|Off switch, or a push-to-make button for the Start button.
3030

@@ -37,11 +37,11 @@ Finally, there are connectors for external Start and On|Off switches. You may co
3737
| PWR\|FLAT | Green when powered<br />Flashing red and green when the battery is low | Green |
3838
| 5V | Green when 5V is being supplied | Green |
3939
| H0–1, L0–3 | Green when the corresponding output is on [^1]<br />Red when the output's current limit is reached | Off |
40-
| RUN\|ERROR | Orange on power-up, or USB reset <br />Flashing green when ready to run<br /> Solid green when running or booting | Orange |
40+
| RUN\|ERROR | Orange on power-up, or USB disconnection <br />Flashing green when ready to run<br /> Solid green when running or booting | Orange |
4141

4242
[^1]: The outputs only turn on when your program runs (specifically, when the `Robot` object is created).
4343

44-
On power-up, the Power Board will emit some beeps, which are related to the version of the firmware it has installed.
44+
On power-up and when waiting for the start button, the Power Board will beep once.
4545

4646
If the Power Board starts beeping (and all the outputs turn off) then this means that the whole board's current limit has been triggered.
4747

docs/kit/servo-board.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ brown wire) at the bottom of the board.
2222

2323
For the servo board to operate correctly, you must connect it to the 12V
2424
power rail from the power board. A green LED will light next to the
25-
servo board 12V connector when it is correctly powered.
25+
servo board 12V connector when it is correctly powered and the 8 outputs
26+
on the left-side of the board can be used.
27+
28+
To use the 4 auxillary outputs on the right-side of the board, 5V needs to be connected to the auxillary input.
2629

2730
## Case Dimensions
2831

0 commit comments

Comments
 (0)