Skip to content

Commit ebe6a22

Browse files
authored
Update README.md
1 parent e8746a8 commit ebe6a22

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,30 @@ SparkFun Qwiic 4m Distance Sensor with VL53L1X
22
========================================
33
[![Build Status](https://github.com/sparkfun/SparkFun_VL53L1X_Arduino_Library/workflows/LibraryBuild/badge.svg)](https://github.com/sparkfun/SparkFun_VL53L1X_Arduino_Library/actions)
44

5+
56

6-
![SparkFun Distance Sensor Breakout - 4 Meter, VL53L1X (Qwiic)](https://cdn.sparkfun.com//assets/parts/1/2/9/4/8/14722-SparkFun_Distance_Sensor_Breakout-_4_Meter__VL53L1X__Qwiic_-01.jpg)
7+
<table class="table table-hover table-striped table-bordered">
8+
<tr align="center">
9+
<td><a href="https://www.sparkfun.com/products/14722"><img src="https://cdn.sparkfun.com//assets/parts/1/2/9/4/8/14722-SparkFun_Distance_Sensor_Breakout-_4_Meter__VL53L1X__Qwiic_-01.jpg" alt="SparkFun Distance Sensor Breakout - 4 Meter, VL53L1X (Qwiic)"></a></td>
10+
<td><a href="https://www.sparkfun.com/products/18993"><img src="https://cdn.sparkfun.com//assets/parts/1/8/5/7/2/18993-SparkFun_Distance_Sensor_-_1.3_Meter__VL53L4CD__Qwiic_-01.jpg" alt="SparkFun Distance Sensor - 1.3 Meter, VL53L4CD (Qwiic)"></a></td>
11+
</tr>
12+
<tr align="center">
13+
<td>SparkFun Distance Sensor Breakout - 4 Meter, VL53L1X (Qwiic) <i>[<a href="https://www.sparkfun.com/products/14722">SEN-14722</a>]</i></td>
14+
<td>SparkFun Distance Sensor - 1.3 Meter, VL53L4CD (Qwiic)<i>[<a href="https://www.sparkfun.com/products/18993">SEN-18993</a>]</i></td>
15+
</tr>
16+
</table>
717

8-
[*SparkFun Distance Sensor Breakout - 4 Meter, VL53L1X (Qwiic)(SEN-14722)*](https://www.sparkfun.com/products/14722)
18+
The VL53L1X is a Time Of Flight (ToF) sensor that use a VCSEL (vertical cavity surface emitting laser) to emit a class 1 IR laser and time the reflection to the target. What does all this mean? Using the VL53L1X, you can measure the distance to an object up to 4 meters away with millimeter resolution! That’s pretty incredible.
919

10-
The VL53L1X is the latest Time Of Flight (ToF) sensor to be released. It uses a VCSEL (vertical cavity surface emitting laser) to emit a class 1 IR laser and time the reflection to the target. What does all this mean? You can measure the distance to an object up to 4 meters away with millimeter resolution! That’s pretty incredible.
20+
We’re far from done: The VL53L1X is a highly complex sensor with a multitude of options and configurations. We’ve written example sketches that allow you to read the distance, signal rate, and range status. Because STMicroelectronics has chosen not to release a complete datasheet we are forced to reverse engineer the interface from their example code and I2C data stream captures. If you’re into puzzles we could use your help to make the library better!
1121

12-
We’re far from done: The VL53L1X is a highly complex sensor with a multitude of options and configurations. We’ve written example sketches that allow you to read the distance, signal rate, and range status. Because ST has chosen not to release a complete datasheet we are forced to reverse engineer the interface from their example code and I2C data stream captures. If you’re into puzzles we could use your help to make the library better!
13-
14-
We’ve found the precision of the sensor to be 1mm but the accuracy is around +/-5mm.
22+
We’ve found the precision of VL53L1X sensor to be 1mm but the accuracy is around +/-5mm.
1523

1624
SparkFun labored with love to create this code. Feel like supporting open source hardware?
1725
Buy a [breakout board](https://www.sparkfun.com/products/14722) from SparkFun!
1826

27+
*Note: The VL53L1X is the cousin of VL53L1X. Overall, the sensor functions the same except for a few differences in the specifications. We've also found the precision of VL53L4CD sensor to be 1mm but the accuracy is around +/-7mm (white target: 88%, indoor, no infrared).*
28+
1929
Repository Contents
2030
-------------------
2131

@@ -25,12 +35,15 @@ Repository Contents
2535

2636
Documentation
2737
--------------
28-
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/qwiic-distance-sensor-vl53l1x-hookup-guide)**
38+
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
39+
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/qwiic-distance-sensor-vl53l1x-hookup-guide)**- Basic tutorial for the VL53L1X and VL53L4CD
2940

30-
Product Versions
41+
Products that use this Library
3142
--------------
32-
* **[SEN-14722](https://www.sparkfun.com/products/14722)** - SparkFun red version
33-
* **[SPX-14667](https://www.sparkfun.com/products/14667)** - SparkX Version
43+
44+
* **[SEN-18993](https://www.sparkfun.com/products/18993)** - SparkFun red version for VL53L4CD
45+
* **[SEN-14722](https://www.sparkfun.com/products/14722)** - SparkFun red version for VL53L1X
46+
* **[SPX-14667](https://www.sparkfun.com/products/14667)** - SparkX Version for VL53L1X
3447

3548
License Information
3649
-------------------

0 commit comments

Comments
 (0)