Merge branch 'readregion_api_change' of https://github.com/sparkfun/SparkFun_Toolkit into readregion_api_change

Author: SFE-Brudnerd

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,3 @@
+# VSCode directories
+.vscode
+

src/sfeTkArdI2C.cpp

@@ -220,6 +220,10 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size
     if (!_i2cPort)
         return kSTkErrBusNotInit;
 
+    // Buffer valid?
+    if (!data)
+        return kSTkErrBusNullBuffer;
+  
     readBytes = 0;
 
     uint16_t nOrig = numBytes; // original number of bytes.
@@ -261,7 +265,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size
 
     } // end while
 
-    readBytes = nOrig - numBytes;
+    readBytes = nOrig - numBytes; // Bytes read.
 
-    return kSTkErrOk;
+    return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success
 }

src/sfeTkArdI2C.h

@@ -168,11 +168,12 @@ class sfeTkArdI2C : public sfeTkII2C
         @note This method is virtual to allow it to be overridden to support a device that requires a unique impl
 
         @param devReg The device's register's address.
-        @param data Data to write.
-        @param numBytes - length of data
+        @param data Data being read.
+        @param numBytes Number of bytes to read.
         @param[out] readBytes - Number of bytes read
 
-        @retval kStkErrOk on success
+
+        @retval kSTkErrOk on success
     */
     sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes);