Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mlx90395/badge/?version=latest
:target: https://docs.circuitpython.org/projects/mlx90395/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_MLX90395/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90395/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 using the Adafruit MLX90395 tri-Axis magnetometer breakout
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-mlx90395/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-mlx90395
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-mlx90395
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-mlx90395
Usage Example
=============
.. code-block:: python3
from time import sleep
import board
import busio
from adafruit_mlx90395 import MLX90395, OSR
i2c = busio.I2C(board.SCL, board.SDA)
sensor = MLX90395(i2c)
while True:
mag_x, mag_y, mag_z = sensor.magnetic
print("X1:{0:10.2f}, Y:{1:10.2f}, Z:{2:10.2f} uT".format(mag_x, mag_y, mag_z))
print("")
sleep(0.5)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mlx90395/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_MLX90395/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-mlx90395",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, mlx90395, magnet, position, magnetometer, 3-axis, hard, iron",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/8c/39/6eb35fd7b72ca9ebf18a5eae3a5ba63dbac72f81a078bdceaa2380d46d26/adafruit_circuitpython_mlx90395-1.0.14.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mlx90395/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/mlx90395/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_MLX90395/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90395/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 using the Adafruit MLX90395 tri-Axis magnetometer breakout\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-mlx90395/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-mlx90395\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-mlx90395\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-mlx90395\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n from time import sleep\n import board\n import busio\n from adafruit_mlx90395 import MLX90395, OSR\n\n i2c = busio.I2C(board.SCL, board.SDA)\n sensor = MLX90395(i2c)\n while True:\n mag_x, mag_y, mag_z = sensor.magnetic\n\n print(\"X1:{0:10.2f}, Y:{1:10.2f}, Z:{2:10.2f} uT\".format(mag_x, mag_y, mag_z))\n print(\"\")\n\n sleep(0.5)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mlx90395/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_MLX90395/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for using the Adafruit MLX90395 tri-Axis magnetometer breakout",
"version": "1.0.14",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MLX90395"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" mlx90395",
" magnet",
" position",
" magnetometer",
" 3-axis",
" hard",
" iron"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8444f0ebf8f23f373ecc6b2901f70b64bfe6c9263ccba4a408d03808f18cd47",
"md5": "6adad896bf26a5f3e313b26ffff4008d",
"sha256": "e6033ac6463ebdab7f595966f739fab65a566a4ee8cb706efaf5663002b521a5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mlx90395-1.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6adad896bf26a5f3e313b26ffff4008d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6676,
"upload_time": "2024-10-07T22:13:28",
"upload_time_iso_8601": "2024-10-07T22:13:28.540152Z",
"url": "https://files.pythonhosted.org/packages/d8/44/4f0ebf8f23f373ecc6b2901f70b64bfe6c9263ccba4a408d03808f18cd47/adafruit_circuitpython_mlx90395-1.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c396eb35fd7b72ca9ebf18a5eae3a5ba63dbac72f81a078bdceaa2380d46d26",
"md5": "e33aebdc6529c0e6f1b46212ce444599",
"sha256": "a61a328f762f4e1752f903b92007b0e942ed3e62e13dfc032cd2fecd86d91d61"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mlx90395-1.0.14.tar.gz",
"has_sig": false,
"md5_digest": "e33aebdc6529c0e6f1b46212ce444599",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27728,
"upload_time": "2024-10-07T22:13:29",
"upload_time_iso_8601": "2024-10-07T22:13:29.497775Z",
"url": "https://files.pythonhosted.org/packages/8c/39/6eb35fd7b72ca9ebf18a5eae3a5ba63dbac72f81a078bdceaa2380d46d26/adafruit_circuitpython_mlx90395-1.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:13:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MLX90395",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-mlx90395"
}
JSON
