Merge pull request #9 from sparkfun/feature/class-refactor

Feature/class refactor

Author: gigapod

README.md

@@ -13,13 +13,21 @@ Arduino Library for the SparkFun Pulsed Coherent Radar Sensor
 ![GitHub issues](https://img.shields.io/github/issues/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
 
 
-
 The [SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125 (SEN-24540)](https://www.sparkfun.com/sparkfun-pulsed-coherent-radar-sensor-acconeer-xm125-qwiic.html) brings powerful 60 GHz radar technology to your projects. This sensor isn't limited to surface detection; it can see through walls, cabinets, and even pockets (depending on the material), making it perfect for unique applications. Measure distances with millimeter precision, detect motion, the speed of an object, or even gestures!
 
 The XM125 boasts an impressive range of up to 20 meters, allowing you to create long-range sensing projects. The actual measurable distance is dependent on the object size, shape, dielectric properties, and lens (e.g. water level measurements up to 20 meters with lens utilization, human presence detection up to 7 meters with lens-free utilization). Despite its power, the sensor has remarkably low in power consumption, which is ideal for battery-powered applications. The real magic lies in the sensor's ability to do more than measure distance; the XM125 can differentiate between stationary objects and moving targets using pulsed coherent radar. This means you can sense an object's presence and how fast something is moving!
 
 Looking for the board that matches this library - pick up a [SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125 (Qwiic)](https://www.sparkfun.com/sparkfun-pulsed-coherent-radar-sensor-acconeer-xm125-qwiic.html) at www.sparkfun.com.
 
+### *Upgrading to Version 2.\* from Version 1.\**
+
+Version 2.0+ of this library is not compatible with Version 1.* implementations/use. For Version 2.0, the single class defined by the library, `SparkFunXM125`, was divided into two distinct classes:
+
+*  SparkFunXM125Distance - Used when the XM125 is running the ***Distance*** application
+*  SparkFunXM125Presence - Used when the XM125 is running the ***Presence*** application
+
+Moving to use Version 2.0 of the library just requires changing the class name used in your sketch - from `SparkFunXM125` to either `SparkFunXM125Distance` or `SparkFunXM125Presence`
+
 ## Functionality
 
 The SparkFun Pulsed Coherent Radar sensor can run as an I2C client device, or as a standalone development board. This library is used when the sensor is operating as a standalone I2C device. 

examples/Example01_PresenceBasicReadings/Example01_PresenceBasicReadings.ino

@@ -4,14 +4,14 @@
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
   This example shows how operate the XM125 when the device is in Presence Reading Mode.
-  The sensor is initialized, then the presence distance values will print out 
+  The sensor is initialized, then the presence distance values will print out
   to the terminal.
 
   By: Madison Chodikov
   SparkFun Electronics
   Date: 2024/1/22
   SparkFun code, firmware, and software is released under the MIT License.
-	Please see LICENSE.md for further details.
+    Please see LICENSE.md for further details.
 
   Hardware Connections:
   QWIIC --> QWIIC
@@ -21,15 +21,15 @@
   Feel like supporting our work? Buy a board from SparkFun!
   https://www.sparkfun.com/products/ - Qwiic XM125 Breakout
 */
-#include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
+#include <Arduino.h>
 
-SparkFunXM125 radarSensor;
+SparkFunXM125Presence radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
 
-// Presence distance values 
+// Presence distance values
 uint32_t distance = 0;
 
 // Error statuses
@@ -50,7 +50,7 @@ void setup()
 
     // If begin is successful (1), then start example
     int startErr = radarSensor.begin(i2cAddress, Wire);
-    if(startErr == 1)
+    if (startErr == 1)
     {
         Serial.println("Begin");
     }
@@ -59,15 +59,16 @@ void setup()
         Serial.print("Start Error Code: ");
         Serial.println(startErr);
         Serial.println("Device failed to setup - Freezing code.");
-        while(1); // Runs forever
+        while (1)
+            ; // Runs forever
     }
 
     // Start the sensor with default register values
     int32_t setupError = radarSensor.presenceDetectorStart();
-    if(setupError != 0)
+    if (setupError != 0)
     {
-      Serial.print("Presence Detection Start Setup Error: ");
-      Serial.println(setupError); 
+        Serial.print("Presence Detection Start Setup Error: ");
+        Serial.println(setupError);
     }
 
     // New line and delay for easier reading
@@ -83,23 +84,23 @@ void loop()
     // Get the presence distance value and print out if no errors
     presValError = radarSensor.getPresenceDistanceValuemm(distance);
 
-    if(presValError == 0)
+    if (presValError == 0)
     {
-      Serial.print("Presence Detected: ");
-      Serial.print(distance);
-      Serial.println("mm");
-      //Serial.print(distance * .1);
-      //Serial.println("cm");
-      //Serial.print(distance * .001);
-      //Serial.println("m");
-      //Serial.print(distance * .001);
-      //Serial.println("m");
-      //Serial.print(distance * .03937008);
-      //Serial.println("In");
+        Serial.print("Presence Detected: ");
+        Serial.print(distance);
+        Serial.println("mm");
+        // Serial.print(distance * .1);
+        // Serial.println("cm");
+        // Serial.print(distance * .001);
+        // Serial.println("m");
+        // Serial.print(distance * .001);
+        // Serial.println("m");
+        // Serial.print(distance * .03937008);
+        // Serial.println("In");
     }
     else
     {
-      Serial.println("Error returning presence distance value");
+        Serial.println("Error returning presence distance value");
     }
 
     // Delay 0.5 seconds between readings

examples/Example02_PresenceGPIO0Usage/Example02_PresenceGPIO0Usage.ino

@@ -4,14 +4,14 @@
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
   This example shows how operate the XM125 when the device is in Presence Reading Mode.
-  The sensor is initialized, then the presence values will print out to the terminal 
-  and trigger the GPIO0 pin high when there is a presence detected. 
+  The sensor is initialized, then the presence values will print out to the terminal
+  and trigger the GPIO0 pin high when there is a presence detected.
 
   By: Madison Chodikov
   SparkFun Electronics
   Date: 2024/1/22
   SparkFun code, firmware, and software is released under the MIT License.
-	Please see LICENSE.md for further details.
+    Please see LICENSE.md for further details.
 
   Hardware Connections:
   QWIIC --> QWIIC
@@ -21,15 +21,15 @@
   Feel like supporting our work? Buy a board from SparkFun!
   https://www.sparkfun.com/products/ - Qwiic XM125 Breakout
 */
-#include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
+#include <Arduino.h>
 
-SparkFunXM125 radarSensor;
+SparkFunXM125Presence radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
 
-// Presence distance values 
+// Presence distance values
 uint32_t distance = 0;
 uint32_t presenceDetected = 0;
 uint32_t presenceDetectedSticky = 0;
@@ -46,14 +46,14 @@ void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("XM125 Example 2: Presence GPIO0 Pin Usage");    
+    Serial.println("XM125 Example 2: Presence GPIO0 Pin Usage");
     Serial.println("");
 
     Wire.begin();
 
     // If begin is successful (0), then start example
     int startErr = radarSensor.begin(i2cAddress, Wire);
-    if(startErr == 1)
+    if (startErr == 1)
     {
         Serial.println("Begin");
     }
@@ -62,64 +62,65 @@ void setup()
         Serial.print("Start Error Code: ");
         Serial.println(startErr);
         Serial.println("Device failed to setup - Freezing code.");
-        while(1); // Runs forever
+        while (1)
+            ; // Runs forever
     }
 
     delay(200);
 
-  // Presence Sensor Setup
+    // Presence Sensor Setup
     // Reset sensor configuration to reapply configuration registers
     radarSensor.setPresenceCommand(SFE_XM125_PRESENCE_RESET_MODULE);
 
-    // Check error and busy bits 
+    // Check error and busy bits
     radarSensor.getPresenceDetectorErrorStatus(errorStatus);
-    if(errorStatus != 0)
+    if (errorStatus != 0)
     {
-      Serial.print("Detector status error: ");
-      Serial.println(errorStatus);
+        Serial.print("Detector status error: ");
+        Serial.println(errorStatus);
     }
 
     delay(100);
 
-    // Turn presence detection on GPIO0 on 
-    if(radarSensor.setPresenceDetectionOnGPIO(1) != 0)
+    // Turn presence detection on GPIO0 on
+    if (radarSensor.setPresenceDetectionOnGPIO(1) != 0)
     {
-      Serial.println("GPIO0 Pin Setup Error");
+        Serial.println("GPIO0 Pin Setup Error");
     }
     radarSensor.getPresenceDetectionOnGPIO(gpioUsage);
     Serial.print("GPIO0 Detection Status: ");
     Serial.println(gpioUsage);
 
-    // Apply configuration 
-    if(radarSensor.setPresenceCommand(SFE_XM125_PRESENCE_APPLY_CONFIGURATION) != 0)
+    // Apply configuration
+    if (radarSensor.setPresenceCommand(SFE_XM125_PRESENCE_APPLY_CONFIGURATION) != 0)
     {
-      // Check for errors
-      radarSensor.getPresenceDetectorErrorStatus(errorStatus);
-      if(errorStatus != 0)
-      {
-        Serial.print("Detector status error: ");
-        Serial.println(errorStatus);
-      }
-  
-      Serial.println("Configuration application error");
+        // Check for errors
+        radarSensor.getPresenceDetectorErrorStatus(errorStatus);
+        if (errorStatus != 0)
+        {
+            Serial.print("Detector status error: ");
+            Serial.println(errorStatus);
+        }
+
+        Serial.println("Configuration application error");
     }
 
     // Poll detector status until busy bit is cleared
-    if(radarSensor.presenceBusyWait() != 0)
+    if (radarSensor.presenceBusyWait() != 0)
     {
-      Serial.print("Busy wait error");
+        Serial.print("Busy wait error");
     }
 
-    // Check detector status 
+    // Check detector status
     radarSensor.getPresenceDetectorErrorStatus(errorStatus);
-    if(errorStatus != 0)
+    if (errorStatus != 0)
     {
-      Serial.print("Detector status error: ");
-      Serial.println(errorStatus);
+        Serial.print("Detector status error: ");
+        Serial.println(errorStatus);
     }
 
     Serial.println();
-    
+
     delay(1000);
 }
 
@@ -131,15 +132,15 @@ void loop()
     // Get the presence distance value and print out if no errors
     presValError = radarSensor.getPresenceDistanceValuemm(distance);
 
-    if(presValError == 0)
+    if (presValError == 0)
     {
-      Serial.print("Presence Detected: ");
-      Serial.print(distance);
-      Serial.println("mm");
+        Serial.print("Presence Detected: ");
+        Serial.print(distance);
+        Serial.println("mm");
     }
     else
     {
-      Serial.println("Error returning presence distance value");
+        Serial.println("Error returning presence distance value");
     }
 
     // Delay 0.5 seconds between readings

examples/Example03_PresenceSerialPlotter/Example03_PresenceSerialPlotter.ino

@@ -11,7 +11,7 @@
   SparkFun Electronics
   Date: 2024/1/22
   SparkFun code, firmware, and software is released under the MIT License.
-	Please see LICENSE.md for further details.
+    Please see LICENSE.md for further details.
 
   Hardware Connections:
   QWIIC --> QWIIC
@@ -21,15 +21,15 @@
   Feel like supporting our work? Buy a board from SparkFun!
   https://www.sparkfun.com/products/ - Qwiic XM125 Breakout
 */
-#include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
+#include <Arduino.h>
 
-SparkFunXM125 radarSensor;
+SparkFunXM125Presence radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
 
-// Presence distance values 
+// Presence distance values
 uint32_t distance = 0;
 uint32_t presenceDetected = 0;
 uint32_t presenceDetectedSticky = 0;
@@ -52,7 +52,7 @@ void setup()
 
     // If begin is successful (0), then start example
     int startErr = radarSensor.begin(i2cAddress, Wire);
-    if(startErr == 1)
+    if (startErr == 1)
     {
         Serial.println("Begin");
     }
@@ -61,17 +61,18 @@ void setup()
         Serial.print("Start Error Code: ");
         Serial.println(startErr);
         Serial.println("Device failed to setup - Freezing code.");
-        while(1); // Runs forever
+        while (1)
+            ; // Runs forever
     }
 
     delay(200);
 
     // Start the sensor with default register values
     int32_t setupError = radarSensor.presenceDetectorStart();
-    if(setupError != 0)
+    if (setupError != 0)
     {
-      Serial.print("Presence Detection Start Setup Error: ");
-      Serial.println(setupError); 
+        Serial.print("Presence Detection Start Setup Error: ");
+        Serial.println(setupError);
     }
 
     // New line and delay for easier reading
@@ -87,10 +88,10 @@ void loop()
     // Get the presence distance value and print out if no errors
     presValError = radarSensor.getPresenceDistanceValuemm(distance);
 
-    if(presValError == 0)
+    if (presValError == 0)
     {
-      radarSensor.getPresenceDistance(distance);
-      Serial.println(distance);
+        radarSensor.getPresenceDistance(distance);
+        Serial.println(distance);
     }
 
     // Delay 0.5 seconds between readings