Skip to content

Commit a5c7094

Browse files
Example menu images
1 parent 3d5d772 commit a5c7094

11 files changed

+115
-26
lines changed
169 KB
Loading
169 KB
Loading
169 KB
Loading
172 KB
Loading
170 KB
Loading
171 KB
Loading
168 KB
Loading
165 KB
Loading

docs/examples.md

Lines changed: 43 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,20 @@ This first example just does some basic measurements to make sure everything is
44

55

66
<figure markdown>
7-
[![Optical Tracking Odometry Sensor Arduino Example 1](assets/imgs/Example1_Menu.jpg){ width="90%" }](assets/imgs/Example1_Menu.jpg "Click to enlarge")
7+
[![Optical Tracking Odometry Sensor Arduino Example 1](assets/img/Arduino_Example_1_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_1_Menu.jpg "Click to enlarge")
88
<figcaption markdown>Finding Example 1</figcaption>
99
</figure>
1010

1111
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
1212

13-
1413
??? "Example 1 Arduino Code"
1514
```
1615
--8<-- ""
1716
```
1817

1918
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.
2019

21-
<figure markdown>
22-
[![OTOS Arduino Example 1 Output](assets/imgs/Example1_Output.jpg){ width="90%" }](assets/imgs/Example1_Output.jpg "Click to enlarge")
23-
<figcaption markdown>Example 1 Output</figcaption>
24-
</figure>
20+
2521

2622
###Example 2: SetUnits
2723

@@ -31,41 +27,41 @@ To find Example 2, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **E
3127

3228

3329
<figure markdown>
34-
[![Optical Tracking Odometry Sensor Arduino Example 2](assets/imgs/Example2_Menu.jpg){ width="90%" }](assets/imgs/Example2_Menu.jpg "Click to enlarge")
30+
[![Optical Tracking Odometry Sensor Arduino Example 2](assets/img/Arduino_Example_2_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_2_Menu.jpg "Click to enlarge")
3531
<figcaption markdown>Finding Example 2</figcaption>
3632
</figure>
3733

3834
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
3935

40-
<!--
36+
4137

4238
??? "Example 2 Arduino Code"
4339
```
4440
--8<-- ""
4541
```
46-
-->
42+
4743

4844
###Example 3: Calibration
4945

50-
The IMU on the OTOS includes a gyroscope and accelerometer, which could have an offset. The OTOS performs a quick calibration when it powers up, but it is recommended to perform a more thorough calibration at the start of all your programs.
46+
The IMU on the Optical Tracking Odometry Sensor includes a gyroscope and accelerometer, which could have an offset. The OTOS performs a quick calibration when it powers up, but it is recommended to perform a more thorough calibration at the start of all your programs.
5147

5248
To find Example 3, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **Example3_Calibration**:
5349

5450

5551
<figure markdown>
56-
[![Optical Tracking Odometry Sensor Arduino Example 3](assets/imgs/Example3_Menu.jpg){ width="90%" }](assets/imgs/Example3_Menu.jpg "Click to enlarge")
52+
[![Optical Tracking Odometry Sensor Arduino Example 3](assets/img/Arduino_Example_3_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_3_Menu.jpg "Click to enlarge")
5753
<figcaption markdown>Finding Example 3</figcaption>
5854
</figure>
5955

6056
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
6157

62-
<!--
58+
6359

6460
??? "Example 3 Arduino Code"
6561
```
6662
--8<-- ""
6763
```
68-
-->
64+
6965

7066

7167
###Example 4: SetOffsetAndPosition
@@ -81,19 +77,19 @@ To find Example 4, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **E
8177

8278

8379
<figure markdown>
84-
[![Optical Tracking Odometry Sensor Arduino Example 4](assets/imgs/Example4_Menu.jpg){ width="90%" }](assets/imgs/Example4_Menu.jpg "Click to enlarge")
80+
[![Optical Tracking Odometry Sensor Arduino Example 4](assets/img/Arduino_Example_4_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_4_Menu.jpg "Click to enlarge")
8581
<figcaption markdown>Finding Example 4</figcaption>
8682
</figure>
8783

8884
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
8985

90-
<!--
86+
9187

9288
??? "Example 4 Arduino Code"
9389
```
9490
--8<-- ""
9591
```
96-
-->
92+
9793

9894
###Example 5: VelocityAndAcceleration
9995

@@ -104,19 +100,19 @@ To find Example 5, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **E
104100

105101

106102
<figure markdown>
107-
[![Optical Tracking Odometry Sensor Arduino Example 5](assets/imgs/Example5_Menu.jpg){ width="90%" }](assets/imgs/Example5_Menu.jpg "Click to enlarge")
103+
[![Optical Tracking Odometry Sensor Arduino Example 5](assets/img/Arduino_Example_5_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_5_Menu.jpg "Click to enlarge")
108104
<figcaption markdown>Finding Example 5</figcaption>
109105
</figure>
110106

111107
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
112108

113-
<!--
109+
114110

115111
??? "Example 5 Arduino Code"
116112
```
117113
--8<-- ""
118114
```
119-
-->
115+
120116

121117
###Example 6: StandardDeviation
122118

@@ -132,19 +128,19 @@ To find Example 6, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **E
132128

133129

134130
<figure markdown>
135-
[![Optical Tracking Odometry Sensor Arduino Example 6](assets/imgs/Example6_Menu.jpg){ width="90%" }](assets/imgs/Example6_Menu.jpg "Click to enlarge")
131+
[![Optical Tracking Odometry Sensor Arduino Example 6](assets/img/Arduino_Example_6_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_6_Menu.jpg "Click to enlarge")
136132
<figcaption markdown>Finding Example 6</figcaption>
137133
</figure>
138134

139135
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
140136

141-
<!--
137+
142138

143139
??? "Example 6 Arduino Code"
144140
```
145141
--8<-- ""
146142
```
147-
-->
143+
148144

149145

150146

@@ -157,16 +153,38 @@ To find Example 7, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **E
157153

158154

159155
<figure markdown>
160-
[![Optical Tracking Odometry Sensor Arduino Example 7](assets/imgs/Example7_Menu.jpg){ width="90%" }](assets/imgs/Example7_Menu.jpg "Click to enlarge")
156+
[![Optical Tracking Odometry Sensor Arduino Example 7](assets/img/Arduino_Example_7_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_7_Menu.jpg "Click to enlarge")
161157
<figcaption markdown>Finding Example 7</figcaption>
162158
</figure>
163159

164160
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
165161

166-
<!--
162+
167163

168164
??? "Example 7 Arduino Code"
169165
```
170166
--8<-- ""
171167
```
172-
-->
168+
169+
170+
171+
###Example 8: SelfTest
172+
173+
This example shows how to set the offset for the sensor relative to the center of the robot. The units default to inches and degrees, but if you want to use different units, make sure you specify them before setting the offset.
174+
175+
To find Example 8, go to **File** > **Examples** > **SparkFun Qwiic OTOS** > **Example8_SelfTest**:
176+
177+
178+
<figure markdown>
179+
[![Optical Tracking Odometry Sensor Arduino Example 8](assets/img/Arduino_Example_8_Menu.jpg){ width="90%" }](assets/img/Arduino_Example_8_Menu.jpg "Click to enlarge")
180+
<figcaption markdown>Finding Example 8</figcaption>
181+
</figure>
182+
183+
Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
184+
185+
186+
187+
??? "Example 8 Arduino Code"
188+
```
189+
--8<-- ""
190+
```

docs/software_setup_and_programming.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ We've written a library to get you started with the SparkFun Optical Tracking Od
1313
[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 }
1414
</center>
1515

16-
## Python
1716

1817

1918

2019
<!--
20+
## Python
21+
22+
2123
Arduino library
2224
2325

0 commit comments

Comments
 (0)