Skip to main content

Library for the ST ICM-20X Wide-Range 6-DoF Accelerometer and Gyro Family

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Library for the ST ICM-20X Wide-Range 6-DoF Accelerometer and Gyro Family

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-icm20x

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

sudo pip3 install adafruit-circuitpython-icm20x

To install in a virtual environment in your current project:

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:

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:

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_icm20x-2.1.1.tar.gz (29.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_icm20x-2.1.1.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.1.tar.gz
Algorithm Hash digest
SHA256 a4858b0f4e4496f4e0b4447ee485d4930aea8e70f4231b809067676991cc29a9
MD5 f86c58c3e1c71713316f793829096839
BLAKE2b-256 ef131507b4f430888fbfc557620cbbf7fc50e6a2cc5685c7fae82821134375fb

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_icm20x-2.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b024276a7cebf2dcbbcbb13a0903f1f8304312c65d2b2badaaadcc88994e9b21
MD5 ff1df5dcbf78f430bbd49148fc17ae34
BLAKE2b-256 d9a77c522ab543595f4965143266592a945a3f2343885f1fe1a2086d0a622ea2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page