Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lis331/badge/?version=latest
:target: https://docs.circuitpython.org/projects/lis331/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_LIS331/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_LIS331/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
A library for the ST LIS331 family of high-g 3-axis accelerometers
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-lis331/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-lis331
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-lis331
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-lis331
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_lis331
i2c = board.I2C() # uses board.SCL and board.SDA
lis = adafruit_lis331.LIS331(i2c)
while True:
print("Acceleration : X: %.2f, Y:%.2f, Z:%.2f ms^2" % lis.acceleration)
time.sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/lis331/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_LIS331/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-lis331",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, lis331, lis331hh, h3lis331dl, accelerometer, accel, IMU",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/78/85/a47a40656e7c66dff9e97772c7ff6278bd8b2d9c87f649ecf1115f0cb8f3/adafruit_circuitpython_lis331-1.0.19.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lis331/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/lis331/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_LIS331/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_LIS331/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\nA library for the ST LIS331 family of high-g 3-axis accelerometers\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=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-lis331/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-lis331\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-lis331\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-lis331\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_lis331\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n lis = adafruit_lis331.LIS331(i2c)\n\n while True:\n print(\"Acceleration : X: %.2f, Y:%.2f, Z:%.2f ms^2\" % lis.acceleration)\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/lis331/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_LIS331/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for the ST LIS331 family of high-g 3-axis accelerometers",
"version": "1.0.19",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_LIS331"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" lis331",
" lis331hh",
" h3lis331dl",
" accelerometer",
" accel",
" imu"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0069811098319d602b587977c17d477fc1a8736e6654ac6241c480619ca1c913",
"md5": "8516fb40225022fdb3c759525cfaa23f",
"sha256": "8ab4ee17408468695e3f7b679da7db4b05721116762420dc9827437b32e12ffc"
},
"downloads": -1,
"filename": "adafruit_circuitpython_lis331-1.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8516fb40225022fdb3c759525cfaa23f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8425,
"upload_time": "2024-10-07T22:03:46",
"upload_time_iso_8601": "2024-10-07T22:03:46.931937Z",
"url": "https://files.pythonhosted.org/packages/00/69/811098319d602b587977c17d477fc1a8736e6654ac6241c480619ca1c913/adafruit_circuitpython_lis331-1.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7885a47a40656e7c66dff9e97772c7ff6278bd8b2d9c87f649ecf1115f0cb8f3",
"md5": "40f11811eda3a679a9447ebcd74d8cc0",
"sha256": "901762ab00f3e1f1b18d3eed6247e704645a8a88d7aa0aeae3b91b7acf9a5bbf"
},
"downloads": -1,
"filename": "adafruit_circuitpython_lis331-1.0.19.tar.gz",
"has_sig": false,
"md5_digest": "40f11811eda3a679a9447ebcd74d8cc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30330,
"upload_time": "2024-10-07T22:03:48",
"upload_time_iso_8601": "2024-10-07T22:03:48.631198Z",
"url": "https://files.pythonhosted.org/packages/78/85/a47a40656e7c66dff9e97772c7ff6278bd8b2d9c87f649ecf1115f0cb8f3/adafruit_circuitpython_lis331-1.0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:03:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_LIS331",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-lis331"
}
JSON
