Variable ina219Const

Type Declaration

• busMillivolts: function

  • busMillivolts(raw: number): number

    Converts a raw bus-voltage register to millivolts.

    Parameters

    • raw: number

      The register value.

    Returns number

    The bus voltage.

• busRegister: function

  • busRegister(millivolts: number): number

    Builds the bus-voltage register a monitor reports for a bus voltage.

    Parameters

    • millivolts: number

      The bus voltage in millivolts.

    Returns number

    The register value, with the conversion-ready flag set.

• 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.

• conversionReady: function

  • conversionReady(raw: number): boolean

    Reports whether a bus-voltage register says a conversion is ready.

    Parameters

    • raw: number

      The register value.

    Returns boolean

    Whether the conversion-ready flag is set.

• 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.

• currentRegister: function

  • currentRegister(microamps: number, currentLsbMicroamps: number): number

    Builds the current register a monitor reports for a current.

    Parameters

    • microamps: number

      The current in microamps.

    • currentLsbMicroamps: number

      The current LSB the calibration was set for.

    Returns number

    The signed register value.

• mathOverflow: function

  • mathOverflow(raw: number): boolean

    Reports whether a bus-voltage register flags a math overflow.

    Parameters

    • raw: number

      The register value.

    Returns boolean

    Whether the current and power readings are meaningless, which means the calibration needs revisiting.

• 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.

• 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 twenty times the current LSB.

• powerRegister: function

  • powerRegister(microwatts: number, currentLsbMicroamps: number): number

    Builds the power register a monitor reports for a power.

    Parameters

    • microwatts: number

      The power in microwatts.

    • currentLsbMicroamps: number

      The current LSB the calibration was set for.

    Returns number

    The register value.

• shuntMicrovolts: function

  • shuntMicrovolts(raw: number): number

    Parameters

    • raw: number

    Returns number

• shuntRegister: function

  • shuntRegister(microvolts: number): number

    Builds the shunt-voltage register a monitor reports for a shunt voltage.

    The inverse of shuntMicrovolts, so a node can be written and tested against what a monitor sends without one attached.

    Parameters

    • microvolts: number

      The shunt voltage in microvolts.

    Returns number

    The signed register value, at 10 uV per count.