improve the examples, add more functions and fix some bugs

Author: mathieukaelin

examples/read-magnetic-fields-with-i2c/read-magnetic-fields-with-i2c.ino

@@ -5,6 +5,7 @@ uint8_t registerReadbackValue = 0;
 uint16_t magFieldBx, magFieldBy, magFieldBz, temperature;
 int16_t magFieldBxSigned, magFieldBySigned, magFieldBzSigned, temperatureSigned;
 double magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius;
+double norm, theta, phi;
 uint8_t frameCounter;
 char data[400];
 
@@ -14,7 +15,7 @@ void setup() {
   mv300sensori2c.setClockFrequency(400000);
   Serial.begin(115200, SERIAL_8N1);
   while(!Serial){}//wait for serial port to connect. Needed for native USB
-  mv300sensori2c.writeRegister(16, 4, 0); //Set TRIGMODE=1 (Trigger measurement after write or read frame), BRANGE=0 (±250mT)
+  mv300sensori2c.writeRegister(16, 4, 0); //Set TRIGMODE=1 (I2C quick read mode: Trigger measurement after write or read frame), BRANGE=0 (±250mT)
   mv300sensori2c.writeRegister(17, 1, 0); //Set MODE = 1 (Host Controlled Mode)
   for(uint8_t i=0;i<20;++i) {
     registerReadbackValue=mv300sensori2c.readRegister(i, 0);
@@ -26,7 +27,7 @@ void setup() {
 
 void loop() {
   delayMicroseconds(175); //wait for the previous conversion to finish
-  mv300sensori2c.readMagneticComponents(&magFieldBx, &magFieldBy, &magFieldBz, &temperature, &frameCounter);
+  mv300sensori2c.readMagneticComponents(&magFieldBx, &magFieldBy, &magFieldBz, &temperature, &frameCounter, 1);
   magFieldBxSigned=twosComplement(magFieldBx,  12);
   magFieldBySigned=twosComplement(magFieldBy,  12);
   magFieldBzSigned=twosComplement(magFieldBz,  12);
@@ -35,6 +36,7 @@ void loop() {
   magFieldByInMilliTesla=convertMagneticFieldFromLsbToMilliTesla(magFieldBySigned, 0);
   magFieldBzInMilliTesla=convertMagneticFieldFromLsbToMilliTesla(magFieldBzSigned, 0);
   temperatureInDegreeCelsius=convertTemperatureFromLsbToDegreeCelsius(temperatureSigned);
-  sprintf(data, "Bx = % 8.3f mT, By = % 8.3f mT, Bz = % 8.3f mT, Temperature = % 6.1f °C, frame = %u", magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius, frameCounter);
+  computeNormThetaPhi(magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, &norm, &theta, &phi);
+  sprintf(data, "Bx [mT]:%+8.3f, By [mT]:%+8.3f, Bz [mT]:%+8.3f, Temperature [°C]:%+6.1f, frame:%u, Norm [mT]:%+8.3f, Theta [°]:%+8.3f, Phi [°]:%+8.3f", magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius, frameCounter, norm, theta, phi);
   Serial.println(data);
 }

examples/read-magnetic-fields-with-spi/read-magnetic-fields-with-spi.ino

@@ -7,14 +7,15 @@ uint8_t registerReadbackValue = 0;
 uint16_t magFieldBx, magFieldBy, magFieldBz, temperature;
 int16_t magFieldBxSigned, magFieldBySigned, magFieldBzSigned, temperatureSigned;
 double magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius;
+double norm, theta, phi;
 uint8_t frameCounter;
 char data[400];
 
 void setup() {
-  mv300sensorspi.begin(spiSclkClockFrequency, SPI_MODE3, spiChipSelectPin);
+  mv300sensorspi.begin(spiSclkClockFrequency, SPI_MODE0, spiChipSelectPin);
   Serial.begin(115200, SERIAL_8N1);
   while(!Serial){}//wait for serial port to connect. Needed for native USB
-  mv300sensorspi.writeRegister(16, 4, 0); //Set TRIGMODE=1 (Trigger measurement after write or read frame), BRANGE=0 (±250mT)
+  mv300sensorspi.writeRegister(16, 0, 0); //Set TRIGMODE=0 (not used with SPI), BRANGE=0 (±250mT)
   mv300sensorspi.writeRegister(17, 1, 0); //Set MODE = 1 (Host Controlled Mode)
   for(uint8_t i=0;i<20;++i) {
     registerReadbackValue=mv300sensorspi.readRegister(i, 0);
@@ -35,6 +36,7 @@ void loop() {
   magFieldByInMilliTesla=convertMagneticFieldFromLsbToMilliTesla(magFieldBySigned, 0);
   magFieldBzInMilliTesla=convertMagneticFieldFromLsbToMilliTesla(magFieldBzSigned, 0);
   temperatureInDegreeCelsius=convertTemperatureFromLsbToDegreeCelsius(temperatureSigned);
-  sprintf(data, "Bx = % 8.3f mT, By = % 8.3f mT, Bz = % 8.3f mT, Temperature = % 6.1f °C, frame = %u", magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius, frameCounter);
+  computeNormThetaPhi(magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, &norm, &theta, &phi);
+  sprintf(data, "Bx [mT]:%+8.3f, By [mT]:%+8.3f, Bz [mT]:%+8.3f, Temperature [°C]:%+6.1f, frame:%u, Norm [mT]:%+8.3f, Theta [°]:%+8.3f, Phi [°]:%+8.3f", magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius, frameCounter, norm, theta, phi);
   Serial.println(data);
 }

keywords.txt

@@ -36,6 +36,7 @@ writeRegisterWithCrcCheck	KEYWORD2
 twosComplement	KEYWORD2
 convertMagneticFieldFromLsbToMilliTesla	KEYWORD2
 convertTemperatureFromLsbToDegreeCelsius	KEYWORD2
+computeNormThetaPhi	KEYWORD2
 
 #######################################
 # Instances (KEYWORD2)