Variable bmp280`Const`

bmp280: {
    addressPrimary: number;
    addressSecondary: number;
    calibrationLength: number;
    chipId: number;
    dataLength: number;
    oversampling: {
        skipped: number;
        x1: number;
        x16: number;
        x2: number;
        x4: number;
        x8: number;
    };
    register: {
        calibration: number;
        chipId: number;
        config: number;
        ctrlMeas: number;
        data: number;
        reset: number;
        status: number;
    };
    resetWord: number;
    sim: {
        statusIdle: number;
        burst(): Buffer;
        burstFor(celsius: number, hectopascals: number): Buffer;
        calibration(): Buffer;
        part(address: number): hal.I2cPart;
        reporting(
            address: number,
            celsius: number,
            hectopascals: number,
        ): hal.I2cPart;
    };
    skippedOutput: number;
    calibration(bytes: Uint8Array): Bmp280Calibration;
    configBits(config: Bmp280Config): number;
    configFromBits(bits: number): Bmp280Config;
    ctrlMeasBits(ctrl: Bmp280CtrlMeas): number;
    ctrlMeasFromBits(bits: number): Bmp280CtrlMeas;
    imageUpdating(status: number): boolean;
    measurementBytes(pressure: number, temperature: number): Buffer;
    measuring(status: number): boolean;
    oversamplingFactor(code: number): number;
    parseMeasurement(bytes: Uint8Array): Bmp280RawMeasurement;
    pressureSkipped(pressure: number): boolean;
    standbyMicros(code: number): number;
    temperatureSkipped(temperature: number): boolean;
} = ...

A Bosch BMP280 pressure and temperature sensor, the BME280 without humidity.

Type Declaration

addressPrimary: number

The address a BMP280 answers on with its SDO pin low.
addressSecondary: number

The address it answers on with SDO high.
calibrationLength: number

How many bytes the calibration block holds.
chipId: number

The value its chip-ID register reads, which confirms the part.
dataLength: number

How many bytes one measurement burst holds.
oversampling: { skipped: number; x1: number; x16: number; x2: number; x4: number; x8: number }

The oversampling codes: how many samples each measurement averages.
- skipped: number
  
  The measurement is skipped.
- x1: number
  
  One sample.
- x16: number
  
  Sixteen samples.
- x2: number
  
  Two samples.
- x4: number
  
  Four samples.
- x8: number
  
  Eight samples.
register: {
    calibration: number;
    chipId: number;
    config: number;
    ctrlMeas: number;
    data: number;
    reset: number;
    status: number;
}

The registers a driver reads and writes.
- calibration: number
  
  The first of the 24 calibration bytes.
- chipId: number
  
  The chip-ID register.
- config: number
  
  The configuration register.
- ctrlMeas: number
  
  The measurement-control register.
- data: number
  
  The first of the six data bytes.
- reset: number
  
  The reset register.
- status: number
  
  The status register.
resetWord: number

The word written to the reset register to restart the part.
sim: {
    statusIdle: number;
    burst(): Buffer;
    burstFor(celsius: number, hectopascals: number): Buffer;
    calibration(): Buffer;
    part(address: number): hal.I2cPart;
    reporting(
        address: number,
        celsius: number,
        hectopascals: number,
    ): hal.I2cPart;
}

A BMP280 that is not there, for a bus with nothing plugged in. A BMP280 is a BME280 without humidity, so part holds the temperature and pressure half of a real part and reads 20.44 C and 848.05 hPa.
- statusIdle: number
  
  The status a simulated part reports when it is neither measuring nor loading.
- burst: function
  - burst(): Buffer
    The six data registers a simulated part holds: one measurement a real part took.
    
    Returns Buffer
    Defined in sensors/src/index.ts:1542
- burstFor: function
  - burstFor(celsius: number, hectopascals: number): Buffer
    The six data registers that compensate to a reading against the simulated trimming.
    Parameters
    
    celsius: number
    The temperature.
    
    hectopascals: number
    The pressure.
    Returns Buffer
    The bytes a burst read would return.
    Defined in sensors/src/index.ts:1553
- calibration: function
  - calibration(): Buffer
    The 24 trimming bytes a simulated part holds.
    
    Returns Buffer
    Defined in sensors/src/index.ts:1537
- part: function
  - part(address: number): hal.I2cPart
    A part holding a real part's trimming and one measurement it took.
    Parameters
    
    address: number
    The address it answers to.
    Returns hal.I2cPart
    The part, to put on a simulated bus.
    Defined in sensors/src/index.ts:1519
- reporting: function
  - reporting(address: number, celsius: number, hectopascals: number): hal.I2cPart
    A part that reads what it is asked to, within a hundredth of a degree and of a hectopascal.
    Parameters
    
    address: number
    The address it answers to.
    
    celsius: number
    The temperature it reports.
    
    hectopascals: number
    The pressure it reports.
    Returns hal.I2cPart
    The part, to put on a simulated bus.
    Defined in sensors/src/index.ts:1532
skippedOutput: number

The raw output a channel reports when its measurement is switched off.
calibration: function
- calibration(bytes: Uint8Array): Bmp280Calibration
  Reads the factory calibration out of the registers, once at start-up.
  Parameters
  - bytes: Uint8Array
    The 24-byte calibration block.
  Returns Bmp280Calibration
  The calibration, to reuse for every measurement.
  
  Throws
  If the block is the wrong length.
  - Defined in sensors/src/index.ts:1565
configBits: function
- configBits(config: Bmp280Config): number
  Assembles the config register value.
  Parameters
  - config: Bmp280Config
    The standby time, filter, and interface settings.
  Returns number
  The register value to write.
  - Defined in sensors/src/index.ts:1660
configFromBits: function
- configFromBits(bits: number): Bmp280Config
  Parses a config register value.
  Parameters
  - bits: number
    The register value, as read from the device.
  Returns Bmp280Config
  The decoded settings.
  - Defined in sensors/src/index.ts:1670
ctrlMeasBits: function
- ctrlMeasBits(ctrl: Bmp280CtrlMeas): number
  Assembles the ctrl_meas register value.
  Parameters
  - ctrl: Bmp280CtrlMeas
    The oversampling codes and power mode to encode.
  Returns number
  The register value to write.
  - Defined in sensors/src/index.ts:1640
ctrlMeasFromBits: function
- ctrlMeasFromBits(bits: number): Bmp280CtrlMeas
  Parses a ctrl_meas register value.
  Parameters
  - bits: number
    The register value, as read from the device.
  Returns Bmp280CtrlMeas
  The decoded settings.
  - Defined in sensors/src/index.ts:1650
imageUpdating: function
- imageUpdating(status: number): boolean
  Reports whether a status register says the calibration is being copied.
  Parameters
  - status: number
    The status register.
  Returns boolean
  Whether the image registers are being reloaded.
  - Defined in sensors/src/index.ts:1630
measurementBytes: function
- measurementBytes(pressure: number, temperature: number): Buffer
  Builds the six data-register bytes a part reports for two raw outputs.
  
  The inverse of parseMeasurement, so a node can be written and tested against what a sensor sends without one attached.
  Parameters
  - pressure: number
    The 20-bit uncompensated pressure.
  - temperature: number
    The 20-bit uncompensated temperature.
  Returns Buffer
  The six bytes in read order.
  - Defined in sensors/src/index.ts:1590
measuring: function
- measuring(status: number): boolean
  Reports whether a status register says a conversion is running.
  Parameters
  - status: number
    The status register.
  Returns boolean
  Whether a measurement is in progress.
  - Defined in sensors/src/index.ts:1620
oversamplingFactor: function
- oversamplingFactor(code: number): number
  Returns how many samples an oversampling code averages.
  Parameters
  - code: number
    The oversampling code, 0 to 7.
  Returns number
  The sample count, or 0 when the measurement is switched off.
  - Defined in sensors/src/index.ts:1680
parseMeasurement: function
- parseMeasurement(bytes: Uint8Array): Bmp280RawMeasurement
  Splits a six-byte data read into its two uncompensated outputs.
  Parameters
  - bytes: Uint8Array
    The six data registers in read order.
  Returns Bmp280RawMeasurement
  The raw pressure and temperature, before compensation.
  
  Throws
  If the read is the wrong length.
  - Defined in sensors/src/index.ts:1576
pressureSkipped: function
- pressureSkipped(pressure: number): boolean
  Reports whether a raw pressure says the measurement is switched off.
  Parameters
  - pressure: number
    The 20-bit uncompensated pressure.
  Returns boolean
  Whether the channel's oversampling is set to skip.
  - Defined in sensors/src/index.ts:1600
standbyMicros: function
- standbyMicros(code: number): number
  Returns the standby time a standby code selects in normal mode.
  Parameters
  - code: number
    The standby code, 0 to 7.
  Returns number
  The standby time in microseconds.
  - Defined in sensors/src/index.ts:1690
temperatureSkipped: function
- temperatureSkipped(temperature: number): boolean
  Reports whether a raw temperature says the measurement is switched off.
  Parameters
  - temperature: number
    The 20-bit uncompensated temperature.
  Returns boolean
  Whether the channel's oversampling is set to skip.
  - Defined in sensors/src/index.ts:1610

Variable bmp280Const

Type Declaration

addressPrimary: number

addressSecondary: number

calibrationLength: number

chipId: number

dataLength: number

oversampling: { skipped: number; x1: number; x16: number; x2: number; x4: number; x8: number }

skipped: number

x1: number

x16: number

x2: number

x4: number

x8: number

register: { calibration: number; chipId: number; config: number; ctrlMeas: number; data: number; reset: number; status: number;}

calibration: number

chipId: number

config: number

ctrlMeas: number

data: number

reset: number

status: number

resetWord: number

sim: { statusIdle: number; burst(): Buffer; burstFor(celsius: number, hectopascals: number): Buffer; calibration(): Buffer; part(address: number): hal.I2cPart; reporting( address: number, celsius: number, hectopascals: number, ): hal.I2cPart;}

statusIdle: number

burst: function

Returns Buffer

burstFor: function

Parameters

Returns Buffer

calibration: function

Returns Buffer

part: function

Parameters

Returns hal.I2cPart

reporting: function

Parameters

Returns hal.I2cPart

skippedOutput: number

calibration: function

Parameters

Returns Bmp280Calibration

Throws

configBits: function

Parameters

Returns number

configFromBits: function

Parameters

Returns Bmp280Config

ctrlMeasBits: function

Parameters

Returns number

ctrlMeasFromBits: function

Parameters

Returns Bmp280CtrlMeas

imageUpdating: function

Parameters

Returns boolean

measurementBytes: function

Parameters

Returns Buffer

measuring: function

Parameters

Returns boolean

oversamplingFactor: function

Parameters

Returns number

parseMeasurement: function

Parameters

Returns Bmp280RawMeasurement

Throws

pressureSkipped: function

Parameters

Returns boolean

standbyMicros: function

Parameters

Returns number

temperatureSkipped: function

Parameters

Returns boolean

Variable bmp280`Const`

register: {
calibration: number;
chipId: number;
config: number;
ctrlMeas: number;
data: number;
reset: number;
status: number;
}

sim: {
statusIdle: number;
burst(): Buffer;
burstFor(celsius: number, hectopascals: number): Buffer;
calibration(): Buffer;
part(address: number): hal.I2cPart;
reporting(
address: number,
celsius: number,
hectopascals: number,
): hal.I2cPart;
}