xref: /freebsd/sys/contrib/device-tree/Bindings/iio/light/veml6030.yaml (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)

# SPDX-License-Identifier: GPL-2.0+
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/light/veml6030.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: VEML6030 Ambient Light Sensor (ALS)

maintainers:
  - Rishi Gupta <gupt21@gmail.com>

description: |
  Bindings for the ambient light sensor veml6030 from Vishay
  Semiconductors over an i2c interface.

  Irrespective of whether interrupt is used or not, application
  can get the ALS and White channel reading from IIO raw interface.

  If the interrupts are used, application will receive an IIO event
  whenever configured threshold is crossed.

  Specifications about the sensor can be found at:
    https://www.vishay.com/docs/84366/veml6030.pdf

properties:
  compatible:
    enum:
      - vishay,veml6030

  reg:
    description:
      I2C address of the device.
    enum:
      - 0x10 # ADDR pin pulled down
      - 0x48 # ADDR pin pulled up

  interrupts:
    description:
      interrupt mapping for IRQ. Configure with IRQ_TYPE_LEVEL_LOW.
      Refer to interrupt-controller/interrupts.txt for generic
      interrupt client node bindings.
    maxItems: 1

required:
  - compatible
  - reg

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>

    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        light-sensor@10 {
                compatible = "vishay,veml6030";
                reg = <0x10>;
                interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
        };
    };
...