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": "",
"name": "adafruit-circuitpython-mlx90393",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,three-axis,magnetometer,magnet,mlx90393,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ad/7c/e6704a2102cb41d7885d12cd6206a2a111cbc0e9621e4ef4cca3497bc249/adafruit-circuitpython-mlx90393-2.1.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.1.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": "dfd44bf4ee874f21c2c3e17d033712a943fdeb3c138ae7f9663467e6ffd2e0cf",
"md5": "e702915b05f055d8d491b634eb1dfd3b",
"sha256": "eae56c37e7aaf56257d6ee576ea09f82a1525b606eae4ca329cfe5639e8efb95"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mlx90393-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e702915b05f055d8d491b634eb1dfd3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8930,
"upload_time": "2023-05-26T16:24:28",
"upload_time_iso_8601": "2023-05-26T16:24:28.581638Z",
"url": "https://files.pythonhosted.org/packages/df/d4/4bf4ee874f21c2c3e17d033712a943fdeb3c138ae7f9663467e6ffd2e0cf/adafruit_circuitpython_mlx90393-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad7ce6704a2102cb41d7885d12cd6206a2a111cbc0e9621e4ef4cca3497bc249",
"md5": "676e4606910a6f69752b758cf84e0c7f",
"sha256": "dbba87cfc478a1e027c60db25a440803de113909626d8e7e928ecb29cc47610b"
},
"downloads": -1,
"filename": "adafruit-circuitpython-mlx90393-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "676e4606910a6f69752b758cf84e0c7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30267,
"upload_time": "2023-05-26T16:24:30",
"upload_time_iso_8601": "2023-05-26T16:24:30.016768Z",
"url": "https://files.pythonhosted.org/packages/ad/7c/e6704a2102cb41d7885d12cd6206a2a111cbc0e9621e4ef4cca3497bc249/adafruit-circuitpython-mlx90393-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 16:24:30",
"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
