sparkfun · gigapod · Feb 15, 2025 · Feb 14, 2025 · Feb 15, 2025 · Feb 15, 2025
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,8 @@
 MIT License
 
-Copyright (c) 2025 SparkFun Electronics
+
+Copyright (c) 2024-2025 SparkFun Electronics
+
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +21,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
diff --git a/README.md b/README.md
@@ -1,49 +1,77 @@
-SparkFun XM125 A121 Arduino Library
-========================================
 
-[![SparkFun Pulsed Coherent Radar Sensor – Acconeer XM125 (Qwiic)](https://cdn.sparkfun.com/r/600-600/assets/parts/2/4/8/6/5/SEN-24540-Pulsed-Coherent-Radar-Sensor-Feature.jpg)](https://www.sparkfun.com/products/24540)
+![SparkFun Pulsed Coherent Radar Sensor – Acconeer XM125 (Qwiic)](docs/images/gh-banner-2025-xm125.png "SparkFun Pulsed Coherent Radar Sensor")
 
-[*SparkFun Pulsed Coherent Radar Sensor – Acconeer XM125 (Qwiic) (SEN-24540)*](https://www.sparkfun.com/products/24540)
+# SparkFun Pulsed Coherent Radar Sensor – Acconeer XM125
 
-This is the SparkFun library for the Acconeer Entry+ Module XM125 with the A121 60GHz Pulsed Coherent Radar sensor and I<sup>2</sup>C interface.
+Arduino Library for the SparkFun Pulsed Coherent Radar Sensor 
 
+![License](https://img.shields.io/github/license/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
+![Release](https://img.shields.io/github/v/release/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
+![Release Date](https://img.shields.io/github/release-date/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
+![Documentation - build](https://img.shields.io/github/actions/workflow/status/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library/build-deploy-ghpages.yml?label=doc%20build)
+![Compile - Test](https://img.shields.io/github/actions/workflow/status/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library/test-compile-sketch.yml?label=compile%20test)
+![GitHub issues](https://img.shields.io/github/issues/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
 
-Repository Contents
--------------------
 
-* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
-* **/src** - Source files for the library (.cpp, .h).
-* **/docs** - Datasheet and application note for the XM125 and A121.
-* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
-* **library.properties** - General library properties for the Arduino package manager.
-* **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this 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!
 
-Documentation
---------------
+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!
 
-* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
-* **[Hookup Guide](https://docs.sparkfun.com/SparkFun_Qwiic_Pulsed_Radar_Sensor_XM125)** - Basic hookup guide for the SparkFUn Qwiic Pulsed Coherent Radar Sensor - XM125.
-* **[Product Repository](https://github.com/sparkfun/SparkFun_Qwiic_Pulsed_Radar_Sensor_XM125)** - Main repository for the SparkFun Qwiic XM125 (including hardware files)
+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.
 
+## Functionality
 
-Products that use this Library 
----------------------------------
+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. 
 
-* [*SEN-24540*](https://www.sparkfun.com/products/24540)
+When running as a I2C client device, the Acconeer XM125 is loaded with a specific firmware application from Acconeer. 
 
+The *SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125* comes with the ***Presence Detector*** firmware loaded, which is accessible using the ***Presence*** focused methods in this library. 
 
-License Information
--------------------
+This library also supports the ***Distance Detection*** application firmware from Acconeer. To enable this functionally, the ***Distance Detection*** firmware must be loaded onto the *SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125* board. The firmware is available from [Acconeer](https://developer.acconeer.com/home/a121-docs-software/xm125-xe125/) as part of the XM125/A121 SDK. The files are located in the `out/` folder - with naming patter of `i2c_*_detector.bin`. Install instructions are noted in our [Hook Up Guide](https://docs.sparkfun.com/SparkFun_Qwiic_Pulsed_Radar_Sensor_XM125/introduction/) for the product.
 
-This product is _**open source**_! 
 
-Please review the LICENSE.md file for license information. 
+This library provides a extensive interface that enables the following functionality/interaction with the SparkFun Pulsed Coherent Radar Sensor when the sensor is operating as an I2C sensor device:
 
-If you have any questions or concerns on licensing, please contact technical support on our [SparkFun forums](https://forum.sparkfun.com/viewforum.php?f=152).
+|Function|Firmware|
+|---|---|
+|Distance Detection | `i2c_distance_detector` |
+|Presence Detection | `i2c_presence_detector` |
 
-Distributed as-is; no warranty is given.
+## General Use
+
+### TO DO
+
+
+## Examples
+
+The following examples are provided with the library
+
+| Example | Description |
+|---|---|
+|[Presence Basic Readings](examples/Example01_PresenceBasicReadings/Example01_PresenceBasicReadings.ino)| The sensor is initialized, then the presence distance values will print out to the terminal.|
+| [Presence GPIO 0 Usage](examples/Example02_PresenceGPIO0Usage/Example02_PresenceGPIO0Usage.ino)|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. |
+|[Presence Serial Plotter](examples/Example03_PresenceSerialPlotter/Example03_PresenceSerialPlotter.ino)|The sensor is initialized, then the presence values will print out to the terminal and the serial monitor.|
+|[Presence Advanced Readings](examples/Example04_PresenceAdvancedReadings/Example04_PresenceAdvancedReadings.ino)|The sensor is initialized, then the presence distance, intra-presence, and inter-presence values will be printed to the terminal.|
+|[Presence Advanced Settings](examples/Example05_PresenceAdvancedSettings/Example05_PresenceAdvancedSettings.ino)|The sensor is initialized, then the presence distance values will print out to the terminal just as they do in example one. If you wish to change the settings of the device, do so before applying the configuration.|
+|[Distance Basic Readings](examples/Example06_DistanceBasicReadings/Example06_DistanceBasicReadings.ino)|The sensor is initialized, then the distance values will print out to the terminal in mm. |
+|[Distance Threshold Settings](examples/Example07_DistanceThresholdSettings/Example07_DistanceThresholdSettings.ino)|The sensor is initialized, then the distance amplitude, and strength , fixed amplitude, and sensitivity thresholds are set. |
+|[Distance Serial Plotter](examples/Example08_DistanceSerialPlotter/Example08_DistanceSerialPlotter.ino)|This example prints out the distance values of the 0 distance channels to the serial plotter tool in Arduino.|
+|[Distance Advanced Settings](examples/Example09_DistanceAdvancedSettings/Example09_DistanceAdvancedSettings.ino)|The sensor is initialized, then the distance (mm) and advanced values are output to the terminal. |
+
+
+## Documentation
+
+The full API and use documentation for this library is provided [here](https://docs.sparkfun.com/SparkFun_Qwiic_XM125_Arduino_Library/). For a quick reference, the main methods available in the library are listed [here](https://docs.sparkfun.com/SparkFun_Qwiic_XM125_Arduino_Library/class_qw_dev_x_m125.html).
+
+Curious about the hardware this board works with - visit the SparkFun Pulsed Coherent Radar Sensor [hardware repository](https://github.com/sparkfun/SparkFun_Qwiic_Pulsed_Radar_Sensor_XM125).
+
+The Hookup Guide for the SparkFun Qwiic Soil Moisture Sensor is available [here](https://docs.sparkfun.com/SparkFun_Qwiic_Pulsed_Radar_Sensor_XM125/introduction/).
+
+## License Information
+
+This product is ***open source***!
+
+This product is licensed using the [MIT Open Source License](https://opensource.org/license/mit). 
 
-- Your friends at SparkFun.
 
-_<COLLABORATION CREDIT>_
diff --git a/docs/images/gh-banner-2025-xm125.png b/docs/images/gh-banner-2025-xm125.png
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;
@@ -114,7 +114,7 @@ void loop()
     radarSensor.getPresenceDetectorPresenceDetected(presenceDetected);
     radarSensor.getPresenceDetectorPresenceStickyDetected(presenceDetectedSticky);
 
-    if((presenceDetected == 1) | (presenceDetectedSticky == 1))
+    if((presenceDetected == 1) || (presenceDetectedSticky == 1))
     {
       radarSensor.getPresenceDistance(distance);
       Serial.print("Presence Detected: ");

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
+{  };