Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-qmc5883l/badge/?version=latest
:target: https://circuitpython-qmc5883l.readthedocs.io/
:alt: Documentation Status
.. image:: https://github.com/jposada202020/CircuitPython_qmc5883l/workflows/Build%20CI/badge.svg
:target: https://github.com/jposada202020/CircuitPython_qmc5883l/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython driver for the qmc5883l magnetometer
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.
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-qmc5883l/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-qmc5883l
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-qmc5883l
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 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:
.. 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 qmc5883l
Or the following command to update an existing version:
.. code-block:: shell
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 <https://circuitpython-qmc5883l.readthedocs.io/>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/jposada202020/CircuitPython_qmc5883l/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-qmc5883l",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,qmc5883l,magnetometer,driver,sensor,qmc5883l",
"author": "",
"author_email": "\"Jose D. Montoya\" <qmc@mailmeto.mozmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fb/34/62d8b843f3df4363166d9ea99d5742be77232b3f93922750829284a6cc10/circuitpython-qmc5883l-0.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/circuitpython-qmc5883l/badge/?version=latest\n :target: https://circuitpython-qmc5883l.readthedocs.io/\n :alt: Documentation Status\n\n.. image:: https://github.com/jposada202020/CircuitPython_qmc5883l/workflows/Build%20CI/badge.svg\n :target: https://github.com/jposada202020/CircuitPython_qmc5883l/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython driver for the qmc5883l magnetometer\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.\n\n=====================\n\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-qmc5883l/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-qmc5883l\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-qmc5883l\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 circuitpython-qmc5883l\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 qmc5883l\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nTake a look a the ``qmc5883l_simpletest.py`` in the examples directory\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-qmc5883l.readthedocs.io/>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/jposada202020/CircuitPython_qmc5883l/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 qmc5883l magnetometer",
"version": "0.1.2",
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"qmc5883l",
"magnetometer",
"driver",
"sensor",
"qmc5883l"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f79d642bbce32808e50e060373849dfe2430cb17bacc03778b298ed47a800c9",
"md5": "9d5d35f1e070a3333e5766c560b33c40",
"sha256": "5cc5f702490d6bb4b8d0d6c1477bb31c108112f46c7eb2c1cb6d169cf440082b"
},
"downloads": -1,
"filename": "circuitpython_qmc5883l-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d5d35f1e070a3333e5766c560b33c40",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6031,
"upload_time": "2023-04-20T22:34:49",
"upload_time_iso_8601": "2023-04-20T22:34:49.298147Z",
"url": "https://files.pythonhosted.org/packages/2f/79/d642bbce32808e50e060373849dfe2430cb17bacc03778b298ed47a800c9/circuitpython_qmc5883l-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb3462d8b843f3df4363166d9ea99d5742be77232b3f93922750829284a6cc10",
"md5": "03fdb7393f63d223351cb17738a2fbe9",
"sha256": "92f1f605ed4e1f3414553bfb35817942bdbffa787c8117a428b9b47becdba9f5"
},
"downloads": -1,
"filename": "circuitpython-qmc5883l-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "03fdb7393f63d223351cb17738a2fbe9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27368,
"upload_time": "2023-04-20T22:34:51",
"upload_time_iso_8601": "2023-04-20T22:34:51.349284Z",
"url": "https://files.pythonhosted.org/packages/fb/34/62d8b843f3df4363166d9ea99d5742be77232b3f93922750829284a6cc10/circuitpython-qmc5883l-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-20 22:34:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "circuitpython-qmc5883l"
}
JSON