Skip to content

GitLab

"tests/mock_data/hydrosurv_adapter/platform_status.json" did not exist on "e3120afeee67961356fbdfe07451c8d22ca9666f"
Switch branch/tag
History Find file
Clone
Name Last commit Last update
examples refactor: formats and examples
formats refactor: formats and examples
project fix(acknowledgement): schema for swagger, update hydrosurv egs#
CONTRIBUTING.md refactor: update fields for all formats
LICENSE Add MIT License
README.md refactor: formats and examples
__init__.py refactor: all messages from flask model to json schema definitions
generate_swagger.py refactor: formats and examples
requirements.txt refactor: update fields for all formats
README.md

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.

Message Types

Each message below will be wrapped in a message_wrapper:

  • 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

  1. Run the command below
python3 generate_swagger.py
  1. Go to http://127.0.0.1:5000

Quick Links

  1. Schema Fields Definitions
  2. JSON Schema Examples
  3. Ongoing Project: SoAR README.md