Introduction
============
.. image:: https://readthedocs.org/projects/micropython-lis3mdl/badge/?version=latest
:target: https://micropython-lis3mdl.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-lis3mdl.svg
:alt: latest version on PyPI
:target: https://pypi.python.org/pypi/micropython-lis3mdl
.. image:: https://static.pepy.tech/personalized-badge/micropython-lis3mdl?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-lis3mdl
.. 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 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 <https://pypi.org/project/micropython-lis3mdl/>`_.
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 <https://micropython-lis3mdl.readthedocs.io/en/latest/>`_.
Raw data
{
"_id": null,
"home_page": "",
"name": "micropython-lis3mdl",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sensor,micropython,lis3mdl,magnetometer,temperature,driver",
"author": "",
"author_email": "JDM <xxyx@mailmeto.mozmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ff/5e/63dde21dbc1389f5e99823a400ef86b645d74653785bea414226509ecac5/micropython-lis3mdl-0.2.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/micropython-lis3mdl/badge/?version=latest\n :target: https://micropython-lis3mdl.readthedocs.io/en/latest/\n :alt: Documentation Status\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-lis3mdl.svg\n :alt: latest version on PyPI\n :target: https://pypi.python.org/pypi/micropython-lis3mdl\n\n.. image:: https://static.pepy.tech/personalized-badge/micropython-lis3mdl?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-lis3mdl\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 LIS3MDL magnetometer\n\n\nInstalling with mip\n====================\nTo install using mpremote\n\n.. code-block:: shell\n\n mpremote mip install github:jposada202020/MicroPython_LIS3MDL\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n mip.install(\"github:jposada202020/MicroPython_LIS3MDL\")\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_LIS3MDL/examples.json\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n mip.install(\"github:jposada202020/MicroPython_LIS3MDL/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-lis3mdl/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install micropython-lis3mdl\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install micropython-lis3mdl\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-lis3mdl\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-lis3mdl.readthedocs.io/en/latest/>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MicroPython Driver for the ST LIS3MDL magnetometer",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/jposada202020/MicroPython_LIS3MDL"
},
"split_keywords": [
"sensor",
"micropython",
"lis3mdl",
"magnetometer",
"temperature",
"driver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7df8279373622e030eaaaf8de4649f9687960fd6109fcd1879f562f388557dfa",
"md5": "07de83b6508797735ea16acaaebdf993",
"sha256": "f6b132d69832805553d8ea05f14eaf510407fc2bfb64606b7ed92b6042784122"
},
"downloads": -1,
"filename": "micropython_lis3mdl-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07de83b6508797735ea16acaaebdf993",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7315,
"upload_time": "2023-08-30T23:44:44",
"upload_time_iso_8601": "2023-08-30T23:44:44.634793Z",
"url": "https://files.pythonhosted.org/packages/7d/f8/279373622e030eaaaf8de4649f9687960fd6109fcd1879f562f388557dfa/micropython_lis3mdl-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff5e63dde21dbc1389f5e99823a400ef86b645d74653785bea414226509ecac5",
"md5": "c9efd37557cc891cd56b4b96b1a546bf",
"sha256": "4629adacb54d1198be2828cdf59f80226ed721058d715bae872915962dfa3aeb"
},
"downloads": -1,
"filename": "micropython-lis3mdl-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c9efd37557cc891cd56b4b96b1a546bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19510,
"upload_time": "2023-08-30T23:44:45",
"upload_time_iso_8601": "2023-08-30T23:44:45.719986Z",
"url": "https://files.pythonhosted.org/packages/ff/5e/63dde21dbc1389f5e99823a400ef86b645d74653785bea414226509ecac5/micropython-lis3mdl-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-30 23:44:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jposada202020",
"github_project": "MicroPython_LIS3MDL",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "micropython-lis3mdl"
}
JSON
