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,ina230 (on i2c bus)

Vendor: Texas Instruments

Description

TI INA230 and INA231 Bidirectional Current and Power Monitor.
The <zephyr/dt-bindings/sensor/ina230.h> file should be included in the
DeviceTree and it provides macro that can be used for initializing the
configuration register.

Properties

Properties not inherited from the base binding file.

Name

Type

Details

mask

int

Mask register, default matches the power-on reset value

alert-limit

int

Alert register, default matches the power-on reset value

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-microamps

int

This value should be selected so that measurement resolution is
maximized, that is:

  current-lsb(A) = maximum expected current(A) / 2^15

(sensor has 15 bits). For example, if maximum expected current is 15A:

  current-lsb(A) = 15A / 2^15 ~= 457uA

Rounded values may be used for convenience, e.g. 500uA/LSB or 1mA/LSB
while keeping a good measurement resolution. The units are in uA/LSB
so that low maximum currents can be measured with enough resolution.

This property is required.

rshunt-milliohms

int

Shunt resistor value in milliohms

This property is required.

alert-gpios

phandle-array

Alert pin

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.