Skip to content

Commit 47cf77d

Browse files
FIRST Tech Challenge updates
1 parent 5a39389 commit 47cf77d

File tree

9 files changed

+53
-10
lines changed

9 files changed

+53
-10
lines changed
145 KB
Loading

docs/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ This example shows how to set the offset for the sensor relative to the center o
7777
Note that as of firmware version 1.0, these values will be lost after a power cycle, so you will need to set them each time you power up the sensor.
7878

7979

80-
To find Example 4, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **Example4_SetOffsetAndPositione**:
80+
To find Example 4, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **Example4_SetOffsetAndPosition**:
8181

8282

8383
<figure markdown>

docs/hardware_assembly.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,18 @@ icon: fontawesome/solid/screwdriver-wrench
33
---
44

55

6-
The SparkFun Optical Tracking Odometry Sensor needs to be rigidly mounted to a robot chassis and oriented flat to the floor. We've designed a few 3D printing models you can use, but you may need to design your own mount for this board, depending on your use case. Accurate readings really require that the sensor is mounted correctly; attempting to move the sensor by hand can work, but tracking accuracy will suffer.
6+
The SparkFun Optical Tracking Odometry Sensor needs to be rigidly mounted to a robot chassis and oriented flat to the floor. If you don't already have a chassis, we've designed a few 3D printing models you can use. That said, you may need to design your own mount for this board, depending on your use case.
7+
8+
You can access these designs here:
9+
10+
<center>
11+
[:octicons-download-16:{ .heart } Download 3D Mounting Designs](./../Hardware/SparkFun_Optical_Tracking_Odometry_Sensor.brd){ .md-button .md-button--primary }
12+
</center>
13+
14+
15+
!!! warning
16+
17+
Accurate readings require that the sensor is mounted correctly; attempting to move the sensor by hand may work, but tracking accuracy will suffer.
718

819

920
<figure markdown>
@@ -13,7 +24,14 @@ The SparkFun Optical Tracking Odometry Sensor needs to be rigidly mounted to a r
1324

1425

1526
!!! attention
27+
1628
Reminder - make sure you peel off the yellow kapton tape!
1729

1830

31+
The height that the sensor needs to be mounted will be dependent on the surface being read. Glossy surfaces are ideal; running a calibration will determine the necessary height.
32+
33+
!!! first-tech "FIRST Tech Challenge"
34+
35+
[![FIRST Tech Logo](assets/img/FIRSTTech_IconVert_RGB.jpg){ align="left" width="100"}](assets/img/FIRSTTech_IconVert_RGB.jpg "Click to enlarge")
1936

37+
FIRST Tech Challenge: Note here that we are using the foam surface typical of FIRST Tech Challenge competitions and the sensor is mounted at 10mm from the surface.

docs/hardware_overview.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: material/cog
66

77
## STM32CO
88

9-
The STM32C011F4U6 microcontroller has a high-performance Arm® Cortex®-M0+ 32-bit RISC core operating at up to 48 MHz frequency. It incorporates a memory protection unit (MPU), high-speed embedded memories (6 Kbytes of SRAM and up to 32 Kbytes of flash program memory with read and write protection), DMA, an extensive range of system functions, enhanced I/Os, and peripherals. The device offers standard communication interfaces (one I2C, one SPI / one I2S, and two USARTs), one 12-bit ADC (2.5 MSps) with up to 15 channels, a low-power RTC, an advanced control PWM timer, four general-purpose 16-bit timers, two watchdog timers, and a SysTick timer. For more information, refer to the [datasheet](assets/documentation/stm32c011d6-3082107.pdf).
9+
The STM32C011F4U6 microcontroller has a high-performance Arm® Cortex®-M0+ 32-bit RISC core operating at up to 48 MHz frequency. It incorporates a memory protection unit (MPU), high-speed embedded memory (6 Kbytes of SRAM and up to 32 Kbytes of flash program memory with read and write protection), DMA, an extensive range of system functions, enhanced I/Os, and peripherals. The device offers standard communication interfaces (one I<sup>2</sup>C, one SPI / one I2S, and two USARTs), one 12-bit ADC (2.5 MSps) with up to 15 channels, a low-power RTC, an advanced control PWM timer, four general-purpose 16-bit timers, two watchdog timers, and a SysTick timer. For more information, refer to the [datasheet](assets/documentation/stm32c011d6-3082107.pdf).
1010

1111
<!--
1212
<figure markdown>
@@ -55,8 +55,11 @@ The PAA5160E1-Q from PixArt Imaging has a tracking speed of 2.5m/s and a typical
5555
</figure>
5656
-->
5757

58-
!!! attention
59-
FIRST Tech users should note that for the foam competition files, the sensor really needs to be mounted at exactly 10mm from the surface with a tolerance of +/ 1mm. Beyond that, the tracking is less accurate; beyond +/- 3mm, and it just can't track the foam surface at all really.
58+
!!! first-tech "FIRST Tech Challenge"
59+
60+
[![FIRST Tech Logo](assets/img/FIRSTTech_IconVert_RGB.jpg){ align="left" width="100"}](assets/img/FIRSTTech_IconVert_RGB.jpg "Click to enlarge")
61+
62+
FIRST Tech Challenge: Note here that for the foam competition files, the sensor really needs to be mounted at exactly 10mm from the surface with a tolerance of +/ 1mm. Beyond that, the tracking is less accurate; beyond +/- 3mm, and it can't track the foam surface at all.
6063

6164

6265

@@ -74,7 +77,7 @@ The LSM6DSO from STMicroelectronics has a 3-axis digital accelerometer and 3-axi
7477

7578
## GPIO
7679

77-
The PTH pins on the side of the board allow you to provide power, access the I<sup>2</sup>C Data and Clock lines, and there are two pins available for UART/generic programming purposes. In normal operation, IO9 acts as a "data ready" interrupt, so a user could use that to synchronize measurements if needed.
80+
The PTH pins on the side of the board allow you to provide power, access the I<sup>2</sup>C Data and Clock lines, and there are two pins available for UART/generic programming purposes. In normal operation, IO9 acts as a "data ready" interrupt; this pin could be used to synchronize measurements if needed.
7881

7982
<!--
8083
<figure markdown>
@@ -130,7 +133,7 @@ If you choose to use one or more Qwiic breakouts in your project, it is importan
130133
The board dimensions are illustrated in the drawing below; the listed measurements are in inches.
131134

132135
<figure markdown>
133-
[![Board measures 0.9" by 2.4"](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png){ width="600" }](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png "Click to enlarge")
136+
[![Board measures 1" by 1"](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png){ width="600" }](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png "Click to enlarge")
134137
<figcaption markdown>SparkFun Optical Tracking Odometry Sensor Board Dimensions</figcaption>
135138
</figure>
136139

docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ icon: material/book-open-page-variant
1515
![Product Thumbnail]()
1616
</figure></a>
1717

18-
-
18+
- The SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic) is an all-in-one, Qwiic enabled tracking sensor that allows you to accurately drive your XRP or other robotics with minimal space and setup requirements.
1919

2020
<center>
2121
[Purchase from SparkFun :fontawesome-solid-cart-plus:{ .heart }](https://www.sparkfun.com/products/24904){ .md-button .md-button--primary }

docs/software_setup_and_programming.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22
icon: simple/arduino
33
---
44

5+
## Arduino
6+
57
!!! attention
68
If this is your first time using Arduino, please review our tutorial on [installing the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-arduino-ide). If you have not previously installed an Arduino library, please check out our [installation guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library).
79

810
We've written a library to get you started with the SparkFun Optical Tracking Odometry Sensor. You can obtain this library through the Arduino Library Manager by searching for "Odometry" and installing the latest version from SparkFun. If you prefer downloading libraries manually, you can grab them from the GitHub Repository.
911

1012
<center>
11-
[SparkFun Optical Tracking Odometry Sensor Arduino Library GitHub](https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library){ .md-button .md-button--primary }
13+
[SparkFun Optical Tracking Odometry Sensor Arduino Library GitHub](https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library/archive/refs/heads/main.zip){ .md-button .md-button--primary }
1214
</center>
1315

16+
## Python
17+
1418

1519

1620
<!--

docs/stylesheet/extra.css

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,21 @@
181181
mask-image: var(--md-admonition-icon--hot);
182182
}
183183

184-
184+
/* FIRST-Tech ========================================================================== */
185+
.md-typeset .admonition.first-tech,
186+
.md-typeset details.first-tech {
187+
border-color: #0066B3;
188+
}
189+
.md-typeset .first-tech > .admonition-title,
190+
.md-typeset .first-tech > summary {
191+
background-color: rgba(0, 92, 95, 0.1);
192+
}
193+
.md-typeset .first-tech > .admonition-title::before,
194+
.md-typeset .first-tech > summary::before {
195+
background-color: #0066B3;
196+
-webkit-mask-image: var(--md-admonition-icon--first-tech);
197+
mask-image: var(--md-admonition-icon--first-tech);
198+
}
185199

186200
/* ================================================================================== */
187201
/* Header Permalinks */

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ theme:
131131
terminal: octicons/terminal-16
132132
serial: fontawesome/solid/display
133133
hot: material/fire-alert
134+
first-tech: simple/first
134135
# Permalink icon
135136
link: octicons/link-16
136137

@@ -256,6 +257,8 @@ nav:
256257
- Software Setup: software_setup_and_programming.md
257258
- Examples:
258259
- Arduino Examples: examples.md
260+
# - Python Examples:
261+
# - FIRST Tech Challenge:
259262
- Resources: resources.md
260263
- Support:
261264
- Troubleshooting: troubleshooting.md

overrides/.icons/first.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)