ported to the TMF882X library

Author: gigapod

docs/index.md

@@ -1,51 +1,55 @@
-# The Qwiic OLED Arduino Library
+# The Qwiic TMF882X Arduino Library
 
-![SparkFun Qwiic OLED Arduino Library](img/TMF882XLibBanner.png "SparkFun Qwiic TMF882X Arduino Library")
+![SparkFun Qwiic TMF882X Arduino Library](img/TMF882XLibBanner.png "SparkFun Qwiic TMF882X Arduino Library")
 
-The SparkFun Qwiic OLED Arduino Library is a single graphics module that supports all SparkFun OLED boards based on the SSD1306 from Solomon Systech. Prior to this library, three different libraries were used to support our four different OLED boards. 
-
-The SparkFun Qwiic OLED Library delivers a common implementation for all our Qwiic OLED products, delivering a unified, fast, and efficient solution that implements a familiar and easy to understand user experience.
+The SparkFun Qwiic TMF882X Arduino Library is a single module that supports all SparkFun TMF882X boards based on the TMF882X Time of Flight sensors from AMS. 
 
 ### Key Features
-*   Implements common graphics capabilities: pixel, line, rectangle, filled rectangle, circle, filled circle, bitmap, text and raster operators (i.e. XOR).
-* Smart data transfer to the device – only sends _dirty_ regions of the graphics buffer to the OLED device, not the entire buffer. 
-* High performance – 2x faster than our previous OLED library, often much higher. 
-* Efficient memory usage. No dynamic memory utilized. Static resources are loaded once, and only on explicit declaration. 
-* Implements a familiar interface, making migration from older libraries straight forward
+* Implemented using the AMS provided TMF882X SDK.
+* Uses a callback function design pattern to efficiently deliver the data results from the connected TMF882X device. 
+* Supports factor calibration of the sensor. 
+* Enables rapid use of the built in SPAD Map functionality of the device, as well as defining custom SPAD Maps to meet desired needs. 
+* Supports data collection based on data counts, timeout value or until a stop command is issues.
 
 ### Getting Started
 
-The [Getting Started Page](software.md) outlines library installation and the general use of the qwiic OLED library. 
-
-Detailed examples are included as part of the library installation process and available in the Arduino IDE `File > Examples >` menu. A walk-thru of key examples is contained in the [Examples](sparkfun-qwiic-oled-arduino-library-examples/ex_01_hello/) section of this documentation set. 
+The [Getting Started Page](software.md) outlines library installation and the general use of the Qwiic TMF882X library. 
 
+Detailed examples are included as part of the library installation process and available in the Arduino IDE `File > Examples >` menu. 
 
 A full [API Reference](api_device.md) is also provided for the library.
 
 ### Supported Products
 
-The SparkFun Qwiic OLED Arduino Library supports the following SparFun Products
+The SparkFun Qwiic TMF882X Arduino Library supports the following SparFun Products
 
 <table class="table table-hover table-striped table-bordered">
     <tr>
         <td width="120" pad=10 style="vertical-align: middle;">
-            <a href="https://www.sparkfun.com/products/14532"><img src="https://cdn.sparkfun.com//assets/parts/1/2/6/2/1/14532-SparkFun_Micro_OLED_Breakout__Qwiic_-01.jpg"></a></td>
+            <a href="https://www.sparkfun.com/products/19036"><img src="https://cdn.sparkfun.com/assets/parts/1/8/6/4/0/19036-SparkFun_Qwiic_dToF_Imager_-_TMF8820-01.jpg"></a></td>
+         <td style="text-align:left; vertical-align: middle; padding-left: 20px;font-weight: bold;">
+            <a href="https://www.sparkfun.com/products/19036">SparkFun Qwiic dToF Imager TMF8820</a>
+        </td>
+    </tr>
+    <tr>
+        <td width="120" pad=10 style="vertical-align: middle;">
+            <a href="https://www.sparkfun.com/products/19036"><img src="https://cdn.sparkfun.com/assets/parts/1/8/8/4/4/19218-SparkFun_Qwiic_Mini_dToF_Imager_-_TMF8820-01.jpg"></a></td>
          <td style="text-align:left; vertical-align: middle; padding-left: 20px;font-weight: bold;">
-            <a href="https://www.sparkfun.com/products/14532">SparkFun Micro OLED Breakout (Qwiic)</a>
+           <a href="https://www.sparkfun.com/products/19036">SparkFun Qwiic Mini dToF Imager TMF8820)</a>
         </td>
     </tr>
     <tr>
         <td width="120" pad=10 style="vertical-align: middle;">
-            <a href="https://www.sparkfun.com/products/17153"><img src="https://cdn.sparkfun.com//assets/parts/1/6/1/3/5/17153-SparkFun_Qwiic_OLED_Display__0.91_in__128x32_-05.jpg"></a></td>
+            <a href="https://www.sparkfun.com/products/19037"><img src="https://cdn.sparkfun.com/assets/parts/1/8/6/4/1/19037-SparkFun_Qwiic_dToF_Imager_-_TMF8821-01.jpg"></a></td>
          <td style="text-align:left; vertical-align: middle; padding-left: 20px;font-weight: bold;">
-           <a href="https://www.sparkfun.com/products/17153">SparkFun Qwiic OLED Display (0.91 in, 128x32)</a>
+           <a href="https://www.sparkfun.com/products/19037">SparkFun Qwiic dToF Imager TMF8821</a>
         </td>
     </tr>
     <tr>
         <td width="120" pad=10 style="vertical-align: middle;">
-            <a href="https://www.sparkfun.com/products/15173"><img src="https://cdn.sparkfun.com//assets/parts/1/3/5/8/8/15173-SparkFun_Transparent_Graphical_OLED_Breakout__Qwiic_-01a.jpg"></a></td>
+            <a href="https://www.sparkfun.com/products/19037"><img src="https://cdn.sparkfun.com/assets/parts/1/9/0/9/8/19451-SparkFun_Qwiic_Mini_dToF_Imager_-_TMF8821-01.jpg"></a></td>
          <td style="text-align:left; vertical-align: middle; padding-left: 20px;font-weight: bold;">
-           <a href="https://www.sparkfun.com/products/15173">SparkFun Transparent Graphical OLED Breakout (Qwiic)</a>
+           <a href="https://www.sparkfun.com/products/19037">SparkFun Qwiic Mini dToF Imager TMF8821</a>
         </td>
     </tr>
 </table>
@@ -61,7 +65,7 @@ The SparkFun Qwiic OLED Arduino Library supports the following SparFun Products
 * [SAMD21](https://www.sparkfun.com/products/14812)
 * [nrf5280](https://www.sparkfun.com/products/15025)
 * [Teensy](https://www.sparkfun.com/products/16402)
-* [ATMega328](https://www.sparkfun.com/products/18158)
+
 
 ### License
-The SparkFun Qwiic OLED Arduino Library is licensed using the Open Source MIT License
+The SparkFun Qwiic TMF882X Arduino Library is licensed using the Open Source MIT License