Variable ina226`Const`

ina226: {
    averaging: {
        samples1: number;
        samples1024: number;
        samples128: number;
        samples16: number;
        samples256: number;
        samples4: number;
        samples512: number;
        samples64: number;
    };
    baseAddress: number;
    busLsbMicrovolts: number;
    configReset: number;
    conversionTime: {
        us1100: number;
        us140: number;
        us204: number;
        us2116: number;
        us332: number;
        us4156: number;
        us588: number;
        us8244: number;
    };
    deviceId: number;
    manufacturerId: number;
    mode: {
        busContinuous: number;
        busTriggered: number;
        powerDown: number;
        shuntAndBusContinuous: number;
        shuntAndBusTriggered: number;
        shuntContinuous: number;
        shuntTriggered: number;
    };
    pin: { ground: number; scl: number; sda: number; supply: number };
    powerLsbRatio: number;
    register: {
        alertLimit: number;
        busVoltage: number;
        calibration: number;
        configuration: number;
        current: number;
        dieId: number;
        manufacturerId: number;
        maskEnable: number;
        power: number;
        shuntVoltage: number;
    };
    shuntLsbNanovolts: number;
    sim: {
        busMicrovolts: number;
        maxMicroamps: number;
        microamps: number;
        shuntMilliohms: number;
        part(address: number): hal.WordPart;
        reporting(
            address: number,
            shuntMilliohms: number,
            maxMicroamps: number,
            busMicrovolts: number,
            microamps: number,
        ): hal.WordPart;
    };
    activeAlertFunction(mask: Ina226MaskEnable): Ina226AlertFunction | null;
    address(a1: number, a0: number): number;
    averagingSamples(averaging: number): number;
    busMicrovolts(raw: number): number;
    busRegister(microvolts: number): number;
    busVolts(raw: number): number;
    calibration(currentLsbMicroamps: number, shuntMilliohms: number): number;
    configFromRegister(raw: number): Ina226Config;
    configToRegister(config: Ina226Config): number;
    conversionMicros(conversionTime: number): number;
    currentAmps(raw: number, currentLsbMicroamps: number): number;
    currentMicroamps(raw: number, currentLsbMicroamps: number): number;
    currentRegister(microamps: number, currentLsbMicroamps: number): number;
    currentRegisterFromShunt(shunt: number, calibration: number): number;
    dieId(raw: number): Ina226DieIdFields;
    identify(manufacturerId: number, dieId: number): Ina226DieIdFields;
    maskEnableFromRegister(raw: number): Ina226MaskEnable;
    maskEnableToRegister(mask: Ina226MaskEnable): number;
    minimumCurrentLsbMicroamps(maxExpectedMicroamps: number): number;
    modeIsContinuous(mode: number): boolean;
    modeMeasuresBus(mode: number): boolean;
    modeMeasuresShunt(mode: number): boolean;
    powerMicrowatts(raw: number, currentLsbMicroamps: number): number;
    powerRegister(microwatts: number, currentLsbMicroamps: number): number;
    powerRegisterFromCurrent(current: number, bus: number): number;
    powerWatts(raw: number, currentLsbMicroamps: number): number;
    shuntMillivolts(raw: number): number;
    shuntNanovolts(raw: number): number;
    shuntRegister(nanovolts: number): number;
    updateMicroseconds(config: Ina226Config): number;
} = ...

A TI INA226 current, voltage, and power monitor with an alert pin.

Type Declaration

averaging: {
    samples1: number;
    samples1024: number;
    samples128: number;
    samples16: number;
    samples256: number;
    samples4: number;
    samples512: number;
    samples64: number;
}

The averaging codes: how many samples each result folds together.
- samples1: number
  
  Every conversion reported, the reset setting.
- samples1024: number
  
  1024 samples.
- samples128: number
  
  128 samples.
- samples16: number
  
  16 samples.
- samples256: number
  
  256 samples.
- samples4: number
  
  4 samples.
- samples512: number
  
  512 samples.
- samples64: number
  
  64 samples.
baseAddress: number

The address with both A1 and A0 tied to GND.
busLsbMicrovolts: number

The bus voltage one count carries, in microvolts.
configReset: number

The value the configuration register reads after a reset.
conversionTime: {
    us1100: number;
    us140: number;
    us204: number;
    us2116: number;
    us332: number;
    us4156: number;
    us588: number;
    us8244: number;
}

The conversion-time codes, for the bus and the shunt voltage alike.
- us1100: number
  
  1.1 ms, the reset setting.
- us140: number
  
  140 us.
- us204: number
  
  204 us.
- us2116: number
  
  2.116 ms.
- us332: number
  
  332 us.
- us4156: number
  
  4.156 ms.
- us588: number
  
  588 us.
- us8244: number
  
  8.244 ms.
deviceId: number

The device identifier the die-ID register carries for an INA226.
manufacturerId: number

The value the manufacturer-ID register reads.
mode: {
    busContinuous: number;
    busTriggered: number;
    powerDown: number;
    shuntAndBusContinuous: number;
    shuntAndBusTriggered: number;
    shuntContinuous: number;
    shuntTriggered: number;
}

The operating-mode codes.
- busContinuous: number
  
  Bus conversions back to back.
- busTriggered: number
  
  One bus conversion.
- powerDown: number
  
  No conversions; the registers stay readable and writable.
- shuntAndBusContinuous: number
  
  Shunt and bus conversions back to back, the reset setting.
- shuntAndBusTriggered: number
  
  One shunt and one bus conversion.
- shuntContinuous: number
  
  Shunt conversions back to back.
- shuntTriggered: number
  
  One shunt conversion.
pin: { ground: number; scl: number; sda: number; supply: number }

What an address pin is tied to, as the code the address helper takes.
- ground: number
  
  Tied to GND.
- scl: number
  
  Tied to SCL.
- sda: number
  
  Tied to SDA.
- supply: number
  
  Tied to VS.
powerLsbRatio: number

How many times the power LSB is the current LSB.
register: {
    alertLimit: number;
    busVoltage: number;
    calibration: number;
    configuration: number;
    current: number;
    dieId: number;
    manufacturerId: number;
    maskEnable: number;
    power: number;
    shuntVoltage: number;
}

The registers a driver reads and writes.
- alertLimit: number
  
  The alert limit.
- busVoltage: number
  
  The bus voltage result.
- calibration: number
  
  The calibration register.
- configuration: number
  
  The configuration register.
- current: number
  
  The current result.
- dieId: number
  
  The die-ID register.
- manufacturerId: number
  
  The manufacturer-ID register.
- maskEnable: number
  
  The Mask/Enable register.
- power: number
  
  The power result.
- shuntVoltage: number
  
  The shunt voltage result.
shuntLsbNanovolts: number

The shunt voltage one count carries, in nanovolts.
sim: {
    busMicrovolts: number;
    maxMicroamps: number;
    microamps: number;
    shuntMilliohms: number;
    part(address: number): hal.WordPart;
    reporting(
        address: number,
        shuntMilliohms: number,
        maxMicroamps: number,
        busMicrovolts: number,
        microamps: number,
    ): hal.WordPart;
}

An INA226 that is not there, for a bus with nothing plugged in. It carries TI's manufacturer id and the INA226 die id, its conversion-ready flag is set, and reporting takes the same shunt and largest current a driver is given.
- busMicrovolts: number
  
  The bus voltage part reports, in microvolts.
- maxMicroamps: number
  
  The largest current part is sized for, in microamps.
- microamps: number
  
  The current part reports, in microamps.
- shuntMilliohms: number
  
  The shunt part sits across, in milliohms.
- part: function
  - part(address: number): hal.WordPart
    A part carrying 500 mA at 12 V through the shunt a driver starts with.
    Parameters
    
    address: number
    The address it answers to.
    Returns hal.WordPart
    The part, to put on a simulated bus.
    Defined in sensors/src/index.ts:3598
- reporting: function
  - reporting(
        address: number,
        shuntMilliohms: number,
        maxMicroamps: number,
        busMicrovolts: number,
        microamps: number,
    ): hal.WordPart
    A part that reads what it is asked to, on the steps its registers count in: 1.25 mV of bus, 2.5 uV of shunt, and the calibration's current step.
    Parameters
    
    address: number
    The address it answers to.
    
    shuntMilliohms: number
    The shunt, as the driver is given it.
    
    maxMicroamps: number
    The largest current, as the driver is given it.
    
    busMicrovolts: number
    The bus voltage it reports.
    
    microamps: number
    The current it reports; negative flows the other way.
    Returns hal.WordPart
    The part, to put on a simulated bus.
    Defined in sensors/src/index.ts:3613
activeAlertFunction: function
- activeAlertFunction(mask: Ina226MaskEnable): Ina226AlertFunction | null
  Returns the limit comparison the alert pin actually responds to.
  
  Only one limit function drives the pin at a time; with several enabled the part honors the most significant bit.
  Parameters
  - mask: Ina226MaskEnable
    The enables in force.
  Returns Ina226AlertFunction | null
  The highest-priority enabled function, or null if none is enabled.
  - Defined in sensors/src/index.ts:3375
address: function
- address(a1: number, a0: number): number
  Returns the 7-bit address the A1 and A0 pins select.
  Parameters
  - a1: number
    What the A1 pin is tied to, one of pin.
  - a0: number
    What the A0 pin is tied to.
  Returns number
  The address, 0x40 to 0x4F.
  
  Throws
  If either pin code is not 0, 1, 2, or 3.
  - Defined in sensors/src/index.ts:3262
averagingSamples: function
- averagingSamples(averaging: number): number
  Returns how many samples an averaging code folds into one result.
  Parameters
  - averaging: number
    The averaging code, 0 to 7.
  Returns number
  The sample count, 1 to 1024.
  - Defined in sensors/src/index.ts:3272
busMicrovolts: function
- busMicrovolts(raw: number): number
  Converts a raw bus-voltage register to microvolts.
  Parameters
  - raw: number
    The register value.
  Returns number
  The bus voltage, at 1.25 mV per count.
  - Defined in sensors/src/index.ts:3452
busRegister: function
- busRegister(microvolts: number): number
  Builds the bus-voltage register a monitor reports for a bus voltage.
  Parameters
  - microvolts: number
    The bus voltage.
  Returns number
  The register value.
  - Defined in sensors/src/index.ts:3529
busVolts: function
- busVolts(raw: number): number
  Converts a raw bus-voltage register to volts.
  Parameters
  - raw: number
    The register value.
  Returns number
  The bus voltage.
  - Defined in sensors/src/index.ts:3462
calibration: function
- calibration(currentLsbMicroamps: number, shuntMilliohms: number): number
  Computes the calibration register for a shunt and current resolution.
  Parameters
  - currentLsbMicroamps: number
    The microamps per count the current register should carry.
  - shuntMilliohms: number
    The shunt resistor value.
  Returns number
  The register value to write.
  - Defined in sensors/src/index.ts:3412
configFromRegister: function
- configFromRegister(raw: number): Ina226Config
  Parses the configuration register.
  Parameters
  - raw: number
    The register value, as read from the device.
  Returns Ina226Config
  The decoded settings; reserved bits are ignored.
  - Defined in sensors/src/index.ts:3322
configToRegister: function
- configToRegister(config: Ina226Config): number
  Assembles the configuration register value.
  Parameters
  - config: Ina226Config
    The settings to encode.
  Returns number
  The register value to write, with reserved bit 14 set as at reset.
  - Defined in sensors/src/index.ts:3332
conversionMicros: function
- conversionMicros(conversionTime: number): number
  Returns how long a conversion-time code takes.
  Parameters
  - conversionTime: number
    The conversion-time code, 0 to 7.
  Returns number
  The typical conversion time in microseconds.
  - Defined in sensors/src/index.ts:3282
currentAmps: function
- currentAmps(raw: number, currentLsbMicroamps: number): number
  Converts a raw current register to amps.
  Parameters
  - raw: number
    The signed register value.
  - currentLsbMicroamps: number
    The resolution the calibration selected.
  Returns number
  The current.
  - Defined in sensors/src/index.ts:3484
currentMicroamps: function
- currentMicroamps(raw: number, currentLsbMicroamps: number): number
  Converts a raw current register to microamps.
  Parameters
  - raw: number
    The signed register value.
  - currentLsbMicroamps: number
    The resolution the calibration selected.
  Returns number
  The current.
  - Defined in sensors/src/index.ts:3473
currentRegister: function
- currentRegister(microamps: number, currentLsbMicroamps: number): number
  Builds the current register a monitor reports for a current.
  Parameters
  - microamps: number
    The current.
  - currentLsbMicroamps: number
    The current LSB the calibration was set for.
  Returns number
  The signed register value.
  - Defined in sensors/src/index.ts:3540
currentRegisterFromShunt: function
- currentRegisterFromShunt(shunt: number, calibration: number): number
  Computes the current register the part derives from a shunt reading.
  Parameters
  - shunt: number
    The signed shunt-voltage register.
  - calibration: number
    The calibration register in force.
  Returns number
  The signed current register.
  - Defined in sensors/src/index.ts:3562
dieId: function
- dieId(raw: number): Ina226DieIdFields
  Splits a die-ID register into its device and revision fields.
  Parameters
  - raw: number
    The die-ID register.
  Returns Ina226DieIdFields
  The 12-bit device identifier and the 4-bit revision.
  - Defined in sensors/src/index.ts:3385
identify: function
- identify(manufacturerId: number, dieId: number): Ina226DieIdFields
  Checks that a pair of identification registers belongs to an INA226.
  
  A node reads both at start-up, so a wrong part on the address, or a bus that reads all ones, is caught before its readings are trusted.
  Parameters
  - manufacturerId: number
    The manufacturer-ID register.
  - dieId: number
    The die-ID register.
  Returns Ina226DieIdFields
  The decoded die ID.
  
  Throws
  If either register does not carry the value the datasheet fixes.
  - Defined in sensors/src/index.ts:3400
maskEnableFromRegister: function
- maskEnableFromRegister(raw: number): Ina226MaskEnable
  Parses the Mask/Enable register.
  Parameters
  - raw: number
    The register value, as read from the device.
  Returns Ina226MaskEnable
  The decoded enables and flags.
  - Defined in sensors/src/index.ts:3352
maskEnableToRegister: function
- maskEnableToRegister(mask: Ina226MaskEnable): number
  Assembles the Mask/Enable register value.
  Parameters
  - mask: Ina226MaskEnable
    The enables and flags to encode.
  Returns number
  The register value to write.
  - Defined in sensors/src/index.ts:3362
minimumCurrentLsbMicroamps: function
- minimumCurrentLsbMicroamps(maxExpectedMicroamps: number): number
  Returns the smallest current resolution that still covers a maximum.
  Parameters
  - maxExpectedMicroamps: number
    The largest current the application measures.
  Returns number
  The minimum current LSB in microamps.
  - Defined in sensors/src/index.ts:3422
modeIsContinuous: function
- modeIsContinuous(mode: number): boolean
  Reports whether a mode code keeps converting after the first result.
  Parameters
  - mode: number
    The mode code, 0 to 7.
  Returns boolean
  Whether the mode is one of the three continuous ones.
  - Defined in sensors/src/index.ts:3312
modeMeasuresBus: function
- modeMeasuresBus(mode: number): boolean
  Reports whether a mode code converts the bus voltage.
  Parameters
  - mode: number
    The mode code, 0 to 7.
  Returns boolean
  Whether the bus input is measured.
  - Defined in sensors/src/index.ts:3302
modeMeasuresShunt: function
- modeMeasuresShunt(mode: number): boolean
  Reports whether a mode code converts the shunt voltage.
  Parameters
  - mode: number
    The mode code, 0 to 7.
  Returns boolean
  Whether the shunt input is measured.
  - Defined in sensors/src/index.ts:3292
powerMicrowatts: function
- powerMicrowatts(raw: number, currentLsbMicroamps: number): number
  Converts a raw power register to microwatts.
  Parameters
  - raw: number
    The register value.
  - currentLsbMicroamps: number
    The resolution the calibration selected.
  Returns number
  The power. The power LSB is fixed at 25 times the current LSB.
  - Defined in sensors/src/index.ts:3495
powerRegister: function
- powerRegister(microwatts: number, currentLsbMicroamps: number): number
  Builds the power register a monitor reports for a power.
  Parameters
  - microwatts: number
    The power.
  - currentLsbMicroamps: number
    The current LSB the calibration was set for.
  Returns number
  The register value.
  - Defined in sensors/src/index.ts:3551
powerRegisterFromCurrent: function
- powerRegisterFromCurrent(current: number, bus: number): number
  Computes the power register the part derives from a current and a bus voltage.
  Parameters
  - current: number
    The signed current register.
  - bus: number
    The bus-voltage register.
  Returns number
  The power register.
  - Defined in sensors/src/index.ts:3573
powerWatts: function
- powerWatts(raw: number, currentLsbMicroamps: number): number
  Converts a raw power register to watts.
  Parameters
  - raw: number
    The register value.
  - currentLsbMicroamps: number
    The resolution the calibration selected.
  Returns number
  The power.
  - Defined in sensors/src/index.ts:3506
shuntMillivolts: function
- shuntMillivolts(raw: number): number
  Converts a raw shunt-voltage register to millivolts.
  Parameters
  - raw: number
    The signed register value.
  Returns number
  The shunt voltage.
  - Defined in sensors/src/index.ts:3442
shuntNanovolts: function
- shuntNanovolts(raw: number): number
  Converts a raw shunt-voltage register to nanovolts.
  Parameters
  - raw: number
    The signed register value.
  Returns number
  The shunt voltage, at 2.5 uV per count.
  - Defined in sensors/src/index.ts:3432
shuntRegister: function
- shuntRegister(nanovolts: number): number
  Builds the shunt-voltage register a monitor reports for a shunt voltage.
  
  The inverse of shuntNanovolts, so a node can be written and tested against what a monitor sends without one attached.
  Parameters
  - nanovolts: number
    The shunt voltage.
  Returns number
  The signed register value.
  - Defined in sensors/src/index.ts:3519
updateMicroseconds: function
- updateMicroseconds(config: Ina226Config): number
  Returns how often the result registers update with these settings.
  Parameters
  - config: Ina226Config
    The settings in force.
  Returns number
  The update interval in microseconds, or 0 in power-down.
  - Defined in sensors/src/index.ts:3342

Variable ina226Const

Type Declaration

averaging: { samples1: number; samples1024: number; samples128: number; samples16: number; samples256: number; samples4: number; samples512: number; samples64: number;}

samples1: number

samples1024: number

samples128: number

samples16: number

samples256: number

samples4: number

samples512: number

samples64: number

baseAddress: number

busLsbMicrovolts: number

configReset: number

conversionTime: { us1100: number; us140: number; us204: number; us2116: number; us332: number; us4156: number; us588: number; us8244: number;}

us1100: number

us140: number

us204: number

us2116: number

us332: number

us4156: number

us588: number

us8244: number

deviceId: number

manufacturerId: number

mode: { busContinuous: number; busTriggered: number; powerDown: number; shuntAndBusContinuous: number; shuntAndBusTriggered: number; shuntContinuous: number; shuntTriggered: number;}

busContinuous: number

busTriggered: number

powerDown: number

shuntAndBusContinuous: number

shuntAndBusTriggered: number

shuntContinuous: number

shuntTriggered: number

pin: { ground: number; scl: number; sda: number; supply: number }

ground: number

scl: number

sda: number

supply: number

powerLsbRatio: number

register: { alertLimit: number; busVoltage: number; calibration: number; configuration: number; current: number; dieId: number; manufacturerId: number; maskEnable: number; power: number; shuntVoltage: number;}

alertLimit: number

busVoltage: number

calibration: number

configuration: number

current: number

dieId: number

manufacturerId: number

maskEnable: number

power: number

shuntVoltage: number

shuntLsbNanovolts: number

sim: { busMicrovolts: number; maxMicroamps: number; microamps: number; shuntMilliohms: number; part(address: number): hal.WordPart; reporting( address: number, shuntMilliohms: number, maxMicroamps: number, busMicrovolts: number, microamps: number, ): hal.WordPart;}

busMicrovolts: number

maxMicroamps: number

microamps: number

shuntMilliohms: number

part: function

Parameters

Returns hal.WordPart

reporting: function

Parameters

Returns hal.WordPart

activeAlertFunction: function

Parameters

Returns Ina226AlertFunction | null

address: function

Parameters

Returns number

Throws

averagingSamples: function

Parameters

Returns number

busMicrovolts: function

Parameters

Returns number

busRegister: function

Parameters

Returns number

busVolts: function

Parameters

Variable ina226`Const`

averaging: {
samples1: number;
samples1024: number;
samples128: number;
samples16: number;
samples256: number;
samples4: number;
samples512: number;
samples64: number;
}

conversionTime: {
us1100: number;
us140: number;
us204: number;
us2116: number;
us332: number;
us4156: number;
us588: number;
us8244: number;
}

mode: {
busContinuous: number;
busTriggered: number;
powerDown: number;
shuntAndBusContinuous: number;
shuntAndBusTriggered: number;
shuntContinuous: number;
shuntTriggered: number;
}

register: {
alertLimit: number;
busVoltage: number;
calibration: number;
configuration: number;
current: number;
dieId: number;
manufacturerId: number;
maskEnable: number;
power: number;
shuntVoltage: number;
}

sim: {
busMicrovolts: number;
maxMicroamps: number;
microamps: number;
shuntMilliohms: number;
part(address: number): hal.WordPart;
reporting(
address: number,
shuntMilliohms: number,
maxMicroamps: number,
busMicrovolts: number,
microamps: number,
): hal.WordPart;
}