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.2.tar.gz (29.3 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.2.tar.gz
Algorithm Hash digest
SHA256 fc442ab33f0076643c9b04c4b31f0b6f5c1ef931bc6b954a6edf4934c02465e9
MD5 ef3e1eadaa67c7c60cd932c93213ed4b
BLAKE2b-256 eef487ab7fa39c3d8180b86af46d9ae98517d00ded43cdf24683702590348e39

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d638119d508fe1d0e8392acdeb54200283be6b2f90cc7afb3c3e277b4c302ecf
MD5 845e05e786497cf5758d27fc5b27a73e
BLAKE2b-256 da8b282cc1117a02de96cab7165fb78b30ba6727ad6d684347254b3e9a4018d1

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