Merge pull request #3 from sparkfun/feature/sf-toolkit-v1

changes made to support sparkfun toolkit v1.0,

Author: gigapod

examples/Example8_SelfTest/Example8_SelfTest.ino

@@ -1,6 +1,6 @@
 /*
     SPDX-License-Identifier: MIT
-    
+
     Copyright (c) 2024 SparkFun Electronics
 */
 
@@ -41,10 +41,10 @@ void setup()
     Serial.println("The OTOS must be stationary during the self test!");
 
     // Perform the self test
-    sfeTkError_t result = myOtos.selfTest();
-    
+    sfTkError_t result = myOtos.selfTest();
+
     // Check if the self test passed
-    if(result == kSTkErrOk)
+    if (result == ksfTkErrOk)
     {
         Serial.println("Self test passed!");
     }

library.properties

@@ -1,10 +1,10 @@
 name=SparkFun Qwiic OTOS Arduino Library
-version=1.0.2
+version=1.1.0
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=A library to use the SparkFun Qwiic Optical Tracking Odometry Sensor
-paragraph=
+paragraph=The SparkFun Qwiic Optical Tracking Odometry Sensor empowers you to elevate a robots navigation capabilities with precision and streamlined integration.
 category=Sensors
 url=https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library
 architectures=*
-depends=SparkFun Toolkit (<1.0.0)
+depends=SparkFun Toolkit (>=1.0.0)

src/SparkFun_Qwiic_OTOS_Arduino_Library.h

@@ -1,8 +1,27 @@
-/*
-    SPDX-License-Identifier: MIT
-    
-    Copyright (c) 2024 SparkFun Electronics
-*/
+/**
+ * @file SparkFun_Qwiic_OTOS_Arduino_Library.h
+ * @brief Arduino wrapper for the SparkFun Qwiic OTOS sensor driver
+ * @details This file provides an Arduino-compatible interface to the SparkFun Qwiic
+ *          Optical Tracking Odometry Sensor (OTOS). It wraps the platform-agnostic
+ *          C++ driver to provide familiar Arduino conventions and simplified usage.
+ *
+ * Features:
+ * - Simple Arduino-style begin() function
+ * - Default Wire interface support
+ * - Compatible with all Arduino platforms
+ * - Inherits all functionality from base C++ driver
+ * - Automatic I2C bus configuration
+ *
+ * @author SparkFun Electronics
+ * @date February 2024
+ * @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * @see https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library
+ */
+
+// ...existing code...
 
 /*******************************************************************************
     SparkFun_Qwiic_OTOS_Arduino_Library.h - Arduino wrapper of the C++ driver
@@ -13,14 +32,16 @@
 *******************************************************************************/
 
 #pragma once
-
+// clang-format off
 #include "Arduino.h"
-#include "sfeQwiicOtos.h"
+#include <SparkFun_Toolkit.h>
+#include "sfTk/sfDevOTOS.h"
 #include <Wire.h>
+// clang-format on
 
 /// @brief Arduino class for the SparkFun Qwiic Optical Tracking Odometry Sensor
 /// (OTOS)
-class QwiicOTOS : public sfeQwiicOtos
+class QwiicOTOS : public sfDevOTOS
 {
   public:
     /// @brief Begins the Qwiic OTOS and verifies it is connected
@@ -32,7 +53,7 @@ class QwiicOTOS : public sfeQwiicOtos
         _theI2CBus.init(wirePort, kDefaultAddress);
 
         // Begin the sensor
-        return sfeQwiicOtos::begin(&_theI2CBus) == kSTkErrOk;
+        return sfDevOTOS::begin(&_theI2CBus) == ksfTkErrOk;
     }
 
   protected:
@@ -42,5 +63,5 @@ class QwiicOTOS : public sfeQwiicOtos
     }
 
   private:
-    sfeTkArdI2C _theI2CBus;
+    sfTkArdI2C _theI2CBus;
 };