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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_icm20x-2.1.9-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.9.tar.gz
Algorithm Hash digest
SHA256 e6cb36f3f271140fca92d2da6fa8cc71cdeb95b4d2c67732eefeec0025c1e111
MD5 53af7adc2770ac4fa7b7e531f0c6a316
BLAKE2b-256 a31ec4c24828a510ee8549d08835ae6b027ff141384c04f28b5477a27e74f486

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 196060f16f9000771f9a62838964719c56c91c9c905118308bffb26758b48362
MD5 a9e57d3dd389107da5cbc1a0b9d7ca7b
BLAKE2b-256 0083b5ad486ca23d2289dec309bfd7ee6970b9c226fed7efaa76d24d24eee9fe

See more details on using hashes here.

Supported by

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