Variable tmp117Const

Type Declaration

• address: { add0Gnd: number; add0Scl: number; add0Sda: number; add0Vplus: number }

  The addresses the ADD0 pin selects.

  • add0Gnd: number

    ADD0 tied to GND.

  • add0Scl: number

    ADD0 tied to SCL.

  • add0Sda: number

    ADD0 tied to SDA.

  • add0Vplus: number

    ADD0 tied to V+.

• configReset: number

  The value the configuration register reads after a reset.

• deviceId: number

  The value the device-ID register reads, which confirms the part.

• eepromUnlock: number

  The word written to the EEPROM-unlock register to allow a write.

• generalCallReset: number

  The byte a general-call reset sends to address 0x00.

• highLimitReset: number

  The value the high-limit register holds after a reset.

• lowLimitReset: number

  The value the low-limit register holds after a reset.

• register: {
      configuration: number;
      deviceId: number;
      eeprom1: number;
      eeprom2: number;
      eeprom3: number;
      eepromUl: number;
      tempOffset: number;
      tempResult: number;
      thighLimit: number;
      tlowLimit: number;
  }

  The registers a driver reads and writes.

  • configuration: number

    The configuration register.

  • deviceId: number

    The device-ID register.

  • eeprom1: number

    The first general-purpose EEPROM word.

  • eeprom2: number

    The second general-purpose EEPROM word.

  • eeprom3: number

    The third general-purpose EEPROM word.

  • eepromUl: number

    The EEPROM unlock register.

  • tempOffset: number

    The temperature offset applied to every result.

  • tempResult: number

    The temperature result.

  • thighLimit: number

    The high alert limit.

  • tlowLimit: number

    The low alert limit.

• tempResultReset: number

  The value the result register holds before the first conversion.

• celsius: function

  • celsius(raw: number): number

    Converts a raw temperature register to degrees Celsius.

    Parameters

    • raw: number

      The signed 16-bit register.

    Returns number

    The temperature.

• configBits: function

  • configBits(config: sensors.Tmp117Config): number

    Assembles the 16-bit configuration register value.

    Parameters

    • config: sensors.Tmp117Config

      The settings to encode.

    Returns number

    The register value to write.

• configFromBits: function

  • configFromBits(bits: number): sensors.Tmp117Config

    Parses a 16-bit configuration register value.

    Parameters

    • bits: number

      The register value, as read from the device.

    Returns sensors.Tmp117Config

    The decoded settings. Every value decodes, so this never throws.

• conversionMicros: function

  • conversionMicros(averaging: number): number

    Returns how long an averaging code takes to convert.

    Parameters

    • averaging: number

      The averaging code, 0 to 3.

    Returns number

    The active conversion time in microseconds.

• conversions: function

  • conversions(averaging: number): number

    Returns how many conversions an averaging code folds into one result.

    Parameters

    • averaging: number

      The averaging code, 0 to 3.

    Returns number

    The conversion count: 1, 8, 32, or 64.

• cycleMicros: function

  • cycleMicros(cycle: number, averaging: number): number

    Returns the result interval for a cycle and averaging pair.

    Parameters

    • cycle: number

      The conversion-cycle code, 0 to 7.

    • averaging: number

      The averaging code, 0 to 3.

    Returns number

    The interval in microseconds, never shorter than the conversions take.

• dataReady: function

  • dataReady(config: number): boolean

    Reports whether a configuration register says a conversion is ready.

    Parameters

    • config: number

      The configuration register.

    Returns boolean

    Whether a new result is waiting.

• deviceIdFromRegister: function

  • deviceIdFromRegister(raw: number): number

    Returns the device identifier a device-ID register carries.

    Parameters

    • raw: number

      The device-ID register.

    Returns number

    The 12-bit identifier, which is 0x117 for a TMP117.

• eepromBusy: function

  • eepromBusy(config: number): boolean

    Reports whether a configuration register says an EEPROM write is running.

    Parameters

    • config: number

      The configuration register.

    Returns boolean

    Whether the part is still writing.

• eepromUnlockBusy: function

  • eepromUnlockBusy(unlock: number): boolean

    Reports whether an EEPROM-unlock register says a write is running.

    Parameters

    • unlock: number

      The EEPROM unlock register.

    Returns boolean

    Whether the part is still writing.

• highAlert: function

  • highAlert(config: number): boolean

    Reports whether a configuration register flags a high alert.

    Parameters

    • config: number

      The configuration register.

    Returns boolean

    Whether the result went above the high limit.

• lowAlert: function

  • lowAlert(config: number): boolean

    Reports whether a configuration register flags a low alert.

    Parameters

    • config: number

      The configuration register.

    Returns boolean

    Whether the result went below the low limit.

• microCelsius: function

  • microCelsius(raw: number): number

    Converts a raw temperature register to micro-degrees Celsius.

    Parameters

    • raw: number

      The signed 16-bit register.

    Returns number

    The temperature, truncated toward zero.

• nanoCelsius: function

  • nanoCelsius(raw: number): number

    Converts a raw temperature register to nano-degrees Celsius.

    Parameters

    • raw: number

      The signed 16-bit register.

    Returns number

    The temperature, exact at the part's 7.8125 m°C resolution.

• nominalMicros: function

  • nominalMicros(cycle: number): number

    Returns the nominal cycle a conversion-cycle code names.

    Parameters

    • cycle: number

      The conversion-cycle code, 0 to 7.

    Returns number

    The cycle with no averaging, in microseconds.

• rawFromCelsius: function

  • rawFromCelsius(celsius: number): number

    Builds the raw register for a temperature in degrees Celsius.

    Parameters

    • celsius: number

      The temperature.

    Returns number

    The nearest register value, saturating at the part's range.

• rawFromMicroCelsius: function

  • rawFromMicroCelsius(microCelsius: number): number

    Builds the raw register for a temperature in micro-degrees Celsius.

    Parameters

    • microCelsius: number

      The temperature.

    Returns number

    The nearest register value, saturating at the part's range.

• revision: function

  • revision(raw: number): number

    Returns the die revision a device-ID register carries.

    Parameters

    • raw: number

      The device-ID register.

    Returns number

    The 4-bit revision.

• temperatureBytes: function

  • temperatureBytes(raw: number): Buffer

    Builds the two bytes the part sends for a temperature register.

    Parameters

    • raw: number

      The signed 16-bit register.

    Returns Buffer

    The register, most significant byte first.

• temperatureFromBytes: function

  • temperatureFromBytes(bytes: Uint8Array): number

    Reads a temperature register out of the two bytes the part sends.

    Parameters

    • bytes: Uint8Array

      The register, most significant byte first.

    Returns number

    The signed register value.

    Throws

    If the read is not two bytes.