adafruit-circuitpython-adxl34x


Nameadafruit-circuitpython-adxl34x JSON
Version 1.12.13 PyPI version JSON
download
home_pageNone
SummaryA CircuitPython driver for the ADXL34x family of accelerometers.
upload_time2024-10-07 21:36:27
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit hardware accelerometer acceleration spi i2c triple axismicropython circuitpython
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-adxl34x/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/adxl34x/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_ADXL34x/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_ADXL34x/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 CircuitPython driver for the ADXL34x family of accelerometers

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-adxl34x/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-adxl34x

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-adxl34x

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-adxl34x

Usage Example
=============
.. code:: python3

    import time
    import board
    import adafruit_adxl34x

    i2c = board.I2C()  # uses board.SCL and board.SDA
    accelerometer = adafruit_adxl34x.ADXL345(i2c)

    while True:
        print("%f %f %f"%accelerometer.acceleration)
        time.sleep(1)

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/adxl34x/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_ADXL34x/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-adxl34x",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, hardware, accelerometer, acceleration, spi, i2c, triple, axismicropython, circuitpython",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/3d/21/d96fc0673268c6ef19835d4b1806855612922fb6bfece03d58b77ad542b4/adafruit_circuitpython_adxl34x-1.12.13.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-adxl34x/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/adxl34x/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_ADXL34x/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_ADXL34x/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 CircuitPython driver for the ADXL34x family of accelerometers\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-adxl34x/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-adxl34x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-adxl34x\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-adxl34x\n\nUsage Example\n=============\n.. code:: python3\n\n    import time\n    import board\n    import adafruit_adxl34x\n\n    i2c = board.I2C()  # uses board.SCL and board.SDA\n    accelerometer = adafruit_adxl34x.ADXL345(i2c)\n\n    while True:\n        print(\"%f %f %f\"%accelerometer.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/adxl34x/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_ADXL34x/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A CircuitPython driver for the ADXL34x family of accelerometers.",
    "version": "1.12.13",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ADXL34x"
    },
    "split_keywords": [
        "adafruit",
        " hardware",
        " accelerometer",
        " acceleration",
        " spi",
        " i2c",
        " triple",
        " axismicropython",
        " circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d1c77694d47a15e66fef784df4ae9a4e306a7303db81cf892ef57fadf762d6df",
                "md5": "aaf4c4b71da8141964e2ecea26971422",
                "sha256": "23f59666018ee1f6fad067e3cfecb06ae2f711e9b91368279a386f61ba516d8a"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_adxl34x-1.12.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aaf4c4b71da8141964e2ecea26971422",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8047,
            "upload_time": "2024-10-07T21:36:25",
            "upload_time_iso_8601": "2024-10-07T21:36:25.594864Z",
            "url": "https://files.pythonhosted.org/packages/d1/c7/7694d47a15e66fef784df4ae9a4e306a7303db81cf892ef57fadf762d6df/adafruit_circuitpython_adxl34x-1.12.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3d21d96fc0673268c6ef19835d4b1806855612922fb6bfece03d58b77ad542b4",
                "md5": "6040b31a4fc7adc091e0bcfcf67fa7c1",
                "sha256": "f84ec988f67d4d3258db8140e14c8ce9dce099e6600bb806a774cfb65eaf6e1a"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_adxl34x-1.12.13.tar.gz",
            "has_sig": false,
            "md5_digest": "6040b31a4fc7adc091e0bcfcf67fa7c1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 30555,
            "upload_time": "2024-10-07T21:36:27",
            "upload_time_iso_8601": "2024-10-07T21:36:27.208881Z",
            "url": "https://files.pythonhosted.org/packages/3d/21/d96fc0673268c6ef19835d4b1806855612922fb6bfece03d58b77ad542b4/adafruit_circuitpython_adxl34x-1.12.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 21:36:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_ADXL34x",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-adxl34x"
}
        
Elapsed time: 0.37129s