Worked on errors

Deleted unneeded files, updated functions unsure of, worked on many errors

Author: MadisonC-SparkFun

examples/Example01_BasicUsage/Example01_BasicUsage.ino

@@ -1,23 +1,35 @@
-// TODO: Add includes as needed
 #include "SparkFun_Qwiic_XM125_Arduino_Library.h"
 
-// TODO: Change Template
-TemplateClass myDevice;
+SfeXM125 sensor;
+
+// I2C default address
+uint8_t i2cAddress = SFE_XM125_I2C_ADDRESS;
 
 void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("Template Example 1 - Basic Uasge"); // TODO: Update
+    Serial.println("XM125 Example 1: Basic Distance Readings");
+    Serial.println("");
 
     // TODO: Check return value of begin
-    myDevice.begin();
+    sensor.begin();
 
-    // TODO: Add other setup code if needed. Most setup should be done in begin()
+    // If begin is successful (0), then start example
+    if(sensor.begin(i2cAddress, Wire) == 1)
+    {
+        Serial.println("Begin");
+    }
+    else // Otherwise, infinite loop
+    {
+        Serial.println("Device failed to setup - Freezing code.");
+        while(1); // Runs forever
+    }
 }
 
 void loop()
 {
-    // Request Distance Data to the device 
-    
+    // Request Distance Data from the device 
+
+    delay(100);
 }

src/SparkFun_Qwiic_XM125_Arduino_Library.h

@@ -1,62 +1,30 @@
-#include "sfe_bus.h"
-#include "sfeXM125Regs.h"
+#include "sfeQwiicXM125.h"
+#include <Arduino.h>
+#include <Wire.h>
 
-// Add any definitions hereby
-
-
-class QwDevXM125
+class SfeXM125 : public QwDevXM125
 {
     public: 
 
-        // 
-        ///////////////////////////////////////////////////////////////////////
-        // begin()
-        //
-        //
-        // This method follows the standard startup pattern in SparkFun Arduino
-        // libraries.
-        //
-        //  Parameter   Description
-        //  ---------   ----------------------------
-        //  wirePort    optional. The Wire port. If not provided, the default port is used
-        //  address     optional. I2C Address. If not provided, the default address is used.
-        //  retval      true on success, false on startup failure
-        //
-        // This method is overridden, implementing two versions.
-        //
-        // Version 1:
-        // User skips passing in an I2C object which then defaults to Wire.
-        bool begin(uint8_t deviceAddress = SFE_XM125_I2C_ADDRESS)
+        SfeXM125()
         {
-            // Setup  I2C object and pass into the superclass
-            setCommunicationBus(_i2cBus, deviceAddress);
-
-            // Initialize the I2C buss class i.e. setup default Wire port
-            _i2cBus.init();
-
-            // Initialize the system - return results
-            return this->QwDevXM125::init();
         }
 
-        //Version 2:
-        // User passes in an I2C object and an address (optional).
-        bool begin(TwoWire &wirePort, uint8_t deviceAddress = SFE_XM125_I2C_ADDRESS)
+        /// @brief  Sets up Arduino I2C driver using the specified I2C address then calls the super class begin.
+        /// @param address Address of the I2C device.
+        /// @return True if successful, false otherwise.
+        bool begin(uint8_t deviceAddress = SFE_XM125_I2C_ADDRESS, TwoWire &wirePort = Wire)
         {
-            // Setup  I2C object and pass into the superclass
-            setCommunicationBus(_i2cBus, deviceAddress);
-
             // Give the I2C port provided by the user to the I2C bus class.
-            _i2cBus.init(wirePort, true);
+            _i2cBus.init(wirePort, deviceAddress);
 
             // Initialize the system - return results
-            return this->QwDevXM125::init();
+            return this->QwDevXM125::begin(&_i2cBus);
         }
 
     private: 
 
         // I2C bus class
-        sfe_XM125::QwI2C _i2cBus;
-
-
-
-}
+        sfeTkArdI2C _i2cBus;
+        //QwDevXM125::QwI2C _i2cBus; // original code
+};