Skip to content

Commit a5825ef

Browse files
authored
Merge pull request #3 from cparata/master
Update README
2 parents 08e1947 + 4b4794b commit a5825ef

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# VL53L3CX
2-
The VL53L3CX is the latest Time-of-Flight (ToF) product from STMicroelectronics and embeds ST’s third generation FlightSense patented technology. It combines a high performance proximity and ranging sensor, with multi target distance measurements and automatic smudge correction. The miniature reflowable package integrates a single photon avalanche diode (SPAD) array and physical infrared filters to achieve the best ranging performance in various ambient lighting conditions, with a wide range of cover glass windows.
2+
Arduino library to support the VL53L3CX Time-of-Flight ranging sensor with advanced multi-object detection.
33

4-
# API
5-
This sensor uses I2C to communicate. And I2C instance is required to access to the sensor.
4+
## API
65

7-
The API provides simple distance measure, single swipe gesture detection, directional (left/right) swipe gesture detection and single tap gesture detection.
6+
This sensor uses I2C to communicate. And I2C instance is required to access to the sensor.
7+
The APIs provide simple distance measure and multi-object detection in both polling and interrupt modes.
88

9-
# Examples
9+
## Examples
1010

1111
There are 2 examples with the VL53L3CX library.
1212

@@ -19,18 +19,22 @@ In order to use these examples you need to connect the VL53L3CX satellite sensor
1919
- pin 6 (GND) of the VL53L3CX satellite connected to GND of the Nucleo board
2020
- pins 7, 8, 9 and 10 are not connected.
2121

22-
* VL53L3CX_Sat_HelloWorld: This example code is to show how to get multi-object detection and proximity values of the VL53L3CX satellite sensor in polling mode.
22+
* VL53L3CX_Sat_HelloWorld: This example code is to show how to get multi-object detection and proximity
23+
values of the VL53L3CX satellite sensor in polling mode.
2324

24-
* VL53L3CX_Sat_HelloWorld_Interrupt: This example code is to show how to get multi-object detection and proximity values of the VL53L3CX satellite sensor in interrupt mode.
25+
* VL53L3CX_Sat_HelloWorld_Interrupt: This example code is to show how to get multi-object detection and proximity
26+
values of the VL53L3CX satellite sensor in interrupt mode.
2527

26-
# Note
27-
The VL53L3CX is a fully integrated miniature module with a low power microcontroller with advanced digital firmware. Detection with full field of view (FoV) is up to 300 cm +. It works with many types of glass roofing materials. Xshutdown (reset) and stop GPIO are integrated to optimize remote operation.
28+
## Note
2829

29-
# Documentation
30-
You can find the source files at
30+
The VL53L3CX is a fully integrated miniature module with a low power microcontroller with advanced digital firmware.
31+
Detection with full field of view (FoV) is up to 300 cm +. It works with many types of glass roofing materials.
32+
Xshutdown (reset) and stop GPIO are integrated to optimize remote operation.
3133

34+
## Documentation
35+
36+
You can find the source files at
3237
https://github.com/stm32duino/VL53L3CX
3338

3439
The VL53L3CX datasheet is available at
35-
3640
https://www.st.com/content/st_com/en/products/imaging-and-photonics-solutions/proximity-sensors/vl53l3cx.html

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=STM32duino VL53L3CX
2-
version=1.0.0
2+
version=1.0.1
33
author=STMicroelectronics
44
maintainer=stm32duino
55
sentence=Allows controlling the VL53L3CX (Time-of-Flight ranging sensor with multi target detection)

0 commit comments

Comments
 (0)