Skip to content

Commit abaea07

Browse files
committed
Update product names & yml files
Updating Hardware Overview & Resources documents with current XRP Beta product names. Updating main and workflows .yml files to current version.
1 parent 383b9b1 commit abaea07

File tree

4 files changed

+93
-50
lines changed

4 files changed

+93
-50
lines changed

.github/workflows/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
python-version: 3.x
2020

2121
- name: Install Python dependencies
22-
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
22+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 setuptools
2323

2424
# - name: Install Chrome
2525
# run: sudo apt install google-chrome-stable

docs/hardware_overview.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
In this document, we'll take a close look at the heart of the Experiential Robotics Platform (XRP) Kit, the XRP Controller. This document outlines all of the parts on this board you'll interact with while building and using the XRP Kit.
1+
In this document, we'll take a close look at the heart of the Experiential Robotics Platform (XRP) Kit - Beta, the XRP Controller - Beta. This document outlines all of the parts on this board you'll interact with while building and using the XRP Kit - Beta.
22

3-
## Controller Board Overview
3+
## XRP Controller - Beta Overview
44

5-
Let's take a broad look at the major components on the XRP Controller. The photo below points them out along with their names:
5+
Let's take a broad look at the major components on the XRP Controller - Beta. The photo below points them out along with their names:
66

77
<figure markdown>
8-
[![Overview photo labeling the major components and other hardware on the XRP Controller Board](./assets/img/XRP_Controller-Overview.jpg){ width="400"}](./assets/img/XRP_Controller-Overview.jpg "Click to enlarge")
8+
[![Overview photo labeling the major components and other hardware on the XRP Controller - Beta](./assets/img/XRP_Controller-Overview.jpg){ width="400"}](./assets/img/XRP_Controller-Overview.jpg "Click to enlarge")
99
<figcaption>Having trouble seeing the detail in the image? Click on it for a larger view.</figcaption>
1010
</figure>
1111

12-
You'll notice that along with the arrows showing the name of some of the smaller components, the board uses what's called silkscreen to label all the connectors, buttons, LEDs and other parts you'll interact with while building and using the XRP Robotics Kit.
12+
You'll notice that along with the arrows showing the name of some of the smaller components, the board uses what's called silkscreen to label all the connectors, buttons, LEDs and other parts you'll interact with while building and using the XRP Kit - Beta.
1313

1414
## Raspberry Pi Pico W
1515

16-
The Raspberry Pi Pico W microcontroller acts as the brain of this board. It combines a RP2040 processor with a wireless module for both 2.4GHz 802.11n wireless LAN and Bluetooth<sup>&trade;</sup> 5.2. The RP2040 communicates with the motor controllers, IMU and other components to control the robotics kit's behavior. The photo below highlights the Pico W on the Controller Board:
16+
The Raspberry Pi Pico W microcontroller acts as the brain of this board. It combines a RP2040 processor with a wireless module for both 2.4GHz 802.11n wireless LAN and Bluetooth<sup>&trade;</sup> 5.2. The RP2040 communicates with the motor controllers, IMU and other components to control the robotics kit's behavior. The photo below highlights the Pico W on the Controller board:
1717

1818
<figure markdown>
1919
[![Photo highlighting the Pico W microcontroller](./assets/img/XRP_Controller-PicoW.jpg){ width="400"}](./assets/img/XRP_Controller-PicoW.jpg "Click to enlarge")
@@ -23,13 +23,13 @@ Think of the Pico W as a brain sending signals to other parts of the "body" to t
2323

2424
## DRV8835 Motor Drivers
2525

26-
The pair of DRV8835 H-Bridge motor drivers from Texas Instruments<sup>&trade;</sup> on the XRP Controller Board control the direction and speed of the Robotics Kit's motors.
26+
The pair of DRV8835 H-Bridge motor drivers from Texas Instruments<sup>&trade;</sup> on the XRP Controller - Beta control the direction and speed of the Robotics Kit's motors.
2727

2828
<figure markdown>
2929
[![Photo highlighting the motor drivers.](./assets/img/XRP_Controller-Motor_Drivers.jpg){ width="400"}](./assets/img/XRP_Controller-Motor_Drivers.jpg "Click to enlarge")
3030
</figure>
3131

32-
The term H-bridge comes from how this circuit design looks on a schematic diagram. It has four internal switches that control whether the motor spins Clockwise (CW), Counter Clockwise (CCW), Coasts (no drive power), and Stops. When going through the XRP Kit curriculum you'll learn how to program the robot to tell the motor drivers to control the motors' speed and direction.
32+
The term H-bridge comes from how this circuit design looks on a schematic diagram. It has four internal switches that control whether the motor spins Clockwise (CW), Counter Clockwise (CCW), Coasts (no drive power), and Stops. When going through the XRP Kit - Beta curriculum you'll learn how to program the robot to tell the motor drivers to control the motors' speed and direction.
3333

3434
## LSM6DSO 6-Dof IMU
3535

@@ -51,35 +51,35 @@ Now let's take a closer look at the parts on this board used for providing power
5151

5252
### Barrel Jack Connector
5353

54-
The barrel jack connector is the primary power input for the entire XRP Kit. This connector mates with the cable from the XRP Kit's battery pack for battery-powered operation. Take note that the maximum safe voltage that can be applied to this connector is <b>11V</b> and the minimum to run the system is <b>5V</b>. The 4-AA battery pack included with the kit supplies a maximum of <b>6V</b> so most users will have no issues exceeding the max voltage.
54+
The barrel jack connector is the primary power input for the entire XRP Kit - Beta. This connector mates with the cable from the XRP Kit - Beta's battery pack for battery-powered operation. Take note that the maximum safe voltage that can be applied to this connector is <b>11V</b> and the minimum to run the system is <b>5V</b>. The 4-AA battery pack included with the kit supplies a maximum of <b>6V</b> so most users will have no issues exceeding the max voltage.
5555

5656
### Pico W USB-Connector
5757

58-
The Pico W has a Micro-USB connector that can be used to power the Controller Board with <b>5V</b> from a USB cable. It also is the primary interface you'll use to initially set up the Pico W with a computer and program the Pico W over a USB cable.
58+
The Pico W has a Micro-USB connector that can be used to power the controller board with <b>5V</b> from a USB cable. It also is the primary interface you'll use to initially set up the Pico W with a computer and program the Pico W over a USB cable.
5959

6060
### Power Switch
6161

62-
The power switch highlighted above controls the voltage input to the Controller Board. This two-way switch turns the kit's power on and off. You can use this to turn the robot off while keeping the battery pack plugged in. The switch does not affect the Pico W's power when a USB cable is plugged in.
62+
The power switch highlighted above controls the voltage input to the controller Board. This two-way switch turns the kit's power on and off. You can use this to turn the robot off while keeping the battery pack plugged in. The switch does not affect the Pico W's power when a USB cable is plugged in.
6363

6464
## Motor Connectors
6565

66-
The Controller Board has four six-pin connectors labeled <b>Motor L</b>, <b>Motor R</b>, <b>Motor 3</b>, and <b>Motor 4</b> and two three-pin connectors labeled <b>Servo 1</b> and <b>Servo 2</b>.
66+
The controller board has four six-pin connectors labeled <b>Motor L</b>, <b>Motor R</b>, <b>Motor 3</b>, and <b>Motor 4</b> and two three-pin connectors labeled <b>Servo 1</b> and <b>Servo 2</b>.
6767

6868
<figure markdown>
6969
[![Photo highlighting the motor connectors.](./assets/img/XRP_Controller-Motor_Connectors_All.jpg){width="400"}](./assets/img/XRP_Controller-Motor_Connectors_All.jpg)
7070
</figure>
7171

7272
### DC Motor Connectors
7373

74-
The DC Motor connectors are where you'll plug in the left and right motors while assembling the kit. These connectors include the power connections for the motor as well as the encoders on the motors. The board routes these connections through the motor drivers to GPIO pins on the Pico W. You'll use these pins to monitor how many rotations the motor completes and use that data to determine how far the robot has traveled. Refer to the Pinout table at the end of this document for the specific GPIO pins each motor connects to on the Pico W. The Controller Board has two extra motor connectors for expansion projects using more than two motors.
74+
The DC Motor connectors are where you'll plug in the left and right motors while assembling the kit. These connectors include the power connections for the motor as well as the encoders on the motors. The board routes these connections through the motor drivers to GPIO pins on the Pico W. You'll use these pins to monitor how many rotations the motor completes and use that data to determine how far the robot has traveled. Refer to the Pinout table at the end of this document for the specific GPIO pins each motor connects to on the Pico W. The controller board has two extra motor connectors for expansion projects using more than two motors.
7575

7676
### Servo Motor Connectors
7777

78-
The two three-pin connectors on either side of the board labeled Servo 1 and Servo 2 mate with servo motors. You'll use the Servo 2 connector to hook up the servo included in the XRP kit. Servo 1 connector is an extra one for expansion projects. These connectors have power pins (<b>5V</b> and Ground) and a signal pin to control the motion of the servo motor. Servo motors use a communication method called pulse width modulation (PWM) that tells the motor to move and with some motors, where to move to. If you're interested in learning more about how servo motors work, you may want to check out SparkFun's [Servos Explained](https://www.sparkfun.com/servos) page for information and tutorials on how to use them.
78+
The two three-pin connectors on either side of the board labeled Servo 1 and Servo 2 mate with servo motors. You'll use the Servo 2 connector to hook up the servo included in the XRP Kit - Beta. Servo 1 connector is an extra one for expansion projects. These connectors have power pins (<b>5V</b> and Ground) and a signal pin to control the motion of the servo motor. Servo motors use a communication method called pulse width modulation (PWM) that tells the motor to move and with some motors, where to move to. If you're interested in learning more about how servo motors work, you may want to check out SparkFun's [Servos Explained](https://www.sparkfun.com/servos) page for information and tutorials on how to use them.
7979

8080
## Expansion Connectors
8181

82-
The Controller Board has four four-pin connectors labeled (from left to right when looking at the labels upright) <b>Line</b>, <b>Extra</b>, <b>Qwiic</b>, and <b>Range</b>. Their labels indicate their use as well as which GPIO pins they connect to on the Pico W. These connectors provide an easy plug-in connection for the line follower and distance sensor as well as two extra connectors for expansion projects. These connectors are polarized meaning they only work when connected properly but they are keyed and there is only one way to plug a cable into them.
82+
The controller board has four four-pin connectors labeled (from left to right when looking at the labels upright) <b>Line</b>, <b>Extra</b>, <b>Qwiic</b>, and <b>Range</b>. Their labels indicate their use as well as which GPIO pins they connect to on the Pico W. These connectors provide an easy plug-in connection for the line follower and distance sensor as well as two extra connectors for expansion projects. These connectors are polarized meaning they only work when connected properly but they are keyed and there is only one way to plug a cable into them.
8383

8484
<figure markdown>
8585
[![Photo highlighting Qwiic and expansion connectors](./assets/img/XRP_Controller-Qwiic.jpg){width="400"}](./assets/img/XRP_Controller-Qwiic.jpg)
@@ -95,23 +95,23 @@ The Range connector is where you'll plug the cable for the ultrasonic range sens
9595

9696
### Qwiic Connector
9797

98-
The Qwiic connector works with SparkFun's [Qwiic ecosystem](https://www.sparkfun.com/qwiic) of sensors that communicate over I<sup>2</sup>C. This is a two-wire communication protocol that works with a large variety of sensors and other electronics. With this, you can customize the XRP Kit to add things like environmental sensing, OLED screens, data logging, and more!
98+
The Qwiic connector works with SparkFun's [Qwiic ecosystem](https://www.sparkfun.com/qwiic) of sensors that communicate over I<sup>2</sup>C. This is a two-wire communication protocol that works with a large variety of sensors and other electronics. With this, you can customize the XRP Kit - Beta to add things like environmental sensing, OLED screens, data logging, and more!
9999

100100
### Extra Connector
101101

102-
The Extra connector has pins for both power and ground as well as pins that connect to the Pico W's GPIO28 and GPIO22. Note, these pins are <i>shared</i> with other functionality on the XRP Controller Board. GPIO28 is shared with the VIN Measure pin which lets you measure the voltage level on VIN so you can monitor the remaining battery charge. GPIO22 is shared with the User Button. Both pins' primary functions can be disabled with the solder jumpers, refer to the Solder Jumpers section below for more information.
102+
The Extra connector has pins for both power and ground as well as pins that connect to the Pico W's GPIO28 and GPIO22. Note, these pins are <i>shared</i> with other functionality on the XRP Controller - Beta. GPIO28 is shared with the VIN Measure pin which lets you measure the voltage level on VIN so you can monitor the remaining battery charge. GPIO22 is shared with the User Button. Both pins' primary functions can be disabled with the solder jumpers, refer to the Solder Jumpers section below for more information.
103103

104104
## Buttons
105105

106-
The Controller Board has three push buttons labeled <b>USER</b>, <b>RESET</b>, and <b>BOOTSEL</b> (on the Pico W). The USER button connects to GPIO22 on the Pico W 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 BOOTSEL button either when plugging in a USB cable or when pressing the RESET button sets the Pico W to behave as a mass storage device when connected to a computer for uploading firmware.
106+
The XRP Controller - Beta has three push buttons labeled <b>USER</b>, <b>RESET</b>, and <b>BOOTSEL</b> (on the Pico W). The USER button connects to GPIO22 on the Pico W 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 BOOTSEL button either when plugging in a USB cable or when pressing the RESET button sets the Pico W to behave as a mass storage device when connected to a computer for uploading firmware.
107107

108108
<figure markdown>
109109
[![Photo highlighting buttons.](./assets/img/XRP_Controller-Push_Buttons.jpg){width="400"}](./assets/img/XRP_Controller-Push_Buttons.jpg)
110110
</figure>
111111

112112
## LEDs
113113

114-
There are three LEDs on the Controller Board labeled <b>MOT</b>, <b>SYS</b>, and <b>LED</b>.
114+
There are three LEDs on the XRP Controller - Beta labeled <b>MOT</b>, <b>SYS</b>, and <b>LED</b>.
115115

116116
<figure markdown>
117117
[![Photo highlighting LEDs](./assets/img/XRP_Controller-LEDs.jpg){width="400"}](./assets/img/XRP_Controller-LEDs.jpg)
@@ -124,9 +124,9 @@ These LEDs provide a visual indication to the user. The LEDs labeled <b>MOT</b>
124124
!!! warning Advanced Users Only
125125

126126
These solder jumpers can change the behavior of the board in a lasting way. Using these requires extra tools not included in the XRP
127-
Kit along with knowledge of how to use and interact with solder jumpers. We recommend that only advanced users adjust and change the solder jumpers. If you'd like to learn more about how to use solder jumpers, check out SparkFun's [How to Work with Jumper Pads and PCB Traces](https://learn.sparkfun.com/tutorials/how-to-work-with-jumper-pads-and-pcb-traces) tutorial.
127+
Kit - Beta along with knowledge of how to use and interact with solder jumpers. We recommend that only advanced users adjust and change the solder jumpers. If you'd like to learn more about how to use solder jumpers, check out SparkFun's [How to Work with Jumper Pads and PCB Traces](https://learn.sparkfun.com/tutorials/how-to-work-with-jumper-pads-and-pcb-traces) tutorial.
128128

129-
Lastly, this Controller Board has nine solder jumpers. A solder jumper provides a customization option for advanced users to control the behavior of the pins and components they connect to. The solder jumpers on this board are labeled (from top-to-bottom when looking at the photo below): <b>VIN_MEAS</b>, <b>MOT_MODE_R/4</b>, <b>MOT_MODE_L/3</b>, <b>USER_BTN</b>, <b>I2C</b>, <b>IMU_ADR</b>, <b>SYS</b>, <b>MOT</b>, and <b>VUSB</b>.
129+
Lastly, the XRP Controller - Beta has nine solder jumpers. A solder jumper provides a customization option for advanced users to control the behavior of the pins and components they connect to. The solder jumpers on this board are labeled (from top-to-bottom when looking at the photo below): <b>VIN_MEAS</b>, <b>MOT_MODE_R/4</b>, <b>MOT_MODE_L/3</b>, <b>USER_BTN</b>, <b>I2C</b>, <b>IMU_ADR</b>, <b>SYS</b>, <b>MOT</b>, and <b>VUSB</b>.
130130

131131
<figure markdown>
132132
[![Photo highlighting solder jumpers.](./assets/img/XRP_Controller-Solder_Jumpers.jpg){width="400"}](./assets/img/XRP_Controller-Solder_Jumpers.jpg)
@@ -197,7 +197,7 @@ Lastly, this Controller Board has nine solder jumpers. A solder jumper provides
197197

198198
## Pinout Reference Table
199199

200-
The table below offers a quick reference for the complete pinout on the XRP Controller Board and which pins they connect to on the Pico W.
200+
The table below offers a quick reference for the complete pinout on the XRP Controller - Beta and which pins they connect to on the Pico W.
201201

202202
<table>
203203
<tr>

docs/resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
For more information about the XRP Controller Board, take a look at the following resources:
1+
For more information about the XRP Controller - Beta, take a look at the following resources:
22

33
* [Schematic (PDF)](./assets/hardware_files/XRP_Controller.pdf)
44
* [Eagle Files (ZIP)](./assets/hardware_files/XRP_Controller.zip)

0 commit comments

Comments
 (0)