Introduction¶

CircuitPython driver for the qmc5883l magnetometer

Dependencies¶

This driver depends on:

• Adafruit CircuitPython

• Bus Device

• Register

Please ensure all dependencies are available on the CircuitPython filesystem.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-qmc5883l

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-qmc5883l

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-qmc5883l

Installing to a Connected CircuitPython Device with Circup¶

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install qmc5883l

Or the following command to update an existing version:

circup update

Usage Example¶

Take a look a the qmc5883l_simpletest.py in the examples directory

Documentation¶

API documentation for this library can be found on Read the Docs.

Contributing¶

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Table of Contents¶