Skip to main content

IMU sensor codes in Python for the exosuit

Project description

IMU Module for Python

Coverage Status Docker Image CI

This is the repository for imu sensor codes for the lower-limb exosuit.

Install

To install the library run: d

uv pip install imu-python

OR

uv pip install git+https://github.com/TUM-Aries-Lab/imu-module.git@<specific-tag>

Development

  1. Install uv
  2. git clone git@github.com:TUM-Aries-Lab/imu-module.git
  3. make init to create the virtual environment and install dependencies
  4. make format to format the code and check for errors
  5. make test to run the test suite
  6. make clean to delete the temporary files and directories

Publishing

It's super easy to publish your own packages on PyPI. To build and publish this package run:

  1. Update the version number in pyproject.toml and imu_module/init.py
  2. Commit your changes and add a git tag "<new.version.number>"
  3. Push the tag git push --tag

The package can then be found at: https://pypi.org/project/imu-python

Module Usage

"""Basic docstring for my module."""
import time
from imu_python.definitions import IMUUpdateTime
from imu_python.factory import IMUFactory


def main() -> None:
    """Run a simple demonstration."""
    sensor_managers = IMUFactory.detect_and_create()
    for manager in sensor_managers:
        manager.start()

    try:
        while True:
            for manager in sensor_managers:
                manager.get_data()
            time.sleep(IMUUpdateTime.freq_hz)
    except KeyboardInterrupt:
        for manager in sensor_managers:
            manager.stop()


if __name__ == "__main__":
    main()

Program Usage

uv run python -m imu_python

Structure

├── src
│   └── imu_python
│       ├── data_handler
│       │   ├── __init__.py
│       │   ├── data_plotter.py
│       │   ├── data_reader.py
│       │   ├── data_writer.py
│       │   └── gain_calculator.py
│       ├── __init__.py
│       ├── __main__.py
│       ├── base_classes.py
│       ├── definitions.py
│       ├── devices.py
│       ├── factory.py
│       ├── i2c_bus.py
│       ├── orientation_filter.py
│       ├── sensor_manager.py
│       ├── utils.py
│       └── wrapper.py
├── tests
│   ├── __init__.py
│   ├── base_classes_test.py
│   ├── conftest.py
│   ├── devices_test.py
│   ├── factory_test.py
│   ├── i2c_bus_test.py
│   ├── orientation_filter_test.py
│   ├── reader_writer_test.py
│   ├── sensor_manager_test.py
│   ├── utils_test.py
│   └── wrapper_test.py
├── .dockerignore
├── .gitignore
├── .pre-commit-config.yaml
├── .python-version
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── pyproject.toml
├── repo_tree.py
└── uv.lock

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

imu_python-0.0.13.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

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

imu_python-0.0.13-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file imu_python-0.0.13.tar.gz.

File metadata

  • Download URL: imu_python-0.0.13.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for imu_python-0.0.13.tar.gz
Algorithm Hash digest
SHA256 2cc20a45b45248a97396a20cf3cf6834600b31d55d854c9a9b174d7788583ce8
MD5 ccf38e028d4a6283a2e3f84de1e37c16
BLAKE2b-256 9db548d64571e4067fd30cde507530251774e13bc942a17465f98bb2a7872941

See more details on using hashes here.

Provenance

The following attestation bundles were made for imu_python-0.0.13.tar.gz:

Publisher: pypi-publish.yml on TUM-Aries-Lab/imu-module

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file imu_python-0.0.13-py3-none-any.whl.

File metadata

  • Download URL: imu_python-0.0.13-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for imu_python-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 42d5056505a746dece22271d87087087435aae7c08c4fe196bd9eb3503151ae8
MD5 ad52f9cf001ad8d276767e03bb435cbc
BLAKE2b-256 322e6747abb8abfcc26fa13d2fc598172c02068b5258d9dcbc1d1dbd5c5d0197

See more details on using hashes here.

Provenance

The following attestation bundles were made for imu_python-0.0.13-py3-none-any.whl:

Publisher: pypi-publish.yml on TUM-Aries-Lab/imu-module

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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