diff --git a/README.md b/README.md index 567f58bb0330b5119823be33c3f43c415e901adc..04df03d401729ca5ef50e629ce20723f3c635231 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,14 @@ This project repository is a collaborative workspace. It consists of all message # Message Types -* Each message below will be treated as the `payload` that are wrapped in a `full_message_format` that includes a `message_header`. - -| Type | Summary of File | Serialized/Compiled in Platform-Specific Format? | -| --------------------------| ---------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| `planning_configuration` | Autonomy Engine's Configuration file (if c2 needs to update its respective platform directly)| No | -| `mission_plan` | Mission plan generated by Autonomy Engine per platform | No | -| `encoded_mission_plan` | Encoded/serialized platform-specific mission plan | Yes | -| `encoded_platform_status`| Encoded/serialized platform-specific platform status | Yes | -| `platform_status` | Decoded/de-serialized generic platform status | No | -| `encoded_observation` | Encoded/serialized observation data from platform for Autonomy Engine | Yes | -| `observation` | Decoded/de-serialized observation data from platform for Autonomy Engine | No | -| `acknowledgement` | Decoded/de-serialized acknowledgement message from the Hydrosurv Adapater | No | +Each message below will be treated as the `payload` that are wrapped in a `full_message_format` that includes a `message_header`: +* `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). # Quick Links 1. [Schema Fields Definitions](https://git.noc.ac.uk/communications-backbone-system/backbone-message-format/-/tree/7-message-formats-initial/formats) 2. [JSON Schema Examples](https://git.noc.ac.uk/communications-backbone-system/backbone-message-format/-/tree/7-message-formats-initial/examples) -3. [SoAR README.md](https://git.noc.ac.uk/communications-backbone-system/backbone-message-format/-/tree/7-message-formats-initial/project/SOAR_README.md) \ No newline at end of file +3. Ongoing Project: [SoAR README.md](https://git.noc.ac.uk/communications-backbone-system/backbone-message-format/-/tree/7-message-formats-initial/project/SOAR_README.md) \ No newline at end of file diff --git a/project/SOAR_README.md b/project/SOAR_README.md index 6fb08154dd08e78bf0b901defbe20933b3226fe0..b73f4173139d3740db1eb4a671432cee69f54d4b 100644 --- a/project/SOAR_README.md +++ b/project/SOAR_README.md @@ -42,81 +42,3 @@ Squad of Adaptive Robots Project | NOC (AH1) | emergency | GUI | TBD – AH1 (ABORT command via Black Box) | TBD | TBD | TBD – all platforms pre-compiled ABORT via Black box | | NOC (GUI) | planning configuration | GUI | Autonomy Engine | Yes | No | N/A | | NOC (GUI) | emergency | GUI | TBD | TBD | TBD | TBD | - - -## Breakdown of Message Sources & Types - -### 1/ Autonomy Engine -#### Transmit -* mission plan _(sent per platform??)_ -* TBD: - * Will emergency commands be sent via the autonomy engine (from the GUI) or directly to the C2s? - -#### Receive -* configuration file -* emergency stop all -* decoded ecosub status message -* decoded reav status message -* decoded autosub-hover status message -* decoded ecosub observation data _(from squad 1 platforms)_ - ----------------------------------- - -### 2/ Ecosub C2 -#### Transmit -* compiled ecosub mission plan -* decoded ecosub status message -* autonomy configuration file -* decoded ecosub observation data - - -#### Receive -* mission plan -* encoded ecosub status message -* encoded ecosub observation data - ----------------------------------- - -### 3/ Autosub C2 -#### Transmit -* compiled autosub-hover mission plan -* decoded autosub-hover status message -* autonomy configuration file - - -#### Receive -* mission plan -* encoded autosub-hover status message - - ----------------------------------- - -### 4/ Reav C2 -#### Transmit -* decoded reav-60 status message? - - -#### Receive -* mission plan -* encoded reav-60 status message? - ----------------------------------- - -### 5/ Hermes Box/Hydrosurv Smart Router? -#### Transmit -* encoded ecosub status message -* encoded (or is this already decoded?) reav status message -* encoded autosub status message -* encoded ecosub observation data -* TBD: - * are there acknowledgment messages from platforms? - * how are we receiving beacon messages per platform? - -#### Receive -* compiled ecosub mission plan -* compiled reav mission plan -* compiled autosub mission plan -* compiled ecosub emergency command -* compiled reav emergency command -* compiled autosub emergency command ------------------------------------- \ No newline at end of file