Places new documentation in documentation folder

* Replaces old references to ISM part
* Updates SPI MODE
* Updates a few bit fields that have changed in the v4.0 reference document
* Adds a few tap related functions
* Adds a software reset function
* Updates all examples with correct output data rate comment
* Also updates all examples with sofware reset function and additional sensor class

Author: edspark

Documentation/KX132/KX132-1211-Technical-Reference-Manual-Rev-1.0.pdf

@@ -24,6 +24,7 @@
 #include "SparkFun_KX13X.h"
 
 SparkFun_KX132 kxAccel; 
+// SparkFun_KX134 kxAccel; // For the KX134, uncomment this and comment line above
 
 outputData myData;   // Struct for the accelerometer's data
 
@@ -40,14 +41,17 @@ void setup()
     delay(50);
 
 
-  if( !kxAccel.begin(chipSelect) )
+  if( !kxAccel.begin() )
 	{
     Serial.println("Could not communicate with the the KX13X. Freezing.");
     while(1);
 	}
 
 	Serial.println("Ready.");
 
+	if( kxAccel.softwareReset() )
+		Serial.println("Reset.");
+
 	// Many settings for KX13X can only be                    														
 	// applied when the accelerometer is powered down.                  														
 	// However there are many that can be changed "on-the-fly"
@@ -57,7 +61,7 @@ void setup()
 
   kxAccel.setRange(0x18);         // 16g Range
 	kxAccel.enableDataEngine();     // Enables the bit that indicates data is ready.
-	// kxAccel.setOutputDataRate(); // Default is 400Hz
+	// kxAccel.setOutputDataRate(); // Default is 50Hz
 	kxAccel.enableAccel();          
 
 

Documentation/KX132/kx132-1211-technical-reference-manual.pdf

@@ -25,6 +25,7 @@
 #include "SparkFun_KX13X.h"
 
 SparkFun_KX132 kxAccel; 
+// SparkFun_KX134 kxAccel; // For the KX134, uncomment this and comment line above
 
 outputData myData;     //  Struct for the accelerometer's data
 byte dataReadyPin = 2; //  Change to fit your project.
@@ -50,6 +51,10 @@ void setup()
 
 	Serial.println("Ready.");
 
+	// Reset the chip so that old settings don't apply to new setups.
+	if( kxAccel.softwareReset() )
+		Serial.println("Reset.");
+
 	// Many settings for KX13X can only be                    														
 	// applied when the accelerometer is powered down.                  														
 	// However there are many that can be changed "on-the-fly"

Documentation/KX134/KX134-1211-Technical-Reference-Manual-Rev-1.0.pdf

@@ -25,6 +25,7 @@
 #include "SparkFun_Qwiic_KX13X.h"
 
 SparkFun_KX132 kxAccel; 
+// SparkFun_KX134 kxAccel; // For the KX134, uncomment this and comment line above
 
 outputData myData;     //  Struct for the accelerometer's data
 byte dataReadyPin = 2; //  Change to fit your project.
@@ -50,6 +51,10 @@ void setup()
 
 	Serial.println("Ready.");
 
+	// Reset the chip so that old settings don't apply to new setups.
+	if( kxAccel.softwareReset() )
+		Serial.println("Reset.");
+
 	// Many settings for KX13X can only be                    														
 	// applied when the accelerometer is powered down.                  														
 	// However there are many that can be changed "on-the-fly"
@@ -77,7 +82,7 @@ void setup()
 																						 //  Changes depending on the resolution, see datasheet for more info.
 
   kxAccel.setRange(0x18);        //  16g Range
-	//kxAccel.setOutputDataRate(); //  Default is 400Hz
+	//kxAccel.setOutputDataRate(); //  Default is 50Hz
 	kxAccel.enableAccel();          
 
 

Documentation/KX134/KX134-1211-Technical-Reference-Manual-Rev-4.0.pdf

@@ -1,7 +1,7 @@
 /*
   example6-tap
 
-  This example shows the how to enable the tap interrupts
+  This example shows the how to enable the tap interrupts.
 
 	Please refer to the header file for more possible settings, found here:
 	..\SparkFun_KX13X_Arduino_Library\src\sfe_kx13x_defs.h
@@ -20,22 +20,18 @@
 	License	(http://opensource.org/licenses/MIT).
 */
 
-#include <SPI.h>
 #include <Wire.h>
 #include "SparkFun_KX13X.h"
 
-SparkFun_KX132_SPI kxAccel; 
+SparkFun_KX132 kxAccel; 
+// SparkFun_KX134 kxAccel; // For the KX134, uncomment this and comment line above
 
-byte chipSelect = 1; // Change to fit your project.
+byte direction = 0;
 
 void setup() 
 {
 
-	// Get the chip select pin ready.
-	pinMode(chipSelect, OUTPUT);
-	digitalWrite(chipSelect, HIGH);
-
-	SPI.begin();
+	Wire.begin();
 
 	Serial.begin(115200);
   Serial.println("Welcome.");
@@ -45,24 +41,29 @@ void setup()
     delay(50);
 
 
-  if( !kxAccel.begin(chipSelect) )
+  if( !kxAccel.begin() )
 	{
     Serial.println("Could not communicate with the the KX13X. Freezing.");
     while(1);
 	}
 
 	Serial.println("Ready.");
 
+	// Reset the chip so that old settings don't apply to new setups.
+	if( kxAccel.softwareReset() )
+		Serial.println("Reset.");
+
 	// Many settings for KX13X can only be                    														
 	// applied when the accelerometer is powered down.                  														
 	// However there are many that can be changed "on-the-fly"
 	// check datasheet for more info, or the comments in the
 	// "...regs.h" file which specify which can be changed when.
 	kxAccel.enableAccel(false); 
 
-  kxAccel.setRange(0x18);         // 16g Range
-	kxAccel.enableTapEngine();      // Enable tap Engine
-	// kxAccel.setOutputDataRate(); // Default is 400Hz
+  kxAccel.setRange(0x18);                 //  16g Range
+	kxAccel.enableTapEngine();              //  Enable tap Engine
+	kxAccel.enableDirecTapInterupt();       //  This enables checking the direction of the interrupt
+	//kxAccel.setTapDataRate(uint8_t rate); //  Default is 400Hz
 	kxAccel.enableAccel();          
 
 
@@ -73,14 +74,14 @@ void loop()
 	// Check if tap was detected
 	if( kxAccel.tapDetected() )
 	{
-		Serial.println("Tap Detected.");
+		Serial.print("Tap Detected: ");
+		Serial.println(kxAccel.getDirection(), HEX);
 		kxAccel.clearInterrupt();
-		while(1);
 	}
 
-	if( kxAccel.unknownTap() || kxAccel.doubleTapDetected() )
+	if( kxAccel.unknownTap() || kxAccel.doubleTapDetected() ) // These all share the same bit space
 		kxAccel.clearInterrupt();
 
-  delay(30); // Delay should be 1/ODR (Output Data Rate), default tap ODR is 400Hz
+  delay(25); // Delay should be 1/ODR (Output Data Rate), default tap ODR is 400Hz
 
 }

examples/example1_basic_readings/example1_basic_readings.ino

@@ -24,6 +24,7 @@
 #include "SparkFun_KX13X.h"
 
 SparkFun_KX132_SPI kxAccel; 
+// SparkFun_KX134_SPI kxAccel; // For the KX134, uncomment this and comment line above
 
 outputData myData;   // Struct for the accelerometer's data
 byte chipSelect = 1; // Change to fit your project.
@@ -53,6 +54,10 @@ void setup()
 
 	Serial.println("Ready.");
 
+	// Reset the chip so that old settings don't apply to new setups.
+	if( kxAccel.softwareReset() )
+		Serial.println("Reset.");
+
 	// Many settings for KX13X can only be                    														
 	// applied when the accelerometer is powered down.                  														
 	// However there are many that can be changed "on-the-fly"
@@ -62,7 +67,7 @@ void setup()
 
   kxAccel.setRange(0x18);         // 16g Range
 	kxAccel.enableDataEngine();     // Enables the bit that indicates data is ready.
-	// kxAccel.setOutputDataRate(); // Default is 400Hz
+	// kxAccel.setOutputDataRate(); // Default is 50Hz
 	kxAccel.enableAccel();          
 
 

examples/example2_interrupts/example2_interrupts.ino

@@ -105,13 +105,13 @@ class SparkFun_KX132_SPI : public QwDevKX132
         return this->QwDevKX132::init();
     }
 
-    bool begin(SPIClass &spiPort, SPISettings ismSettings, uint8_t cs)
+    bool begin(SPIClass &spiPort, SPISettings kxSettings, uint8_t cs)
     {
         // Setup a SPI object and pass into the superclass
         setCommunicationBus(_spiBus);
 
 				// Initialize the SPI bus class with provided SPI port, SPI setttings, and chip select pin.
-        _spiBus.init(spiPort, ismSettings, cs, true);
+        _spiBus.init(spiPort, kxSettings, cs, true);
 
         // Initialize the system - return results
         return this->QwDevKX132::init();
@@ -226,13 +226,13 @@ class SparkFun_KX134_SPI : public QwDevKX134
         return this->QwDevKX134::init();
     }
 
-    bool begin(SPIClass &spiPort, SPISettings ismSettings, uint8_t cs)
+    bool begin(SPIClass &spiPort, SPISettings kxSettings, uint8_t cs)
     {
         // Setup a SPI object and pass into the superclass
         setCommunicationBus(_spiBus);
 
 				// Initialize the SPI bus class with provided SPI port, SPI setttings, and chip select pin.
-        _spiBus.init(spiPort, ismSettings, cs, true);
+        _spiBus.init(spiPort, kxSettings, cs, true);
 
         // Initialize the system - return results
         return this->QwDevKX134::init();