Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tlv493d/badge/?version=latest
:target: https://docs.circuitpython.org/projects/tlv493d/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_TLV493D/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_TLV493D/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 TLV493D 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://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-tlv493d/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-tlv493d
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-tlv493d
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-tlv493d
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_tlv493d
i2c = board.I2C() # uses board.SCL and board.SDA
tlv = adafruit_tlv493d.TLV493D(i2c)
while True:
print("X: %s, Y:%s, Z:%s uT"%tlv.magnetic)
time.sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tlv493d/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_TLV493D/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-tlv493d",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,tlv493d,tlv,sensor,magnetometer",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/a4/de/8b3d416a7c48d1c3b6619cf28fbe610a2db7fb48bb37d2ba36feafaca891/adafruit-circuitpython-tlv493d-2.0.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tlv493d/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/tlv493d/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_TLV493D/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_TLV493D/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 TLV493D 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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-tlv493d/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-tlv493d\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-tlv493d\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-tlv493d\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_tlv493d\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n tlv = adafruit_tlv493d.TLV493D(i2c)\n\n while True:\n print(\"X: %s, Y:%s, Z:%s uT\"%tlv.magnetic)\n time.sleep(1)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tlv493d/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_TLV493D/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 TLV493D 3-axis magnetometer",
"version": "2.0.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TLV493D"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"tlv493d",
"tlv",
"sensor",
"magnetometer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0565347bb91179c41fb996537c75787004aae600eef619d30bbb2ffe5d55866",
"md5": "012029528bfe2d4c1570abf5cdcd00cf",
"sha256": "6352276e9ce000a07e6a968333dcec22182a4fe2ac9db7dde1553edf3d278a88"
},
"downloads": -1,
"filename": "adafruit_circuitpython_tlv493d-2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "012029528bfe2d4c1570abf5cdcd00cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5538,
"upload_time": "2023-12-09T17:35:43",
"upload_time_iso_8601": "2023-12-09T17:35:43.078500Z",
"url": "https://files.pythonhosted.org/packages/d0/56/5347bb91179c41fb996537c75787004aae600eef619d30bbb2ffe5d55866/adafruit_circuitpython_tlv493d-2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4de8b3d416a7c48d1c3b6619cf28fbe610a2db7fb48bb37d2ba36feafaca891",
"md5": "939a44be26c49939cad33ea18f066182",
"sha256": "815471e79a92c66c65bc48c26724948ec83e9deaf41ef388e03e20135d840177"
},
"downloads": -1,
"filename": "adafruit-circuitpython-tlv493d-2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "939a44be26c49939cad33ea18f066182",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26528,
"upload_time": "2023-12-09T17:35:46",
"upload_time_iso_8601": "2023-12-09T17:35:46.746937Z",
"url": "https://files.pythonhosted.org/packages/a4/de/8b3d416a7c48d1c3b6619cf28fbe610a2db7fb48bb37d2ba36feafaca891/adafruit-circuitpython-tlv493d-2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:35:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_TLV493D",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-tlv493d"
}
JSON
