Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mlx90393/badge/?version=latest
:target: https://docs.circuitpython.org/projects/mlx90393/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_MLX90393/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/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
Adafruit CircuitPython driver for the MLX90393 3-axis magnetometer.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-mlx90939/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-mlx90939
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-mlx90939
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-mlx90939
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_mlx90393
i2c = board.I2C() # uses board.SCL and board.SDA
SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
while True:
MX, MY, MZ = SENSOR.magnetic
print("[{}]".format(time.monotonic()))
print("X: {} uT".format(MX))
print("Y: {} uT".format(MY))
print("Z: {} uT".format(MZ))
# Display the status field if an error occured, etc.
if SENSOR.last_status > adafruit_mlx90393.STATUS_OK:
SENSOR.display_status()
time.sleep(1.0)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mlx90393/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_MLX90393/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-mlx90393",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, three-axis, magnetometer, magnet, mlx90393, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/97/a5/7b7e37644a82f8820082e2f26ee39b62cc44ce6584f851a6715014b4e393/adafruit_circuitpython_mlx90393-2.2.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mlx90393/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/mlx90393/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_MLX90393/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/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\nAdafruit CircuitPython driver for the MLX90393 3-axis magnetometer.\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\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-mlx90939/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-mlx90939\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-mlx90939\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-mlx90939\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_mlx90393\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)\n\n while True:\n MX, MY, MZ = SENSOR.magnetic\n print(\"[{}]\".format(time.monotonic()))\n print(\"X: {} uT\".format(MX))\n print(\"Y: {} uT\".format(MY))\n print(\"Z: {} uT\".format(MZ))\n # Display the status field if an error occured, etc.\n if SENSOR.last_status > adafruit_mlx90393.STATUS_OK:\n SENSOR.display_status()\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/mlx90393/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_MLX90393/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for the MLX90393 3-axis magnetometer.",
"version": "2.2.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393"
},
"split_keywords": [
"adafruit",
" three-axis",
" magnetometer",
" magnet",
" mlx90393",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "440af190b002f9623da51a3d06ab6247a942e45a8192403f4cae0f97956b6ae5",
"md5": "1ef65b4745106be20c2534451bb15cfa",
"sha256": "9619f99932725de9b62e284b2de1b0f13e35149f62b9d4838634c115a5abed49"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mlx90393-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ef65b4745106be20c2534451bb15cfa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9215,
"upload_time": "2024-10-07T22:13:16",
"upload_time_iso_8601": "2024-10-07T22:13:16.691781Z",
"url": "https://files.pythonhosted.org/packages/44/0a/f190b002f9623da51a3d06ab6247a942e45a8192403f4cae0f97956b6ae5/adafruit_circuitpython_mlx90393-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97a57b7e37644a82f8820082e2f26ee39b62cc44ce6584f851a6715014b4e393",
"md5": "cd2a0c3828d6407b91a51de7f622bf1b",
"sha256": "f07fad13d0e8b6380f5257c31ed823011201dd6ad55df0be2cb30f6fc6c8c637"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mlx90393-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "cd2a0c3828d6407b91a51de7f622bf1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30453,
"upload_time": "2024-10-07T22:13:17",
"upload_time_iso_8601": "2024-10-07T22:13:17.991224Z",
"url": "https://files.pythonhosted.org/packages/97/a5/7b7e37644a82f8820082e2f26ee39b62cc44ce6584f851a6715014b4e393/adafruit_circuitpython_mlx90393-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:13:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MLX90393",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-mlx90393"
}
JSON
