Skip to content

Commit 979133d

Browse files
Updating names and overview
1 parent 7a8a34a commit 979133d

File tree

6 files changed

+36
-23
lines changed

6 files changed

+36
-23
lines changed

docs/github/contribute.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Spot an improvement opportunity? Feel free to contribute to our open-source desi
44
## :material-file-document-multiple: Improve our Documentation
55
All of this documentation can be modified by you! Please help us make it better.
66

7-
* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/docs) of the [SparkFun ESP32 Qwiic Pro Mini repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
7+
* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/docs) of the [SparkFun Optical Tracking Odometry Sensor repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
88

99
<!-- ### :material-source-pull:&nbsp;Submit a Correction -->
1010
### Submit a Correction
@@ -18,7 +18,7 @@ All of this documentation can be modified by you! Please help us make it better.
1818
## :material-cog:&nbsp;Improve our Hardware Design
1919
All of our designs are open-source! Please help us make it better.
2020

21-
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/Hardware) of the [SparkFun ESP32 Qwiic Pro Mini repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
21+
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/Hardware) of the [SparkFun Optical Tracking Odometry Sensor repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
2222

2323
<!-- ### :material-source-pull:&nbsp;Submit a Design Enhancement -->
2424
### Submit a Design Enhancement

docs/github/file_issue.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/S
2020

2121
All of our documentation can be modified by you! Please help us make it better.
2222

23-
* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/docs) of the [SparkFun ESP32 Qwiic Pro Mini repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
23+
* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/docs) of the [SparkFun Optical Tracking Odometry Sensor repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
2424

2525
### 🔍 Spot something wrong?
2626

@@ -38,7 +38,7 @@ If a section of the documentation is incorrect, please [open an issue](https://g
3838

3939
All of our designs are open-source! Please help us make it better.
4040

41-
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/Hardware) of the [SparkFun ESP32 Qwiic Pro Mini repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
41+
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor/tree/main/Hardware) of the [SparkFun Optical Tracking Odometry Sensor repository](https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor).
4242

4343
### Does something not make sense? 🤔
4444

docs/hardware_overview.md

Lines changed: 23 additions & 12 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 I2Cs, 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 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).
1010

1111
<!--
1212
<figure markdown>
@@ -19,10 +19,16 @@ The STM32C011F4U6 microcontroller has a high-performance Arm® Cortex®-M0+ 32-b
1919

2020
The Red LED indicator lights when power is provided to the board.
2121

22+
<!--
23+
<figure markdown>
24+
[![Power LED(assets/img/){ width="200" }](assets/img/ "Click to enlarge")
25+
<figcaption markdown>Power LED</figcaption>
26+
</figure>
27+
-->
2228

2329
## Qwiic Connectors
2430

25-
The Qwiic Connectors on the SparkFun Optical Tracking Odometry Sensor provide power and I<sup>2</sup>C connectivity simultaneously. <!--The default I<sup>2</sup>C address is . -->
31+
The Qwiic Connectors on the SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic) provide power and I<sup>2</sup>C connectivity simultaneously. <!--The default I<sup>2</sup>C address is . -->
2632

2733
<!--
2834
<figure markdown>
@@ -61,16 +67,23 @@ The LSM6DSO from STMicroelectronics has a 3-axis digital accelerometer and 3-axi
6167
</figure>
6268
-->
6369

70+
## GPIO
6471

72+
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.
6573

66-
## Debugging Test Points
6774

68-
We've broken out test points for serial wire debugging. They are located here:
6975

70-
Standard arrangement of testpoints
71-
hookup a jlink and use to access flash memory, program, add breakpoints, etc
7276

77+
## Debugging Test Points
7378

79+
We've broken out test points for serial wire debugging if you wish to access flash memory or directly program the board. They are located here:
80+
81+
<!--
82+
<figure markdown>
83+
[![Debugging Test Points](assets/img/){ width="200" }](assets/img/ "Click to enlarge")
84+
<figcaption markdown>Debugging Test Points</figcaption>
85+
</figure>
86+
-->
7487

7588

7689
## Jumpers
@@ -85,12 +98,10 @@ hookup a jlink and use to access flash memory, program, add breakpoints, etc
8598

8699
### Power Jumper
87100

88-
If you are concerned about power consumption, need to run dark, or just really don't like LEDs, cut the jumper highlighted below to disconnect power from the Red LED on the front of the board.
89-
90-
101+
If you are concerned about power consumption, need to run dark, or just really don't like LEDs, cut the jumper highlighted below to disconnect power from the red LED on the front of the board.
91102

92103
<figure markdown>
93-
[![Power Jumper](assets/img/24409_SoilMoistureSensor_I2CJumper.jpg){ width="200" }](assets/img/24409_SoilMoistureSensor_I2CJumper.jpg "Click to enlarge")
104+
[![Power Jumper](assets/img/){ width="200" }](assets/img/ "Click to enlarge")
94105
<figcaption markdown>Power Jumper</figcaption>
95106
</figure>
96107

@@ -100,7 +111,7 @@ If you are concerned about power consumption, need to run dark, or just really d
100111
If you choose to use one or more Qwiic breakouts in your project, it is important to note that this board comes equipped with pull-up resistors on the clock and data pins. If you are daisy-chaining multiple Qwiic devices, you will want to cut this jumper; if multiple sensors are connected to the bus with the pull-up resistors enabled, the parallel equivalent resistance will create too strong of a pull-up for the bus to operate correctly. As a general rule of thumb, disable all but one pair of pull-up resistors if multiple devices are connected to the bus. To disable the pull up resistors, use an X-acto knife to cut the joints between the jumper pads highlighted below.
101112

102113
<figure markdown>
103-
[![I2C Jumper](assets/img/24409_SoilMoistureSensor_I2CJumper.jpg){ width="200" }](assets/img/24409_SoilMoistureSensor_I2CJumper.jpg "Click to enlarge")
114+
[![I2C Jumper](assets/img/){ width="200" }](assets/img/ "Click to enlarge")
104115
<figcaption markdown>I<sup>2</sup>C Jumper</figcaption>
105116
</figure>
106117

@@ -109,7 +120,7 @@ If you choose to use one or more Qwiic breakouts in your project, it is importan
109120
The board dimensions are illustrated in the drawing below; the listed measurements are in inches.
110121

111122
<figure markdown>
112-
[![Board measures 0.9" by 2.4"](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png){ width="200" }](assets/board_files/24904_SparkFun_Optical_Tracking_Odometry_Sensor_BoardOutline.png "Click to enlarge")
123+
[![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")
113124
<figcaption markdown>SparkFun Soil Moisture Sensor Board Dimensions</figcaption>
114125
</figure>
115126

docs/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: material/book-open-page-variant
66
<div class="grid cards desc" markdown>
77

88
- <a href="https://www.sparkfun.com/products/24904">
9-
**SparkFun Optical Tracking Odometry Sensor**<br>
9+
**SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic)**<br>
1010
**SKU:** SEN-24904
1111

1212
---
@@ -31,8 +31,8 @@ To follow along with this tutorial, you will need the following materials. You m
3131
<tr>
3232
<td>
3333
<a href="https://www.sparkfun.com/products/24904">
34-
<center><img src="" style="width:140px; height:140px; object-fit:contain;" alt="SparkFun Optical Tracking Odometry Sensor"></center>
35-
<h3 class="title">SparkFun Optical Tracking Odometry Sensor</h3>
34+
<center><img src="" style="width:140px; height:140px; object-fit:contain;" alt="SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic)"></center>
35+
<h3 class="title">SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic)</h3>
3636
</a>
3737
SEN-24904
3838
</td>
@@ -104,7 +104,7 @@ As a more professionally oriented product, we will skip over the more fundamenta
104104
</div>
105105
</center>
106106

107-
The SparkFun Optical Tracking Odometry Sensor takes advantage of the [Qwiic connect system](https://www.sparkfun.com/qwiic). We recommend familiarizing yourself with the **Logic Levels** and **I<sup>2</sup>C** tutorials. Click on the banner above to learn more about [Qwiic products](https://www.sparkfun.com/qwiic).
107+
The SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic) takes advantage of the [Qwiic connect system](https://www.sparkfun.com/qwiic). We recommend familiarizing yourself with the **Logic Levels** and **I<sup>2</sup>C** tutorials. Click on the banner above to learn more about [Qwiic products](https://www.sparkfun.com/qwiic).
108108

109109
<center>
110110
<iframe width="600" height="327" src="https://www.youtube.com/embed/x0RDEHqFIF8" title="SparkFun's Qwiic Connect System" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

docs/software_setup_and_programming.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ icon: simple/arduino
55
!!! attention
66
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).
77

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

1010
<center>
1111
[SparkFun Optical Tracking Sensor Arduino Library GitHub](){ .md-button .md-button--primary }
1212
</center>
1313

14+
15+
1416
<!--
1517
Arduino library
1618

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation page information
2-
site_name: SparkFun Optical Tracking Odometry Sensor Hookup Guide
3-
site_description: A guide for getting started with the SparkFun Optical Tracking Odometry Sensor
2+
site_name: SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic) Hookup Guide
3+
site_description: A guide for getting started with the SparkFun Optical Tracking Odometry Sensor - PAA5160E1 (Qwiic)
44
site_url: https://sparkfun.github.io/SparkFun_Optical_Tracking_Odometry_Sensor
55
site_author: SparkFun Electronics
66

0 commit comments

Comments
 (0)