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
│       ├── __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
│   ├── 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.9.tar.gz (11.8 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.9-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: imu_python-0.0.9.tar.gz
  • Upload date:
  • Size: 11.8 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.9.tar.gz
Algorithm Hash digest
SHA256 1f75b86b0db2223908b4735c789d957fc8dcfe78627f00f59ef083df52454490
MD5 b87a7169a93883d483e4526c980bfd0a
BLAKE2b-256 edf277c7b32de86325bbc5eaba7906964b0613aafec9eea58df79558280da075

See more details on using hashes here.

Provenance

The following attestation bundles were made for imu_python-0.0.9.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.9-py3-none-any.whl.

File metadata

  • Download URL: imu_python-0.0.9-py3-none-any.whl
  • Upload date:
  • Size: 13.4 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 87573e23b17394db171992b134f4606c47840fc1447ad205626378649d69d86c
MD5 0e101518db82875f3e62e839fb2291ef
BLAKE2b-256 28aa3e94b4eac8c4d26899ee4f13e15c294070773305596ec1cec1d91ec8d9bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for imu_python-0.0.9-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