@@ -8,6 +8,7 @@ Each message below will be wrapped in a `payload` field and will have a `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
*`survey`: this would be demanded track, platform actual path, and survey line
*`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).
...
...
@@ -68,16 +69,26 @@ eg
*`soar.*.*.*.to_platform.*` - all messages outbound to platforms (hermes)
*`soar.*.slocum.#` - all messages relating to a slocum platform type
## Run Docs
Run the command below and go to `http://127.0.0.1:5000`
## Run Docs & Save Schema When Updating Message Formats
1.Run the command below and go to `http://127.0.0.1:5000`
```
python3 generate_schema_config.py
```
2. Copy the schema generated `http://127.0.0.1:5000/soar_protocol.json` into the `backbone-message-format/project/<project_name>/swagger.json`
3. In the json copied, remove the key `"definitions"` from the schema and save this.
## Run Tests
Run the command below
Run both tests below:
1. Test 1
```
python3 -m unittest tests/test_schemas.py
```
2. Test 2
```
cd tests-js/docker; docker compose up --build
```
## Quick Links
1.[Generated Swagger Docs (recommended to look at this)](https://git.noc.ac.uk/communications-backbone-system/backbone-message-format/-/blob/dev/project/soar/swagger.json)
