@johntalton/boschieu

    6.0.1 • Public • Published

    Bosch Integrated Environmental Unit

    Common Unified Sensor API for supported IEU chips.

    npm Version GitHub package.json version CI CodeQL GitHub Downloads Per Month GitHub last commit Package Quality

    Provides full feature access to all supported chips (bmp280 bme280 bme680 bmp388 bmp390) while still providing rich chip specific features (multiple heater profiles and fifo access).

    Tested with these products:

    (note: Adafruit no-longer sells the bmp085 or bmp180, donation of legacy chips are welcome to aid in greater product support)

    📐 Example Usage

    🔧 API

    The API is organized around simple sensor class BoschSensor which provides an object interface for manipulating the sensor. All method return a Promise.

    A simple demo usage follows.

    const i2c1 = await i2c.openPromisified(1);
    const addressedI2C1 = new I2CAddressedBus(i2c1, 0x77);
    const sensor = await BoschIEU.sensor(addressedI2C1);
    await sensor.detectChip();
    await sensor.calibration();
    const result = await sensor.measurement();

    📘 BoschIEU

    📄 sensor(addressedBus)

    A static factory method to provide access to the BoschSensor class.

    📘 BoschIEU Sensor

    📄 detectChip()

    After constructing a sensor object, the detectChip method is recommended as it will attempt to (get this) detect which version of the chip to use for further register interactions.

    sensor.detectChip()
       .then(() => { if(sensor.valid()) ... })

    Alternatively, if you are you wish to set the chip during initialization that is also possible

       // sensor.chipId = Chip.bmp388

    📄 id()

    Returns the chips id as defined by the vendor. This is only valid after a chip has been detected (valid() returns true) (note that legacy id() call will internal run detectChip() for now...)

    sensor.id()
       .then(id => console.log('sensors Id', id);

    📄 calibration()

    Fetches the calibration constants from the chip. These values are unique for each chip and needed to perform compensation of the raw data values into temperature and pressure readings.

    Note: This must be called before the measurement call will return valid results.

    Note: The method itself caches results in the class and is not needed externally (though returned for user inspection)

    📄 fifo()

    The fifo getter method returns a static Fifo class implementation. This provides a namespace for fifo functionality.

    sensor.fifo.flush( ... ).then(...)

    📄 profile()

    Returns current chip profile from the device.

    📄 setProfile(profile)

    Sets the profile for the chip.

    Note: This will set the entire profile, if fields are not included in profile they will be set to the defaults for the Chip.

    📄 reset()

    Write a soft-reset to the chip. Returning it to power-on state.

    sensor.reset().then( ... )

    📄 measurement(...)

    Reads and calculates related measurement data from the Chip.

    sensor.measurement().then(results => {
      // process results
    });

    📘 Fifo

    📄 flush()

    Flushes the fifo buffer using command register.

    📄 read()

    Reads the current fifo buffer in full (as specified by size) and parses and compensates frame data.

    📘 Converter

    Converter class of common helps are included (ft to meters, altitude from Pa, etc)

    Install

    npm i @johntalton/boschieu

    DownloadsWeekly Downloads

    28

    Version

    6.0.1

    License

    MIT

    Unpacked Size

    93.9 kB

    Total Files

    25

    Last publish

    Collaborators

    • johntalton