Class Ina226

A Texas Instruments INA226 driven over an I2C bus, measuring shunt and bus voltage, current, and power on demand.

Index

Constructors

Accessors

calibrationWord currentLsbMicroamps identity

Methods

init measure setAlert

Constructors

constructor

new Ina226(
    bus: I2cBus,
    address: number,
    settings?: Ina226Settings | null,
): Ina226
A driver for the part at address on bus. Nothing is sent until init or the first measure.
Parameters
- bus: I2cBus
- address: number
- Optionalsettings: Ina226Settings | null
Returns Ina226
- Defined in native/index.d.ts:1035

Accessors

calibrationWord

get calibrationWord(): number
The calibration word the driver programs.

Returns number
- Defined in native/index.d.ts:1054

currentLsbMicroamps

get currentLsbMicroamps(): number
The current step the driver programs, in microamps per count.

Returns number
- Defined in native/index.d.ts:1052

identity

get identity(): Ina226DieIdFields | null
The die id read at initialization, or null before it.

Returns Ina226DieIdFields | null
- Defined in native/index.d.ts:1056

Methods

init

init(): Promise<void>
Resets the part, checks it is an INA226, writes the configuration and the calibration, and reads the calibration back. Rejects when nothing answers or another part does.

Returns Promise<void>
- Defined in native/index.d.ts:1040

measure

measure(): Promise<Ina226Reading>
Triggers one shunt and bus conversion and resolves with every result, initializing the part first if init has not run.

Returns Promise<Ina226Reading>
- Defined in native/index.d.ts:1045

setAlert

setAlert(mask: Ina226MaskEnable, limit: number): Promise<void>
Programs the alert pin: which limit it watches, one function at a time, and the limit, in the units of the register the function watches.
Parameters
- mask: Ina226MaskEnable
- limit: number
Returns Promise<void>
- Defined in native/index.d.ts:1050