Skip to content

Commit 3dd4f9a

Browse files
authored
Merge pull request #388 from srobo/pre-kickstart-docs-runthrough
Pre Kickstart docs run-through
2 parents 46e7d5b + bc509ff commit 3dd4f9a

File tree

6 files changed

+17
-18
lines changed

6 files changed

+17
-18
lines changed

_data/kit_versions.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
# The format of this file should be like such:
33
# - version: 20xx.y.z
44
# released: 2038-01-19
5-
[]
5+
- version: 2023.0.0
6+
released: 2022-10-21

kit/brain_board/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Brain Board
1616
<img src="{{ site.baseurl }}/images/content/kit/brain.png" alt="A photo of a brain board" title="A brain board" class="right" style="max-width: 50%"/>
1717
The Brain Board provided with your kit is what runs the code you write and controls the other peripheral boards. It consists of a [Raspberry Pi 4B](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/) and a Student Robotics KCH HAT.
1818

19-
The LEDs on the HAT display the current status of the robot and can be used to help debug your robot. There are also 3 RGB (Red, Green and Blue) LEDs that you can control from your code.
19+
The LEDs on the HAT display the current status of the robot and can be used to help debug your robot. There are also 3 RGB (Red, Green, and Blue) LEDs that you can control from your code.
2020

2121
## Board Diagram
2222

@@ -55,7 +55,7 @@ The OK LED shows the status of your code using different colours.
5555
Your Brain Board will not power on unless it's connected to the "L2" port on the Power Board.
5656
This is because the rest of the power outputs are disabled until the usercode runs.
5757

58-
## Flashing SD card
58+
## Flashing the SD card
5959

6060
The SD card is located on the underside of the board underneath the green power connector. Grab the SD card with your fingers and simply pull it out of the slot.
6161

@@ -66,7 +66,7 @@ The flashing procedure is identical to flashing Raspberry Pi images.
6666

6767
### Etcher
6868

69-
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.
69+
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 should also work.
7070

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

kit/brain_board/updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ extra_js: updates
88

99
Keeping your kit up to date is very important. It enables us to deploy new features, as well as fix bugs.
1010

11-
Once you have downloaded the file you need, refer to the documentation on [updating your brain board]({{ site.baseurl }}/kit/brain_board#flashing-sd-card) to apply the update.
11+
Once you have downloaded the file you need, refer to the documentation on [updating your brain board]({{ site.baseurl }}/kit/brain_board#flashing-the-sd-card) to apply the update.
1212

1313
Each update file is a complete upgrade. Each file contains the changes of those before it. If you need to jump up multiple versions, you can do so by using the latest file.
1414

kit/motor_board.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@ Motor Board
99
<img src="{{ site.baseurl }}/images/content/kit/mcv4b.png" alt="A phot of an un-cased motor board" title="An un-cased motor board" class="right" />
1010
The Motor Board can be used to control two 12V DC motors. Your kit contains two of these boards to allow you to control up to four motors. These can be used for moving your robot, although don't feel you are limited to using them for this purpose.
1111

12-
The speed and direction of the two outputs are controlled independently through the USB interface.
13-
The USB interface is isolated from the rest of the board to prevent damage to the host in the case of a board failure.
14-
Due to this isolation the board must have power applied to the power connector, from the motor rail on the power board, to function.
15-
If the board does not have power applied to the power connector then the kit will report that there is a problem with the motor board.
12+
The speed and direction of the two outputs are controlled independently through the USB connection. The board also needs power delivered from a 12V port on the Power Board in order to drive the motors.
1613

1714
The motor board uses [pulse-width modulation][wiki-pwm] (PWM) to control the
1815
amount of power that is sent to the motors.
@@ -25,8 +22,8 @@ Board Diagram
2522
![motor board diagram]({{ site.baseurl }}/images/content/kit/mcv4b_board_diagram.png "The Motor Board")
2623

2724
<div class="info">
28-
The serial and expansion connectors labelled in the above diagram are not currently used by any part of our kit and we don't typically provide support for their use.
29-
We strongly advise that you do not connect anything to these ports unless you understand their purpose, since incorrect use can damage the kit.
25+
The expansion connector labelled in the above diagram is not currently used by any part of our kit.
26+
Do not connect anything to this port, since incorrect use can damage the kit.
3027
</div>
3128

3229
Indicators
@@ -55,10 +52,10 @@ Specification
5552
| Output voltage | 11.1V ± 15% |
5653
| Continuous output current per channel | 10A |
5754
| Peak output current [^1] | 20A |
58-
| UART connection voltage [^2] | 3.3–5V |
55+
| Serial connection voltage [^2] | 3.3–5V |
5956

6057
[^1]: Can be sustained for 1 second, on a single channel.
61-
[^2]: If the board is controlled solely via the UART connection, this voltage must be supplied via the UART connector.
58+
[^2]: If the board is controlled solely via the serial connection, this voltage must be supplied via the serial connector. We use the UART serial protocol.
6259

6360
Designs
6461
-------

kit/power_board.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ Connectors
2525

2626
There are six power output connectors on the board, labelled L0–L3, H0, and H1.
2727
These are enabled when your robot code is started, and supply around 11.1V
28-
(±15%). They should be used to connect to the motor and servo board power
29-
inputs. The "H" connectors will supply more current than the "L" connectors.
28+
(±15%). These may be referred to as 12V ports elsewhere in the docs. They should
29+
be used to connect to the motor and servo board power inputs. The "H" connectors
30+
will supply more current than the "L" connectors.
3031

3132
<div class="warning">
3233
When connecting the brain board, the "L2" port should be used.
@@ -60,7 +61,7 @@ Indicators
6061

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

63-
On power-up, the Power Board will emit some beeps, which are related to the version of the firmware it has installed.
64+
On power-up, the Power Board will emit a beep.
6465

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

kit/servo_board.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Indicators
2323
| --------------------- | ------------------------------------------------------------------------------------------------ | ---------------------- |
2424
| Power <!-- DS1 --> | The board is powered over USB. | On |
2525
| 5.5V On <!-- DS15 --> | There is 5.5V power on the board. This usually indicates that the 12V connector rail is powered. | Off |
26-
| Aux On <!-- DS16 --> | There is auxiliary power on the board. | Off |
26+
| Aux On <!-- DS16 --> | There is auxiliary power on the board. | On |
2727
| STATUS\|ERROR <!-- DS10 --> | Blue when the board has successfully booted<br />Solid pink if an error has occurred (often 12V power being lost) | Blue |
2828

2929
Connectors
@@ -58,7 +58,7 @@ universally the case and some servos do care about the time between pulses as
5858
well.
5959

6060
The Servo Board is able to precisely control the duration of the pulses sent to
61-
servos (based on the values you configure using the python API), within the
61+
servos (based on the values you configure using the Python API), within the
6262
ranges in the table below.
6363

6464
Conversely the time between pulses sent to a given servo is allowed a much wider

0 commit comments

Comments
 (0)