This document defines the ECMAScript class supporting the VL6180 time-of-flight range finder and ambient light sensor from STMicroelectronics.
This class specification conforms to the Ambient Light and Proximity Sensor Classes of ECMA-419, ECMAScript® Embedded Systems API Specification.
Module Specifier: embedded:sensor/AmbientLight-Proximity/VL6180
The VL6180 Sensor Class extends the AmbientLight and Proximity Sensor Classes with additional properties on the option objects passed to the configure method and returned by the sample method.
| Property | Description |
|---|---|
sensor |
An I2C class constructor options object with the configuration to use for communication with the VL6180. This property is required. Its hz property defaults to 400_000 and its address property to 0x29. |
All of the following properties are optional.
| Property | Description |
|---|---|
rangingMode |
Number specifying ranging mode. 0 for single shot or 1 for continuous. Initial value is 0. |
rangingFrequency |
Number specifying time delay between range measurements in continuous mode. Range 10 ms to 2550 ms. Initial value is 10 ms. |
averagingSamplePeriod |
Number specifying how many samples to average together for each range read. Range 0 to 255. Initial value is 48. |
maxConvergenceTime |
Number specifying maximum time to run measurements in ranging modes. Range 1 ms to 63 ms. Initial value is 49 ms. |
crosstalkCompensationRate |
Number specifying the crosstalk compensation rate in Mcps (9.7 format). Initial value is 0. |
crosstalkValidHeight |
Number specifying minimum range value in mm to qualify for cross-talk compensation. Initial value is 20 mm. |
earlyConvergenceEstimate |
Number specifying maximum convergence rate allowed without aborting ranging operation or 0 to disable convergence estimation. Initial value is 0. |
enableSampleReadyPolling |
Boolean specifying if "sample ready" bit should be set when samples are ready. Initial value is false. |
analogueGain |
Number specifying ALS analog gain. Options are 40, 20, 10, 5, 2.5, 1.67, 1.25, and 1. Initial value is 1. |
alsMode |
Number specifying the ALS mode. 0 for single shot or 1 for continuous. Initial value is 0. |
alsFrequency |
Number specifying time delay between range measurements in continuous mode. Range 10 ms to 2550 ms. Initial value is 2550 ms. |
Samples returned from VL6180 instances include the lightmeter and proximity objects defined, respectively, in the AmbientLight and Proximity Sensor Classes.
| Property | Description |
|---|---|
lightmeter.illuminance |
A number that represents the sampled ambient light level in Lux. |
proximity.near |
A boolean that indicates if a proximate object is detected. |
proximity.distance |
A number that represents the distance to the nearest sensed object in centimeters or null if no object is detected. |
proximity.max |
A number that represents the maximum sensing range of the sensor in centimeters. |
VL6180 implements the configuration and identification properties of the Provenance Sensor Class Pattern, including the optional uniqueID property of identification.
| Property | Description |
|---|---|
configuration |
Object describing the sensor's current configuration. Properties match the configure options object above. |
identification |
Object that uniquely identifies an individual VL6180 component. |
| Property | Description |
|---|---|
model |
String "ST VL6180X". |
classification |
String "AmbientLight-Proximity". |
revision |
Object with 5 Numbers describing the model and module revision: modelID, modelRevMajor, modelRevMinor, moduleRevMajor, and moduleRevMinor. |
uniqueID |
A unique identifier for the particular VL6180 hardware, generated from the Identification Date and Time registers on the device. |