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.8.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.8-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.8.tar.gz
Algorithm Hash digest
SHA256 49c6e870f60b150f4c7d3c9f3a7288f9bed2d46c148ae33d4ce7142d4b6bf9e5
MD5 3c3ae1f8746a476fa0eed26b53f0da3e
BLAKE2b-256 d3dc5ff51a7f31a803531cb4e504a13e9a9ccaa956eaf620ac362eb0edad35bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b9497e44bd57b5fa0883cf7048852cc44a3c414e0f0c2cd4369e89ee10ad087a
MD5 5e354d5be044b8d19efd2efa644aa0db
BLAKE2b-256 5fb23d2ca8769afc410050c2b0d282015b9f0a001aac9c46428c0eb07cfc112a

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