Add Examples and correct some bugs

Author: mathieukaelin

README.md

@@ -23,14 +23,14 @@ MIT license, all text above must be included in any redistribution.
 
 ## Connections
 ### Power supply
-| Arduino  | MagAlpha |
-| -------- | -------- |
-| GND      | GND      |
+| Arduino  | MagVector |
+| -------- | --------- |
+| GND      | GND       |
 | **+3.3V** (Not 5V)| VDD  |
 
 | Warning |
 | :-------: |
-| Unlike some Arduino & Genuino boards, the **MagAlpha runs at 3.3V**. Even if the I/O can tolerate 5V, check that the voltage applied to VDD is at 3.3V. **Applying a voltages higher than 3.3V to the VDD pin could damage the sensor**.|
+| Unlike some Arduino & Genuino boards, the **MagVector runs at 3.3V**. Even if the I/O can tolerate 5V, check that the voltage applied to VDD is at 3.3V. **Applying a voltages higher than 3.3V to the VDD pin could damage the sensor**.|
 
 ### Serial communication
 MagVector sensors have different communication interfaces available. The MV300 is available with either a I2C or a SPI communication interface.
@@ -44,19 +44,19 @@ MagVector sensors have different communication interfaces available. The MV300 i
 Do not forget to connect SA1 and SA2 pins to define the I2C device address.
 
 #### SPI (4-wire interface)
-| Arduino         | MagAlpha |
-| --------------- | -------- |
-| COPI (aka MOSI) | COPI     |
-| CIPO (aka MISO) | CIPO     |
-| SCK             | SCLK     |
+| Arduino         | MagVector |
+| --------------- | --------- |
+| COPI (aka MOSI) | COPI      |
+| CIPO (aka MISO) | CIPO      |
+| SCK             | SCLK      |
 | any available digital pin (default: pin 7) | /CS |
 
 ## Setup
 Install the library directly from within the Arduino IDE by using the Library Manager (Sketch => Include Library => Manage Libraries...).
 
 It is also possible to import the library Zip file (check release tab) from the Arduino IDE (Sketch => Include Library => Add .ZIP Library...).
 
-The library can also be manually installed by copying the MagAlpha library folder in your arduinosketchfolder/libraries/ folder. You may need to create the libraries subfolder if its your first library. Restart the IDE to see the library.
+The library can also be manually installed by copying the MagVector library folder in your arduinosketchfolder/libraries/ folder. You may need to create the libraries subfolder if its your first library. Restart the IDE to see the library.
 
 Check this tutorial on Arduino library installation for more information:
 * [All About Arduino Libraries](http://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use)

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

@@ -0,0 +1,40 @@
+#include <mv300sensor.h>
+
+MV300SensorI2c mv300sensori2c;
+uint8_t registerReadbackValue = 0;
+uint16_t magFieldBx, magFieldBy, magFieldBz, temperature;
+int16_t magFieldBxSigned, magFieldBySigned, magFieldBzSigned, temperatureSigned;
+double magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius;
+uint8_t frameCounter;
+char data[400];
+
+void setup() {
+  mv300sensori2c.begin();
+  mv300sensori2c.setDeviceAddress(0x14);
+  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(17, 1, 0); //Set MODE = 1 (Host Controlled Mode)
+  for(uint8_t i=0;i<20;++i) {
+    registerReadbackValue=mv300sensori2c.readRegister(i, 0);
+    sprintf(data, "Reg[%u] = %u", i, registerReadbackValue);
+    Serial.println(data);
+  }
+  mv300sensori2c.readRegister(0, 1); //Read register 0 and trigger a new acquisition by setting 2-bit Trigger to 1
+}
+
+void loop() {
+  delayMicroseconds(175); //wait for the previous conversion to finish
+  mv300sensori2c.readMagneticComponents(&magFieldBx, &magFieldBy, &magFieldBz, &temperature, &frameCounter);
+  magFieldBxSigned=twosComplement(magFieldBx,  12);
+  magFieldBySigned=twosComplement(magFieldBy,  12);
+  magFieldBzSigned=twosComplement(magFieldBz,  12);
+  temperatureSigned=twosComplement(temperature, 12);
+  magFieldBxInMilliTesla=convertMagneticFieldFromLsbToMilliTesla(magFieldBxSigned, 0);
+  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);
+  Serial.println(data);
+}

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

@@ -0,0 +1,40 @@
+#include <mv300sensor.h>
+
+MV300SensorSpi mv300sensorspi;
+const uint8_t spiChipSelectPin = 7;
+int32_t spiSclkClockFrequency = 1000000;
+uint8_t registerReadbackValue = 0;
+uint16_t magFieldBx, magFieldBy, magFieldBz, temperature;
+int16_t magFieldBxSigned, magFieldBySigned, magFieldBzSigned, temperatureSigned;
+double magFieldBxInMilliTesla, magFieldByInMilliTesla, magFieldBzInMilliTesla, temperatureInDegreeCelsius;
+uint8_t frameCounter;
+char data[400];
+
+void setup() {
+  mv300sensorspi.begin(spiSclkClockFrequency, SPI_MODE3, 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(17, 1, 0); //Set MODE = 1 (Host Controlled Mode)
+  for(uint8_t i=0;i<20;++i) {
+    registerReadbackValue=mv300sensorspi.readRegister(i, 0);
+    sprintf(data, "Reg[%u] = %u", i, registerReadbackValue);
+    Serial.println(data);
+  }
+  mv300sensorspi.readRegister(0, 1); //Read register 0 and trigger a new acquisition by setting 2-bit Trigger to 1
+}
+
+void loop() {
+  delayMicroseconds(175); //wait for the previous conversion to finish
+  mv300sensorspi.readMagneticComponents(&magFieldBx, &magFieldBy, &magFieldBz, &temperature, &frameCounter, 1);
+  magFieldBxSigned=twosComplement(magFieldBx,  12);
+  magFieldBySigned=twosComplement(magFieldBy,  12);
+  magFieldBzSigned=twosComplement(magFieldBz,  12);
+  temperatureSigned=twosComplement(temperature, 12);
+  magFieldBxInMilliTesla=convertMagneticFieldFromLsbToMilliTesla(magFieldBxSigned, 0);
+  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);
+  Serial.println(data);
+}

keywords.txt

@@ -13,26 +13,29 @@ MV300SensorSpi	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
-begin                                   KEYWORD2
-end                                     KEYWORD2
-setDeviceAddress                        KEYWORD2
-getDeviceAddress                        KEYWORD2
-setDataMode                             KEYWORD2
-getDataMode                             KEYWORD2
-setChipSelectPin                        KEYWORD2
-setClockFrequency                       KEYWORD2
-getClockFrequency                       KEYWORD2
-readMagneticComponents                  KEYWORD2
-readRegisterQuickReadMode               KEYWORD2
-readRegisterBurstMode                   KEYWORD2
-writeRegisterBurstMode                  KEYWORD2
-readRegister                            KEYWORD2
-writeRegister                           KEYWORD2
-readMagneticComponentsWithCrcCheck      KEYWORD2
-readRegisterQuickReadModeWithCrcCheck   KEYWORD2
-readRegisterBurstModeWithCrcCheck       KEYWORD2
-readRegisterWithCrcCheck                KEYWORD2
-writeRegisterWithCrcCheck               KEYWORD2
+begin	KEYWORD2
+end	KEYWORD2
+setDeviceAddress	KEYWORD2
+getDeviceAddress	KEYWORD2
+setDataMode	KEYWORD2
+getDataMode	KEYWORD2
+setChipSelectPin	KEYWORD2
+setClockFrequency	KEYWORD2
+getClockFrequency	KEYWORD2
+readMagneticComponents	KEYWORD2
+readRegisterQuickReadMode	KEYWORD2
+readRegisterBurstMode	KEYWORD2
+writeRegisterBurstMode	KEYWORD2
+readRegister	KEYWORD2
+writeRegister	KEYWORD2
+readMagneticComponentsWithCrcCheck	KEYWORD2
+readRegisterQuickReadModeWithCrcCheck	KEYWORD2
+readRegisterBurstModeWithCrcCheck	KEYWORD2
+readRegisterWithCrcCheck	KEYWORD2
+writeRegisterWithCrcCheck	KEYWORD2
+twosComplement	KEYWORD2
+convertMagneticFieldFromLsbToMilliTesla	KEYWORD2
+convertTemperatureFromLsbToDegreeCelsius	KEYWORD2
 
 #######################################
 # Instances (KEYWORD2)

library.properties

@@ -1,4 +1,4 @@
-name=MagVector 3D Magnetic Sensor Library
+name=MagVector 3D Magnetic Sensor
 version=1.0.0
 author=Mathieu Kaelin, Monolithic Power Systems <[email protected]>
 maintainer=Mathieu Kaelin <[email protected]>

src/mv300sensor.cpp

@@ -17,6 +17,28 @@ uint8_t crcPolynomialLookupTable[256] ={0x00,0x07,0x0e,0x09,0x1c,0x1b,0x12,0x15,
                                         0xae,0xa9,0xa0,0xa7,0xb2,0xb5,0xbc,0xbb,0x96,0x91,0x98,0x9f,0x8a,0x8d,0x84,0x83,
                                         0xde,0xd9,0xd0,0xd7,0xc2,0xc5,0xcc,0xcb,0xe6,0xe1,0xe8,0xef,0xfa,0xfd,0xf4,0xf3};
 
+int16_t twosComplement(uint16_t value, uint8_t numberOfBits) {
+  if ((value & (1 << (numberOfBits - 1))) != 0) {
+    value = value - (1 << numberOfBits);
+  }
+  return value;
+}
+
+double convertMagneticFieldFromLsbToMilliTesla(int16_t magneticFieldInLsb, uint8_t brange) {
+  int16_t valueInMilliTesla;
+  if (brange == 0) {
+    valueInMilliTesla=magneticFieldInLsb/7.0;
+  }
+  else {
+    valueInMilliTesla=magneticFieldInLsb/14.0;
+  }
+  return valueInMilliTesla;
+}
+
+double convertTemperatureFromLsbToDegreeCelsius(int16_t temperatureInLsb) {
+  return (temperatureInLsb/5.0)-41.0;
+}
+
 MV300SensorI2c::MV300SensorI2c(){
   i2cAddress=0x14;
 }

src/mv300sensor.h

@@ -10,6 +10,10 @@
 #include <SPI.h>
 #include <Wire.h>
 
+int16_t twosComplement(uint16_t value, uint8_t numberOfBits=12);
+double convertMagneticFieldFromLsbToMilliTesla(int16_t magneticFieldInLsb, uint8_t brange=0);
+double convertTemperatureFromLsbToDegreeCelsius(int16_t temperatureInLsb);
+
 class MV300SensorI2c {
 public:
   MV300SensorI2c();