Skip to content

Commit 2f8f7cc

Browse files
Updating to examples, hardware assembly
1 parent 2d8e32f commit 2f8f7cc

11 files changed

+269
-46
lines changed
Loading
Loading

docs/hardware_assembly.md

+5-14
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@ 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. 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.
6+
The SparkFun Optical Tracking Odometry Sensor needs to be rigidly mounted to a robot chassis and oriented flat to the floor in order to get accurate data. If you don't already have a mount, 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.
77

8-
You can access these designs here:
8+
The height that the sensor needs to be mounted will be dependent on the surface being read. If you have a shiny or glossy surface, you should be able to mount the sensor anywhere in the range of 10mm to 27mm, measured from the front face of the optical sensor. If you have a darker or more diffuse surface, you may need to mount the sensor at the low-end of that range. You'll need to test to determine what height works for your surface.
9+
10+
You can access the XRP mount on Printables:
911

1012
<center>
11-
[:octicons-download-16:{ .heart } Download 3D Mounting Designs](./../Hardware/SparkFun_Optical_Tracking_Odometry_Sensor.brd){ .md-button .md-button--primary }
13+
[XRP Mount on Printables](https://www.printables.com/model/872179-odometry-clip-for-xrp){ .md-button .md-button--primary target="_blank" }
1214
</center>
1315

14-
1516
!!! warning
1617

1718
Accurate readings require that the sensor is mounted correctly; attempting to move the sensor by hand may work, but tracking accuracy will suffer.
@@ -31,8 +32,6 @@ Here is the underside of the XRP with the Optical Tracking Sensor attached via t
3132
</figure>
3233

3334

34-
35-
3635
!!! attention
3736

3837
Reminder - make sure you peel off the yellow kapton tape!
@@ -42,11 +41,3 @@ Here is the underside of the XRP with the Optical Tracking Sensor attached via t
4241
[![Peel off the Kapton tape!](assets/img/SEN-24904-Action-4.jpg){ width="600" }](assets/img/SEN-24904-Action-4.jpg "Click to enlarge")
4342
<figcaption markdown>Peel off the Kapton tape before use</figcaption>
4443
</figure>
45-
46-
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.
47-
48-
!!! first-tech "FIRST Tech Challenge"
49-
50-
[![FIRST Tech Logo](assets/img/FIRSTTech_IconVert_RGB.jpg){ align="left" width="100"}](assets/img/FIRSTTech_IconVert_RGB.jpg "Click to enlarge")
51-
52-
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_assembly_FTC.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
icon: first
3+
---
4+
5+
<!--
6+
[![FIRST Tech Logo](assets/img/FIRSTTech_IconVert_RGB.jpg){ align="center" width="200"}](assets/img/FIRSTTech_IconVert_RGB.jpg "Click to enlarge")
7+
-->
8+
9+
The SparkFun Optical Tracking Odometry Sensor needs to be rigidly mounted to a robot chassis and oriented flat to the floor in order to get accurate data. If you don't already have a mount, 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.
10+
11+
Accurate readings require that the sensor is mounted correctly; attempting to move the sensor by hand may work, but tracking accuracy will suffer. 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.
12+
13+
14+
The FTC mounts are available on Onshape:
15+
16+
<center>
17+
[FTC mounts on Onshape](https://cad.onshape.com/documents/1253798610182bf3a147f431/w/11cc45e6a7c8080b22bb8377/e/d4827c4f09d804607ba1824b){ .md-button .md-button--primary target="_blank" }
18+
</center>
19+
20+
In addition, instructions for the FTC mounts are available here:
21+
22+
<center>
23+
[Instructions for FTC mounts]( https://docs.google.com/document/d/1Lvl2MDyql5VbqD7VTcGUG2xGibc90_Fd-FUR2ew7Pfw/edit){ .md-button .md-button--primary target="_blank" }
24+
</center>
25+
26+
27+
28+
29+
The image below shows the 3D mounted clip with the Optical Tracking Sensor attached to an FTC Bot:
30+
31+
<figure markdown>
32+
[![Optical Tracking Sensor Mounted to the Underside of the FTC Bot](assets/img/SEN-24904-Action-23-Highlighted.jpg){ width="600" }](assets/img/SEN-24904-Action-23-Highlighted.jpg "Click to enlarge")
33+
<figcaption markdown>Optical Tracking Sensor Mounted to the FTC Bot</figcaption>
34+
</figure>
35+
36+
Here is the underside of the FTC Bot with the Optical Tracking Sensor attached via the mounting clip:
37+
38+
<figure markdown>
39+
[![Optical Tracking Sensor Mounted to the Underside of the FTC Bot](assets/img/SEN-24904-Action-21-Highlighted.jpg){ width="600" }](assets/img/SEN-24904-Action-21-Highlighted.jpg "Click to enlarge")
40+
<figcaption markdown>Optical Tracking Sensor Mounted to the FTC Bot</figcaption>
41+
</figure>
42+
43+
44+
!!! attention
45+
46+
Reminder - make sure you peel off the yellow kapton tape!
47+
48+
49+
<figure markdown>
50+
[![Peel off the Kapton tape!](assets/img/SEN-24904-Action-4.jpg){ width="600" }](assets/img/SEN-24904-Action-4.jpg "Click to enlarge")
51+
<figcaption markdown>Peel off the Kapton tape before use</figcaption>
52+
</figure>
53+
54+
55+
<!--
56+
!!! first-tech "FIRST Tech Challenge"
57+
58+
[![FIRST Tech Logo](assets/img/FIRSTTech_IconVert_RGB.jpg){ align="left" width="100"}](assets/img/FIRSTTech_IconVert_RGB.jpg "Click to enlarge")
59+
60+
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.
61+
-->

docs/hardware_overview.md

+13-16
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,6 @@ icon: material/cog
33
---
44

55

6-
7-
## STM32CO
8-
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).
10-
11-
12-
<figure markdown>
13-
[![STM32 Processor](assets/img/24904-Optical-Tracking-Odometry-Sensor_STM32.jpg){ width="400" }](assets/img/24904-Optical-Tracking-Odometry-Sensor_STM32.jpg "Click to enlarge")
14-
<figcaption markdown>STM32 Processor</figcaption>
15-
</figure>
16-
17-
18-
196
## Optical Tracking Sensor - PAA5160
207

218
The PAA5160E1-Q from PixArt Imaging has a tracking speed of 2.5m/s and a typical tracking error rate of 3~5% within a working range of 10mm to 27mm. With an 850nm class 1 laser a resolution of 20,000 DPI and a frame rate of 20,000 fps, it is ideal for surfaces like concrete, epoxy, laminated wood, or glossy/semi-glossy flooring. That said, dark or diffuse surfaces are more challenging, so these specs may vary based on the surfaces that are being used. More information can be found in the [datasheet](assets/documentation/PAA5160_Datasheet_General.pdf).
@@ -41,9 +28,7 @@ The PAA5160E1-Q from PixArt Imaging has a tracking speed of 2.5m/s and a typical
4128
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.
4229

4330

44-
45-
46-
## 6-DOF IMU Accelerometer
31+
## LSM6DSO IMU Accelerometer
4732

4833
The LSM6DSO from STMicroelectronics has a 3-axis digital accelerometer and 3-axis digital gyroscope featuring a full-scale acceleration range of ±2/±4/±8/±16 g and an angular rate range of ±125/±250/±500/±1000/±2000 dps. For more information, refer to the [datasheet](assets/documentation/lsm6dso.pdf).
4934

@@ -53,6 +38,18 @@ The LSM6DSO from STMicroelectronics has a 3-axis digital accelerometer and 3-axi
5338
<figcaption markdown>LSM6DSO 6-DOF IMU Accelerometer</figcaption>
5439
</figure>
5540

41+
42+
## STM32CO
43+
44+
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).
45+
46+
47+
<figure markdown>
48+
[![STM32 Processor](assets/img/24904-Optical-Tracking-Odometry-Sensor_STM32.jpg){ width="400" }](assets/img/24904-Optical-Tracking-Odometry-Sensor_STM32.jpg "Click to enlarge")
49+
<figcaption markdown>STM32 Processor</figcaption>
50+
</figure>
51+
52+
5653
## Power
5754

5855
The LED indicator lights when power is provided to the board.

docs/resources.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
For more resources related to the SparkFun SparkFun Optical Tracking Odometry Sensor, check out the links listed here:
55

6-
* [Product Page](https://www.sparkfun.com/products/24904)
7-
* [Schematic](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_Schematic.pdf) (PDF)
8-
* [Eagle Files](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_EagleFiles.zip) (ZIP)
9-
* [Board Dimensions](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png) (PDF)
10-
* [Hardware GitHub Respository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor)
11-
* [Arduino Library GitHub Repository](https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library)
6+
* [Product Page](https://www.sparkfun.com/products/24904){ target="_blank" }
7+
* [Schematic (PDF)](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_Schematic.pdf){ target="_blank" }
8+
* [Eagle Files (ZIP)](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_EagleFiles.zip){ target="_blank" }
9+
* [Board Dimensions(PNG)](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png){ target="_blank" }
10+
* [Hardware GitHub Respository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor){ target="_blank" }
11+
* [Arduino Library GitHub Repository](https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library){ target="_blank" }

docs/single_page.md

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ icon: fontawesome/solid/scroll
1414
# Hardware Assembly
1515
--8<-- "./docs/hardware_assembly.md:5"
1616

17+
# Hardware Assembly - FTC
18+
--8<-- "./docs/hardware_assembly_FTC.md:5"
19+
1720
## Software Setup
1821
--8<-- "./docs/software_setup_and_programming.md:5"
1922

mkdocs.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,9 @@ nav:
253253
- Hookup Guide:
254254
- Introduction: introduction.md
255255
- Hardware Overview: hardware_overview.md
256-
- Hardware Assembly: hardware_assembly.md
256+
- Hardware Assembly:
257+
- XRP: hardware_assembly.md
258+
- FTC: hardware_assembly_FTC.md
257259
- Software Setup: software_setup_and_programming.md
258260
- Examples:
259261
- Arduino Examples: examples.md

overrides/.icons/FIRSTTech_iconHorz_RGB_reverse.svg

+42
Loading

overrides/.icons/FIRSTicon_CMYK_withTM.svg

+29-8
Loading

0 commit comments

Comments
 (0)