How pkepes/vl53l8cx-library works
This is an ESP-IDF adaptation of ST’s VL53L8CX Ultra Lite Driver, not an application or an Arduino library. The principal workflow is that an ESP32 application configures the sensor through the public API, starts ranging, and retrieves multizone measurements over I²C. Optional plugins provide cross-talk calibration, detection thresholds, and motion-indicator configuration. The README also documents examples for ranging modes, power modes, per-zone targets, and parameter access. Relationships reflect sampled calls; those additional example capabilities are represented at the API level because their implementations were not sampled.
Main entry points: vl53l8cx_api.c Sensor API · vl53l8cx_plugin_xtalk.c Cross-talk calibration · platform.c I²C and GPIO · vl53l8cx_plugin_detection_thresholds.c Detection thresholds
Components 12
Application API
- Sensor API
src/vl53l8cx_api.c - API and results
include/vl53l8cx_api.h
Sensor Features
- Cross-talk calibration
src/vl53l8cx_plugin_xtalk.c - Cross-talk API
include/vl53l8cx_plugin_xtalk.h - Detection thresholds
src/vl53l8cx_plugin_detection_thresholds.c - Threshold API
include/vl53l8cx_plugin_detection_thresholds.h - Motion indicator
src/vl53l8cx_plugin_motion_indicator.c - Motion API
include/vl53l8cx_plugin_motion_indicator.h
ESP32 Transport
- Platform interface
include/platform.h - I²C and GPIO
src/platform.c
Other components
- ESP-IDF application
- VL53L8CX sensor
Connections 17
- ESP-IDF application → Sensor API: configures and ranges
- Sensor API → API and results: uses types
- ESP-IDF application → Cross-talk calibration: calibrates cross-talk
- ESP-IDF application → Detection thresholds: sets thresholds
- ESP-IDF application → Motion indicator: configures motion
- Cross-talk calibration → Cross-talk API: uses definitions
- Detection thresholds → Threshold API: uses definitions
- Motion indicator → Motion API: uses definitions
- Cross-talk calibration → Sensor API: calls configuration
- Detection thresholds → Sensor API: calls DCI
- Motion indicator → Sensor API: writes DCI
- Sensor API → I²C and GPIO: reads and writes
- I²C and GPIO → Platform interface: implements interface
- I²C and GPIO → VL53L8CX sensor: transfers I²C data
- Cross-talk calibration → I²C and GPIO: transfers calibration data
- Sensor API → VL53L8CX sensor: controls ranging
- VL53L8CX sensor → Sensor API: returns measurements