Changed the name of bool error defined as global variable that was ca…

…using trouble on some platforms
monolithicpower · Jan 7, 2025 · be54578 · be54578
1 parent 2dd9f3e
commit be54578
Showing 10 changed files with 28 additions and 41 deletions.
diff --git a/examples/gen3/gen3.ino b/examples/gen3/gen3.ino
@@ -11,7 +11,7 @@ MagAlphaGen3 magalpha;
 double angle_real;
 uint16_t zero, bct, angle_raw;
 uint8_t register_value[2];
-bool error;
+bool crc_error;
 
 void setup() {
 
@@ -73,8 +73,8 @@ void loop() {
     angle_raw = magalpha.readAngleRaw16();
     Serial.print("Angle raw (16 bits) = ");
     Serial.println(angle_raw, HEX);
-    angle_raw = magalpha.readAngleRaw(&error);
-    if(error) {
+    angle_raw = magalpha.readAngleRaw(&crc_error);
+    if(crc_error) {
         Serial.println("An error occured during readAngleRaw");
     } else {
         Serial.print("readAngleRaw succeded, Angle raw (16 bits) = ");

diff --git a/examples/gen4/gen4.ino b/examples/gen4/gen4.ino
@@ -11,7 +11,7 @@ MagAlphaGen4 magalpha;
 double angle_real;
 uint16_t zero, bct, angle_raw;
 uint8_t register_value[2];
-bool error;
+bool crc_error;
 
 void setup() {
 
@@ -91,8 +91,8 @@ void loop() {
     angle_raw = magalpha.readAngleRaw16();
     Serial.print("Angle raw (16 bits) = ");
     Serial.println(angle_raw, HEX);
-    angle_raw = magalpha.readAngleRaw(&error);
-    if(error) {
+    angle_raw = magalpha.readAngleRaw(&crc_error);
+    if(crc_error) {
         Serial.println("An error occured during readAngleRaw");
     } else {
         Serial.print("readAngleRaw succeded, Angle raw (16 bits) = ");

diff --git a/examples/gen6/gen6.ino b/examples/gen6/gen6.ino
@@ -11,7 +11,7 @@ MagAlphaGen6 magalpha;
 double angle_real, speed;
 uint16_t zero, bct, angle_raw, turn;
 uint8_t register_value[2];
-bool error;
+bool crc_error;
 
 void setup() {
 
@@ -96,8 +96,8 @@ void loop() {
     angle_raw = magalpha.readAngleRaw16();
     Serial.print("Angle raw (16 bits) = ");
     Serial.println(angle_raw, HEX);
-    angle_raw = magalpha.readAngleRaw(&error);
-    if(error) {
+    angle_raw = magalpha.readAngleRaw(&crc_error);
+    if(crc_error) {
         Serial.println("An error occured during readAngleRaw");
     } else {
         Serial.print("readAngleRaw succeded, Angle raw (16 bits) = ");

diff --git a/examples/gen7/gen7.ino b/examples/gen7/gen7.ino
@@ -11,7 +11,7 @@ MagAlphaGen7 magalpha;
 double angle_real, speed;
 uint16_t zero, angle_raw, turn;
 uint8_t register_value[2];
-bool error;
+bool crc_error;
 
 void setup() {
 
@@ -35,21 +35,6 @@ void loop() {
     register_value[0] = magalpha.readRegister(0);
     register_value[0] = magalpha.writeRegister(0, 0x00);
 
-    /*
-    uint16_t readAngleRaw16(bool *error, bool *inversion, bool isShortRead=false);
-    uint16_t readAngleCounter(uint16_t *angle, bool *error, bool *inversion);
-    uint16_t readAngleSpeed(uint16_t *angle, bool *error, bool *inversion);
-    uint16_t readAngleMultiturn(uint16_t *angle, bool *error, bool *inversion);
-    uint16_t readAngleTemperature(uint16_t *angle, bool *error, bool *inversion);
-    uint8_t readRegister(uint8_t address, bool *error, bool *inversion);
-    uint16_t readRegisterBurst(uint8_t address, uint8_t readbackValueArray[], uint16_t numberOfRegister, bool *error, bool *inversion);
-    uint8_t writeRegister(uint8_t address, uint8_t value, bool *error, bool *inversion, bool *wrongHandshaking);
-    void writeRegisterBurst(uint8_t address, uint8_t valueArray[], uint16_t numberOfRegister, bool *error, bool *inversion, bool *wrongHandshaking);
-    void setCrcCheckSetting(bool enable);
-    uint16_t appendCrc4(uint16_t data);
-    void checkCrc4(uint16_t readData, uint16_t *computedCrc, bool *errorDetected, bool *inversionDetected);
-    */
-
     // Read & Write registers in burst mode
     register_value[0] = 0x55;
     register_value[1] = 0xAA;
@@ -104,8 +89,8 @@ void loop() {
     angle_raw = magalpha.readAngleRaw16();
     Serial.print("Angle raw (16 bits) = ");
     Serial.println(angle_raw, HEX);
-    angle_raw = magalpha.readAngleRaw(&error);
-    if(error) {
+    angle_raw = magalpha.readAngleRaw(&crc_error);
+    if(crc_error) {
         Serial.println("An error occured during readAngleRaw");
     } else {
         Serial.print("readAngleRaw succeded, Angle raw (16 bits) = ");

diff --git a/examples/gen8/gen8.ino b/examples/gen8/gen8.ino
@@ -11,7 +11,7 @@ MagAlphaGen8 magalpha;
 double angle_real, speed;
 uint16_t zero, angle_raw, turn;
 uint8_t register_value[2];
-bool error;
+bool crc_error;
 
 void setup() {
 
@@ -89,8 +89,8 @@ void loop() {
     angle_raw = magalpha.readAngleRaw16();
     Serial.print("Angle raw (16 bits) = ");
     Serial.println(angle_raw, HEX);
-    angle_raw = magalpha.readAngleRaw(&error);
-    if(error) {
+    angle_raw = magalpha.readAngleRaw(&crc_error);
+    if(crc_error) {
         Serial.println("An error occured during readAngleRaw");
     } else {
         Serial.print("readAngleRaw succeded, Angle raw (16 bits) = ");

diff --git a/examples/legacy/edit-magalpha-config/edit-magalpha-config.ino b/examples/legacy/edit-magalpha-config/edit-magalpha-config.ino
@@ -48,11 +48,11 @@ void loop() {
   Serial.println(angleRaw8, DEC);
 
   //Read the angle (16-bit raw angle value) and check the parity bit to detect possible communication error
-  bool error;
-  angleRaw16 = magAlpha.readAngleRaw(&error);
+  bool crc_error;
+  angleRaw16 = magAlpha.readAngleRaw(&crc_error);
   Serial.print("    magAlpha.readAngleRaw16(&error) = ");
   Serial.print(angleRaw16, DEC);
-  if (error == true){
+  if (crc_error){
     Serial.print("\t => Communication error detected");
   }
   else{

diff --git a/examples/legacy/read-magalpha-angle-and-error/read-magalpha-angle-and-error.ino b/examples/legacy/read-magalpha-angle-and-error/read-magalpha-angle-and-error.ino
@@ -19,11 +19,11 @@ void setup() {
 void loop() {
   // put your main code here, to run repeatedly:
   uint16_t angleRaw16;
-  bool error;
+  bool crc_error;
   //Read the angle
-  angleRaw16 = magAlpha.readAngleRaw(&error);
+  angleRaw16 = magAlpha.readAngleRaw(&crc_error);
   Serial.print(angleRaw16, DEC);
-  if (error){
+  if (crc_error){
     Serial.print("\t => Communication Error Detected");
   }
   else{

diff --git a/.../legacy/read-magalpha-angle-with-ssi-and-error/read-magalpha-angle-with-ssi-and-error.ino b/.../legacy/read-magalpha-angle-with-ssi-and-error/read-magalpha-angle-with-ssi-and-error.ino
@@ -1,4 +1,4 @@
-#include <MagAlphaBase.h>
+#include <MagAlpha.h>
 
 //Check https://www.arduino.cc/en/reference/SPI for SPI signals connections
 //Connect SSI SSCK to SPI SCLK signal
@@ -20,11 +20,11 @@ void setup() {
 void loop() {
   // put your main code here, to run repeatedly:
   uint16_t angleRaw16;
-  bool error;
+  bool crc_error;
   //Read the angle
-  angleRaw16 = magAlphaSsi.readAngleRaw(&error);
+  angleRaw16 = magAlphaSsi.readAngleRaw(&crc_error);
   Serial.print(angleRaw16, DEC);
-  if (error){
+  if (crc_error){
     Serial.print("\t => Communication Error Detected");
   }
   else{

diff --git a/examples/legacy/read-magalpha-angle-with-ssi/read-magalpha-angle-with-ssi.ino b/examples/legacy/read-magalpha-angle-with-ssi/read-magalpha-angle-with-ssi.ino
@@ -1,4 +1,4 @@
-#include <MagAlphaBase.h>
+#include <MagAlpha.h>
 
 //Check https://www.arduino.cc/en/reference/SPI for SPI signals connections
 //Connect SSI SSCK to SPI SCLK signal

diff --git a/src/MagAlpha.h b/src/MagAlpha.h
@@ -23,6 +23,8 @@
 #define MA_SPI_MODE_0       SPI_MODE0
 #define MA_SPI_MODE_3       SPI_MODE3
 
+#include "MagAlphaBase.h"
+
 /*====================================================================================*/
 /*========================== MagAlphaGen3 Legacy =====================================*/
 /*====================================================================================*/