Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lis3mdl/badge/?version=latest
:target: https://docs.circuitpython.org/projects/lis3mdl/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL/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 helper library for the LIS3MDL 3-axis 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.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-lis3mdl/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-lis3mdl
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-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 .venv/bin/activate
pip3 install adafruit-circuitpython-lis3mdl
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_lis3mdl
i2c = board.I2C() # uses board.SCL and board.SDA
sensor = adafruit_lis3mdl.LIS3MDL(i2c)
while True:
mag_x, mag_y, mag_z = sensor.magnetic
print('X:{0:10.2f}, Y:{1:10.2f}, Z:{2:10.2f} uT'.format(mag_x, mag_y, mag_z))
print('')
time.sleep(1.0)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/lis3mdl/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-lis3mdl",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, lis3mdl, magnetometer, LSM6DS33, IMU",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/64/26/7d66e3efd9ad9d9f7a4d114a9ef984035c52c75c055fe00164a8b2eb6d12/adafruit_circuitpython_lis3mdl-1.2.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lis3mdl/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/lis3mdl/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL/actions\n :alt: Build Status\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 helper library for the LIS3MDL 3-axis 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.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\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/adafruit-circuitpython-lis3mdl/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-lis3mdl\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-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 .venv/bin/activate\n pip3 install adafruit-circuitpython-lis3mdl\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_lis3mdl\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n sensor = adafruit_lis3mdl.LIS3MDL(i2c)\n\n while True:\n mag_x, mag_y, mag_z = sensor.magnetic\n\n print('X:{0:10.2f}, Y:{1:10.2f}, Z:{2:10.2f} uT'.format(mag_x, mag_y, mag_z))\n print('')\n time.sleep(1.0)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/lis3mdl/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for the LIS3MDL 3-axis magnetometer",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" lis3mdl",
" magnetometer",
" lsm6ds33",
" imu"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b62baa54bb8c733da36b85b996bb0a04ad4245fadf23bf5b527ecb395329ca48",
"md5": "934c63d76e0175444c971f0cbaae4970",
"sha256": "5b767d961b696ccb6835241659f619b262050296fe25674550755f854c1a3109"
},
"downloads": -1,
"filename": "adafruit_circuitpython_lis3mdl-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "934c63d76e0175444c971f0cbaae4970",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6877,
"upload_time": "2024-10-07T22:04:00",
"upload_time_iso_8601": "2024-10-07T22:04:00.166008Z",
"url": "https://files.pythonhosted.org/packages/b6/2b/aa54bb8c733da36b85b996bb0a04ad4245fadf23bf5b527ecb395329ca48/adafruit_circuitpython_lis3mdl-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64267d66e3efd9ad9d9f7a4d114a9ef984035c52c75c055fe00164a8b2eb6d12",
"md5": "293ffba69dc5e225a0e495fb5e0799db",
"sha256": "42ba109ed1a6dfc254350b20db750a24d4707080e21d7b06530853c64c7e3ddd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_lis3mdl-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "293ffba69dc5e225a0e495fb5e0799db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30017,
"upload_time": "2024-10-07T22:04:01",
"upload_time_iso_8601": "2024-10-07T22:04:01.062818Z",
"url": "https://files.pythonhosted.org/packages/64/26/7d66e3efd9ad9d9f7a4d114a9ef984035c52c75c055fe00164a8b2eb6d12/adafruit_circuitpython_lis3mdl-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:04:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_LIS3MDL",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-lis3mdl"
}
JSON
