The HMC5883 is a digital compass designed for low-field magnetic sensing. This device has a wide magnetic field range of +/-8 Oe and an output rate of 160 Hz. The HMC5883 sensor includes automatic degaussing strap drivers, offset cancellation, and a 12-bit ADC that enables 1° to 2° compass heading accuracy. All I²C Mini Modules are designed to operate at 5VDC.

In this tutorial, we are going to explain the detailed working of HMC5883 with particle photon. Particle photon is a board which facilitates sending and receiving data from the website, that is supporting the most basic feature of Internet Of Things(IoT).

Step 1: Hardware Required:

The materials that we need for accomplishing our goal includes the following hardware components:

1. HMC5883

2. Particle Photon

3. I2C Cable

4. I2C Shield for Particle Photon

Step 2: Hardware Hookup:

The hardware hookup section basically explains the wiring connections required between the sensor and the particle photon. Ensuring correct connections is the basic necessity while working on any system for the desired output. So, the requisite connections are as follows:

The HMC5883 will work over I2C . Here is the example wiring diagram, demonstrating how to wire up each interface of the sensor.

Out-of-the-box, the board is configured for an I2C interface, as such we recommend using this hookup if you’re otherwise agnostic. All you need is four wires!

Only four connections are required Vcc, Gnd, SCL and SDA pins and these are connected with the help of I2C cable.

These connections are demonstrated in the pictures above.

Step 3: Code to Measure Magnetic Field Intensity:

Let's start with the particle code now.

While using the sensor module with the Arduino, we include application.h and spark_wiring_i2c.h library. "application.h" and spark_wiring_i2c.h library contains the functions which facilitate the i2c communication between the sensor and the particle.

The entire particle code is given below for the convenience of the user:

<p>#include<application.h></p><p>#include<spark_wiring_i2c.h></p><p> // HMC5883 I2C address is 0x1E(30)</p><p>#define Addr 0x1E
int xMag = 0, yMag =  0, zMag = 0;</p><p>void setup()</p><p>{    </p><p>// Set variable    </p><p>Particle.variable("i2cdevice", "HMC5883");    </p><p>Particle.variable("xMag", xMag);    </p><p>Particle.variable("yMag", yMag);    </p><p>Particle.variable("zMag", zMag);      </p><p>// Initialise I2C communication as MASTER    </p><p>Wire.begin();    </p><p>// Initialise Serial Communication, set baud rate = 9600    </p><p>Serial.begin(9600);        </p><p>// Start I2C Transmission    </p><p>Wire.beginTransmission(Addr);    </p><p>// Select configure register A    </p><p>Wire.write(0x00);    </p><p>// Set normal measurement configuration, data output rate = 0.75Hz    </p><p>Wire.write(0x60);    </p><p>// Stop I2C Transmission    </p><p>Wire.endTransmission();        </p><p>// Start I2C Transmission    </p><p>Wire.beginTransmission(Addr);    </p><p>// Select Mode register    </p><p>Wire.write(0x02);    </p><p>// Set continuous measurement    </p><p>Wire.write(0x00);    </p><p>// Stop I2C Transmission    </p><p>Wire.endTransmission();    </p><p>delay(300);</p><p>}    </p><p>void loop()</p><p>{    </p><p>unsigned int data[6];    </p><p>// Start I2C Transmission    </p><p>Wire.beginTransmission(Addr);    </p><p>// Select data register    </p><p>Wire.write(0x03);    </p><p>// Stop I2C Transmission    </p><p>Wire.endTransmission();</p><p>// Request 6 bytes of data    </p><p>Wire.requestFrom(Addr, 6);</p><p>// Read 6 bytes of data    </p><p>// xMag msb, xMag lsb, zMag msb, zMag lsb, yMag msb, yMag lsb    </p><p>if(Wire.available() == 6)    </p><p>{        </p><p>data[0] = Wire.read();        </p><p>data[1] = Wire.read();        </p><p>data[2] = Wire.read();        </p><p>data[3] = Wire.read();        </p><p>data[4] = Wire.read();        </p><p>data[5] = Wire.read();   </p><p>}    </p><p>delay(300);          </p><p>// Convert the data     </p><p>xMag = ((data[0] * 256) + data[1]);    </p><p>if(xMag > 32767)    </p><p>{        </p><p>xMag -= 65536;    </p><p>}    </p><p>zMag = ((data[2] * 256) + data[3]);    </p><p>if(zMag > 32767)    </p><p>{        </p><p>zMag -= 65536;    </p><p>}    </p><p>yMag = ((data[4] * 256) + data[5]);    </p><p>if(yMag > 32767)    </p><p>{        </p><p>yMag -= 65536;    </p><p>}        </p><p>// Output data to dashboard    </p><p>Particle.publish("Magnetic Field in X-Axis : ", String(xMag));    </p><p>delay(1000);    </p><p>Particle.publish("Magnetic Field in Y-Axis : ", String(yMag));    </p><p>delay(1000);    </p><p>Particle.publish("Magnetic Field in Z-Axis : ", String(zMag));    </p><p>delay(1000);</p><p>}</p>

Particle.variable() function creates the variables to store the output of the sensor and Particle.publish() function displays the output on the dashboard of the site.

The sensor output is shown in the picture above for your reference.

Step 4: Applications:

HMC5883 is a surface-mount, multi-chip module designed for low-field magnetic sensing with a digital interface for applications such as low cost compassing and magnetometry. Its one to two degree high level accuracy and precision enables Pedestrian Navigation and LBS Applications.