Skip to content

ac0745/adas-api

main
Switch branches/tags
Code

Latest commit

Files

Permalink
Failed to load latest commit information.

ADAS-API

Made by Phoenix Racing Coventry

Welcome to the Formula Student AI Vehicle Control API, created by Phoenix Racing Coventry. This API allows you to control vehicles participating in the Formula Student AI competition. With this API, you can send commands to vehicles, such as changing their speed or direction, and receive real-time data about the vehicle's performance.

This API is based on the Official Formula Student API. However we have implemented/improved the following aspects:

  • Full reports on faults and warnings.
  • Independent front/rear braking.
  • ! TODO Automatic state machine handling.

How to use the API

:octocat: Simulating the AI Vehicle

In order to simulate the vehicle, use the following command: ./setup_vcan.sh

  • This shell script uses recorded CAN frames.

:octocat: Viewing CAN frames

In order to view the CAN frames in real time use this command: cantools monitor docs/candata.dbc

  • This command is useful for debugging and monitoring the behaviour of the vehicle.

:octocat: Compiling the Project

To build the projects run: cmake . && cmake --build .

:octocat: Running the Terminal User Interface

Use the following command to run the TUI: bin/demo


HOW TO RUN THE UI

ℹ️ This TUI allows for interaction with the software through a graphical interface, which allows you to easily perform tasks such as:

  • Setting a steer angle;
  • Viewing the messages from both the VCU and the AI;
  • Setting wheel speed;
  • Checking Autonomous states, etc.
  1. Make sure that the side switches are off.
  2. Put the AI Dongle in the vehicle.
  3. Turn the Grossfunc on.
  4. Turn on the side switches in this order:
  • AS
  • TS
  • LV
  1. Turn on the vehicle's PC
  2. If you run the TUI it should show the following:
title: Include a screenshot showcasing the state of the TUI
flavour text
  1. Select the desired mission from the side screen.
  • [Mission of your choice].
  • Press Set.
title: Include a screenshot showcasing the state of the TUI
flavour text
  1. In the TUI set the Mission Status to SELECTED.
  • Status AS should change to READY
title: Include a screenshot showcasing the state of the TUI
flavour text
  1. Wait 5 seconds.
  2. Flip the switch on the Grossfunc to 1.
title: Include a screenshot showcasing the state of the TUI
flavour text
  • Go is ON.
  • AS is DRIVING.
  1. Set Mission status to RUNNING.
title: Include a screenshot showcasing the state of the TUI
flavour text
  1. Set Drive to DRIVE.
title: Include a screenshot showcasing the state of the TUI
flavour text
  1. Enjoy the TUI!

Contributors:



Support and Contributions


For any questions or issues with the API, please reach out to Phoenix Racing Coventry at sample@email.com

We welcome and appreciate all contributions to this project! Whether you are fixing bugs, improving existing features, or adding new ones, your help is valuable to us.

Here are a few ways you can contribute:

  • Report bugs and request new features by creating an issue in the Issues section.
  • Improve the documentation by making updates to the README file or other relevant documentation.
  • Submit a pull request with your changes to the codebase. Make sure to follow the existing coding style and to write tests to ensure that your changes work as expected.

Before you start working on a contribution, please make sure to check if there is an existing issue or pull request for the same issue. If there is, you can join the discussion and help with the development.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Languages