Overview

This project repository is a collaborative workspace. It consists of all messages transferred into and out of the Communications Backbone. Message type schemas will be developed once reviewing each platform's data and statuses defined by each partner.

The schemas are using OpenApi 3.0 (due to the payload sub-schemas that vary according to the message_type).

Message Types

Each message below will be wrapped in a payload field and will have a header with message metadata information:

• mission_plan: these would be two message types, i. encoded (platform-specific serialized message) and ii. parsed, human-readable message.
• platform_status: these would be two message types, i. encoded (platform-specific serialized message) and ii. parsed, human-readable message.
• observation: this would be desired scientific data sent by the platform
• acknowledgement: level of acknowledgment where an acknowledgement is sent when a message is i. received, ii. sent to the next destination (e.g. platform in the water).
• planning_configuration: sent from the GUI to initialise the AI model (autonomy engine).

Run Docs

Run the command below and go to http://127.0.0.1:5000

python3 generate_schema_config.py

Run Tests

Run the command below

python3 -m unittest tests/test_schemas.py

Quick Links

1. Generated Swagger Docs (recommended to look at this)
2. Schema Fields Definitions
3. JSON Schema Examples
4. Ongoing Project: SoAR README.md