Fahrsimulator_MSY2526_UX/docs/CONFIGURATION.md

1.9 KiB

Configuration

Application settings are loaded from classpath properties files in src/main/resources/config.

application.properties

Key Purpose Current Default
app.mode Generic mode flag test
streaming.url Initial URL for pixel streaming view http://localhost
python.path Python interpreter for simulator process C:\\Program Files\\PyManager\\python.exe
mqtt.broker.url MQTT broker connection URL tcp://localhost:1883
mqtt.client.id MQTT client identifier JavaClientPublisherSubscriber
mqtt.topic MQTT topic to subscribe to PREDICTION
mqtt_sim.enabled Enables simulator startup false
mqtt_sim.script Simulator script path src/main/resources/scripts/mqtt_simulator.py
animation.output.path Generated animation state file path data/animation.json
unreal.enabled Enables Unreal startup flow true
unreal.executable PowerShell script to start Unreal process absolute path
unreal.signalling_server.script Signalling server BAT file path absolute path
unreal.pid.file Unreal PID file for shutdown cleanup absolute path
unreal.signalling.pid.file Signalling PID file for shutdown cleanup absolute path

Notes:

  • Paths can be provided with or without wrapping quotes; startup sanitizes surrounding quotes.
  • Unreal-related defaults are environment-specific and should be replaced per machine.

logger.properties

Key Purpose Current Default
logger.level Minimum log level DEBUG
logger.file.enabled Enables file logging true
logger.file Log output file logs/application.log
logger.max.size.mb Rotation threshold 10
  • src/main/resources/scripts/mqtt_simulator.py
  • src/main/resources/scripts/start_avatar.ps1