Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-l3gd20/badge/?version=latest
:target: https://docs.circuitpython.org/projects/l3gd20/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_L3GD20/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_L3GD20/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
Adafruit 9-DOF Absolute Orientation IMU Fusion Breakout - L3GD20 Driver
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `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-l3gd20/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-l3gd20
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-l3gd20
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-l3gd20
Usage Example
=============
Of course, you must import the library to use it:
.. code:: python3
import adafruit_l3gd20
This driver takes an instantiated and active I2C object as an argument
to its constructor.
.. code:: python3
import board
i2c = board.I2C()
Once you have the I2C object, you can create the sensor object:
.. code:: python3
sensor = adafruit_l3gd20.L3GD20_I2C(i2c)
And then you can start reading the measurements:
.. code:: python3
print(sensor.gyro)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/l3gd20/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_l3gd20/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-l3gd20",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, 9dof, 9-dof, absolute, orientation, IMU, fusion, breakout, hardwarel3gd20, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/db/10/e08f5a253fabf09ca73e15a41f3cc513ce18a15b0dadcdbc83aaf237ab5b/adafruit_circuitpython_l3gd20-2.3.20.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-l3gd20/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/l3gd20/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_L3GD20/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_L3GD20/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\nAdafruit 9-DOF Absolute Orientation IMU Fusion Breakout - L3GD20 Driver\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-l3gd20/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-l3gd20\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-l3gd20\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-l3gd20\n\nUsage Example\n=============\n\nOf course, you must import the library to use it:\n\n.. code:: python3\n\n import adafruit_l3gd20\n\n\nThis driver takes an instantiated and active I2C object as an argument\nto its constructor.\n\n.. code:: python3\n\n import board\n\n i2c = board.I2C()\n\nOnce you have the I2C object, you can create the sensor object:\n\n.. code:: python3\n\n sensor = adafruit_l3gd20.L3GD20_I2C(i2c)\n\n\nAnd then you can start reading the measurements:\n\n.. code:: python3\n\n print(sensor.gyro)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/l3gd20/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_l3gd20/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for L3GD20 9-DOF absolute orientation IMU fusion breakout.",
"version": "2.3.20",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_L3GD20"
},
"split_keywords": [
"adafruit",
" 9dof",
" 9-dof",
" absolute",
" orientation",
" imu",
" fusion",
" breakout",
" hardwarel3gd20",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8b1b7acce1d684ae815489e9807892be441cd25a14a867ebedc0d223fb05a34",
"md5": "b870172337b97bf5c38ce893122bd036",
"sha256": "32ae7deb38dae082a50a1d8e96a57ad021e6ba72b15109ec085d9270e1266adb"
},
"downloads": -1,
"filename": "adafruit_circuitpython_l3gd20-2.3.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b870172337b97bf5c38ce893122bd036",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7136,
"upload_time": "2024-10-07T22:03:30",
"upload_time_iso_8601": "2024-10-07T22:03:30.412579Z",
"url": "https://files.pythonhosted.org/packages/b8/b1/b7acce1d684ae815489e9807892be441cd25a14a867ebedc0d223fb05a34/adafruit_circuitpython_l3gd20-2.3.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db10e08f5a253fabf09ca73e15a41f3cc513ce18a15b0dadcdbc83aaf237ab5b",
"md5": "a5dfa90ba818c181f6b4b34a595fbaf8",
"sha256": "c5e6ba1a32a285bc061d56ded8c256a0465d6235a1e97f00f71b4b1711b7ba36"
},
"downloads": -1,
"filename": "adafruit_circuitpython_l3gd20-2.3.20.tar.gz",
"has_sig": false,
"md5_digest": "a5dfa90ba818c181f6b4b34a595fbaf8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28421,
"upload_time": "2024-10-07T22:03:32",
"upload_time_iso_8601": "2024-10-07T22:03:32.807532Z",
"url": "https://files.pythonhosted.org/packages/db/10/e08f5a253fabf09ca73e15a41f3cc513ce18a15b0dadcdbc83aaf237ab5b/adafruit_circuitpython_l3gd20-2.3.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:03:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_L3GD20",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-l3gd20"
}
JSON
