wayland/vl53l1x-time-of-flight@0.0.3
License: BSD-3-Clause
Time-of-Flight (ToF) sensor. Arduino library for the ST VL53L1X sensor (https://www.st.com/en/imaging-and-photonics-solutions/vl53l1x.html). Wraps the Pololu VL43L1X library for Arduino (https://github.com/pololu/vl53l1x-arduino).
| Node | Description |
|---|---|
| example-output-to-oled | Example demonstrating output of range measurement to an OLED screen. |
| example-set-address | Patch to demonstrate setting of I²C address. |
| example-test-configuration | Patch to test nodes used to set and get configuration options. |
| example-test-tof-sensor | Patch to test tof-sensor. |
| get-address | Read the I²C address of the VL53L1X. |
| get-distance-mode | Read current distance mode of VL53L1X. |
| get-measurement-timing-budget | Read measurement timing budget of VL53L1X. |
| get-roi | Read dimensions of region of interest (ROI). |
| get-timeout | Read current timeout setting of VL53L1X. |
| init | Initialize VL53L1X device. |
| read-distance | Read distance (mm). |
| set-address | Set I²C address of VL53L1X device. |
| set-distance-mode | Set distance mode. The VL53L1X has three distance modes (DM): short, medium, and long.
Long distance mode allows the longest possible ranging distance of 4 m to be reached. However, this maximum ranging distance is impacted by ambient light.
Short distance mode is more immune to ambient light, but its maximum ranging distance is typically limited to 1.3 m. |
| set-measurement-timing-budget | Set measurement timing budget. The VL53L1X timing budget can be set from 20 ms up to 1000 ms.
• 20 ms is the minimum timing budget and can be used only in Short distance mode.
• 33 ms is the minimum timing budget which can work for all distance modes.
• 140 ms is the timing budget which allows the maximum distance of 4 m (in the dark on a white chart) to be reached under Long distance mode
Increasing the timing budget increases the maximum distance the device can range and improves the repeatability error. However, average power consumption augments accordingly. |
| set-roi | Set a region of interest (ROI). The ROI position is centered, only the ROI size can be changed. The full sensor (16x16 SPADs) provides a nominal
27 ° field of view (FoV). The FoV can be reduced to a minimum of 15 ° by setting the ROI to 4x4 SPADs. For further information please see: https://www.st.com/resource/en/application_note/dm00516219-using-the-programmable-region-of-interest-roi-with-the-vl53l1x-stmicroelectronics.pdf |
| set-timeout | Set timeout. |
| start-continuous | Start continuous ranging measurements, with the given inter-measurement period in milliseconds determining how often the sensor takes a measurement. |
| stop-continuous | Stop continuous measurements. |
| timeout-occurred | Did a timeout occur in one of the read functions since the last call to this node? |
| tof-sensor | Time-of-Flight (ToF) sensor. |
| vl53l1x-device | Create VL53L1X device. |