Skip to content

API Service

Justus Dicker edited this page Jul 14, 2025 · 1 revision

Overview

The API Service hosts the web interface and acts as the main controller for sending commands to the robot.
It uses Java, Maven, and Spring Boot.

  • The web page is located in the resources/static directory.
  • The API must connect to the MQTT broker to function.

Best Practices

  • Always run the API in a named screen session: API
  • Start the MQTT Broker first.

Commands

Action Command
Run sudo screen -S API mvn spring-boot:run
Test if running `sudo screen -list
Stop sudo screen -S API -X stuff "^C"

Caution

If you disconnect SSH, the API keeps running thanks to screen.

Important

Always name the session API to ensure stop.sh and other scripts work.

Clone this wiki locally