tritonuas/hub repository overview

⁠Hub

Hub is a back-end web-server that facilitates communication between other modules in the TUAS system, including Houston⁠, OBC⁠, and more. It also communicates with the Interop Judging Server⁠ to grab the mission plans and submit waypoints. As of now, it does NOT deal with computer vision stuff; for that, see matts-new-glasses⁠.

Hub is currently hosted on Dockerhub⁠.

⁠Dependencies

• go 1.14
• protobuf-compiler
• docker⁠
• docker-compose⁠ (needed to run hub concurrently with Influxdb⁠, Grafana⁠ and SITL⁠)

Both of these should be handled with this script

# download git submodules
make submodulesupdate
# install go and protobuf-compiler
make install-dependencies

⁠First Time Setup

In order to compile the protobuf files needed to run Hub, execute the following command

make compile-protos

If this command doesn't work, then run

git submodule update --init

before trying the previous make command again

⁠Build

# Build local hub executable
make build

# Build Docker image
make build-docker

Note that running docker commands may require sudo.

⁠Run

# Run hub with testuser locally
make run

# Run docker image of hub
make run-docker

Run full hub workflow with multiple components (Includes Influxdb⁠, Grafana⁠ and SITL⁠ Will include Interop⁠ in the future)

make run-compose

⁠Stop

# Stop docker-compose workflow
make stop-compose

⁠Ports and Stuff

Check houston⁠ for usage instructions

In houston, the Backend Addr always needs to match that of hub

# find IP of hub
docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' container_name_or_id

⁠Test

make test