Variable hdc1080Const

Type Declaration

• address: number

  The only address the part answers on.

• configurationReset: number

  The value the configuration register reads after a reset.

• deviceId: number

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

• manufacturerId: number

  The value the manufacturer-ID register reads.

• register: {
      configuration: number;
      deviceId: number;
      humidity: number;
      manufacturerId: number;
      serialIdHigh: number;
      serialIdLow: number;
      serialIdMid: number;
      temperature: number;
  }

  The registers a driver reads and writes.

  • configuration: number

    The configuration register.

  • deviceId: number

    The device-ID register.

  • humidity: number

    The humidity result.

  • manufacturerId: number

    The manufacturer-ID register.

  • serialIdHigh: number

    The top word of the serial number.

  • serialIdLow: number

    The bottom word of the serial number.

  • serialIdMid: number

    The middle word of the serial number.

  • temperature: number

    The temperature result.

• celsius: function

  • celsius(raw: number): number

    Converts a raw temperature register to degrees Celsius.

    Parameters

    • raw: number

      The 16-bit register.

    Returns number

    The temperature.

• configFromRegister: function

  • configFromRegister(raw: number): sensors.Hdc1080Config

    Parses the configuration register.

    Parameters

    • raw: number

      The register value, as read from the device.

    Returns sensors.Hdc1080Config

    The decoded settings.

    Throws

    If the humidity-resolution field holds the code the datasheet leaves undefined, which means the value did not come from a working part.

• configToRegister: function

  • configToRegister(config: sensors.Hdc1080Config): number

    Assembles the configuration register value.

    Parameters

    • config: sensors.Hdc1080Config

      The settings to encode.

    Returns number

    The register value to write.

    Throws

    If either resolution is not one the part offers.

• conversionTimeMicros: function

  • conversionTimeMicros(config: sensors.Hdc1080Config): number

    Returns how long to wait after a trigger before the result is readable.

    Parameters

    • config: sensors.Hdc1080Config

      The settings in force.

    Returns number

    The conversion time in microseconds.

    Throws

    If either resolution is not one the part offers.

• humidityRegister: function

  • humidityRegister(milliPercent: number): number

    Builds the humidity register for a humidity in milli-percent.

    Parameters

    • milliPercent: number

      The relative humidity.

    Returns number

    The register value, its 14-bit code in bits 15:2 and clamped to the part's range.

• measurementBytes: function

  • measurementBytes(temperature: number, humidity: number): Buffer

    Builds the four bytes the part sends for a pair of raw registers.

    The inverse of parseMeasurement.

    Parameters

    • temperature: number

      The raw temperature register.

    • humidity: number

      The raw humidity register.

    Returns Buffer

    The frame in read order.

• measurementFromPhysical: function

  • measurementFromPhysical(
        milliCelsius: number,
        milliPercent: number,
    ): sensors.Hdc1080Measurement

    Builds the measurement a part reporting these physical values would send.

    Parameters

    • milliCelsius: number

      The temperature in milli-degrees Celsius.

    • milliPercent: number

      The relative humidity in milli-percent.

    Returns sensors.Hdc1080Measurement

    The measurement, with the raw registers the part would carry.

• milliCelsius: function

  • milliCelsius(raw: number): number

    Converts a raw temperature register to milli-degrees Celsius.

    Parameters

    • raw: number

      The 16-bit register.

    Returns number

    The temperature, exact in integer arithmetic.

• milliPercent: function

  • milliPercent(raw: number): number

    Converts a raw humidity register to milli-percent relative humidity.

    Parameters

    • raw: number

      The 16-bit register.

    Returns number

    The humidity, exact in integer arithmetic.

• parseMeasurement: function

  • parseMeasurement(bytes: Uint8Array): sensors.Hdc1080Measurement

    Parses a four-byte measurement frame.

    The part has no checksum, so every frame decodes.

    Parameters

    • bytes: Uint8Array

      The temperature and humidity registers, each most significant byte first.

    Returns sensors.Hdc1080Measurement

    The raw registers and the physical values they carry.

    Throws

    If the read is not four bytes.

• relativeHumidity: function

  • relativeHumidity(raw: number): number

    Converts a raw humidity register to a relative humidity percentage.

    Parameters

    • raw: number

      The 16-bit register.

    Returns number

    The humidity.

• serialId: function

  • serialId(high: number, mid: number, low: number): number

    Joins the three serial-ID registers into one serial number.

    Parameters

    • high: number

      The top register.

    • mid: number

      The middle register.

    • low: number

      The bottom register.

    Returns number

    The 41-bit serial number.

• serialIdRegisters: function

  • serialIdRegisters(serial: number): number[]

    Splits a serial number back into its three registers.

    Parameters

    • serial: number

      The 41-bit serial number.

    Returns number[]

    The high, middle, and low registers, in that order.

• temperatureRegister: function

  • temperatureRegister(milliCelsius: number): number

    Builds the temperature register for a temperature in milli-degrees Celsius.

    Parameters

    • milliCelsius: number

      The temperature.

    Returns number

    The register value, its 14-bit code in bits 15:2 and clamped to the part's range.