This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

vishay,vcnl36825t (on i2c bus)

Vendor: Vishay Intertechnology, Inc

Description

VCNL36825T proximity and ambient light sensor.  See datasheet at
https://www.vishay.com/docs/84274/vcnl36825t.pdf

Properties

Properties not inherited from the base binding file.

Name

Type

Details

operation-mode

string

Mode of operation.
- "auto": the sensor performs sampling continuously,
- "force": the sampling is performed on every fetch command.

Defaults to sensor reset value.

Default value: auto

Legal values: 'auto', 'force'

measurement-period

int

Measurement period of the sensors in ms.
Higher values yield lower power consumption.
Note:
  - [10, 80] ms only if low power mode is inactive
  - [80, 320] ms only in low power mode

Defaults to 40 ms which is supported in both normal and low-power mode.

Default value: 40

Legal values: 10, 20, 40, 80, 160, 320

proximity-it

string

Proximity integration time in T.
Defaults to sensor reset value.

Default value: 1

Legal values: '1', '1.5', '2', '2.5', '3', '3.5', '4', '8'

proximity-itb

int

Duration of the proximity integration time T in us.
Defaults to sensor reset value.

Default value: 25

Legal values: 25, 50

multi-pulse

int

Number of pulses per single measurement.
Higher values increase accuracy and power consumption.
Defaults to sensor reset value.

Default value: 1

Legal values: 1, 2, 4, 8

laser-current

int

Current used by the laser during measurement periods.
Defaults to minimum allowed value.

Default value: 10

Legal values: 10, 12, 14, 16, 18, 20

low-power

boolean

Activate low power mode.
This allows to increase the measurement period up to 320 ms.

high-gain

boolean

Activate the high gain mode.

sunlight-cancellation

boolean

Activate sunlight cancellation.

high-dynamic-output

boolean

Activate 16bit high dynamic output mode.
Cannot be used with threshold interrupt.

friendly-name

string

Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.

This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).

supply-gpios

phandle-array

GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.