Skip to content

Commit 4cbb207

Browse files
Update example reference with links
1 parent b28e49a commit 4cbb207

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

examples/README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,21 @@ NOTE: Any numbering of examples is to retain consistency with the Arduino librar
77
This example demonstrates how to read the position and heading from the
88
SparkFun Qwiic Optical Tracking Odometry Sensor (OTOS).
99

10+
The key methods showcased by this example are:
11+
-[resetTracking()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#af10d67665906b6cb5e9f66d25b358a4f)
12+
-[getPosition()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a507b45aeb4223a732c6e995b64f0e796)
13+
1014
## Qwiic Otos Ex2 Set Units
1115
This example demonstrates how to change the units of the SparkFun Qwiic
1216
Optical Tracking Odometry Sensor (OTOS).
1317

1418
The OTOS library defaults to inches and degrees, but you can change the
1519
units to suit the needs of your project.
1620

21+
The key methods showcased by this example are:
22+
-[setLinearUnit()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a6373a18efaa75a35abb7e3171013617f)
23+
-[setAngularUnit()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#ac2668f8297ed977b005c6577ce58bca0)
24+
1725
## Qwiic Otos Ex3 Calibration
1826
This example demonstrates how to calibrate the SparkFun Qwiic Optical
1927
Tracking Odometry Sensor (OTOS).
@@ -25,6 +33,11 @@ This example demonstrates how to calibrate the SparkFun Qwiic Optical
2533
the heading measurement. Note that if the heading measurement is off, that
2634
can also cause the x and y measurements to be off, so it's recommended to
2735
calibrate the angular scalar first.
36+
37+
The key methods showcased by this example are:
38+
-[setLinearScalar()](http://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a044cce1266b0870ede4c6d6ad0e24f22)
39+
-[setAngularScalar()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a0cfe24386907cff6b721ce088b566a95)
40+
-[calibrateImu()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a6966d47e4b0276882e4575ad512d5b4e)
2841

2942
## Qwiic Otos Ex4 Set Offsets And Position
3043
This example demonstrates how to set the offset and position of the SparkFun
@@ -37,6 +50,10 @@ This example demonstrates how to set the offset and position of the SparkFun
3750
such as the starting location or from another sensor, you can send that
3851
position to the OTOS and it will continue to track from there.
3952

53+
The key methods showcased by this example are:
54+
-[setOffset()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a578d51d9c510a07fe59698ac3ff7a25d)
55+
-[setPosition()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#ad7921cc40d3ea207340b53622f3a63a5)
56+
4057
## Qwiic Otos Ex5 Velocity And Acceleration
4158
This example demonstrates how to read the velocity and acceleration from the
4259
SparkFun Qwiic Optical Tracking Odometry Sensor (OTOS).
@@ -46,6 +63,10 @@ This example demonstrates how to read the velocity and acceleration from the
4663
that these measurements can be noisy and inaccurate, especially if the
4764
sensor is not flat to the ground.
4865

66+
The key methods showcased by this example are:
67+
-[getVelocity()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a2d5b5f6fc45e28f7c611af7606bb632e)
68+
-[getAcceleration()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a205c550fbe558fd314ba2a5d80ea2ac8)
69+
4970
## Qwiic Otos Ex6 Standard Deviation
5071
This example demonstrates how to read the standard deviation of the
5172
measurements of the SparkFun Qwiic Optical Tracking Odometry Sensor (OTOS).
@@ -61,6 +82,9 @@ This example demonstrates how to read the standard deviation of the
6182
provided primarily for anyone wanting to perform sensor fusion with
6283
additional sensors.
6384

85+
The key methods showcased by this example are:
86+
-[getPositionStdDev()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#abc2101cf659e26f03d9f6a472ab30177)
87+
6488
## Qwiic Otos Ex7 Get Version
6589
This example demonstrates how to get the hardware and firmware version
6690
numbers from the SparkFun Qwiic Optical Tracking Odometry Sensor (OTOS).
@@ -71,6 +95,9 @@ This example demonstrates how to get the hardware and firmware version
7195
https://www.sparkfun.com/products/24904
7296
https://github.com/sparkfun/SparkFun_Optical_Tracking_Odometry_Sensor
7397

98+
The key methods showcased by this example are:
99+
-[getVersionInfo()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#a0e4ba26222411f6109b59f7a65e09ad5)
100+
74101
## Qwiic Otos Ex8 Self Test
75102
This example demonstrates how to perform a self test of the SparkFun Qwiic
76103
Optical Tracking Odometry Sensor (OTOS).
@@ -79,4 +106,5 @@ This example demonstrates how to perform a self test of the SparkFun Qwiic
79106
sensor is functioning correctly. This is performed during QC testing, but
80107
you can also perform this test yourself.
81108

82-
109+
The key methods showcased by this example are:
110+
-[selfTest()](https://docs.sparkfun.com/qwiic_otos_py/classqwiic__otos_1_1_qwiic_o_t_o_s.html#ac7b2f0230c1fa2b3494a06f75f156a64)

0 commit comments

Comments
 (0)