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.

ti,ina237 (on i2c bus)

Vendor: Texas Instruments

Description

TI INA237 Bidirectional Current and Power Monitor.
The <include/dt-bindings/sensor/ina237.h> file should be included
in the DeviceTree and it provides macros that can be used for
initializing the configuration registers.

Properties

Properties not inherited from the base binding file.

Name

Type

Details

adc-config

int

Value of the ADC configuration register (ADC conversion times,
averaging, operating mode and etc).

This property is required.

config

int

Value of the configuration register
e.g shunt voltage and bus voltage ADC conversion
times and averaging, operating mode for INA230 or
delay for initial ADC conversion, shunt full scale range
for INA237.

This property is required.

current-lsb

int

Value of Current LSB in milliamps. When set to 1mA,
Current is read in A, Bus Voltage in V, Shunt
Voltage in V, and Power in mW. Any other value
results in Current, Voltage, and Power registers
being read in counts.

This property is required.

rshunt

int

Shunt resistor value in milliohms

This property is required.

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.