https://github.com/jposada202020/circuitpython_qmc5883l

CircuitPython Driver for the QMC5883L Sensor
https://github.com/jposada202020/circuitpython_qmc5883l

accelerometer circuitpython driver qmc5883l sensor

Last synced: 2 months ago
JSON representation

CircuitPython Driver for the QMC5883L Sensor

• Host: GitHub
• URL: https://github.com/jposada202020/circuitpython_qmc5883l
• Owner: jposada202020
• License: mit
• Created: 2023-03-25T17:16:17.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-07-25T22:26:41.000Z (over 1 year ago)
• Last Synced: 2024-03-25T19:16:21.668Z (9 months ago)
• Topics: accelerometer, circuitpython, driver, qmc5883l, sensor
• Language: Python
• Homepage:
• Size: 79.1 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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/pypi/v/circuitpython-qmc5883l.svg

    :alt: latest version on PyPI

    :target: https://pypi.python.org/pypi/circuitpython-qmc5883l

.. image:: https://static.pepy.tech/personalized-badge/circuitpython-qmc5883l?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads

    :alt: Total PyPI downloads

    :target: https://pepy.tech/project/circuitpython-qmc5883l

.. 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 `_

* `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:

.. 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