Home / Projects / ESP32 Projects / ESP32 Magnetometer using HMC5883L
HMC5883L Breakout Board

ESP32 Magnetometer using HMC5883L

For this article, I will show you how to use an ESP32 microcontroller as a magnetometer - a device that measures the direction and strength of a nearby magnet. In the absence of a nearby magnet, the device detects the Earth’s magnetic field. Hence, a compass is a type of magnetometer.

Here, I will read the data from the HMC5883L magnetometer breakout board, and have the heading shown in a web app accessible through WiFi. The device should connect to the same WiFi connection as the ESP32.

Materials

  • ESP32 (NodeMCU-32S)
  • HMC5883L Breakout Board
  • Breadboard, Connecting Wires, Power Source

The ESP32 is a WiFi microcontroller and is a successor to the popular ESP8266. I created the code for the ESP32 using the Arduino IDE. Note that I am using the NodeMCU-32S which has a different pinout compared to other similarly looking ESP32 boards.

NodeMCU-32S Pinout

The Honeywell HMC5883L is a surface-mount, multi-chip module with a digital interface for applications such as low-cost compassing and magnetometry. It communicates via I2C and is able to provide magnetic flux density in three axes.

For this project, I am using the HMC5883L breakout board:

HMC5883L Breakout Board

This breakout board makes the HMC5883L easier to interface with a microcontroller. The wiring diagram for this breakout board and the ESP32 is on the succeeding section.

Measuring Heading

As mentioned, this project shows the heading of the device. Heading is the angle from the true north. Given the magnetic flux densities in x and y axes, the heading is:

 

However, magnetometers detect magnetic north and not true north. This error, known as magnetic declination, depends on the location of the magnetometer. Hence, correct heading should account for this declination.

Wiring Diagram

Since the HMC5883L communicates via I2C, it connects to the SDA (GPIO21) and SCL (GPIO22) pins of the ESP32. Also, the HMC5883L needs a 3.3V power supply, hence it gets its power from the 3.3V pin of the ESP32.

ESP32 HMC5883L Wiring Diagram

Web App

The web app for this project contains an arrow that rotates according to the heading. A text field indicates the heading in degrees.

ESP32 Magnetometer App

This web app contains both an HTML and JavaScript code. The HTML arranges all the elements in the app while the JavaScript is in charge of reading the data from the ESP32 and rotating the arrow.

The HTML code is inside the “mainpage.h” header while the JavaScript code is inside “jscript.h”.

Here is the <body> part of the HTML:

The heading value is displayed inside the <input> text element with ID ‘heading-value’. The arrow image has an ID ‘arrow’.

Here’s the JavaScript file:

The script utilizes JQuery library.

Here's how the script works: the function getData() every second through the setInterval() method. Once it executes, an AJAX request is made through a page on the ESP32 web server ‘data’. This page returns the heading value from the HM5883L. That heading value is then used to rotate the arrow using transform:rotate.

ESP32 Code

Much of the ESP32 code is the same as the ESP32 web server code. The relevant part is how the ESP32 reads and passes the HMC5883L data to the client.

The code requires Adafruit's Unified Sensor and HMC5883L libraries.

Looking at esp32-magnetometer.ino code, you’ll see this part:

The ‘data’ page serves the AJAX requests from the javascript code. The data from HMC5883L is read and the heading is calculated every time this request is done.

Note than in the code above, the declination angle is considered. Go here to know the declination angle in your location.

The full code is in my repository.

Output Video

The "front" of the HMC5883L breakout board is where the x-axis points on the board. When this is pointed to the north, the arrow in the app points towards north. This corresponds to a heading of 0 degrees.

Check Also

ESP32 Web Server

Sensor Display on ESP32 Web Server

Last time, I showed you how to setup the ESP32 development board with the Arduino …

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.