README.md

 

uppaal2jetracer

uppaal2jetracer bridges formal automata theory and robotic control by transforming timed automata models from UPPAAL into executable control logic for real-time simulation on a JetRacer ROS AI Kit. Designed for researchers, students, and developers, it enables the validation of verifiable traffic scenarios and autonomous driving behaviors, fostering reliable testing environments for advanced mobility solutions.

Installation

To install and use uppaal2jetracer, Docker must be installed on your system. Follow the steps below to set up.

---

1. Clone the Repository

git  clone git@gitlab.kit.edu:unmsq/uppaal2jetracer.git
cd  uppaal2jetracer

2. Run the setup script

cd setup/scripts

• Windows (as Administrator):

  .\setup.bat

• Linux/macOS:

  sudo chmod +x setup.sh
  sudo ./setup.sh

3. Choose Profile

• Open setup/config.ini in a text editor.
• Set profile under [profiles] to the desired profile
• Profiles:
  • jetracer: Used for the setup on the JetRacer. Do not use a different profile for the JetRacer ROS AI Kit!
  • minimal: Used for the minimal setup. No hardware dependencies.

4. Build the Docker Image

cd setup/scripts

• Windows:

  .\build.bat

• Linux/macOS:

  sudo chmod +x build.sh
  ./build.sh

• Check if the build was successful:

  docker image list

  There should be a image named uppaal2jetracer now.

A detailed installation guide can be found in the manual.

Usage

Before running uppaal2jetracer, make sure to complete the build process by following the installation instructions.

---

Running uppaal2jetracer

cd setup/scripts

• Windows:

  .\run.bat

• Linux/macOS:

  sudo chmod +x run.sh
  ./run.sh

A detailed usage guide can be found in the manual.

Contributing

Thank you for your interest in contributing to uppaal2jetracer!

At this time, we are not accepting external contributions while the project is under active development and pending final grading as part of our PSE. We appreciate your understanding and encourage you to check back after the project has been completed and reviewed.

In the meantime, feel free to explore the repository and provide feedback or suggestions by opening an issue.