Updates to example page

SparkFun-Documentation-Team · SparkFun-Documentation-Team · commit 2fdca31a41a0 · 2024-03-26T12:47:29.000-06:00
diff --git a/docs/examples.md b/docs/examples.md
@@ -0,0 +1,55 @@
+###Example 1: Basic Readings
+
+This first example just does some basic measurements to make sure everything is hooked up correctly. To find Example 1, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **Example01_BasicUsage**:
+
+
+<figure markdown>
+[![Optical Tracking Odometry Sensor Arduino Example 1](assets/imgs/Example1_Menu.jpg){ width="90%" }](assets/imgs/Example1_Menu.jpg "Click to enlarge")
+<figcaption markdown>Finding Example 1</figcaption>
+</figure>
+
+Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch: 
+
+
+??? "Example 1 Arduino Code"
+	```
+	--8<-- ""
+	```
+
+Make sure you've selected the correct board and port in the Tools menu and then hit the upload button. Once the code has finished uploading, go ahead and open a [Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics). You should see something similar to the following.  
+
+<figure markdown>
+[![OTOS Arduino Example 1 Output](assets/imgs/Example1_Output.jpg){ width="90%" }](assets/imgs/Example1_Output.jpg "Click to enlarge")
+<figcaption markdown>Example 1 Output</figcaption>
+</figure>
+
+###Example 2: SetUnits
+
+<!--
+
+??? "Example 2 Arduino Code"
+	```
+	--8<-- ""
+	```
+-->
+
+###Example 3: Calibration
+
+<!--
+
+??? "Example 3 Arduino Code"
+	```
+	--8<-- ""
+	```
+-->
+
+
+###Example 4: SetOffsetAndPosition 
+
+<!--
+
+??? "Example 4 Arduino Code"
+	```
+	--8<-- ""
+	```
+-->
diff --git a/docs/hardware_assembly.md b/docs/hardware_assembly.md
@@ -3,7 +3,9 @@ icon: fontawesome/solid/screwdriver-wrench
 ---
 
 
-Using the Qwiic system, assembling the hardware is simple. Connect the SparkFun Optical Tracking Sensor using your Qwiic cable. Then connect the RedBoard to your computer via the MicroUSB cable and voila! You're ready to rock! 
+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. 
+
+
 
 <figure markdown>
 [![Qwiic Cable connecting Optical Tracking Sensor to RedBoard](assets/img/Soil_Moisture_Sensor_Hookup_Guide_Update-02.jpg){ width="600" }](assets/img/Soil_Moisture_Sensor_Hookup_Guide_Update-02.jpg "Click to enlarge")
@@ -13,3 +15,9 @@ Using the Qwiic system, assembling the hardware is simple. Connect the SparkFun
 
 !!! attention
 	Reminder - make sure you peel off the yellow kapton tape before using this! 
+
+
+
+
+
+the sensor really needs to be rigidly mounted to a robot chassis, and oriented flat to the floor. I'm planning on providing a couple 3D printable mount designs that folks can use, but they may need to design their own mount. Also emphasize that the examples really require the sensor to be mounted correctly; attempting to move the sensor by hand can work, but tracking accuracy may be terrible.
diff --git a/docs/hardware_overview.md b/docs/hardware_overview.md
@@ -74,7 +74,7 @@ The LSM6DSO from STMicroelectronics has a 3-axis digital accelerometer and 3-axi
 
 ## GPIO
 
-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. 
+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. 
 
 <!--
 <figure markdown>
diff --git a/docs/single_page.md b/docs/single_page.md
@@ -17,9 +17,6 @@ icon: fontawesome/solid/scroll
 ## Software Setup
 --8<-- "./docs/software_setup_and_programming.md:5"
 
-## Arduino Example
---8<-- "./docs/arduino_example.md:5"
-
 # Troubleshooting Tips
 --8<-- "./docs/troubleshooting.md:5"
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -254,7 +254,7 @@ nav:
     - Hardware Overview: hardware_overview.md
     - Hardware Assembly: hardware_assembly.md
     - Software Setup: software_setup_and_programming.md
-    - Arduino Example: arduino_example.md
+    - Arduino Examples: examples.md
   - Resources: resources.md
   - Support:
     - Troubleshooting: troubleshooting.md
