adafruit-circuitpython-fxas21002c


Nameadafruit-circuitpython-fxas21002c JSON
Version 3.0.2 PyPI version JSON
download
home_page
SummaryCircuitPython library for NXP FXAS21002C gyroscope.
upload_time2023-09-25 15:41:02
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit fxas21002c gyro gyroscope nxp breakout hardware micropython 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-fxas21002c/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/fxas21002c/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_FXAS21002C/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_FXAS21002C/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 module for the NXP FXAS21002C gyroscope.

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-fxas21002c

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-fxas21002c

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

Usage Example
=============

.. code-block:: python3

    import time
    import board
    import adafruit_fxas21002c

    i2c = board.I2C()  # uses board.SCL and board.SDA
    sensor = adafruit_fxas21002c.FXAS21002C(i2c)

    while True:
        gyro_x, gyro_y, gyro_z = sensor.gyroscope
        print('Gyroscope (radians/s): ({0:0.3f},  {1:0.3f},  {2:0.3f})'.format(gyro_x, gyro_y, gyro_z))
        time.sleep(1.0)


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

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-fxas21002c",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,fxas21002c,gyro,gyroscope,nxp,breakout,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/f2/1a/9bd3e02116ea8ed305de2a21f3a5c67c5fc7a28afc7803f3ed3205930e66/adafruit-circuitpython-fxas21002c-3.0.2.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fxas21002c/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/fxas21002c/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_FXAS21002C/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_FXAS21002C/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 module for the NXP FXAS21002C gyroscope.\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=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-fxas21002c/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-fxas21002c\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-fxas21002c\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-fxas21002c\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    import time\n    import board\n    import adafruit_fxas21002c\n\n    i2c = board.I2C()  # uses board.SCL and board.SDA\n    sensor = adafruit_fxas21002c.FXAS21002C(i2c)\n\n    while True:\n        gyro_x, gyro_y, gyro_z = sensor.gyroscope\n        print('Gyroscope (radians/s): ({0:0.3f},  {1:0.3f},  {2:0.3f})'.format(gyro_x, gyro_y, gyro_z))\n        time.sleep(1.0)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fxas21002c/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_fxas21002c/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for NXP FXAS21002C gyroscope.",
    "version": "3.0.2",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_FXAS21002C"
    },
    "split_keywords": [
        "adafruit",
        "fxas21002c",
        "gyro",
        "gyroscope",
        "nxp",
        "breakout",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "26d2d29200d3dfc3dc8fe0ecd9a80ca3e5308f035d1c81ba3f1471905f0b87e6",
                "md5": "4f968eb1f68bf8f65674fcfa62b43576",
                "sha256": "80ed76b9f86bcfb3664eaadda58a36af1474569ff9564e5ddccf1a2c8201e1fd"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_fxas21002c-3.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4f968eb1f68bf8f65674fcfa62b43576",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6197,
            "upload_time": "2023-09-25T15:41:01",
            "upload_time_iso_8601": "2023-09-25T15:41:01.572182Z",
            "url": "https://files.pythonhosted.org/packages/26/d2/d29200d3dfc3dc8fe0ecd9a80ca3e5308f035d1c81ba3f1471905f0b87e6/adafruit_circuitpython_fxas21002c-3.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f21a9bd3e02116ea8ed305de2a21f3a5c67c5fc7a28afc7803f3ed3205930e66",
                "md5": "56d5bdba6b180a09f83ae5d046500af6",
                "sha256": "a16111b075b4b3e77ad77ea82ccfda2bc9daddbc53eae1d7735a22c2bf3e0966"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-fxas21002c-3.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "56d5bdba6b180a09f83ae5d046500af6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27292,
            "upload_time": "2023-09-25T15:41:02",
            "upload_time_iso_8601": "2023-09-25T15:41:02.710930Z",
            "url": "https://files.pythonhosted.org/packages/f2/1a/9bd3e02116ea8ed305de2a21f3a5c67c5fc7a28afc7803f3ed3205930e66/adafruit-circuitpython-fxas21002c-3.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 15:41:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_FXAS21002C",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-fxas21002c"
}
        
Elapsed time: 0.15269s