iniital port/move to sparkfun_toolkit v1.0 done - basic readings compile, but no further tests yet

gigapod · gigapod · commit 64b8c2e8031a · 2025-02-14T15:22:18.000-07:00
diff --git a/examples/Example01_PresenceBasicReadings/Example01_PresenceBasicReadings.ino b/examples/Example01_PresenceBasicReadings/Example01_PresenceBasicReadings.ino
@@ -24,7 +24,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example02_PresenceGPIO0Usage/Example02_PresenceGPIO0Usage.ino b/examples/Example02_PresenceGPIO0Usage/Example02_PresenceGPIO0Usage.ino
@@ -24,7 +24,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example03_PresenceSerialPlotter/Example03_PresenceSerialPlotter.ino b/examples/Example03_PresenceSerialPlotter/Example03_PresenceSerialPlotter.ino
@@ -24,7 +24,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example04_PresenceAdvancedReadings/Example04_PresenceAdvancedReadings.ino b/examples/Example04_PresenceAdvancedReadings/Example04_PresenceAdvancedReadings.ino
@@ -24,7 +24,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example05_PresenceAdvancedSettings/Example05_PresenceAdvancedSettings.ino b/examples/Example05_PresenceAdvancedSettings/Example05_PresenceAdvancedSettings.ino
@@ -25,7 +25,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example06_DistanceBasicReadings/Example06_DistanceBasicReadings.ino b/examples/Example06_DistanceBasicReadings/Example06_DistanceBasicReadings.ino
@@ -24,7 +24,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example07_DistanceThresholdSettings/Example07_DistanceThresholdSettings.ino b/examples/Example07_DistanceThresholdSettings/Example07_DistanceThresholdSettings.ino
@@ -24,7 +24,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example08_DistanceSerialPlotter/Example08_DistanceSerialPlotter.ino b/examples/Example08_DistanceSerialPlotter/Example08_DistanceSerialPlotter.ino
@@ -23,7 +23,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/examples/Example09_DistanceAdvancedSettings/Example09_DistanceAdvancedSettings.ino b/examples/Example09_DistanceAdvancedSettings/Example09_DistanceAdvancedSettings.ino
@@ -24,7 +24,7 @@
 #include <Arduino.h>
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-SfeXM125 radarSensor;
+SparkFunXM125 radarSensor;
 
 // I2C default address
 uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
diff --git a/keywords.txt b/keywords.txt
@@ -17,7 +17,6 @@ sfe_xm125_presence_command_t KEYWORD1
 #########################################################
 
 begin KEYWORD2
-returnRegister KEYWORD2
 distanceBegin KEYWORD2
 distanceDetectorReadingSetup KEYWORD2
 getDistanceDetectorVersion KEYWORD2
diff --git a/library.properties b/library.properties
@@ -1,11 +1,11 @@
 name=SparkFun XM125 Arduino Library 
-version=1.0.4
+version=1.1.0
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=An Arduino library to make use of the Qwiic XM125 A121 Pulsed Radar Module from Acconeer. 
 paragraph=This is the SparkFun library for the Acconeer Entry+ Module XM125 with the A121 60GHz Pulsed Coherent Radar sensor and I2C interface.
 category=Sensors
 url=https://github.com/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library
 architectures=*
-depends=SparkFun Toolkit (<1.0.0)
-includes=SparkFun_Qwiic_XM125_Arduino_Library.h, sfeQwiicXM125.h, sfeXM125Regs.h
+depends=SparkFun Toolkit (>=1.0.0)
+includes=SparkFun_Qwiic_XM125_Arduino_Library.h
diff --git a/src/SparkFun_Qwiic_XM125_Arduino_Library.h b/src/SparkFun_Qwiic_XM125_Arduino_Library.h
@@ -1,12 +1,33 @@
-#include "sfeQwiicXM125.h"
+
+/*!
+ * @file SparkFun_Qwiic_XM125_Arduino_Library.h
+ * @brief Arduino header file for the SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125 (Qwiic) 
+ *
+ * This file contains the class definitions for the SparkFun Pulsed Coherent Radar Sensor Arduino library,
+ * including methods for initialization, distance and presence detection, and configuration.
+ * It uses I2C to communicate with the device.
+ *
+ * @author SparkFun Electronics
+ * @date 2024
+ * @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
+ * 
+ * SPDX-License-Identifier: MIT
+ */
+#pragma once
+
+
+// To make the Arduino machine happy, include the toolkit header before the core implementation for this device
+#include <SparkFun_Toolkit.h>
+#include "sfTk/sfDevXM125.h"
+
 #include <Arduino.h>
 #include <Wire.h>
 
-class SfeXM125 : public QwDevXM125
+class SparkFunXM125 : public sfDevXM125
 {
     public: 
 
-        SfeXM125()
+    SparkFunXM125()
         {
         }
 
@@ -20,12 +41,16 @@ class SfeXM125 : public QwDevXM125
             _i2cBus.init(wirePort, deviceAddress);
 
             // Initialize the system - return results
-            return this->QwDevXM125::begin(&_i2cBus) == 0;
+            return this->sfDevXM125::begin(&_i2cBus) == 0;
         }
 
     private: 
         
         // I2C bus class
-        sfeTkArdI2C _i2cBus;
-        //QwDevXM125::QwI2C _i2cBus; // original code
-};
+        sfTkArdI2C _i2cBus;
+
+};
+
+// for backward compatibility -  
+class SfeXM125 : public SparkFunXM125
+{  };
diff --git a/src/sfTk/sfDevXM125.cpp b/src/sfTk/sfDevXM125.cpp
diff --git a/src/sfTk/sfDevXM125.h b/src/sfTk/sfDevXM125.h
diff --git a/src/sfTk/sfXM125Regs.h b/src/sfTk/sfXM125Regs.h
