dept-of-scrapyard-robotics/vl53lxx

Drive VL53L0X and VL53L1X time-of-flight distance sensors over I2C with PHP

0.6.0 2026-07-29 04:40 UTC

Requires

• php: ^8.3
• fabricate/circuits: ^0.6.0
• fabricate/nuts-and-bolts: ^0.6.0
• gpio/contracts: ^0.6.0
• gpio/digital: ^0.6.0
• gpio/i2c: ^0.6.0

Suggests

• microscrap/i2c: ^0.5.0 - For direct linux-based I2C
• microscrap/mpsse: ^0.5.0 - For I2C over an FTDI Serial-to-USB Device

MIT

• Angel Gonzalez

• framework
• tof
• scrapyard-io
• vl53l0x
• vl53l1x

Published on Packagist.org on 2026-07-29 04:42 UTC

README

I2C drivers for VL53L0X / VL53L1X time-of-flight rangefinders. Extends GeneralPurposeIO\Circuits\SensorIC.

Register

Provider registers catalog slugs vl53l0x and vl53l1x.

Circuit::ic('vl53l0x')->i2c(/* … */)->make();
Circuit::ic('vl53l1x')->i2c(/* … */)->make();

Protocol options: I2C alone, or I2C+DigitalIO when wiring optional XSHUT (xshut_pin + digital driver/device when the I2C bus cannot serve GPIO). XSHUT is strongly recommended for a clean boot (especially over MPSSE).

Distance units

Waveforms\Contracts\Sensors\Enums\DistanceUnit. Both chips implement Waveforms\Distance\MeasuresDistance for Rangefinder::circuit($profile). Raw ranging is millimetres; distance() converts via DistanceUnit::convertFromMm().

VL53L1X demos (soft)

Suggest scrapyard-io/tubes (+ scrapyard-io/ux for Scene HUD). When tubes is installed:

./runner vl53l1x-oled-demo
./runner vl53l1x-canvas-demo
./runner vl53l1x-canvas-demo --profile=vl53l1x

• No --profile: one vl53l1x circuits profile → use it; several → prompt; none → quit.
• Canvas demos use tubes.defaults.canvas (window or panel, e.g. metal-canvas). OLED requires MonochromePanel; canvas / UX reject mono only.
• With UX installed, vl53l1x-canvas-demo is replaced by the UX Scene sketch; alias vl53l1x-ux-canvas-demo also registers.