Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-qmc5883p/badge/?version=latest
:target: https://docs.circuitpython.org/projects/qmc5883p/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython driver for the Adafruit QMC5883P - Triple Axis Magnetometer - STEMMA QT
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6388>`_
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-qmc5883p/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-qmc5883p
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-qmc5883p
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-qmc5883p
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:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_qmc5883p
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
import adafruit_qmc5883p
i2c = board.I2C()
sensor = adafruit_qmc5883p.QMC5883P(i2c)
while True:
mag_x, mag_y, mag_z = sensor.magnetic
print(f"X:{mag_x:2.3f}, Y:{mag_y:2.3f}, Z:{mag_z:2.3f} G")
print("")
time.sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/qmc5883p/en/latest/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-qmc5883p",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, qmc5883p, magnetometer, , sensor",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/97/54/ce4845e52f06d41039c854533a4854c51abbe1e7b5d00f0bf7be7e48c711/adafruit_circuitpython_qmc5883p-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-qmc5883p/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/qmc5883p/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython driver for the Adafruit QMC5883P - Triple Axis Magnetometer - STEMMA QT\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6388>`_\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-qmc5883p/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-qmc5883p\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-qmc5883p\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install adafruit-circuitpython-qmc5883p\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_qmc5883p\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n import board\n import adafruit_qmc5883p\n\n i2c = board.I2C()\n\n sensor = adafruit_qmc5883p.QMC5883P(i2c)\n\n while True:\n mag_x, mag_y, mag_z = sensor.magnetic\n\n print(f\"X:{mag_x:2.3f}, Y:{mag_y:2.3f}, Z:{mag_z:2.3f} G\")\n print(\"\")\n\n time.sleep(1)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/qmc5883p/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for the Adafruit QMC5883P - Triple Axis Magnetometer - STEMMA QT",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_QMC5883P"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" qmc5883p",
" magnetometer",
" ",
" sensor"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dbff82f59acc6864d8e488a2d72507f63fd7ff1b7d5695c132f6f5b42c310a1f",
"md5": "3d6411ab4f97ef13278798a72706bf68",
"sha256": "0188de61b8c7b67fb2e8deffb6cd491f4f068f64b010ff3a4cb4a63d3bb37d7e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_qmc5883p-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d6411ab4f97ef13278798a72706bf68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6569,
"upload_time": "2025-08-08T18:35:00",
"upload_time_iso_8601": "2025-08-08T18:35:00.482693Z",
"url": "https://files.pythonhosted.org/packages/db/ff/82f59acc6864d8e488a2d72507f63fd7ff1b7d5695c132f6f5b42c310a1f/adafruit_circuitpython_qmc5883p-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9754ce4845e52f06d41039c854533a4854c51abbe1e7b5d00f0bf7be7e48c711",
"md5": "260d2048a51b1c2f16721fe4d75c73db",
"sha256": "02d5e677c6c64a4feac877b42531e111c7ae51bd44eda4abac91d343ad59ed8c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_qmc5883p-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "260d2048a51b1c2f16721fe4d75c73db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24746,
"upload_time": "2025-08-08T18:35:01",
"upload_time_iso_8601": "2025-08-08T18:35:01.908924Z",
"url": "https://files.pythonhosted.org/packages/97/54/ce4845e52f06d41039c854533a4854c51abbe1e7b5d00f0bf7be7e48c711/adafruit_circuitpython_qmc5883p-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-08 18:35:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_QMC5883P",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
}
],
"lcname": "adafruit-circuitpython-qmc5883p"
}
JSON
