Updates from code review

Added datasheet in documentation folder; updated file names to be in correct SFE format; added keywords.txt and library.properties files; for full list of exact changes, see CodeStream for details on comments.

Author: MadisonC-SparkFun

Documentation/tmag5273.pdf

@@ -1,10 +1,10 @@
 #include <Wire.h>            // Used to establish serial communication on the I2C bus
-#include "SparkFun_TMAG5273.h" // Used to send and recieve specific information from our sensor
+#include "SparkFun_TMAG5273_Arduino_Library.h" // Used to send and recieve specific information from our sensor
 
 TMAG5273 sensor; // Initialize hall-effect sensor
 
 // I2C default address
-uint8_t i2cAddress = I2C_ADDRESS_INITIAL;
+uint8_t i2cAddress = TMAG5273_I2C_ADDRESS_INITIAL;
 
 void setup() 
 {
@@ -18,7 +18,10 @@ void setup()
   Serial.println("TMAG5273 Example 1: Basic Readings");
   Serial.println("");
   // If begin is successful (0), then start example
-  if(sensor.begin(i2cAddress, Wire) == true)
+
+  Serial.println(sensor.getManufacturerID(), HEX);
+
+  if(sensor.begin(i2cAddress, Wire) == 1)
   {
     Serial.println("Begin");
   }
@@ -36,6 +39,8 @@ void loop()
   // Checks if mag channels are on - turns on in setup
   if(sensor.getMagneticChannel() != 0) 
   {
+    sensor.setTemperatureEn(true);
+
     float magX = sensor.getXData();
     float magY = sensor.getYData();
     float magZ = sensor.getZData();

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -1,5 +1,5 @@
 #include <Wire.h>            // Used to establish serial communication on the I2C bus
-#include "SparkFun_TMAG5273.h" // Used to send and recieve specific information from our sensor
+#include "SparkFun_TMAG5273_Arduino_Library.h" // Used to send and recieve specific information from our sensor
 #include <SimpleFOC.h>
 
 /* For easy reading with this example, try opening the serial plotter! */
@@ -8,7 +8,7 @@
 TMAG5273 sensor; 
 
 // I2C default address
-uint8_t i2cAddress = I2C_ADDRESS_INITIAL;
+uint8_t i2cAddress = TMAG5273_I2C_ADDRESS_INITIAL;
 
 // BLDC motor & driver instance
 BLDCMotor motor = BLDCMotor(8);
@@ -56,14 +56,6 @@ void IRAM_ATTR isr2(){
 }
 
 
-// Setup pins for current sense outputs
-int curr_sense = 32;
-int u_sense = 35;
-int v_sense = 36;
-int w_sense = 39;
-
-
-
 void setup() 
 {  
   Wire.begin();
@@ -136,13 +128,12 @@ void loop()
   { 
     Serial.print("Temperature: ");
     Serial.println(temp);
-    Serial.printf("Button 14 has been pressed %u times\n", aux1.numberKeyPresses);
     aux1.pressed = false;
     delay(1000);
   }
   if(aux2.pressed)
   { 
-    Serial.printf("Button 13 has been pressed %u times\n", aux2.numberKeyPresses);
+    Serial.println("Changing direction.. ");
     aux2.pressed = false;
   }
 

examples/Example2_IoT_Motor_Driver_Readings/Example2_IoT_Motor_Driver_Readings.ino

@@ -1,11 +1,16 @@
 #include <Wire.h>            // Used to establish serial communication on the I2C bus
-#include "SparkFun_TMAG5273.h" // Used to send and recieve specific information from our sensor
+#include "SparkFun_TMAG5273_Arduino_Library.h" // Used to send and recieve specific information from our sensor
 
 // Create a new sensor object
 TMAG5273 sensor; 
 
 // I2C default address
-uint8_t i2cAddress = I2C_ADDRESS_INITIAL;
+uint8_t i2cAddress = TMAG5273_I2C_ADDRESS_INITIAL;
+
+// Set constants for setting up device
+uint8_t conversionAverage = TMAG5273_X32_CONVERSION;
+uint8_t magneticChannel = TMAG5273_XYX_ENABLE;
+uint8_t angleCalculation = TMAG5273_XY_ANGLE_CALCULATION;
 
 void setup() 
 {
@@ -30,15 +35,15 @@ void setup()
   }
 
   // Set the device at 32x average mode 
-  sensor.setConvAvg(X32_CONVERSION);
+  sensor.setConvAvg(conversionAverage);
 
   // Choose new angle to calculate from
   // Can calculate angles between XYX, YXY, YZY, and XZX
-  sensor.setMagneticChannel(XYX_ENABLE);
+  sensor.setMagneticChannel(magneticChannel);
 
   // Enable the angle calculation register
   // Can choose between XY, YZ, or XZ priority
-  sensor.setAngleEn(XY_ANGLE_CALCULATION);
+  sensor.setAngleEn(angleCalculation);
 
 }
 

examples/Example3_AngleCalculations/Example3_AngleCalculations.ino

@@ -1,10 +1,10 @@
 #include <Wire.h>               // Used to establish serial communication on the I2C bus
-#include "SparkFun_TMAG5273.h"  // Used to send and recieve specific information from our sensor
+#include "SparkFun_TMAG5273_Arduino_Library.h"  // Used to send and recieve specific information from our sensor
 
 TMAG5273 sensor;  // Initialize hall-effect sensor
 
 // I2C default address
-uint8_t i2cAddress = I2C_ADDRESS_INITIAL;
+uint8_t i2cAddress = TMAG5273_I2C_ADDRESS_INITIAL;
 
 // Interrupt pin used
 // NOTE: This pin is specific to the SparkFun IoT Motor Driver

examples/Example4_Interrupts/Example4_Interrupts.ino

@@ -1,5 +1,5 @@
 #include <Wire.h>            // Used to establish serial communication on the I2C bus
-#include "SparkFun_TMAG5273.h" // Used to send and recieve specific information from our sensor
+#include "SparkFun_TMAG5273_Arduino_Library.h" // Used to send and recieve specific information from our sensor
 
 TMAG5273 sensor; // Initialize hall-effect sensor
 

examples/Example5_LowPower/Example5_LowPower.ino

@@ -1,10 +1,10 @@
 #include <Wire.h>            // Used to establish serial communication on the I2C bus
-#include "SparkFun_TMAG5273.h" // Used to send and recieve specific information from our sensor
+#include "SparkFun_TMAG5273_Arduino_Library.h" // Used to send and recieve specific information from our sensor
 
 TMAG5273 sensor; // Initialize hall-effect sensor
 
 // I2C default address
-uint8_t i2cAddress = I2C_ADDRESS_INITIAL;
+uint8_t i2cAddress = TMAG5273_I2C_ADDRESS_INITIAL;
 
 void setup() 
 {