The API that deals with spawning and managing digital twin instances.
To install the orchestrator:
- Create a
.env
file in the root directory of the project with contents:
DOCKER_PAT=<DOCKER_PAT>
DOCKER_USER=<username for docker registry>
DOCKER_EMAIL=<email for docker registry>
DOCKER_REGISTRY=ghcr.io
APP_SECRET=<an appliction secret>
DEFAULT_ADMIN_PASSWORD=<a default admin password>
DELETE_CONTAINERS=True
MAX_CONCURRENT_PROCESSES=8
- Run
bash start.sh
UNDEFINED_ERROR = 1
An undefined error occurred.
Suggested action: Unknown
JSON_READ_EC = 2
Error while reading the json file
Suggested action: Fix the json file
MISSION_UPLOAD_FAIL = 3
Error while uploading the mission file
Suggested action: Try again, the server may be overloaded
STREAM_READ_FAILURE = 4
Error while reading the stream
Suggested action: Try again, the server may be overloaded
VEHICLE_TIMED_OUT = 5
The vehicle timed out
Suggested action: Try again, the server may be overloaded
PREMATURE_LANDING = 6
The vehicle landed prematurely
Suggested action: Wait or check the vehicle's config / payload. There may be too much wind or the vehicle can't control properly.
UNKNOWN_VEHICLE = 7
The vehicle config is unknown
Suggested action: Check the vehicle's name in the mission file.
PX4_SIM_DESYNC = 8
The PX4 simulator is desynced
Suggested action: Try again, the server may be overloaded
TOO_MUCH_WIND = 9
There is too much wind for the vehicle to control properly
Suggested action: Wait for better wind conditions