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": "",
"name": "adafruit-circuitpython-lis331",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,lis331,lis331hh,h3lis331dl,accelerometer,accel,IMU",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/6d/28/a0ec1e9eafbb522b9e9c282038ac775968fba5df829c100cdbe22bb73d0d/adafruit-circuitpython-lis331-1.0.16.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.16",
"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": "4ad0f18a6f3ee8382d56d354070bf6ca5f662dc393d10f6c6f3148e8b56e9b28",
"md5": "2ee3df48f3c0e14524d89b6d37598385",
"sha256": "a4dc9ca99ed94b25eddeffdf6d4e22a1201636d2defdc0d23dbbd9d0b0ec54da"
},
"downloads": -1,
"filename": "adafruit_circuitpython_lis331-1.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ee3df48f3c0e14524d89b6d37598385",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8429,
"upload_time": "2023-05-26T16:11:03",
"upload_time_iso_8601": "2023-05-26T16:11:03.696437Z",
"url": "https://files.pythonhosted.org/packages/4a/d0/f18a6f3ee8382d56d354070bf6ca5f662dc393d10f6c6f3148e8b56e9b28/adafruit_circuitpython_lis331-1.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d28a0ec1e9eafbb522b9e9c282038ac775968fba5df829c100cdbe22bb73d0d",
"md5": "1072237b00610339a1c480046f46e068",
"sha256": "e657ccd7b197ac641f6dfb0058cdff6815652ef13222c6aab2f7c12c795e9c75"
},
"downloads": -1,
"filename": "adafruit-circuitpython-lis331-1.0.16.tar.gz",
"has_sig": false,
"md5_digest": "1072237b00610339a1c480046f46e068",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30403,
"upload_time": "2023-05-26T16:11:04",
"upload_time_iso_8601": "2023-05-26T16:11:04.966957Z",
"url": "https://files.pythonhosted.org/packages/6d/28/a0ec1e9eafbb522b9e9c282038ac775968fba5df829c100cdbe22bb73d0d/adafruit-circuitpython-lis331-1.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 16:11:04",
"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": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-lis331"
}
JSON
