Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-icm20x/badge/?version=latest
:target: https://docs.circuitpython.org/projects/icm20x/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_ICM20X/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_ICM20X/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
Library for the ST ICM-20X Wide-Range 6-DoF Accelerometer and Gyro Family
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-icm20x/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-icm20x
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-icm20x
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-icm20x
Usage Example
=============
For use with the ICM20649:
.. code-block:: python3
import time
import board
import adafruit_icm20x
i2c = board.I2C() # uses board.SCL and board.SDA
icm = adafruit_icm20x.ICM20649(i2c)
while True:
print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (icm.acceleration))
print("Gyro X:%.2f, Y: %.2f, Z: %.2f rads/s" % (icm.gyro))
print("")
time.sleep(0.5)
For use with the ICM20948:
.. code-block:: python3
import time
import board
import adafruit_icm20x
i2c = board.I2C() # uses board.SCL and board.SDA
icm = adafruit_icm20x.ICM20948(i2c)
while True:
print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (icm.acceleration))
print("Gyro X:%.2f, Y: %.2f, Z: %.2f rads/s" % (icm.gyro))
print("Magnetometer X:%.2f, Y: %.2f, Z: %.2f uT" % (icm.magnetic))
print("")
time.sleep(0.5)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/icm20x/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_ICM20X/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-icm20x",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, icm20649, icm20948, icm20x, gyro, accelerometer, high-G, 6-axis, wide, range",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ee/f4/87ab7fa39c3d8180b86af46d9ae98517d00ded43cdf24683702590348e39/adafruit_circuitpython_icm20x-2.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-icm20x/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/icm20x/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_ICM20X/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_ICM20X/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nLibrary for the ST ICM-20X Wide-Range 6-DoF Accelerometer and Gyro Family\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=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-icm20x/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-icm20x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-icm20x\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-icm20x\n\nUsage Example\n=============\n\nFor use with the ICM20649:\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_icm20x\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n icm = adafruit_icm20x.ICM20649(i2c)\n\n while True:\n print(\"Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2\" % (icm.acceleration))\n print(\"Gyro X:%.2f, Y: %.2f, Z: %.2f rads/s\" % (icm.gyro))\n print(\"\")\n time.sleep(0.5)\n\nFor use with the ICM20948:\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_icm20x\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n icm = adafruit_icm20x.ICM20948(i2c)\n\n while True:\n print(\"Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2\" % (icm.acceleration))\n print(\"Gyro X:%.2f, Y: %.2f, Z: %.2f rads/s\" % (icm.gyro))\n print(\"Magnetometer X:%.2f, Y: %.2f, Z: %.2f uT\" % (icm.magnetic))\n print(\"\")\n time.sleep(0.5)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/icm20x/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_ICM20X/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library for the ST ICM-20X Wide-Range 6-DoF Accelerometer and Gyro Family",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ICM20X"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" icm20649",
" icm20948",
" icm20x",
" gyro",
" accelerometer",
" high-g",
" 6-axis",
" wide",
" range"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da8b282cc1117a02de96cab7165fb78b30ba6727ad6d684347254b3e9a4018d1",
"md5": "845e05e786497cf5758d27fc5b27a73e",
"sha256": "d638119d508fe1d0e8392acdeb54200283be6b2f90cc7afb3c3e277b4c302ecf"
},
"downloads": -1,
"filename": "adafruit_circuitpython_icm20x-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "845e05e786497cf5758d27fc5b27a73e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10070,
"upload_time": "2024-10-07T21:59:21",
"upload_time_iso_8601": "2024-10-07T21:59:21.862954Z",
"url": "https://files.pythonhosted.org/packages/da/8b/282cc1117a02de96cab7165fb78b30ba6727ad6d684347254b3e9a4018d1/adafruit_circuitpython_icm20x-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eef487ab7fa39c3d8180b86af46d9ae98517d00ded43cdf24683702590348e39",
"md5": "ef3e1eadaa67c7c60cd932c93213ed4b",
"sha256": "fc442ab33f0076643c9b04c4b31f0b6f5c1ef931bc6b954a6edf4934c02465e9"
},
"downloads": -1,
"filename": "adafruit_circuitpython_icm20x-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "ef3e1eadaa67c7c60cd932c93213ed4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29255,
"upload_time": "2024-10-07T21:59:24",
"upload_time_iso_8601": "2024-10-07T21:59:24.401124Z",
"url": "https://files.pythonhosted.org/packages/ee/f4/87ab7fa39c3d8180b86af46d9ae98517d00ded43cdf24683702590348e39/adafruit_circuitpython_icm20x-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 21:59:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_ICM20X",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-icm20x"
}
JSON
