Skip to content

GitLab

Commit 491bee7d authored by Dan Jones's avatar Dan Jones
Browse files

Merge branch '25-update-project-dir-to-latest' into 'dev' 

refactor: project content to latest

Closes #25

See merge request !13
parents 127d45b7 4a3f4c5b
dev 26-add-battery-endurance-for-platform-schema-in-planning-configuration 41-add-optional-operating_area-as-a-wider-zone-outside-region_of_interest 42-add-event-details-and-status-to-acknowledgement-schema 66-tag-current-dev-as-version-1 76-should-depth-and-altitude-be-coordinates 80-add-informational-type-primitive 87-remove-comment-for-platform-status-state 87-remove-todo-comment-from-platform-state action-refactor-test ci-js-test master missionmonitor v2.0.0 v2.0.0-beta.11 v2.0.0-beta.10 v2.0.0-beta.9 v2.0.0-beta.8 v2.0.0-beta.7 v2.0.0-beta.6 v2.0.0-beta.5 v2.0.0-beta.4 v2.0.0-beta.3 v2.0.0-beta.2 v2.0.0-beta.1 v1.0.0 v0.2.0 v0.1.0
2 merge requests!16Resolve "Release v0.1",!13refactor: project content to latest
Pipeline #109800 passed with stages
in 1 minute and 19 seconds
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 13 additions and 761 deletions
project/soar/swagger.json
View file @ 491bee7d
...@@ -31,8 +31,9 @@ ...@@ -31,8 +31,9 @@
"message_type":{ "message_type":{
"description":"Type of message", "description":"Type of message",
"example":"acknowledgement", "example":"acknowledgement",
"type":"string" "type":"string",
}, "enum": ["acknowledgement"]
},
"platform_ID":{ "platform_ID":{
"description":"Unique identifier for this platform", "description":"Unique identifier for this platform",
"example":"reav-x-1", "example":"reav-x-1",
...@@ -107,7 +108,8 @@ ...@@ -107,7 +108,8 @@
"message_type":{ "message_type":{
"description":"Type of message", "description":"Type of message",
"example":"mission_plan", "example":"mission_plan",
"type":"string" "type":"string",
"enum": ["mission_plan"]
}, },
"plan":{ "plan":{
"items":{ "items":{
...@@ -202,7 +204,8 @@ ...@@ -202,7 +204,8 @@
"message_type":{ "message_type":{
"description":"Type of message", "description":"Type of message",
"example":"observation", "example":"observation",
"type":"string" "type":"string",
"enum": ["observation"]
}, },
"platform_ID":{ "platform_ID":{
"description":"Unique identifier for this platform", "description":"Unique identifier for this platform",
...@@ -319,7 +322,8 @@ ...@@ -319,7 +322,8 @@
"message_type":{ "message_type":{
"description":"Type of message", "description":"Type of message",
"example":"planning_configuration", "example":"planning_configuration",
"type":"string" "type":"string",
"enum": ["planning_configuration"]
}, },
"planning_config_ID":{ "planning_config_ID":{
"description":"Unique identifier tagged to version of this configuration plan", "description":"Unique identifier tagged to version of this configuration plan",
...@@ -351,7 +355,8 @@ ...@@ -351,7 +355,8 @@
"description":"Any addition fields/data to be added here", "description":"Any addition fields/data to be added here",
"example":{ "example":{
} },
"type":"object"
}, },
"safe_command":{ "safe_command":{
"description":"Command/Action that is native to respective partner's platform/C2", "description":"Command/Action that is native to respective partner's platform/C2",
...@@ -569,7 +574,8 @@ ...@@ -569,7 +574,8 @@
"message_type":{ "message_type":{
"description":"Type of message", "description":"Type of message",
"example":"platform_status", "example":"platform_status",
"type":"string" "type":"string",
"enum": ["platform_status"]
}, },
"mission_plan_ID":{ "mission_plan_ID":{
"description":"Mission plan ID according to platform-C2 system", "description":"Mission plan ID according to platform-C2 system",
......
projects/__init__.py deleted 100644 → 0
View file @ 127d45b7
projects/soar/SOAR_README.md deleted 100644 → 0
View file @ 127d45b7
# SoAR Project
Squad of Adaptive Robots Project
-----------------------------------
## Message Data Flow Summary
| Partner | Message Type | Source | Destination | Via Comms Backbone? | Contains Serialized Vehicle-Specific File? | Comment |
| --------------------- | ------------------------ | --------------------- | ------------------------------------------ | ------------------- | ------------------------------------------ | ---------------------------------------------------------------------------------------- |
| Hydrosurv (reav) | platform status-compiled | Reav-60 | Hydrosurv Adapter | No | Yes | N/A |
| Hydrosurv (reav) | platform status | Hydrosurv Adapter | Autonomy Engine | Yes | No | N/A |
| Hydrosurv (reav) | mission plan | Autonomy Engine | Hydrosurv Adapter | Yes | No | N/A |
| Hydrosurv (reav) | mission plan-compiled | Hydrosurv Adapter | Reav-60 | No | Yes | N/A |
| Hydrosurv (reav) | acknowledgement | Hydrosurv Adapter | Comms Backbone (Audit) | Yes | No | When hydrosurv adapter has (a) Received, (b) Sent Plan to Reav, and (c) Executed by Reav |
| RHU (autonomy engine) | platform status | C2’s Hydrosurv/Ecosub | Autonomy Engine | Yes | No | N/A |
| RHU (autonomy engine) | mission plan | Autonomy Engine | C2’s Hydrosurv/Ecosub | Yes | No | N/A |
| RHU (autonomy engine) | planning configuration | GUI | Autonomy Engine | Yes | No | N/A |
| RHU (autonomy engine) | observation | Ecosub C2 | Autonomy Engine | Yes | No | N/A |
| RHU (autonomy engine) | survey progress | Ecosub/AH1 C2 | Autonomy Engine | TBD | TBD | N/A |
| RHU (autonomy engine) | scanline | TBD | TBD | TBD | TBD | N/A |
| RHU (autonomy engine) | emergency | GUI | TBD – all | TBD | TBD | TBD – all platforms pre-compiled ABORT via Black box |
| Planet Ocean (ecosub) | platform status-compiled | Ecosub | Black Box TBC | No | Yes | Via Hermes + Router |
| Planet Ocean (ecosub) | platform status-compiled | Black Box TBC | Ecosub C2 | Yes | Yes | N/A |
| Planet Ocean (ecosub) | platform status | Ecosub C2 | Autonomy Engine | Yes | No | N/A |
| Planet Ocean (ecosub) | mission plan | Autonomy Engine | Ecosub C2 | Yes | No | N/A |
| Planet Ocean (ecosub) | mission plan | Ecosub C2 | Black Box TBC | Yes | Yes | N/A |
| Planet Ocean (ecosub) | mission plan-compiled | Black Box TBC | Ecosub | No | Yes | Via Hermes + Router |
| Planet Ocean (ecosub) | observation-compiled | Ecosub | Black Box TBC | No | Yes | Via Hermes + Router |
| Planet Ocean (ecosub) | observation-compiled | Black Box TBC | Ecosub C2 | Yes | Yes | N/A |
| Planet Ocean (ecosub) | observation | Ecosub C2 | Autonomy Engine | Yes | No | N/A |
| Planet Ocean (ecosub) | survey progress | TBD | TBD | TBD | TBD | N/A |
| Planet Ocean (ecosub) | survey progress | TBD | TBD | TBD | TBD | N/A |
| Planet Ocean (ecosub) | scanline | TBD | TBD | TBD | TBD | N/A |
| Planet Ocean (ecosub) | scanline | TBD | TBD | TBD | TBD | N/A |
| Planet Ocean (ecosub) | emergency | GUI | TBD – Ecosub (ABORT command via Black Box) | TBD | TBD | TBD – all platforms pre-compiled ABORT via Black box |
| NOC (AH1) | platform status-compiled | AH1 | Black Box TBC | No | Yes | Via Hermes + Router |
| NOC (AH1) | platform status-compiled | Black Box TBC | NOC C2 | Yes | Yes | N/A |
| NOC (AH1) | platform status | NOC C2 | Autonomy Engine | Yes | No | N/A |
| NOC (AH1) | scan point | Autonomy Engine | NOC C2 | Yes | No | N/A |
| NOC (AH1) | scan point-compiled | NOC C2 | Black Box TBC | Yes | Yes | Would this technically be a mission plan-compiled? |
| NOC (AH1) | scan point | Black Box TBC | Ecosub | No | Yes | Via Hermes + Router |
| NOC (AH1) | survey progress | TBD | TBD | TBD | TBD | TBD |
| NOC (AH1) | survey progress | TBD | TBD | TBD | TBD | TBD |
| 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 |
## Run Docs
1. Run the command below
```
python3 generate_swagger.py
```
2. Go to `http://127.0.0.1:5000/soardocs/`
projects/soar/swagger.json deleted 100644 → 0
View file @ 127d45b7
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment