Skip to content

Commit bbdb345

Browse files
Add links for example readme
1 parent 977af5f commit bbdb345

File tree

1 file changed

+37
-35
lines changed

1 file changed

+37
-35
lines changed

examples/README.md

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,42 @@ Below is a brief summary of each of the example programs included in this reposi
33

44
NOTE: Any numbering of examples is to retain consistency with the Arduino library from which this was ported.
55

6-
## Example1 Readdistance
7-
Ported by SparkFun Electronics, October 2019
8-
Author: Nathan Seidle
9-
Ported: Wes Furuya
10-
SparkFun Electronics
11-
12-
License: This code is public domain but you buy me a beer if you use
13-
this and we meet someday (Beerware license).
14-
15-
## Example2 Setdistancemode
16-
Ported by SparkFun Electronics, October 2019
17-
Author: Nathan Seidle
18-
Ported: Wes Furuya
19-
SparkFun Electronics
20-
21-
License: This code is public domain but you buy me a beer if you use
22-
this and we meet someday (Beerware license).
23-
24-
## Example3 Statusandrate
25-
Ported by SparkFun Electronics, October 2019
26-
Author: Nathan Seidle
27-
Ported: Wes Furuya
28-
SparkFun Electronics
29-
30-
License: This code is public domain but you buy me a beer if you use
31-
this and we meet someday (Beerware license).
32-
33-
## Example4 Setintermeasurementperiod
34-
Ported by SparkFun Electronics, October 2019
35-
Author: Nathan Seidle
36-
Ported: Wes Furuya
37-
SparkFun Electronics
38-
39-
License: This code is public domain but you buy me a beer if you use
40-
this and we meet someday (Beerware license).
6+
## Example1 Read Distance
7+
This example prints the distance to an object. If you are getting weird
8+
readings, be sure the vacuum tape has been removed from the sensor.
419

10+
The key methods showcased by this example are:
11+
- [sensor_init()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#a6247a075a2485d26b5e92ee206bd0d80)
12+
- [start_ranging()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#a9e1ca7a1d6d6eb629c5987f6a13cc2c5)
13+
- [get_distance()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#a481bdfe2107fcaa449a0a38bc6ba7947)
14+
- [stop_ranging()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#a014aacbfdc6ed8f61c495dcc151b5aad)
4215

16+
## Example2 Set Distance Mode
17+
This example configures the sensor to short distance mode and then
18+
prints the distance to an object. If you are getting weird readings,
19+
be sure the vacuum tape has been removed from the sensor.
20+
21+
The key methods showcased by this example are:
22+
- [set_distance_mode()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#a1aac43e830b9df0c84d581c306de498c)
23+
24+
## Example3 Status And Rate
25+
This example configures the sensor to short distance mode and then
26+
prints the distance to an object. The output also includes a
27+
running average of the last 10 readings along with some statistics,
28+
like signal rate and frequency (of the measurements).
29+
30+
If you are getting weird readings, be sure the vacuum tape has been
31+
removed from the sensor.
32+
33+
The key methods showcased by this example are:
34+
- [get_signal_rate()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#a549ebc6209239d6883ca15dea441acaf)
35+
- [get_range_status()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#aea9be5b36fa5459542276c4cfbdd9306)
36+
37+
## Example4 Set Intermeasurement Period
38+
This example configures the inter-measurement period of the sensor
39+
and then prints the distance to an object. If you are getting weird
40+
readings, be sure the vacuum tape has been removed from the sensor.
41+
42+
The key methods showcased by this example are:
43+
- [set_inter_measurement_in_ms()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#a757a1d8d2c5631c1a8aef49d694da912)
44+
- [get_inter_measurement_in_ms()](https://docs.sparkfun.com/qwiic_vl53l1x_py/classqwiic__vl53l1x_1_1_qwiic_v_l53_l1_x.html#aa3188f1f9bb914a6675ff47b5b1f456c)

0 commit comments

Comments
 (0)