Code Review Updates

Updates made from codestream code review by Dryw. For more information on specific changes, see Codestream.

Author: MadisonC-SparkFun

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -10,17 +10,13 @@ void setup()
 {
   Wire.begin();
   // Start serial communication at 115200 baud
-  Serial.begin(115200);   
-  // Set clock speed to be the fastest for better communication 
-  Wire.setClock(1000000);
+  Serial.begin(115200);  
 
   // Begin example of the magnetic sensor code (and add whitespace for easy reading)
   Serial.println("TMAG5273 Example 1: Basic Readings");
   Serial.println("");
-  // If begin is successful (0), then start example
-
-  Serial.println(sensor.getManufacturerID(), HEX);
 
+  // If begin is successful (0), then start example
   if(sensor.begin(i2cAddress, Wire) == 1)
   {
     Serial.println("Begin");

…mple4_Interrupts/Example4_Interrupts.ino …mple2_Interrupts/Example2_Interrupts.inoexamples/Example4_Interrupts/Example4_Interrupts.ino renamed to examples/Example2_Interrupts/Example2_Interrupts.ino examples/Example4_Interrupts/Example4_Interrupts.ino renamed to examples/Example2_Interrupts/Example2_Interrupts.ino

@@ -25,16 +25,14 @@ void setup()
   Wire.begin();
   // Start serial communication at 115200 baud
   Serial.begin(115200);
-  // Set clock speed to be the fastest for better communication
-  Wire.setClock(1000000);
 
   // Configure Interrupt Pin
-  pinMode(intPin, OUTPUT);
+  pinMode(intPin, INPUT);
   // Attach interrupt to pin 4 as a digital, falling pin
   attachInterrupt(digitalPinToInterrupt(intPin), isr1, CHANGE);
 
   // Begin example of the magnetic sensor code (and add whitespace for easy reading)
-  Serial.println("TMAG5273 Example 4: Interrupts");
+  Serial.println("TMAG5273 Example 2: Interrupts");
   Serial.println("");
   // If begin is successful (0), then start example
   if (sensor.begin(i2cAddress, Wire) == true)
@@ -48,16 +46,16 @@ void setup()
   }
 
   // Set interrupt through !INT
-  sensor.setInterruptMode(INTERRUPT_THROUGH_INT);
+  sensor.setInterruptMode(TMAG5273_INTERRUPT_THROUGH_INT);
 
   // Set the !INT pin state - pulse for 10us
-  sensor.setIntPinState(1);
+  sensor.setIntPinState(true);
 
   // Enable the interrupt response for the thresholds
-  sensor.setThresholdEn(1);
+  sensor.setThresholdEn(true);
 
-  int pinStatus = sensor.getInterruptPinStatus();
-  pinMode(4, INPUT);
+  //int pinStatus = sensor.getInterruptPinStatus();
+  pinMode(intPin, INPUT);
 
   // Set X, Y, Z, and T Thresholds for interrupt to be triggered
   sensor.setXThreshold(5);            // mT
@@ -84,7 +82,7 @@ void loop()
 
     int xThresh = sensor.getXThreshold();
     Serial.print("X Threshold: ");
-    Serial.println(zxThresh);
+    Serial.println(xThresh);
 
     if (sensor.getMagneticChannel() != 0)  // Checks if mag channels are on - turns on in setup
     {
@@ -100,6 +98,8 @@ void loop()
       Serial.print(", ");
       Serial.print(magZ);
       Serial.println(") mT");
+      Serial.print(temp);
+      Serial.println(" °C");
     } 
     else 
     {

…/Example5_LowPower/Example5_LowPower.ino …/Example3_LowPower/Example3_LowPower.inoexamples/Example5_LowPower/Example5_LowPower.ino renamed to examples/Example3_LowPower/Example3_LowPower.ino examples/Example5_LowPower/Example5_LowPower.ino renamed to examples/Example3_LowPower/Example3_LowPower.ino

@@ -4,7 +4,7 @@
 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
@@ -14,7 +14,7 @@ uint8_t intPin = 4;
 volatile bool interruptFlag = false;
 
 // Sleeptime constant
-int sleeptime = 0x1;
+int sleeptime = TMAG5273_SLEEP_5MS;
 
 // ISR to print what interrupt was triggered
 void isr1() 
@@ -28,16 +28,10 @@ void setup()
   Wire.begin();
   // Start serial communication at 115200 baud
   Serial.begin(115200);   
-  // Set clock speed to be the fastest for better communication 
-  Wire.setClock(1000000);  
 
-  // Configure Interrupt Pin
-  pinMode(intPin, INPUT);
-  // Attach interrupt to pin 4 as a digital, falling pin
-  attachInterrupt(digitalPinToInterrupt(intPin), isr1, FALLING);
 
   // Begin example of the magnetic sensor code (and add whitespace for easy reading)
-  Serial.println("TMAG5273 Example 5: Low Power / Wake-Up and Sleep");
+  Serial.println("TMAG5273 Example 3: Low Power / Wake-Up and Sleep");
   Serial.println("");
   // If begin is successful (0), then start example
   if(sensor.begin(i2cAddress, Wire) == true)
@@ -50,17 +44,19 @@ void setup()
     while(1); // Runs forever
   }
 
-  // Setup delay for race case
-  delay(500);
+  // Configure Interrupt Pin
+  pinMode(intPin, OUTPUT);
+  // Attach interrupt to pin 4 as a digital, falling pin
+  attachInterrupt(digitalPinToInterrupt(intPin), isr1, FALLING);
 
-  // Set operating mode
-  sensor.setOperatingMode(3); // 0X3
+  // Set operating mode to wake up and sleep
+  sensor.setOperatingMode(TMAG5273_WAKE_UP_AND_SLEEP_MODE); // 0X3
 
   // Set interrupt through !INT
-  sensor.setInterruptMode(INTERRUPT_THROUGH_INT);
+  sensor.setInterruptMode(TMAG5273_INTERRUPT_THROUGH_INT);
 
   // Set the !INT pin state - low until cleared
-  sensor.setIntPinState(0);
+  sensor.setIntPinState(false);
 
   // Set time spent in low power mode between conversions
   sensor.setSleeptime(sleeptime);
@@ -84,7 +80,7 @@ void loop()
   if(interruptFlag == true)
   {
     // Assert flag back to false
-    interruptFlag == false;
+    interruptFlag = false;
 
     if(sensor.readWakeUpAndSleepData(&magX, &magY, &magZ, &temperatureData) == 0)
     {
@@ -105,7 +101,7 @@ void loop()
   }
 
   // Set operating mode back to wakeup and sleep
-  sensor.setOperatingMode(3);
+  sensor.setOperatingMode(TMAG5273_WAKE_UP_AND_SLEEP_MODE);
 
   delay(500);
 

…le6_I2CSettings/Example6_I2CSettings.ino …le4_I2CSettings/Example4_I2CSettings.inoexamples/Example6_I2CSettings/Example6_I2CSettings.ino renamed to examples/Example4_I2CSettings/Example4_I2CSettings.ino examples/Example6_I2CSettings/Example6_I2CSettings.ino renamed to examples/Example4_I2CSettings/Example4_I2CSettings.ino

@@ -11,11 +11,9 @@ void setup()
   Wire.begin();
   // Start serial communication at 115200 baud
   Serial.begin(115200);   
-  // Set clock speed to be the fastest for better communication 
-  Wire.setClock(1000000);
 
   // Begin example of the magnetic sensor code (and add whitespace for easy reading)
-  Serial.println("TMAG5273 Example 6: I2C Settings - Address Change");
+  Serial.println("TMAG5273 Example 4: I2C Settings - Address Change");
   Serial.println("");
 
   // If begin is successful (1), then start example
@@ -29,14 +27,13 @@ void setup()
 
     while(1); // Runs forever
   }
-  
-  // Race Case
-  delay(1000);
 
   Serial.print("Original Address: ");
   Serial.println(sensor.getI2CAddress(), HEX);
 
-  // Change I2C Address - can be any 7-bit value (bits 1-7)
+  // Change I2C Address - must be 7-bits (bits 1-7)
+  // NOTE: The I2C address will reset back to default (0x22) after a power cycle. 
+  // Running other examples without a power cycle will fail due to the I2C address being different. 
   int updatedAddress = 0x23;
 
   // Set the I2C Address  

…culations/Example3_AngleCalculations.ino …culations/Example5_AngleCalculations.inoexamples/Example3_AngleCalculations/Example3_AngleCalculations.ino renamed to examples/Example5_AngleCalculations/Example5_AngleCalculations.ino examples/Example3_AngleCalculations/Example3_AngleCalculations.ino renamed to examples/Example5_AngleCalculations/Example5_AngleCalculations.ino

@@ -17,14 +17,12 @@ void setup()
   Wire.begin();
   // Start serial communication at 115200 baud
   Serial.begin(115200);   
-  // Set clock speed to be the fastest for better communication 
-  Wire.setClock(1000000);  
 
   // Begin example of the magnetic sensor code (and add whitespace for easy reading)
-  Serial.println("TMAG5273 Example 3: Angle Calculations");
+  Serial.println("TMAG5273 Example 5: Angle Calculations");
   Serial.println("");
   // If begin is successful (0), then start example
-  if(sensor.begin(0X22, Wire) == true)
+  if(sensor.begin(i2cAddress, Wire) == true)
   {
     Serial.println("Begin");
   }

…s/Example2_IoT_Motor_Driver_Readings.ino …s/Example6_IoT_Motor_Driver_Readings.inoexamples/Example2_IoT_Motor_Driver_Readings/Example2_IoT_Motor_Driver_Readings.ino renamed to examples/Example6_IoT_Motor_Driver_Readings/Example6_IoT_Motor_Driver_Readings.ino examples/Example2_IoT_Motor_Driver_Readings/Example2_IoT_Motor_Driver_Readings.ino renamed to examples/Example6_IoT_Motor_Driver_Readings/Example6_IoT_Motor_Driver_Readings.ino

@@ -1,6 +1,8 @@
-#include <Wire.h>            // Used to establish serial communication on the I2C bus
+#include <Wire.h> // Used to establish serial communication on the I2C bus
 #include "SparkFun_TMAG5273_Arduino_Library.h" // Used to send and recieve specific information from our sensor
-#include <SimpleFOC.h>
+
+// To download the Arduino Simple FOC Library, use this link: https://docs.simplefoc.com/arduino_simplefoc_library_showcase
+#include <SimpleFOC.h> 
 
 /* For easy reading with this example, try opening the serial plotter! */
 
@@ -16,56 +18,23 @@ BLDCMotor motor = BLDCMotor(8);
 // BLDCDriver6PWM(int phA_h,int phA_l,int phB_h,int phB_l,int phC_h,int phC_l, int en)
 BLDCDriver6PWM driver = BLDCDriver6PWM(16,17, 18,23, 19,33, 34);
 
-//target variable
-float target_velocity = 3;
+//target variable in rad/s (radians per second)
+float target_velocity_rps = 3;
 
 // instantiate the commander
 Commander command = Commander(Serial);
-void doTarget(char* cmd) { command.scalar(&target_velocity, cmd); }
+void doTarget(char* cmd) { command.scalar(&target_velocity_rps, cmd); }
 void doLimit(char* cmd) { command.scalar(&motor.voltage_limit, cmd); }
 
-// Checkout peripherals (aux buttons, leds, etc)
-int aux1Pin = 14;
-int aux2Pin = 13;
-int ledPin = 2;
-
-// Use as the current pin in test for lighting LED test circuit
-int testPin = 12;
-
-// Creates a class for the button information to be stored in for the ISR
-struct Button{
-  const uint8_t PIN;
-  uint32_t numberKeyPresses;
-  bool pressed;
-};
-
-// Creates an instance of each button and their pin on the ESP32
-Button aux1 = {14, 0, false};
-Button aux2 = {13, 0, false};
-
-// Button 1 ISR to increment button count and update status of press
-void IRAM_ATTR isr1(){
-  aux1.numberKeyPresses++;
-  aux1.pressed = true;
-}
-
-// Button 2 ISR to increment button count and update status of press
-void IRAM_ATTR isr2(){
-  aux2.numberKeyPresses++;
-  aux2.pressed = true;
-}
-
 
 void setup() 
 {  
   Wire.begin();
   // Start serial communication at 115200 baud
   Serial.begin(115200);   
-  // Set clock speed to be the fastest for better communication
-  Wire.setClock(1000000);   
 
   // Begin example of the magnetic sensor code
-  Serial.println("TMAG5273 Example 2: Basic Readings with the IoT Motor Driver");
+  Serial.println("TMAG5273 Example 6: Basic Readings with the IoT Motor Driver");
 
   // ********* Driver config *********
   // power supply voltage [V]
@@ -90,20 +59,10 @@ void setup()
 
   Serial.println("Motor ready!");
   Serial.print("Set target velocity [rad/s]: ");
-  Serial.println(target_velocity);
+  Serial.println(target_velocity_rps);
   _delay(1000);
 
-  // Making RGB LED an output
-  pinMode(ledPin, OUTPUT); // RGB LED
-
-  // Aux pins as an interrupt
-  pinMode(aux1.PIN, INPUT_PULLUP); // Sets pin 14 on the ESP32 as an interrupt
-  attachInterrupt(aux1.PIN, isr1, FALLING); // Triggers when aux1 is pulled to GND (button pressed)
-  pinMode(aux2.PIN, INPUT_PULLUP); // Sets pin 13 on the ESP32 as an interrupt
-  attachInterrupt(aux2.PIN, isr2, FALLING); // Triggers when aux2 is pulled to GND (button pressed)
-  
-
-  // If begin is successful (1), then start example
+  // If the TMAG5273begin is successful (1), then start example
   if(sensor.begin(i2cAddress, Wire) == true)
   {
     Serial.println("Begin");
@@ -114,31 +73,13 @@ void setup()
     while(1); // Runs forever
   }
 
-  // Delay for race case setup
-  delay(500);
 }
 
 
 void loop() 
 {
-  // Variable for temperature 
-  float temp = sensor.getTemp();
-  // Button Press ISR
-  if(aux1.pressed)
-  { 
-    Serial.print("Temperature: ");
-    Serial.println(temp);
-    aux1.pressed = false;
-    delay(1000);
-  }
-  if(aux2.pressed)
-  { 
-    Serial.println("Changing direction.. ");
-    aux2.pressed = false;
-  }
-
   // Basic motor movement
-  motor.move(target_velocity);
+  motor.move(target_velocity_rps);
 
   // user communication
   command.run();