Skip to content

Update info in kit docs #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 12, 2023
Merged

Update info in kit docs #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9473ff
Arduino ammendments
WillB97 Jul 10, 2023
62e4f4c
power board ammendments
WillB97 Jul 10, 2023
cfbf791
Pi ammendments
WillB97 Jul 10, 2023
85090f8
Servo board ammendments
WillB97 Jul 10, 2023
8389c8d
Improve wording
WillB97 Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/kit/arduino.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ isn't working. This isn't a guaranteed fix, but may solve some problems.

## GPIO Pins

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.
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.

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

Expand Down
4 changes: 2 additions & 2 deletions docs/kit/pi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

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.
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.

## Power Hat

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

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

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

The output of your code is written to a file named `log.txt` on the USB stick.
8 changes: 4 additions & 4 deletions docs/kit/power-board.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ They should be used to connect to the motor board power input, though can also
be used to power other devices. These are enabled when your robot code is
started and can also be turned on or off from your code.

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.
There are two 5V connectors that can be used to connect low-current devices that take 5V inputs, such as the Raspberry Pi.

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

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.

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

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

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

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.

Expand Down
5 changes: 4 additions & 1 deletion docs/kit/servo-board.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ brown wire) at the bottom of the board.

For the servo board to operate correctly, you must connect it to the 12V
power rail from the power board. A green LED will light next to the
servo board 12V connector when it is correctly powered.
servo board 12V connector when it is correctly powered and the 8 outputs
on the left-side of the board can be used.

To use the 4 auxillary outputs on the right-side of the board, 5V needs to be connected to the auxillary input.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5V

Question: Is this only true for 5V servos? If 12V servos are used, would 12V not need to be applied?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We only have 5V servos.


## Case Dimensions

Expand Down