Skip to content

Commit 861792e

Browse files
committed
Minor docs edits
Fixing image preview error on Introduction page & other small typos.
1 parent e009b40 commit 861792e

File tree

4 files changed

+7
-11
lines changed

4 files changed

+7
-11
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ SparkFun XRP Controller
77
<td><a href="https://www.sparkfun.com/sparkfun-experiential-robotics-platform-xrp-controller-beta.html"><img src="https://cdn.sparkfun.com/assets/parts/2/1/4/3/2/22727-_01.jpg"></a></td>
88
</tr>
99
<tr>
10-
<th style="text-align: center;"><a href="https://www.sparkfun.com/sparkfun-experiential-robotics-platform-xrp-controller.html"><i>SparkFun XRP Controller</i></a></td>
11-
<th style="text-align: center;"><a href="https://www.sparkfun.com/sparkfun-experiential-robotics-platform-xrp-controller-beta.html"><i>SparkFun XRP Controller - Beta</i></a></td>
10+
<th style="text-align: center;"><a href="https://www.sparkfun.com/sparkfun-experiential-robotics-platform-xrp-controller.html"><i>SparkFun XRP Controller</i></a></th>
11+
<th style="text-align: center;"><a href="https://www.sparkfun.com/sparkfun-experiential-robotics-platform-xrp-controller-beta.html"><i>SparkFun XRP Controller - Beta</i></a></th>
1212
</tr>
1313
</table>
1414

docs/hardware_overview.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ The Qwiic connectors work with SparkFun's [Qwiic ecosystem](https://www.sparkfun
114114
The Controller Board has three push buttons labeled <b>USER</b>, <b>RESET</b> and <b>BOOT</b> (on the RP2350).
115115

116116
<figure markdown>
117-
[![Photo highlighting buttons.](./assets/img/XRP-Controller-Buttons.jpg){width="600"}](./assets/img/XRP-Controller-Push_Buttons.jpg "Click to enlarge")
117+
[![Photo highlighting buttons.](./assets/img/XRP-Controller-Buttons.jpg){width="600"}](./assets/img/XRP-Controller-Buttons.jpg "Click to enlarge")
118118
</figure>
119119

120120
The USER button connects to GPIO36 on the RP2350 which allows it to be programmed for various purposes. The RESET button does just what its name suggests and resets the entire board when pressed. This can help to reboot the robot or to restart a sequence you want the Robotics Kit to perform. Holding the BOOT button either when plugging in a USB cable or when pressing the RESET button sets the RP2350 to behave as a mass storage device when connected to a computer for uploading firmware.
@@ -127,7 +127,7 @@ There are five LEDs on the XRP Controller Board labeled <b>MOT</b>, <b>SYS</b>,
127127
[![Photo highlighting LEDs](./assets/img/XRP-Controller-LEDs.jpg){width="600"}](./assets/img/XRP-Controller-LEDs.jpg "Click to enlarge")
128128
</figure>
129129

130-
These LEDs are there to provide a visual indication to users. The LEDs labeled <b>MOT</b> and <b>SYS</b> turn on when their respective power rails are powered. The <b>MOT</b> LED turns on when the motors have power available. The <b>SYS</b> LED turns on when the <b>3.3V</b>/System circuit is powered. This circuit powers the RP2350, RM2, sensors, and the expansion connectors. The <b>LOW VOLT</b> LED is a quick visual indicator to notify users that the supply voltage has dropped below the operating threshold and the board is underpowered. This is particularly helpful when powering the XRP Kit with batteries to indicate they need to be recharged or swapped.
130+
These LEDs are there to provide a visual indication to users. The LEDs labeled <b>MOT</b> and <b>SYS</b> turn on when their respective power rails are powered. The <b>MOT</b> LED turns on when the motors have power available. The <b>SYS</b> LED turns on when the <b>3.3V</b>/System circuit is powered. This circuit powers the RP2350, RM2, sensors, and the expansion connectors. The <b>LOW VOLT</b> LED connects to the 5V Buck regulator POWER_GOOD pin. It provides a quick visual indicator to notify users that the supply voltage has dropped below the operating threshold and the board is underpowered. This is <b>not</b> technically a low battery indicator but it coincidentally starts illuminating when 4xAA batterys are low, depending on the battery chemistry.
131131

132132
The other two LEDs labeled <b>STAT</b> and <b>RGB</b> are user-programmable status LEDs you can program for whatever behavior you prefer. The <b>STAT</b> LED connects to GPIO0 on the Radio Module and can be useful to indicate behavior from the radio such as connection status or data transmission. The <b>RGB</b> LED connects to GPIO37 on the RP2350 and can be programmed to change to any color based on whatever behavior you'd like. For example, you can have it turn from Green to Red when the distance sensor detects the robot is nearing an obstacle.
133133

@@ -212,7 +212,7 @@ The XRP Controller Board has fourteen solder jumpers. A solder jumper provides a
212212
<td>Lets users measure motor current draw using the ADC on IO42. Open to free up IO42 for other use.</td>
213213
</tr>
214214
<tr>
215-
<td>M-R/4</td>
215+
<td>M-R/4 REF</td>
216216
<td>CLOSED</td>
217217
<td>Sets the Right/4 DRV8411 motor driver's voltage reference to <b>3.3V</b.</td>
218218
<td>This sets the DRV8411's reference voltage to match the system voltage. Open to set to a different voltage.</td>
@@ -226,7 +226,7 @@ The XRP Controller Board has fourteen solder jumpers. A solder jumper provides a
226226
<tr>
227227
<td>VIN MEAS</td>
228228
<td>CLOSED</td>
229-
<td></td>
229+
<td>Connects the VIN measurement circuit to IO46</td>
230230
<td>Open to free up IO46 for alternate use</td>
231231
</tr>
232232
<tr>

docs/introduction.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
2-
3-
4-
51
Welcome to the SparkFun Experiential Robotics Platform (XRP) Controller Hardware Overview. This document provides detailed overviews of the hardware present on both versions of the XRP Controller; the [XRP Controller](https://www.sparkfun.com/sparkfun-experiential-robotics-platform-xrp-controller.html) and [XRP Controller - Beta](https://www.sparkfun.com/sparkfun-experiential-robotics-platform-xrp-controller-beta.html).
62

73
Each version of the XRP Controller has their own hardware overview section linked in the navigation menu to the left. If you're not sure which version to select, click on the image below matching the XRP Controller you have:

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ theme:
7070
- navigation.path
7171

7272
# Enables instant previews globally, for all internal links
73-
- navigation.instant.preview
73+
# - navigation.instant.preview
7474

7575
# Highlights all occurrences of a search result when clicked on
7676
- search.highlight

0 commit comments

Comments
 (0)