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: Black

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-icm20x-2.0.14.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-icm20x-2.0.14.tar.gz
Algorithm Hash digest
SHA256 3cf8595514b30337f87e2d6126688506559209173fbcd1f0c3a15b3f44c5de84
MD5 88342d0adef65dc4de28e61c24300ed1
BLAKE2b-256 8c055db0a6ce980397adceba05cb046799e62cde753ab5c07d541918056a2e08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_icm20x-2.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 00970610cc0fa3d40117b37f830f57c77264ee350ed81e75834b077fa063b9c4
MD5 b3f58fb14128175b44cc638ea548f83c
BLAKE2b-256 24c015fc5703308ce193f60b4fcb308950fa78f83de647469200dd640cc91afb

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