Introduction
============
.. image:: https://readthedocs.org/projects/micropython-lis2mdl/badge/?version=latest
:target: https://micropython-lis2mdl.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://img.shields.io/badge/micropython-Ok-purple.svg
:target: https://micropython.org
:alt: micropython
.. image:: https://img.shields.io/pypi/v/micropython-lis2mdl.svg
:alt: latest version on PyPI
:target: https://pypi.python.org/pypi/micropython-lis2mdl
.. image:: https://static.pepy.tech/personalized-badge/micropython-lis2mdl?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads
:alt: Total PyPI downloads
:target: https://pepy.tech/project/micropython-lis2mdl
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
MicroPython Driver for the ST LIS2MDL Magnetometer sensor
Installing with mip
====================
To install using mpremote
.. code-block:: shell
mpremote mip install github:jposada202020/MicroPython_LIS2MDL
To install directly using a WIFI capable board
.. code-block:: shell
mip install github:jposada202020/MicroPython_LIS2MDL
Installing Library Examples
============================
If you want to install library examples:
.. code-block:: shell
mpremote mip install github:jposada202020/MicroPython_LIS2MDL/examples.json
To install directly using a WIFI capable board
.. code-block:: shell
mip install github:jposada202020/MicroPython_LIS2MDL/examples.json
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/micropython-lis2mdl/>`_.
To install for current user:
.. code-block:: shell
pip3 install micropython-lis2mdl
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install micropython-lis2mdl
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-lis2mdl
Usage Example
=============
Take a look at the examples directory
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://micropython-lis2mdl.readthedocs.io/en/latest/>`_.
Raw data
{
"_id": null,
"home_page": "",
"name": "micropython-lis2mdl",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sensor,micropython,lis2mdl,micropython,sensor,driver,lis2mdl,st,magnetic,magnetometer",
"author": "",
"author_email": "JDM <xxyx@mailmeto.mozmail.com>",
"download_url": "https://files.pythonhosted.org/packages/05/f4/be5cd0148b10b367e9c7173542fd3771997ef7d652092922da729cbf4f74/micropython-lis2mdl-0.1.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/micropython-lis2mdl/badge/?version=latest\n :target: https://micropython-lis2mdl.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/badge/micropython-Ok-purple.svg\n :target: https://micropython.org\n :alt: micropython\n\n.. image:: https://img.shields.io/pypi/v/micropython-lis2mdl.svg\n :alt: latest version on PyPI\n :target: https://pypi.python.org/pypi/micropython-lis2mdl\n\n.. image:: https://static.pepy.tech/personalized-badge/micropython-lis2mdl?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads\n :alt: Total PyPI downloads\n :target: https://pepy.tech/project/micropython-lis2mdl\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\nMicroPython Driver for the ST LIS2MDL Magnetometer sensor\n\n\nInstalling with mip\n====================\nTo install using mpremote\n\n.. code-block:: shell\n\n mpremote mip install github:jposada202020/MicroPython_LIS2MDL\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n mip install github:jposada202020/MicroPython_LIS2MDL\n\n\nInstalling Library Examples\n============================\n\nIf you want to install library examples:\n\n.. code-block:: shell\n\n mpremote mip install github:jposada202020/MicroPython_LIS2MDL/examples.json\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n mip install github:jposada202020/MicroPython_LIS2MDL/examples.json\n\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/micropython-lis2mdl/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install micropython-lis2mdl\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install micropython-lis2mdl\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 micropython-lis2mdl\n\n\nUsage Example\n=============\n\nTake a look at the examples directory\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://micropython-lis2mdl.readthedocs.io/en/latest/>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MicroPython Driver for the ST LIS2MDL Magnetometer sensor",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/jposada202020/MicroPython_LIS2MDL"
},
"split_keywords": [
"sensor",
"micropython",
"lis2mdl",
"micropython",
"sensor",
"driver",
"lis2mdl",
"st",
"magnetic",
"magnetometer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3414d1aea9aa752b9765b599c8d5706ccba929adb5fe0f77f7fd2785540c800",
"md5": "1663efa340266d1cb6a194a5cceb018a",
"sha256": "0f0f90a2921e271a3db2da20885f79433f328882b1ea471519c72fb129b7db33"
},
"downloads": -1,
"filename": "micropython_lis2mdl-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1663efa340266d1cb6a194a5cceb018a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7436,
"upload_time": "2023-06-27T03:30:38",
"upload_time_iso_8601": "2023-06-27T03:30:38.886753Z",
"url": "https://files.pythonhosted.org/packages/d3/41/4d1aea9aa752b9765b599c8d5706ccba929adb5fe0f77f7fd2785540c800/micropython_lis2mdl-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05f4be5cd0148b10b367e9c7173542fd3771997ef7d652092922da729cbf4f74",
"md5": "8e9564000eb34ae9a11530d2c9cd019a",
"sha256": "26c522724e96aa81e071a32f1b8e955a8870f178027984dc5a9a159a1143f0eb"
},
"downloads": -1,
"filename": "micropython-lis2mdl-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8e9564000eb34ae9a11530d2c9cd019a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19289,
"upload_time": "2023-06-27T03:30:40",
"upload_time_iso_8601": "2023-06-27T03:30:40.679861Z",
"url": "https://files.pythonhosted.org/packages/05/f4/be5cd0148b10b367e9c7173542fd3771997ef7d652092922da729cbf4f74/micropython-lis2mdl-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 03:30:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jposada202020",
"github_project": "MicroPython_LIS2MDL",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "micropython-lis2mdl"
}
JSON
