GNU Linux-libre 4.19.295-gnu1
[releases.git] / Documentation / devicetree / bindings / iio / health / max30102.txt
1 Maxim MAX30102 heart rate and pulse oximeter sensor
2 Maxim MAX30105 optical particle-sensing module
3
4 * https://datasheets.maximintegrated.com/en/ds/MAX30102.pdf
5 * https://datasheets.maximintegrated.com/en/ds/MAX30105.pdf
6
7 Required properties:
8   - compatible: must be "maxim,max30102" or "maxim,max30105"
9   - reg: the I2C address of the sensor
10   - interrupts: the sole interrupt generated by the device
11
12   Refer to interrupt-controller/interrupts.txt for generic
13   interrupt client node bindings.
14
15 Optional properties:
16   - maxim,red-led-current-microamp: configuration for red LED current
17   - maxim,ir-led-current-microamp: configuration for IR LED current
18   - maxim,green-led-current-microamp: configuration for green LED current
19     (max30105 only)
20
21     Note that each step is approximately 200 microamps, ranging from 0 uA to
22     50800 uA.
23
24 Example:
25
26 max30102@57 {
27         compatible = "maxim,max30102";
28         reg = <0x57>;
29         maxim,red-led-current-microamp = <7000>;
30         maxim,ir-led-current-microamp = <7000>;
31         interrupt-parent = <&gpio1>;
32         interrupts = <16 2>;
33 };