Skip to content

Commit 06b0072

Browse files
committed
Link from the hardware docs to the software docs
We've had links the other way for a long time, but not this way around. Adding these makes the docs more easily navigable.
1 parent 257a15b commit 06b0072

File tree

5 files changed

+9
-2
lines changed

5 files changed

+9
-2
lines changed

kit/arduino.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ This makes for easier connection of wires to the Arduino.
1717

1818
The Arduino only needs to be connected to the kit over USB as it uses this for both power and communication.
1919

20+
The Arduino in your kit has been preloaded with [firmware]({{ site.baseurl }}/programming/arduino/sr_firmware) allowing its inputs and outputs to be used from your Python code.
21+
You can also load your own firmware onto the Arduino to extend its capabilities -- see [Arduino API]({{ site.baseurl }}/programming/arduino) for details.
22+
2023
## Board Diagram
2124

2225
![Ruggeduino diagram]({{ site.baseurl }}/images/content/kit/ruggeduino_diagram.png "The Ruggeduino")

kit/brain_board/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ The Brain Board provided with your kit is what runs the code you write and contr
1919
It consists of a [Raspberry Pi 4B](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/) and a Student Robotics KCH.
2020

2121
The KCH is the board installed on top of the Pi, it powers the brain and has LEDs to show the current status of the robot.
22-
There are also 3 RGB (Red, Green, and Blue) LEDs that you can control from your code.
23-
22+
There are also 3 RGB (Red, Green, and Blue) LEDs that you can control from your code -- see the [Brain Board LED API]({{ site.baseurl }}/programming/leds) for details.
2423

2524
## Board Diagram
2625

kit/motor_board.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ The speed and direction of the two outputs are controlled independently through
1414
The motor board uses [pulse-width modulation][wiki-pwm] (PWM) to control the
1515
amount of power that is sent to the motors.
1616

17+
You can control the motors using the [Motor Board API]({{ site.baseurl }}/programming/motors).
18+
1719
[wiki-pwm]: https://en.wikipedia.org/wiki/Pulse-width_modulation
1820

1921
Board Diagram

kit/power_board.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Power Board
1111
</a>
1212
The Power Board distributes power to the SR kit from the battery.
1313
It provides eight general-purpose power outputs, with port L2 reserved for powering the Brain Board.
14+
You can control the state of these outputs from the [Power Board API]({{ site.baseurl }}/programming/power).
1415

1516
It also holds the internal On|Off switch for the whole robot as well as
1617
the Start button which is used to start your robot code running.

kit/servo_board.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Servo Board
1212
The Servo Board can be used to control up to 12 RC servos.
1313
Many devices are available that can be controlled as servos, such as RC motor speed controllers, so these can also be used with this board.
1414

15+
You can control the state of each servo output from the [Servo Board API]({{ site.baseurl }}/programming/servos).
16+
1517
Board Diagram
1618
-------------
1719
<img src="{{ site.baseurl }}/images/content/kit/servo_board_v4_diagram.png" alt="A diagram of a servo board" />

0 commit comments

Comments
 (0)