updated examples to use the new core changes -- not validated yet

gigapod · gigapod · commit d62988bb96f1 · 2025-02-06T16:05:23.000-07:00
diff --git a/examples/Example_01_BasicReadings/Example_01_BasicReadings.ino b/examples/Example_01_BasicReadings/Example_01_BasicReadings.ino
@@ -81,16 +81,16 @@ void setup()
 
 void loop()
 {
-    if (bmv080.dataAvailable())
+    if (bmv080.isDataAvailable())
     {
-        float pm25 = bmv080.getPM25();
-        float pm1 = bmv080.getPM1();
+        float pm25 = bmv080.PM25();
+        float pm1 = bmv080.PM1();
 
         Serial.print(pm25);
         Serial.print("\t");
         Serial.print(pm1);
 
-        if (bmv080.getIsObstructed() == true)
+        if (bmv080.isObstructed() == true)
         {
             Serial.print("\tObstructed");
         }
diff --git a/examples/Example_02_DutyCycle/Example_02_DutyCycle.ino b/examples/Example_02_DutyCycle/Example_02_DutyCycle.ino
@@ -89,13 +89,13 @@ void setup()
 
 void loop()
 {
-    if(bmv080.dataAvailable())
+    if(bmv080.isDataAvailable())
     {
-        float pm25 = bmv080.getPM25();
+        float pm25 = bmv080.PM25();
 
         Serial.print(pm25);
 
-        if(bmv080.getIsObstructed() == true)
+        if(bmv080.isObstructed() == true)
         {
             Serial.print("\tObstructed");
         }
diff --git a/examples/Example_03_Interrupt/Example_03_Interrupt.ino b/examples/Example_03_Interrupt/Example_03_Interrupt.ino
@@ -95,11 +95,11 @@ void loop()
         int_flag = false; // Reset the flag
         do{
             Serial.println("Reading BMV080");
-            if(bmv080.dataAvailable())
+            if(bmv080.isDataAvailable())
             {
-                float pm25 = bmv080.getPM25();
+                float pm25 = bmv080.PM25();
                 Serial.print(pm25);
-                if(bmv080.getIsObstructed() == true)
+                if(bmv080.isObstructed() == true)
                 {
                     Serial.print("\tObstructed");
                 }
diff --git a/examples/Example_04_SPI/Example_04_SPI.ino b/examples/Example_04_SPI/Example_04_SPI.ino
@@ -80,13 +80,13 @@ void setup()
 
 void loop()
 {
-    if(bmv080.dataAvailable())
+    if(bmv080.isDataAvailable())
     {
-        float pm25 = bmv080.getPM25();
+        float pm25 = bmv080.PM25();
 
         Serial.print(pm25);
 
-        if(bmv080.getIsObstructed() == true)
+        if(bmv080.isObstructed() == true)
         {
             Serial.print("\tObstructed");
         }
diff --git a/examples/Example_05_Parameters/Example_05_Parameters.ino b/examples/Example_05_Parameters/Example_05_Parameters.ino
@@ -91,13 +91,13 @@ void setup()
 
 void loop()
 {
-    if(bmv080.dataAvailable())
+    if(bmv080.isDataAvailable())
     {
-        float pm25 = bmv080.getPM25();
+        float pm25 = bmv080.PM25();
 
         Serial.print(pm25);
 
-        if(bmv080.getIsObstructed() == true)
+        if(bmv080.isObstructed() == true)
         {
             Serial.print("\tObstructed");
         }
@@ -128,22 +128,22 @@ void getSetParameters(void)
 
 
     /* Get default parameter "volumetric_mass_density" */
-    volumetric_mass_density = bmv080.getVolumetricMassDensity();
+    volumetric_mass_density = bmv080.volumetricMassDensity();
     Serial.print("BMV080 parameter 'volumetric_mass_density' READ: ");
     Serial.println(volumetric_mass_density);
 
     /* Get default parameter "integration_time" */
-    integration_time = bmv080.getIntegrationTime();
+    integration_time = bmv080.integrationTime();
     Serial.print("BMV080 parameter 'integration_time' READ: ");
     Serial.println(integration_time);
 
     /* Get default parameter "distribution_id" */
-    distribution_id = bmv080.getDistributionId();
+    distribution_id = bmv080.distributionId();
     Serial.print("BMV080 parameter 'distribution_id' READ: ");
     Serial.println(distribution_id);
 
     /* Get default parameter "do_obstruction_detection" */
-    do_obstruction_detection = bmv080.getDoObstructionDetection();
+    do_obstruction_detection = bmv080.doObstructionDetection();
     Serial.print("BMV080 parameter 'do_obstruction_detection' READ: ");
     if(do_obstruction_detection == true)
     {
@@ -155,7 +155,7 @@ void getSetParameters(void)
     }
 
     /* Get default parameter "do_vibration_filtering" */
-    do_vibration_filtering = bmv080.getDoVibrationFiltering();
+    do_vibration_filtering = bmv080.doVibrationFiltering();
     Serial.print("BMV080 parameter 'do_vibration_filtering' READ: ");
     if(do_vibration_filtering == true)
     {
@@ -167,7 +167,7 @@ void getSetParameters(void)
     }
 
     /* Get default parameter "measurement_algorithm" */
-    measurementAlgorithm = bmv080.getMeasurementAlgorithm();
+    measurementAlgorithm = bmv080.measurementAlgorithm();
     Serial.print("BMV080 parameter 'measurement_algorithm' READ: ");
     switch (measurementAlgorithm)
     {
diff --git a/examples/Example_06_TwoSensors/Example_06_TwoSensors.ino b/examples/Example_06_TwoSensors/Example_06_TwoSensors.ino
@@ -121,26 +121,26 @@ void setup()
 
 void loop()
 {
-    if (bmv080.dataAvailable())
+    if (bmv080.isDataAvailable())
     {
-        pm25 = bmv080.getPM25();
-        isObstructed = bmv080.getIsObstructed();
+        pm25 = bmv080.PM25();
+        isObstructed = bmv080.isObstructed();
         newDataAvailable = true;
         //Serial.println("Sensor 1 data available");
     }
     delay(200); // needs a ~200ms delay in between talking to each sensor
 
-    if (bmv080_2.dataAvailable())
+    if (bmv080_2.isDataAvailable())
     {
-        pm25_2 = bmv080_2.getPM25();
-        isObstructed2 = bmv080_2.getIsObstructed();
+        pm25_2 = bmv080_2.PM25();
+        isObstructed2 = bmv080_2.isObstructed();
         newDataAvailable2 = true;
         //Serial.println("Sensor 2 data available");
     }
 
     delay(200); // needs a ~200ms delay in between talking to each sensor
 
-    if (newDataAvailable & newDataAvailable2)
+    if (newDataAvailable && newDataAvailable2)
     {
         //Serial.print("Sensor 1: ");
 
diff --git a/examples/Example_07_Demo_Alphanumeric/Example_07_Demo_Alphanumeric.ino b/examples/Example_07_Demo_Alphanumeric/Example_07_Demo_Alphanumeric.ino
@@ -100,14 +100,14 @@ void setup()
 
 void loop()
 {
-    if (bmv080.dataAvailable())
+    if (bmv080.isDataAvailable())
     {
-        float pm25 = bmv080.getPM25();
+        float pm25 = bmv080.PM25();
 
         Serial.print(pm25);
         display.print(int(pm25));
 
-        if (bmv080.getIsObstructed() == true)
+        if (bmv080.isObstructed() == true)
         {
             Serial.print("\tObstructed");
             display.print("Obst");
diff --git a/examples/Example_08_Demo_Oled/Example_08_Demo_Oled.ino b/examples/Example_08_Demo_Oled/Example_08_Demo_Oled.ino
@@ -182,10 +182,10 @@ void setup()
 
 void loop()
 {
-    if (bmv080.dataAvailable())
+    if (bmv080.isDataAvailable())
     {
-        pm25Value = bmv080.getPM25();
-        pm1Value = bmv080.getPM1();
+        pm25Value = bmv080.PM25();
+        pm1Value = bmv080.PM1();
 
         Serial.print(pm1Value);
         Serial.print("\t");
@@ -200,7 +200,7 @@ void loop()
         writeBatteryLevelToDisplay();
         myOLED.display(); // actually command the display to show the scene
 
-        if (bmv080.getIsObstructed() == true)
+        if (bmv080.isObstructed() == true)
         {
             Serial.print("\tObstructed");
             writeObstructedBoarder();

Original file line number	Diff line number	Diff line change
`@@ -81,16 +81,16 @@ void setup()`
`81`	`81`
`82`	`82`	`void loop()`
`83`	`83`	`{`
`84`		`- if (bmv080.dataAvailable())`
	`84`	`+ if (bmv080.isDataAvailable())`
`85`	`85`	`{`
`86`		`- float pm25 = bmv080.getPM25();`
`87`		`- float pm1 = bmv080.getPM1();`
	`86`	`+ float pm25 = bmv080.PM25();`
	`87`	`+ float pm1 = bmv080.PM1();`
`88`	`88`
`89`	`89`	`Serial.print(pm25);`
`90`	`90`	`Serial.print("\t");`
`91`	`91`	`Serial.print(pm1);`
`92`	`92`
`93`		`- if (bmv080.getIsObstructed() == true)`
	`93`	`+ if (bmv080.isObstructed() == true)`
`94`	`94`	`{`
`95`	`95`	`Serial.print("\tObstructed");`
`96`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,13 +89,13 @@ void setup()`
`89`	`89`
`90`	`90`	`void loop()`
`91`	`91`	`{`
`92`		`- if(bmv080.dataAvailable())`
	`92`	`+ if(bmv080.isDataAvailable())`
`93`	`93`	`{`
`94`		`- float pm25 = bmv080.getPM25();`
	`94`	`+ float pm25 = bmv080.PM25();`
`95`	`95`
`96`	`96`	`Serial.print(pm25);`
`97`	`97`
`98`		`- if(bmv080.getIsObstructed() == true)`
	`98`	`+ if(bmv080.isObstructed() == true)`
`99`	`99`	`{`
`100`	`100`	`Serial.print("\tObstructed");`
`101`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,11 +95,11 @@ void loop()`
`95`	`95`	`int_flag = false; // Reset the flag`
`96`	`96`	`do{`
`97`	`97`	`Serial.println("Reading BMV080");`
`98`		`- if(bmv080.dataAvailable())`
	`98`	`+ if(bmv080.isDataAvailable())`
`99`	`99`	`{`
`100`		`- float pm25 = bmv080.getPM25();`
	`100`	`+ float pm25 = bmv080.PM25();`
`101`	`101`	`Serial.print(pm25);`
`102`		`- if(bmv080.getIsObstructed() == true)`
	`102`	`+ if(bmv080.isObstructed() == true)`
`103`	`103`	`{`
`104`	`104`	`Serial.print("\tObstructed");`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,13 +80,13 @@ void setup()`
`80`	`80`
`81`	`81`	`void loop()`
`82`	`82`	`{`
`83`		`- if(bmv080.dataAvailable())`
	`83`	`+ if(bmv080.isDataAvailable())`
`84`	`84`	`{`
`85`		`- float pm25 = bmv080.getPM25();`
	`85`	`+ float pm25 = bmv080.PM25();`
`86`	`86`
`87`	`87`	`Serial.print(pm25);`
`88`	`88`
`89`		`- if(bmv080.getIsObstructed() == true)`
	`89`	`+ if(bmv080.isObstructed() == true)`
`90`	`90`	`{`
`91`	`91`	`Serial.print("\tObstructed");`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,13 +91,13 @@ void setup()`
`91`	`91`
`92`	`92`	`void loop()`
`93`	`93`	`{`
`94`		`- if(bmv080.dataAvailable())`
	`94`	`+ if(bmv080.isDataAvailable())`
`95`	`95`	`{`
`96`		`- float pm25 = bmv080.getPM25();`
	`96`	`+ float pm25 = bmv080.PM25();`
`97`	`97`
`98`	`98`	`Serial.print(pm25);`
`99`	`99`
`100`		`- if(bmv080.getIsObstructed() == true)`
	`100`	`+ if(bmv080.isObstructed() == true)`
`101`	`101`	`{`
`102`	`102`	`Serial.print("\tObstructed");`
`103`	`103`	`}`
`@@ -128,22 +128,22 @@ void getSetParameters(void)`
`128`	`128`
`129`	`129`
`130`	`130`	`/* Get default parameter "volumetric_mass_density" */`
`131`		`- volumetric_mass_density = bmv080.getVolumetricMassDensity();`
	`131`	`+ volumetric_mass_density = bmv080.volumetricMassDensity();`
`132`	`132`	`Serial.print("BMV080 parameter 'volumetric_mass_density' READ: ");`
`133`	`133`	`Serial.println(volumetric_mass_density);`
`134`	`134`
`135`	`135`	`/* Get default parameter "integration_time" */`
`136`		`- integration_time = bmv080.getIntegrationTime();`
	`136`	`+ integration_time = bmv080.integrationTime();`
`137`	`137`	`Serial.print("BMV080 parameter 'integration_time' READ: ");`
`138`	`138`	`Serial.println(integration_time);`
`139`	`139`
`140`	`140`	`/* Get default parameter "distribution_id" */`
`141`		`- distribution_id = bmv080.getDistributionId();`
	`141`	`+ distribution_id = bmv080.distributionId();`
`142`	`142`	`Serial.print("BMV080 parameter 'distribution_id' READ: ");`
`143`	`143`	`Serial.println(distribution_id);`
`144`	`144`
`145`	`145`	`/* Get default parameter "do_obstruction_detection" */`
`146`		`- do_obstruction_detection = bmv080.getDoObstructionDetection();`
	`146`	`+ do_obstruction_detection = bmv080.doObstructionDetection();`
`147`	`147`	`Serial.print("BMV080 parameter 'do_obstruction_detection' READ: ");`
`148`	`148`	`if(do_obstruction_detection == true)`
`149`	`149`	`{`
`@@ -155,7 +155,7 @@ void getSetParameters(void)`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`/* Get default parameter "do_vibration_filtering" */`
`158`		`- do_vibration_filtering = bmv080.getDoVibrationFiltering();`
	`158`	`+ do_vibration_filtering = bmv080.doVibrationFiltering();`
`159`	`159`	`Serial.print("BMV080 parameter 'do_vibration_filtering' READ: ");`
`160`	`160`	`if(do_vibration_filtering == true)`
`161`	`161`	`{`
`@@ -167,7 +167,7 @@ void getSetParameters(void)`
`167`	`167`	`}`
`168`	`168`
`169`	`169`	`/* Get default parameter "measurement_algorithm" */`
`170`		`- measurementAlgorithm = bmv080.getMeasurementAlgorithm();`
	`170`	`+ measurementAlgorithm = bmv080.measurementAlgorithm();`
`171`	`171`	`Serial.print("BMV080 parameter 'measurement_algorithm' READ: ");`
`172`	`172`	`switch (measurementAlgorithm)`
`173`	`173`	`{`
Original file line number	Diff line number	Diff line change
`@@ -121,26 +121,26 @@ void setup()`
`121`	`121`
`122`	`122`	`void loop()`
`123`	`123`	`{`
`124`		`- if (bmv080.dataAvailable())`
	`124`	`+ if (bmv080.isDataAvailable())`
`125`	`125`	`{`
`126`		`- pm25 = bmv080.getPM25();`
`127`		`- isObstructed = bmv080.getIsObstructed();`
	`126`	`+ pm25 = bmv080.PM25();`
	`127`	`+ isObstructed = bmv080.isObstructed();`
`128`	`128`	`newDataAvailable = true;`
`129`	`129`	`//Serial.println("Sensor 1 data available");`
`130`	`130`	`}`
`131`	`131`	`delay(200); // needs a ~200ms delay in between talking to each sensor`
`132`	`132`
`133`		`- if (bmv080_2.dataAvailable())`
	`133`	`+ if (bmv080_2.isDataAvailable())`
`134`	`134`	`{`
`135`		`- pm25_2 = bmv080_2.getPM25();`
`136`		`- isObstructed2 = bmv080_2.getIsObstructed();`
	`135`	`+ pm25_2 = bmv080_2.PM25();`
	`136`	`+ isObstructed2 = bmv080_2.isObstructed();`
`137`	`137`	`newDataAvailable2 = true;`
`138`	`138`	`//Serial.println("Sensor 2 data available");`
`139`	`139`	`}`
`140`	`140`
`141`	`141`	`delay(200); // needs a ~200ms delay in between talking to each sensor`
`142`	`142`
`143`		`- if (newDataAvailable & newDataAvailable2)`
	`143`	`+ if (newDataAvailable && newDataAvailable2)`
`144`	`144`	`{`
`145`	`145`	`//Serial.print("Sensor 1: ");`
`146`	`146`
Original file line number	Diff line number	Diff line change
`@@ -100,14 +100,14 @@ void setup()`
`100`	`100`
`101`	`101`	`void loop()`
`102`	`102`	`{`
`103`		`- if (bmv080.dataAvailable())`
	`103`	`+ if (bmv080.isDataAvailable())`
`104`	`104`	`{`
`105`		`- float pm25 = bmv080.getPM25();`
	`105`	`+ float pm25 = bmv080.PM25();`
`106`	`106`
`107`	`107`	`Serial.print(pm25);`
`108`	`108`	`display.print(int(pm25));`
`109`	`109`
`110`		`- if (bmv080.getIsObstructed() == true)`
	`110`	`+ if (bmv080.isObstructed() == true)`
`111`	`111`	`{`
`112`	`112`	`Serial.print("\tObstructed");`
`113`	`113`	`display.print("Obst");`
Original file line number	Diff line number	Diff line change
`@@ -182,10 +182,10 @@ void setup()`
`182`	`182`
`183`	`183`	`void loop()`
`184`	`184`	`{`
`185`		`- if (bmv080.dataAvailable())`
	`185`	`+ if (bmv080.isDataAvailable())`
`186`	`186`	`{`
`187`		`- pm25Value = bmv080.getPM25();`
`188`		`- pm1Value = bmv080.getPM1();`
	`187`	`+ pm25Value = bmv080.PM25();`
	`188`	`+ pm1Value = bmv080.PM1();`
`189`	`189`
`190`	`190`	`Serial.print(pm1Value);`
`191`	`191`	`Serial.print("\t");`
`@@ -200,7 +200,7 @@ void loop()`
`200`	`200`	`writeBatteryLevelToDisplay();`
`201`	`201`	`myOLED.display(); // actually command the display to show the scene`
`202`	`202`
`203`		`- if (bmv080.getIsObstructed() == true)`
	`203`	`+ if (bmv080.isObstructed() == true)`
`204`	`204`	`{`
`205`	`205`	`Serial.print("\tObstructed");`
`206`	`206`	`writeObstructedBoarder();`