Adafruit_QMC5883P/README.md
2025-08-11 09:23:29 -04:00

34 lines
1.4 KiB
Markdown
Executable file

# Adafruit QMC5883P Library [![Build Status](https://github.com/adafruit/Adafruit_QMC5883P/workflows/Arduino%20Library%20CI/badge.svg)](https://github.com/adafruit/Adafruit_QMC5883P/actions)[![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_QMC5883P/html/index.html)
<a href="https://www.adafruit.com/product/6388"><img src="assets/board.jpg?raw=true" width="500px"><br/></a>
This is a library for the QMC5883P 3-axis magnetometer
## Features
- 3-axis magnetic field sensing
- 16-bit resolution
- I2C interface
- Multiple full-scale ranges (±2G, ±8G, ±12G, ±30G)
- Built-in self-test capability
- Temperature compensation
## Installation
To install, use the Arduino Library Manager and search for "Adafruit QMC5883P" and install the library.
## Dependencies
This library depends on the [Adafruit BusIO library](https://github.com/adafruit/Adafruit_BusIO)
## Hardware
The QMC5883P is a 3-axis magnetometer with I2C interface. It requires a 3.3V or 5V power supply.
## Contributing
Contributions are welcome! Please read our [Code of Conduct](https://github.com/adafruit/Adafruit_QMC5883P/blob/master/CODE_OF_CONDUCT.md) before contributing to help this project stay welcoming.
## License
MIT license, all text above must be included in any redistribution. See license.txt for more information.