Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jposada202020/micropython_lis3mdl

MicroPython Driver for the ST LIS3MDL magnetometer
https://github.com/jposada202020/micropython_lis3mdl

driver lis3mdl magnetometer micropython sensor st

Last synced: 4 days ago
JSON representation

MicroPython Driver for the ST LIS3MDL magnetometer

Awesome Lists containing this project

README

        

⛔️ DEPRECATED
===============

This repository is no longer supported, please consider using alternatives.

.. image:: http://unmaintained.tech/badge.svg
:target: http://unmaintained.tech
:alt: No Maintenance Intended
MicroPython Driver for the ST LIS3MDL magnetometer

Installing with mip
====================
To install using mpremote

.. code-block:: shell

mpremote mip install github:jposada202020/MicroPython_LIS3MDL

To install directly using a WIFI capable board

.. code-block:: shell

mip.install("github:jposada202020/MicroPython_LIS3MDL")

Installing Library Examples
============================

If you want to install library examples:

.. code-block:: shell

mpremote mip install github:jposada202020/MicroPython_LIS3MDL/examples.json

To install directly using a WIFI capable board

.. code-block:: shell

mip.install("github:jposada202020/MicroPython_LIS3MDL/examples.json")

Installing from PyPI
=====================

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 micropython-lis3mdl

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

.. code-block:: shell

sudo pip3 install micropython-lis3mdl

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 micropython-lis3mdl

Usage Example
=============

Take a look at the examples directory

Documentation
=============
API documentation for this library can be found on `Read the Docs `_.