:orphan:
.. raw:: html
.. dtcompatible:: vishay,vcnl36825t
.. _dtbinding_vishay_vcnl36825t:
vishay,vcnl36825t (on i2c bus)
##############################
Vendor: :ref:`Vishay Intertechnology, Inc `
.. note::
An implementation of a driver matching this compatible is available in
:zephyr_file:`drivers/sensor/vishay/vcnl36825t/vcnl36825t.c`.
Description
***********
.. code-block:: none
VCNL36825T proximity and ambient light sensor. See datasheet at
https://www.vishay.com/docs/84274/vcnl36825t.pdf
Properties
**********
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``operation-mode``
- ``string``
- .. code-block:: none
Mode of operation.
- "auto": the sensor performs sampling continuously,
- "force": the sampling is performed on every fetch command.
Defaults to sensor reset value.
Note: "force"-mode only available if low-power mode inactive.
Default value: ``auto``
Legal values: ``'auto'``, ``'force'``
* - ``measurement-period``
- ``int``
- .. code-block:: none
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``
- .. code-block:: none
Proximity integration time in T.
Defaults to sensor reset value.
Default value: ``1``
Legal values: ``'1'``, ``'2'``, ``'4'``, ``'8'``
* - ``proximity-itb``
- ``int``
- .. code-block:: none
Duration of the proximity integration time T in us.
Defaults to sensor reset value.
Default value: ``25``
Legal values: ``25``, ``50``
* - ``multi-pulse``
- ``int``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
Activate low power mode.
This allows to increase the measurement period up to 320 ms.
* - ``high-gain``
- ``boolean``
- .. code-block:: none
Activate the high gain mode.
* - ``sunlight-cancellation``
- ``boolean``
- .. code-block:: none
Activate sunlight cancellation.
* - ``high-dynamic-output``
- ``boolean``
- .. code-block:: none
Activate 16bit high dynamic output mode.
Cannot be used with threshold interrupt.
* - ``int-gpios``
- ``phandle-array``
- .. code-block:: none
The INT signal connection.
The signal is active-low as produced by the sensor.
* - ``int-mode``
- ``string``
- .. code-block:: none
Specifies the interrupt behavior.
- "normal": signal if exceeds high or falls below lower threshold
and proximity count is reached.
- "first high": signal if exceeds high threshold first time and signal again
if falls below lower threshold, and proximity count is reached.
Do not trigger if high threshold was never exceeded.
- "logic high / low": signal if high threshold is exceeded and proximity counts is reached,
deactivate if falls below lower threshold.
Defaults to "normal" as this is the easiest configurable mode.
Default value: ``normal``
Legal values: ``'normal'``, ``'first high'``, ``'logic high / low'``
* - ``int-proximity-count``
- ``int``
- .. code-block:: none
Number of consecutive measurements above/below threshold to signal an interrupt.
Defaults to sensor reset value
Default value: ``1``
Legal values: ``1``, ``2``, ``3``, ``4``
* - ``int-smart-persistence``
- ``boolean``
- .. code-block:: none
Activates "smart persistence" feature, aimed to reduce total reaction time
until an interrupt is issued.
* - ``friendly-name``
- ``string``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
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.
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
Properties inherited from the base binding file, which defines
common properties that may be set on many nodes. Not all of these
may apply to the "vishay,vcnl36825t" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
register space
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
See :ref:`zephyr:dt-important-props` for more information.
This property is **deprecated**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Provided names of power domain specifiers
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.