# Adafruit QMC5883P - Triple Axis Magnetometer
## Overview
Sense the magnetic fields that surround us with this handy triple-axis magnetometer (compass) module. Magnetometers can sense where the strongest magnetic force is coming from, generally used to detect magnetic north, but can also be used for measuring magnetic fields. This sensor tends to be paired with a 6-DoF (degree of freedom) accelerometer/gyroscope to create a 9-DoF inertial measurement unit that can detect its orientation in real-space, thanks to Earth's stable magnetic field.
We based this breakout on the [QMC5883P](https://www.qstcorp.com/en_comp_prod/QMC5883P), a magnetometer we see used in many Quadcopter and robotic builds. This compact sensor uses I2C to communicate, and it's very easy to use. Simply download our library and connect the SCL pin to your I2C clock pin, and SDA pin to your I2C data pin and upload our test program to read out magnetic field data.
This sensor can sense ranges from +-2 Gauss (+- 200 uTesla) up to +-30 gauss (+- 3000 uT or 3.0 mT). With 16-bit ADC and settings for over-sampling and downsampling, you can set it up to get just the right range and precision.
To make life easier so you can focus on your important work, we've taken the QMC5883P and put it onto a breakout PCB along with support circuitry to let you use this little wonder with 3.3V (Feather/Raspberry Pi) or 5V (Arduino/ Metro328) logic levels. Additionally, since it speaks I2C, you can easily connect it up with two wires (plus power and ground!).
We've even included [SparkFun qwiic](https://www.sparkfun.com/qwiic) compatible **[STEMMA QT](https://learn.adafruit.com/introducing-adafruit-stemma-qt)** connectors for the I2C bus so **you don't even need to solder!** Just wire it up to your favorite micro and you can use our CircuitPython/Python or [Arduino drivers to easily interface with the QMC5883P](https://github.com/adafruit/Adafruit_QMC5883P) and get magnetic measurements ASAP. [**QT Cable is not included** , but we have a variety in the shop](https://www.adafruit.com/?q=stemma+qt+cable&sort=BestMatch).
It's fully assembled and tested. Comes with a bit of 0.1" standard header in case you want to use it with a breadboard or perfboard. Four 2.5mm (0.1") mounting holes for easy attachment.
# Adafruit QMC5883P - Triple Axis Magnetometer
## Pinouts
The default I2C address is **0x2C**.
## Power Pins
- **VIN** - this is the power pin. It can be powered by 3V or 5V. Give it the same power as the logic level of your microcontroller - e.g. for a 5V micro like Arduino, use 5V.
- **3Vo** - this is the 3.3V output from the voltage regulator, you can grab up to 100mA from this if you like.
- **GND** - common ground for power and logic.
## I2C Logic Pins
- **SCL** - I2C clock pin, connect to your microcontroller's I2C clock line. This pin can use 3-5V logic, and there's a **10K pullup** on this pin.
- **SDA** - I2C data pin, connect to your microcontroller's I2C data line. This pin can use 3-5V logic, and there's a **10K pullup** on this pin.
- **[STEMMA QT](https://learn.adafruit.com/introducing-adafruit-stemma-qt) -** These connectors allow you to connect to development boards with **STEMMA QT** (Qwiic) connectors or to other things with [various associated accessories](https://www.adafruit.com/?q=JST%20SH%204).
## Power LED and Jumper
- **Power LED -** In the upper left corner, above the STEMMA connector, on the front of the board, is the power LED, labeled **on**. It is a green LED.
- **LED jumper ** - This jumper is located on the back of the board and is labeled **LED** on the board silk. Cut the trace on this jumper to cut power to the " **on**" LED.
# Adafruit QMC5883P - Triple Axis Magnetometer
## CircuitPython and Python
It's easy to use the **QMC5883P breakout** with Python or CircuitPython, and the [Adafruit\_CircuitPython\_QMC5883P](https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P) module. This module allows you to easily write Python code to read magnetic field data from the sensor.
You can use this driver with any CircuitPython microcontroller board or with a computer that has GPIO and Python [thanks to Adafruit\_Blinka, our CircuitPython-for-Python compatibility library](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux).
## CircuitPython Microcontroller Wiring
First wire up the breakout to your board exactly as follows. The following is the breakout wired to a Feather RP2040 using the STEMMA connector:
- **Board STEMMA 3V** to **breakout STEMMA **** VIN (red wire)**
- **Board STEMMA GND** to **breakout** **STEMMA** **GND (black wire)**
- **Board STEMMA SCL** to **breakout** **STEMMA** **SCL (yellow wire)**
- **Board STEMMA SDA** to **breakout** **STEMMA** **SDA (blue wire)**
The following is the breakout wired to a Feather RP2040 using a solderless breadboard:
- **Board 3V** to **breakout** **VIN (red wire)**
- **Board GND** to **breakout** **GND (black wire)**
- **Board SCL** to **breakout** **SCL (yellow wire)**
- **Board SDA** to **breakout** **SDA (blue wire)**
## Python Computer Wiring
Since there are _dozens_ of Linux computers/boards you can use, we will show wiring for Raspberry Pi. For other platforms, [please visit the guide for CircuitPython on Linux to see whether your platform is supported](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux).
Here's the Raspberry Pi wired with I2C using the STEMMA connector:
- **Pi 3V** to **breakout STEMMA** **VIN (red wire)**
- **Pi GND** to **breakout** **STEMMA** **GND (black wire)**
- **Pi SCL** to **breakout** **STEMMA** **SCL (yellow wire)**
- **Pi SDA** to **breakout** **STEMMA** **SDA (blue wire)**
Here's the Raspberry Pi wired with I2C using a solderless breadboard:
- **Pi 3V** to **breakout** **VIN (red wire)**
- **Pi GND** to **breakout** **GND (black wire)**
- **Pi SCL** to **breakout** **SCL (yellow wire)**
- **Pi SDA** to **breakout** **SDA (blue wire)**
## Python Installation of QMC5883P Library
You'll need to install the **Adafruit\_Blinka** library that provides the CircuitPython support in Python. This may also require enabling I2C on your platform and verifying you are running Python 3. [Since each platform is a little different, and Linux changes often, please visit the CircuitPython on Linux guide to get your computer ready](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux)!
Once that's done, from your command line run the following command:
- `pip3 install adafruit-circuitpython-qmc5883p`
If your default Python is version 3 you may need to run 'pip' instead. Just make sure you aren't trying to use CircuitPython on Python 2.x, it isn't supported!
## CircuitPython Usage
To use with CircuitPython, you need to first install the **Adafruit\_CircuitPython\_QMC5883P** library, and its dependencies, into the **lib** folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.
Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire** **lib** **folder** and the **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY/lib** folder should contain the following folders and file:
- **adafruit\_bus\_device/**
- **adafruit\_register/**
- **adafruit\_qmc5883p.mpy**
## Python Usage
Once you have the library `pip3` installed on your computer, copy or download the following example to your computer, and run the following, replacing **code.py** with whatever you named the file:
`python3 code.py`
## Example Code
**If running CircuitPython:** Once everything is saved to the **CIRCUITPY** drive, [connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) to see the data printed out!
**If running Python:** The console output will appear wherever you are running Python.
https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P/blob/main/examples/qmc5883p_simpletest.py
First, the QMC5883P sensor is recognized over I2C. Then, in the loop, it prints out the scaled X, Y and Z readings in Gauss from the sensor.
# Adafruit QMC5883P - Triple Axis Magnetometer
## Python Docs
# Adafruit QMC5883P - Triple Axis Magnetometer
## Arduino
Using the QMC5883P breakout with Arduino involves wiring up the breakout to your Arduino-compatible microcontroller, installing the [Adafruit\_QMC5883P](https://github.com/adafruit/Adafruit_QMC5883P) library, and running the provided example code.
## Wiring
Wire as shown for a **5V** board like an Uno. If you are using a **3V** board, like an Adafruit Feather, wire the board's 3V pin to the sensor VIN.
Here is an Adafruit Metro wired up to the sensor using the STEMMA QT connector:
- **Board 5V** to **breakout** **VIN (red wire)**
- **Board GND** to **breakout** **GND (black wire)**
- **Board SCL** to **breakout** **SCL (yellow wire)**
- **Board SDA** to **breakout** **SDA (blue wire)**
Here is an Adafruit Metro wired up using a solderless breadboard:
- **Board 5V** to **breakout** **VIN (red wire)**
- **Board GND** to **breakout** **GND (black wire)**
- **Board SCL** to **breakout** **SCL (yellow wire)**
- **Board SDA** to **breakout** **SDA (blue wire)**
## Library Installation
You can install the **Adafruit\_QMC5883P** library for Arduino using the Library Manager in the Arduino IDE.
Click the **Manage Libraries ...** menu item, search for **Adafruit\_QMC5883P** , and select the **Adafruit QMC5883P** library:
If asked about dependencies, click "Install all".
If the "Dependencies" window does not come up, then you already have the dependencies installed.
Warning: If the dependencies are already installed, you must make sure you update them through the Arduino Library Manager before loading the example!
## Example Code
https://github.com/adafruit/Adafruit_QMC5883P/blob/main/examples/test_QMC5883P/test_QMC5883P.ino
Upload the sketch to your board and open up the Serial Monitor ( **Tools -\> Serial Monitor** ) at 115200 baud. You'll see the QMC5883P recognized over I2C. Then, the raw and scaled X, Y and Z readings will be printed out to the Serial Monitor.
# Adafruit QMC5883P - Triple Axis Magnetometer
## Arduino Docs
# Adafruit QMC5883P - Triple Axis Magnetometer
## WipperSnapper
## What is WipperSnapper
WipperSnapper is a firmware designed to turn any WiFi-capable board into an Internet-of-Things device without programming a single line of code. WipperSnapper connects to [Adafruit IO](https://io.adafruit.com/), a web platform designed ([by Adafruit!](https://www.adafruit.com/about)) to _display_, _respond_, and _interact_ with your project's data.
Simply load the WipperSnapper firmware onto your board, add credentials, and plug it into power. Your board will automatically register itself with your Adafruit IO account.
From there, you can add _components_ to your board such as buttons, switches, potentiometers, sensors, and more! Components are _dynamically _added to hardware, so you can immediately start interacting, logging, and streaming the data your projects produce without writing code.
If you've never used WipperSnapper, click below to read through the quick start guide before continuing.
[Quickstart: Adafruit IO WipperSnapper](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper)
## Wiring
First, wire up a QMC5883P to your board exactly as follows. Here is an example of the QMC5883P wired to an [Adafruit ESP32 Feather V2](https://www.adafruit.com/product/5400) using I2C [with a STEMMA QT cable (no soldering required)](https://www.adafruit.com/product/4210)
- **Board 3V** to **sensor VIN (red wire on STEMMA QT)**
- **Board GND** to **sensor GND (black wire on STEMMA QT)**
- **Board SCL** to **sensor SCL (yellow wire on STEMMA QT)**
- **Board SDA** to **sensor SDA (blue wire on STEMMA QT)**
## Usage
Connect your board to Adafruit IO Wippersnapper and **[navigate to the WipperSnapper board list](https://io.adafruit.com/wippersnapper).**
On this page, **select the WipperSnapper board you're using** to be brought to the board's interface page.
If you do not see your board listed here - you need [to connect your board to Adafruit IO](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper) first.
On the device page, quickly **check that you're running the latest version of the WipperSnapper firmware**.
The device tile on the left indicates the version number of the firmware running on the connected board.
- **If the firmware version is green with a checkmark -** continue with this guide.
- **If the firmware version is red with an exclamation mark "!" -** [update to the latest WipperSnapper firmware](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper) on your board before continuing.
Next, make sure the sensor is plugged into your board and click the ** I2C Scan ** button.
You should see the QMC5883P's default I2C address of `0x2C` pop-up in the I2C scan list.
### I don't see the sensor's I2C address listed!
First, double-check the connection and/or wiring between the sensor and the board.
Then, reset the board and let it re-connect to Adafruit IO WipperSnapper.
With the sensor detected in an I2C scan, you're ready to add the sensor to your board.
**Click the New Component button or the + button** to bring up the component picker.
Adafruit IO supports a large amount of components. To quickly find your sensor, type `QMC` into the search bar, then select the **QMC5883P** component.
On the component configuration page, the QMC5883P's sensor address should be listed along with the sensor's settings.
The **Send Every** option is specific to each sensor's measurements. This option will tell the Feather how often it should read from the QMC5883P sensor and send the data to Adafruit IO. Measurements can range from every second to every 24 hours.
For this example, set the **Send Every ** interval to every 30 seconds.
Your device interface should now show the sensor components you created. After the interval you configured elapses, WipperSnapper will automatically read values from the sensor(s) and send them to Adafruit IO.
To view the data that has been logged from the sensor, click on the graph next to the sensor name.
Here you can see the feed history and edit things about the feed such as the name, privacy, webhooks associated with the feed and more. If you want to learn more about how feeds work, [check out this page](https://learn.adafruit.com/all-the-internet-of-things-episode-four-adafruit-io/advanced-feeds).
# Adafruit QMC5883P - Triple Axis Magnetometer
## Downloads
## Files
- [QMC5883P Datasheet](https://cdn-shop.adafruit.com/product-files/6388/C2847467.pdf)
- [EagleCAD PCB files on GitHub](https://github.com/adafruit/Adafruit-QMC5883P-Triple-Axis-Magnetometer-PCB)
- [3D models on GitHub](https://github.com/adafruit/Adafruit_CAD_Parts/tree/main/6388%20QMC5883P%20Magnetometer)
- [Fritzing object in the Adafruit Fritzing Library](https://github.com/adafruit/Fritzing-Library/blob/master/parts/Adafruit%20QMC5883P%20-%20Triple%20Axis%20Magnetometer%20-%20STEMMA%20QT.fzpz)
## Schematic and Fab Print
## Primary Products
### Adafruit QMC5883P - Triple Axis Magnetometer
[Adafruit QMC5883P - Triple Axis Magnetometer](https://www.adafruit.com/product/6388)
Sense the magnetic fields that surround us with this handy triple-axis magnetometer (compass) module. Magnetometers can sense where the strongest magnetic force is coming from, generally used to detect magnetic north, but can also be used for measuring magnetic fields. This sensor tends to be...
In Stock
[Buy Now](https://www.adafruit.com/product/6388)
[Related Guides to the Product](https://learn.adafruit.com/products/6388/guides)
## Featured Products
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long](https://www.adafruit.com/product/4399)
This 4-wire cable is 50mm / 1.9" long and fitted with JST SH female 4-pin connectors on both ends. Compared with the chunkier JST PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
In Stock
[Buy Now](https://www.adafruit.com/product/4399)
[Related Guides to the Product](https://learn.adafruit.com/products/4399/guides)
### STEMMA QT / Qwiic JST SH 4-pin Cable - 100mm Long
[STEMMA QT / Qwiic JST SH 4-pin Cable - 100mm Long](https://www.adafruit.com/product/4210)
This 4-wire cable is a little over 100mm / 4" long and fitted with JST-SH female 4-pin connectors on both ends. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
In Stock
[Buy Now](https://www.adafruit.com/product/4210)
[Related Guides to the Product](https://learn.adafruit.com/products/4210/guides)
### STEMMA QT / Qwiic JST SH 4-pin Cable with Premium Female Sockets
[STEMMA QT / Qwiic JST SH 4-pin Cable with Premium Female Sockets](https://www.adafruit.com/product/4397)
This 4-wire cable is a little over 150mm / 6" long and fitted with JST-SH female 4-pin connectors on one end and premium female headers on the other. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and...
In Stock
[Buy Now](https://www.adafruit.com/product/4397)
[Related Guides to the Product](https://learn.adafruit.com/products/4397/guides)
### STEMMA QT / Qwiic JST SH 4-pin to Premium Male Headers Cable
[STEMMA QT / Qwiic JST SH 4-pin to Premium Male Headers Cable](https://www.adafruit.com/product/4209)
This 4-wire cable is a little over 150mm / 6" long and fitted with JST-SH female 4-pin connectors on one end and premium Dupont male headers on the other. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert...
In Stock
[Buy Now](https://www.adafruit.com/product/4209)
[Related Guides to the Product](https://learn.adafruit.com/products/4209/guides)
### JST SH 4-pin Cable with Alligator Clips - STEMMA QT / Qwiic
[JST SH 4-pin Cable with Alligator Clips - STEMMA QT / Qwiic](https://www.adafruit.com/product/4398)
This cable will make it super easy to use our plug-and-play STEMMA QT boards with boards like Circuit Playground. On one end you get a Qwiic / STEMMA QT connector (technically known as a JST SH 4-pin plug) into 4 individual wires with grippy alligator clips. We're carrying these to...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4398)
[Related Guides to the Product](https://learn.adafruit.com/products/4398/guides)
## Related Guides
- [MPU6050 6-DoF Accelerometer and Gyro](https://learn.adafruit.com/mpu6050-6-dof-accelerometer-and-gyro.md)
- [Circuit Playground TFT Gizmo Snow Globe](https://learn.adafruit.com/circuit-playground-tft-gizmo-snow-globe.md)
- [NeoTrellis Sound Board](https://learn.adafruit.com/neotrellis-soundboard.md)
- [Adafruit CCS811 Air Quality Sensor](https://learn.adafruit.com/adafruit-ccs811-air-quality-sensor.md)
- [Adafruit LIS2MDL Triple Axis Magnetometer](https://learn.adafruit.com/adafruit-lis2mdl-triple-axis-magnetometer.md)
- [Adafruit STEMMA Speaker](https://learn.adafruit.com/adafruit-stemma-speaker.md)
- [FunHouse IoT Fume Extractor and Air Quality Sensor](https://learn.adafruit.com/funhouse-fume-extractor-iot-air-quality-sensor.md)
- [NeoPixel Menorah](https://learn.adafruit.com/neopixel-menorah.md)
- [Adafruit Pixel Trinkey](https://learn.adafruit.com/adafruit-pixel-trinkey.md)
- [Adafruit IO](https://learn.adafruit.com/adafruit-io.md)
- [CircuitPython with Jupyter Notebooks](https://learn.adafruit.com/circuitpython-with-jupyter-notebooks.md)
- [Adafruit USB Type C Power Delivery Switchable Breakout](https://learn.adafruit.com/adafruit-usb-type-c-power-delivery-switchable-breakout.md)
- [CircuitPython CLUE I Ching Caster](https://learn.adafruit.com/clue-i-ching-caster.md)
- [Blinka Says Tabletop Arcade Game](https://learn.adafruit.com/blinka-says-tabletop-arcade-game.md)
- [Adafruit Feather RP2040 with DVI Output Port](https://learn.adafruit.com/adafruit-feather-rp2040-dvi.md)