Arduino Library for the SparkFun Air Quality PM1/PM2.5/PM10 Sensor - BMV080
The SparkFun Air Quality PM1/PM2.5/PM10 Sensor - BMV080 (Qwiic)is an ultra-small, fan-less air quality sensor for sensing PM2.5 particulate matter! Within the enclosure is a breakout board that breaks out Bosch's BMV080, the world's smallest PM1 and PM2.5 air quality sensor. The sensing element measures merely 4.2mm x 3.5mm x 3.1mm (W x L x H), which is more than 450 times smaller than any comparable device on the market. The innovative design is based on ultra-compact lasers with integrated photodiodes. The sensor applies sophisticated algorithms to measure PM1 and PM2.5 concentrations directly in free space, without requiring an intrusive fan.
The breakout board comes with the BMV080 populated and takes advantage of its flexible cable with the FPC 13-pin 0.33mm connector. On the back of the board is a horizontal Qwiic connector to reduce the amount of soldering on the board. However, the board still breaks out 0.1"-spaced pins for users who prefer a soldered connection or prototyping the pins on a breadboard. The breakout also includes four jumper selectable I2C addresses if you happen to connect more than one BMV080 on the same I2C port. While the breakout was designed for I2C by default, you can also configure the board's jumper to communicate over SPI as well. A special lens allows the laser to pass through the enclosure to take measurements.
Note
To use this library, the Bosch BMV080 SDK must be downloaded from Bosch, and some files copied over into this library once it's installed. Details of this are outlined below here.
If the SDK files are not copied into this library, this library will fail to build.
This library has been verified with the following versions: SparkFun_BMV_Arduino_Library v1.0.1 Bosch BMV080 SDK v11.0.0 Arduino IDE 2.3.5
Architectures Supported/Verified: esp32 (SparkFun Thing Plus - ESP32 WROOM (USB-C)) esp32s2 (SparkFun Thing Plus - ESP32-S2 WROOM) m33f (SparkFun Thing Plus - RA6M5)
The Air Quality PM1/PM2.5/PM10 Sensor - BMV080 can run as an I2C client device, or as a SPI client device. Once connected, the library allows the collaction of PM1, PM2.5 and PM10 readings as well as if the sensor is obstructed.
The library enables setting a variety of sensor settings, properties and operating conditions.
Note
This library uses an pre-compiled archive library provided by Bosch, which is linked to this Arduino library and build time. As such, board support is limited to platforms the Bosch library supports.
Consult the architecture directories in the src folder of this library. Additional information is available from the Bosch BMV080 SDK Documentation.
| Reference | Description |
|---|---|
| Quick Reference | A quick reference API for the the main library object sfDevBMV080 |
| Full Documentation | The full documentation and API for this Arduino library |
| SparkFun Air Quality PM1/PM2.5/PM10 Sensor - BMV080 | Hardware GitHub Repository |
| Hook Up Guide | Hardware Overview and Quick Start for the Air Quality Sensor - BMV080 |
The following examples are provided with the library
| Example | Description |
|---|---|
| Basic Readings | The sensor is initialized, and the values for PM1, PM2.5 and PM10 are output to the console. |
| Duty Cycle | The sensor is placed in a 20 second Duty Cycle mode - with PM 2.5 values read and output every 20 seconds |
| Interruput | Readings are driven by a sensor Interrupt |
| SPI | The sensor is connected to using an SPI connection |
| Set/Get Parameters | Shows how to set and get sensor prameters using the library |
| Two Sensors | Shows how two sensors can operate using the same system |
| Demo Alphanumeric | A demo script that outputs sensed data to an Alpha Numeric display |
| Demo - OLED | Demo that outputs sensor information to a connected OLED display |
| Open - Close | Shows how to open the sensor, take a set of readings and then close the sensor |
To use this library with SparkFun BMV080 Air Quality Sensor, the Bosch SDK for the BMV080 must be installed and files copied into the correct locations within this library.
The following outlines how to install the library.
Using the Arduino Library Manager, install this library.
The SDK is avilable on this page. Select the 'Download the SDK for BMV080` link/button.
Once downloaded, unzip the file.
Files from the SDK must be copied into the installation of this library. This, the SparkFun BMV080 Arduino library, is installed in the following locations:
| OS | Directory |
|---|---|
| macOS | $HOME/Documents/Arduino/libraries/SparkFun_BMV080_Arduino_Library |
| Windows | $HOME\Documents\Arduino\libraries\SparkFun_BMV080_Arduino_Library |
| Linux | $HOME/Arduino/libraries/SparkFun_BMV080_Arduino_Library |
From the Bosch SDK, the following files are copied into the specified library locations.
| Bosch SDK File | SparkFun BMV080 Arduino Library Directory |
|---|---|
| api/inc/bmv080.h | src/sfTk/bmv080.h |
| api/inc/bmv080_defs.h | src/sfTk/bmv080_defs.h |
| api/api/lib/xtensa_esp32/xtensa_esp32_elf_gcc/release/lib_bmv080.a | src/esp32/lib_bmv080.a |
| api/api/lib/xtensa_esp32/xtensa_esp32_elf_gcc/release/lib_postProcessor.a | src/esp32/lib_postProcessor.a |
| api/api/lib/xtensa_esp32s2/xtensa_esp32s2_elf_gcc/release/lib_postProcessor.a | src/esp32s2/lib_postProcessor.a |
| api/api/lib/xtensa_esp32s2/xtensa_esp32s2_elf_gcc/release/lib_bmv080.a | src/esp32s2/lib_bmv080.a |
| api/api/lib/xtensa_esp32s3/xtensa_esp32s3_elf_gcc/release/lib_postProcessor.a | src/esp32s3/lib_postProcessor.a |
| api/api/lib/xtensa_esp32s3/xtensa_esp32s3_elf_gcc/release/lib_bmv080.a | src/esp32s3/lib_bmv080.a |
| api/api/lib/arm_cortex_m0plus/xarm_none_eabi_gcc/release/lib_postProcessor.a | src/cortex-m0plus/lib_postProcessor.a |
| api/api/lib/arm_cortex_m0plus/arm_none_eabi_gcc/release/lib_bmv080.a | src/cortex-m0plus/lib_bmv080.a |
| api/api/lib/arm_cortex_m33f/xarm_none_eabi_gcc/release/lib_postProcessor.a | src/cortex-m33/lib_postProcessor.a |
| api/api/lib/arm_cortex_m33f/arm_none_eabi_gcc/release/lib_bmv080.a | src/cortex-m33/lib_bmv080.a |
| api/api/lib/arm_cortex_m4/xarm_none_eabi_gcc/release/lib_postProcessor.a | src/cortex-m4/lib_postProcessor.a |
| api/api/lib/arm_cortex_m4/arm_none_eabi_gcc/release/lib_bmv080.a | src/cortex-m4/lib_bmv080.a |
| api/api/lib/arm_cortex_m4f/xarm_none_eabi_gcc/release/lib_postProcessor.a | src/cortex-m4f/lib_postProcessor.a |
| api/api/lib/arm_cortex_m4f/arm_none_eabi_gcc/release/lib_bmv080.a | src/cortex-m4f/lib_bmv080.a |
Once the files are copied into place, this library is available for use.
This product is open source!
This product is licensed using the MIT Open Source License.