Merge pull request #8 from sparkfun/feature/remove-bosch-sdk

Feature/remove bosch sdk

Author: gigapod

.github/workflows/compile-sketch.yml

@@ -1,9 +1,6 @@
 name: Cross-compilation test
 
 on:
-  push:
-    branches:
-      - main
   workflow_dispatch:
 
 

README.md

@@ -15,6 +15,21 @@ The [SparkFun Air Quality PM1/PM2.5/PM10 Sensor - BMV080 (Qwiic)](https://www.sp
 
 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](#install-the-bosch-sdk).
+>
+> 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)](https://www.sparkfun.com/sparkfun-thing-plus-esp32-wroom-usb-c.html))
+> esp32s2 ([SparkFun Thing Plus - ESP32-S2 WROOM](https://www.sparkfun.com/sparkfun-thing-plus-esp32-s2-wroom.html))
+> m33f ([SparkFun Thing Plus - RA6M5](https://www.sparkfun.com/sparkfun-thing-plus-ra6m5.html))
+
 ## Functionality
 
 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.
@@ -52,6 +67,61 @@ The following examples are provided with the library
 |[Demo - OLED](examples/Example_08_Demo_Oled/Example_08_Demo_Oled.ino)| Demo that outputs sensor information to a connected OLED display|
 |[Open - Close](examples/Example_09_OpenClose/Example_09_OpenClose.ino)|Shows how to open the sensor, take a set of readings and then close the sensor|
 
+## Install the Bosch SDK
+
+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.
+
+### Install this library
+
+Using the Arduino Library Manager, install this library.
+
+![Install Library](docs/images/sdk-arduino-install.png)
+
+## Download the Bosch BMV080 SDK
+
+The SDK is avilable [on this page](https://www.bosch-sensortec.com/products/environmental-sensors/particulate-matter-sensor/bmv080/#documents). Select the 'Download the SDK for BMV080` link/button.
+
+Once downloaded, unzip the file.
+
+## Copy Files
+
+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:
+
+### Library Install Directory
+
+| 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|
+
+### Files to copy and locations to copy to
+
+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.
+
 ## License Information
 
 This product is ***open source***!

docs/images/sdk-arduino-install.png

@@ -14,26 +14,33 @@ SparkFunBMV080SPI KEYWORD1
 begin KEYWORD2
 init KEYWORD2
 isConnected KEYWORD2
-getDriverVersion KEYWORD2
+driverVersion KEYWORD2
 open KEYWORD2
+close KEYWORD2
 reset KEYWORD2
-getID KEYWORD2
+ID KEYWORD2
 setMode KEYWORD2
-getPM25 KEYWORD2
-getIsObstructed KEYWORD2
+PM10 KEYWORD2
+PM25 KEYWORD2
+PM1 KEYWORD2
+isObstructed KEYWORD2
+setSensorValue KEYWORD2
+readSensor KEYWORD2
 dataAvailable KEYWORD2
-getDutyCyclingPeriod KEYWORD2
+dutyCyclingPeriod KEYWORD2
 setDutyCyclingPeriod KEYWORD2
-getVolumetricMassDensity KEYWORD2
+volumetricMassDensity KEYWORD2
 setVolumetricMassDensity KEYWORD2
-getIntegrationTime KEYWORD2
+integrationTime KEYWORD2
 setIntegrationTime KEYWORD2
-getDistributionId KEYWORD2
+distributionId KEYWORD2
 setDistributionId KEYWORD2
-getDoObstructionDetection KEYWORD2
+doObstructionDetection KEYWORD2
 setDoObstructionDetection KEYWORD2
-getDoVibrationFiltering KEYWORD2
+doVibrationFiltering KEYWORD2
 setDoVibrationFiltering KEYWORD2
+measurementAlgorithm KEYWORD2
+setMeasurementAlgorithm KEYWORD2
 
 #########################################################
 # Constants

keywords.txt

@@ -1,12 +1,12 @@
 name=SparkFun BMV080 Arduino Library
-version=1.0.0
+version=1.0.1
 author=SparkFun Electronics <[email protected]>
 maintainer=SparkFun Electronics <https://www.sparkfun.com>
-sentence=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. 
-paragraph=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.
+sentence=The SparkFun Air Quality PM1/PM2.5/PM10 Sensor - BMV080 (Qwiic)is an ultra-small, fan-less air quality sensor for sensing particulate matter! 
+paragraph=NOTE: This library requires the installation of the Bosch BMV080 SDK - See https://github.com/sparkfun/SparkFun_BMV080_Arduino_Library for instructions. 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.
 category=Sensors
 url=https://github.com/sparkfun/SparkFun_BMV080_Arduino_Library
 architectures=esp32,esp32s2,esp32s3,cortex-m33,cortex-m0plus,cortex-m4f
 precompiled=true
 depends=SparkFun Toolkit (>=1.0.0)
-ldflags=-lbmv080 -lpostProcessor
+ldflags=-l_bmv080 -l_postProcessor

library.properties

@@ -0,0 +1,14 @@
+# Install the BOSCH BMV080 SDK library files for this folder
+
+### From the Bosch BMV080 SDK, copy the following files to this folder.
+
+Using a shell:
+
+Where BOSCH_SDK = *The install directory of the downloaded Bosch SDK*
+
+```sh
+cp $BOSCH_SDK/arm_cortex_m0plus/arm_none_eabi_gcc/release/lib_bmv080.a   lib_bmv080.a
+cp $BOSCH_SDK/arm_cortex_m0plus/arm_none_eabi_gcc/release/lib_postProcessor.a   lib_postProcessor.a
+```
+
+Or just drag and drop via a GUI interface.

src/cortex-m0plus/README.md

@@ -0,0 +1,14 @@
+# Install the BOSCH BMV080 SDK library files for this folder
+
+### From the Bosch BMV080 SDK, copy the following files to this folder.
+
+Using a shell:
+
+Where BOSCH_SDK = *The install directory of the downloaded Bosch SDK*
+
+```sh
+cp $BOSCH_SDK/arm_cortex_m33f/arm_none_eabi_gcc/release/lib_bmv080.a   lib_bmv080.a
+cp $BOSCH_SDK/arm_cortex_m33f/arm_none_eabi_gcc/release/lib_postProcessor.a   lib_postProcessor.a
+```
+
+Or just drag and drop via a GUI interface.

src/cortex-m0plus/libbmv080.a

@@ -0,0 +1,14 @@
+# Install the BOSCH BMV080 SDK library files for this folder
+
+### From the Bosch BMV080 SDK, copy the following files to this folder.
+
+Using a shell:
+
+Where BOSCH_SDK = *The install directory of the downloaded Bosch SDK*
+
+```sh
+cp $BOSCH_SDK/arm_cortex_m4/arm_none_eabi_gcc/release/lib_bmv080.a   lib_bmv080.a
+cp $BOSCH_SDK/arm_cortex_m4/arm_none_eabi_gcc/release/lib_postProcessor.a   lib_postProcessor.a
+```
+
+Or just drag and drop via a GUI interface.

src/cortex-m0plus/libpostProcessor.a

@@ -0,0 +1,14 @@
+# Install the BOSCH BMV080 SDK library files for this folder
+
+### From the Bosch BMV080 SDK, copy the following files to this folder.
+
+Using a shell:
+
+Where BOSCH_SDK = *The install directory of the downloaded Bosch SDK*
+
+```sh
+cp $BOSCH_SDK/arm_cortex_m4f/arm_none_eabi_gcc/release/lib_bmv080.a   lib_bmv080.a
+cp $BOSCH_SDK/arm_cortex_m4f/arm_none_eabi_gcc/release/lib_postProcessor.a   lib_postProcessor.a
+```
+
+Or just drag and drop via a GUI interface.

src/cortex-m33/README.md

@@ -0,0 +1,14 @@
+# Install the BOSCH BMV080 SDK library files for this folder
+
+### From the Bosch BMV080 SDK, copy the following files to this folder.
+
+Using a shell:
+
+Where BOSCH_SDK = *The install directory of the downloaded Bosch SDK*
+
+```sh
+cp $BOSCH_SDK/xtensa_esp32/xtensa_esp32_elf_gcc/release/lib_bmv080.a   lib_bmv080.a
+cp $BOSCH_SDK/xtensa_esp32/xtensa_esp32_elf_gcc/release/lib_postProcessor.a   lib_postProcessor.a
+```
+
+Or just drag and drop via a GUI interface.

src/cortex-m33/libbmv080.a

@@ -0,0 +1,14 @@
+# Install the BOSCH BMV080 SDK library files for this folder
+
+### From the Bosch BMV080 SDK, copy the following files to this folder.
+
+Using a shell:
+
+Where BOSCH_SDK = *The install directory of the downloaded Bosch SDK*
+
+```sh
+cp $BOSCH_SDK/xtensa_esp32s2/xtensa_esp32s2_elf_gcc/release/lib_bmv080.a   lib_bmv080.a
+cp $BOSCH_SDK/xtensa_esp32s2/xtensa_esp32s2_elf_gcc/release/lib_postProcessor.a   lib_postProcessor.a
+```
+
+Or just drag and drop via a GUI interface.

src/cortex-m33/libpostProcessor.a

@@ -0,0 +1,14 @@
+# Install the BOSCH BMV080 SDK library files for this folder
+
+### From the Bosch BMV080 SDK, copy the following files to this folder.
+
+Using a shell:
+
+Where BOSCH_SDK = *The install directory of the downloaded Bosch SDK*
+
+```sh
+cp $BOSCH_SDK/xtensa_esp32s3/xtensa_esp32s3_elf_gcc/release/lib_bmv080.a   lib_bmv080.a
+cp $BOSCH_SDK/xtensa_esp32s3/xtensa_esp32s3_elf_gcc/release/lib_postProcessor.a   lib_postProcessor.a
+```
+
+Or just drag and drop via a GUI interface.