Information

A python software for synchronized data management of specific force platforms sensors compatible with Phidget API and other sensor types such as IMUs.

Note

This repository contains a dockerized streamlit version of the force_platform project, available on this repository.

This project is licensed under de GNU General Public License v3.0.

Documentation

The documentation is available within the software, making it convenient to check out while learning how to use it. It has useful tips and internal links to the software tools.

Simple setup

1. Install Docker.
2. Pull the docker image from DockerHub or the GitHub Container Registry.
3. Start the container and try it out by going to the specified port.

Tip

Need more detailed information? Check out the setup steps for Linux distros or Windows.

Here is a setup example to run it with phidgetbridge-based sensors and IMUs:

Pull the image.

docker pull aaronrpb/force-platform-app:latest

Create a new container called example_app and link the required device paths.

Make sure you have USB sensors connected to the delivered paths in --device, or the daemon will throw a no such file or directory error. If you want just to check the container content without sensors, remove the --device options from de docker run command.

docker run -d --name example_app \
  --device /dev/bus/usb \
  --device /dev/ttyUSB0 \
  --device /dev/ttyUSB1 \
  -p 8501:8501 \
  aaronrpb/force-platform-app

And done! Check it out on http://localhost:8501.

Warning

It is recommended to connect the sensors before starting the container, as the container cannot detect new USB ports while running. Additionally, reconnecting devices during runtime may cause errors or connection failures.

To avoid these issues, you can use the --privileged flag when running the container, though this is not recommended due to security concerns:

docker run -d --name example_app --privileged -p 8501:8501 aaronrpb/force-platform-app

Managing the Application

Once you run docker run, you can stop the app with docker stop <container_name> and restart it with docker start <container_name>.

You can algo check the app logs, with docker logs <container_name>.

More information about docker CLI commands: https://docs.docker.com/reference/cli/docker/.