Skip to content

Update README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2020
Merged

Update README #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# VL53L3CX
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.
Arduino library to support the VL53L3CX Time-of-Flight ranging sensor with advanced multi-object detection.

# API
This sensor uses I2C to communicate. And I2C instance is required to access to the sensor.
## API

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

# Examples
## Examples

There are 2 examples with the VL53L3CX library.

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

* 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.
* 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.

* 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.
* 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.

# Note
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.
## Note

# Documentation
You can find the source files at
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.

## Documentation

You can find the source files at
https://github.com/stm32duino/VL53L3CX

The VL53L3CX datasheet is available at

https://www.st.com/content/st_com/en/products/imaging-and-photonics-solutions/proximity-sensors/vl53l3cx.html
2 changes: 1 addition & 1 deletion library.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=STM32duino VL53L3CX
version=1.0.0
version=1.0.1
author=STMicroelectronics
maintainer=stm32duino
sentence=Allows controlling the VL53L3CX (Time-of-Flight ranging sensor with multi target detection)
Expand Down