Merge branch '28-add-binary-message-format' into 'dev'

feat: support binary payload

Closes #28

See merge request !19

examples/autonomy_engine_adapter/acknowledgement.json

@@ -4,7 +4,7 @@
         "timestamp": "2022-11-16T00:00:00Z",
         "version": 1,
         "source": "hydrosurv_adapter",
-        "destination": "soar.hydrosurv.reav.reav1.receive.acknowledgement",
+        "destination": "soar.hydrosurv.reav.reav1.from_platform.acknowledgement",
         "delivery_type": "publish",
         "encoded": false
     },

examples/autonomy_engine_adapter/mission_plan_AH1.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "autonomy_engine",
-    "destination": "soar.noc.autosub.alr-52.send.mission_plan",
+    "destination": "soar.noc.autosub.alr-52.to_platform.mission_plan",
     "delivery_type": "publish",
     "encoded": false
   },

examples/autonomy_engine_adapter/mission_plan_ECOSUB.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "autonomy_engine",
-    "destination": "soar.planetocean.ecosub.ecosub-1.send.mission_plan",
+    "destination": "soar.planetocean.ecosub.ecosub-1.to_platform.mission_plan",
     "delivery_type": "publish",
     "encoded": false
   },

examples/autonomy_engine_adapter/mission_plan_HYDROSURV.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "autonomy_engine",
-    "destination": "soar.hydrosurv.reav-60.reav-60-1.send.mission_plan",
+    "destination": "soar.hydrosurv.reav-60.reav-60-1.to_platform.mission_plan",
     "delivery_type": "publish",
     "encoded": false
   },

examples/autonomy_engine_adapter/mission_plan_encoded.json

+{
+  "header": {  
+    "message_ID": "t1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
+    "timestamp": "2023-03-16T00:00:00Z",
+    "version": 2,
+    "source": "autonomy_engine",
+    "destination": "soar.hermes.autosub.alr-52.to_platform.mission_plan_encoded",
+    "delivery_type": "publish",
+    "encoded": true
+  },
+  "payload": {
+    "message_type": "mission_plan_encoded",
+    "data": "SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBlB/tRYQW3nez5HWYFBAAD+zwBySUAAAADVek72v1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
+    "file_name": "ah1_03837434286438.sbd",
+    "mime_type": "application/gzip",
+    "is_binary": true
+   }
+}   

examples/autonomy_engine_adapter/observation_encoded.json

+{
+  "header": {  
+    "message_ID": "e1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
+    "timestamp": "2023-03-16T00:00:00Z",
+    "version": 2,
+    "source": "hermes.ecosub2",
+    "destination": "soar.planet-ocean.ecosub.ecosub-2.from_platform.observation_encoded",
+    "delivery_type": "publish",
+    "encoded": true
+  },
+  "payload": {
+    "message_type": "observation_encoded",
+    "data": "T1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
+    "file_name": "ecosub1_200002114.bin",
+    "mime_type": "application/gzip",
+    "is_binary": true
+   }
+}   

examples/autonomy_engine_adapter/planning_configuration.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "gui",
-    "destination": "soar.all.all.all.receive.planning_configuration",
+    "destination": "soar.all.all.all.from_platform.planning_configuration",
     "delivery_type": "publish",
     "encoded": false
   },

examples/autonomy_engine_adapter/platform_status-from_usbl_example.json

@@ -4,7 +4,7 @@
         "timestamp": "2022-11-16T00:00:00Z",
         "version": 2,
         "source": "hermes",
-        "destination": "soar.planet-ocean.ecosub.ecosub-5.receive.platform_status",
+        "destination": "soar.planet-ocean.ecosub.ecosub-5.from_platform.platform_status",
         "delivery_type": "publish",
         "encoded": false
     },

examples/autonomy_engine_adapter/platform_status.json

@@ -4,7 +4,7 @@
         "timestamp": "2022-11-16T00:00:00Z",
         "version": 2,
         "source": "ecosub_c2",
-        "destination": "soar.planet-ocean.ecosub.ecosub-2.receive.platform_status",
+        "destination": "soar.planet-ocean.ecosub.ecosub-2.from_platform.platform_status",
         "delivery_type": "publish",
         "encoded": false
     },

examples/autonomy_engine_adapter/platform_status_encoded.json

+{
+  "header": {  
+    "message_ID": "t1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
+    "timestamp": "2023-03-16T00:00:00Z",
+    "version": 2,
+    "source": "hermes.ah1",
+    "destination": "soar.noc.autosub.alr-52.from_platform.platform_status_encoded",
+    "delivery_type": "publish",
+    "encoded": true
+  },
+  "payload": {
+    "message_type": "platform_status_encoded",
+    "data": "HWYFBAAD+zwBySUAAAADVek72v1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
+    "file_name": "ah1_03837434286438.sbd",
+    "mime_type": "application/gzip",
+    "is_binary": true
+   }
+}   

examples/ecosub_adapter/mission_plan.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "autonomy_engine",
-    "destination": "soar.planetocean.ecosub.ecosub-1.send.mission_plan",
+    "destination": "soar.planetocean.ecosub.ecosub-1.to_platform.mission_plan",
     "delivery_type": "publish",
     "encoded": false
   },

examples/ecosub_adapter/observation.json

@@ -4,7 +4,7 @@
         "timestamp": "2022-11-16T00:00:00Z",
         "version": 2,
         "source": "ecosub_c2",
-        "destination": "soar.planet-ocean.ecosub.ecosub-2.receive.observation",
+        "destination": "soar.planet-ocean.ecosub.ecosub-2.from_platform.observation",
         "delivery_type": "publish",
         "encoded": false
     },

examples/ecosub_adapter/observation_encoded.json

+{
+  "header": {  
+    "message_ID": "e1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
+    "timestamp": "2023-03-16T00:00:00Z",
+    "version": 2,
+    "source": "hermes.ecosub2",
+    "destination": "soar.planet-ocean.ecosub.ecosub-2.from_platform.observation_encoded",
+    "delivery_type": "publish",
+    "encoded": true
+  },
+  "payload": {
+    "message_type": "observation_encoded",
+    "data": "T1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
+    "file_name": "ecosub1_200002114.txt",
+    "is_binary": true
+   }
+}   

examples/ecosub_adapter/platform_status-from_usbl_example.json

@@ -4,7 +4,7 @@
         "timestamp": "2022-11-16T00:00:00Z",
         "version": 2,
         "source": "hermes",
-        "destination": "soar.planet-ocean.ecosub.ecosub-5.receive.platform_status",
+        "destination": "soar.planet-ocean.ecosub.ecosub-5.from_platform.platform_status",
         "delivery_type": "publish",
         "encoded": false
     },

examples/ecosub_adapter/platform_status.json

@@ -4,7 +4,7 @@
         "timestamp": "2022-11-16T00:00:00Z",
         "version": 2,
         "source": "ecosub_c2",
-        "destination": "soar.planet-ocean.ecosub.ecosub-2.receive.platform_status",
+        "destination": "soar.planet-ocean.ecosub.ecosub-2.from_platform.platform_status",
         "delivery_type": "publish",
         "encoded": false
     },

examples/gui_adapter/planning_configuration.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "gui",
-    "destination": "soar.all.all.all.receive.planning_configuration",
+    "destination": "soar.all.all.all.from_platform.planning_configuration",
     "delivery_type": "publish",
     "encoded": false
   },

examples/hydrosurv_adapter/acknowledgement.json

@@ -4,7 +4,7 @@
         "timestamp": "2022-11-16T00:00:00Z",
         "version": 1,
         "source": "hydrosurv_adapter",
-        "destination": "soar.hydrosurv.reav-60.reav-60-1.receive.acknowledgement",
+        "destination": "soar.hydrosurv.reav-60.reav-60-1.from_platform.acknowledgement",
         "delivery_type": "publish",
         "encoded": false
     },

examples/hydrosurv_adapter/mission_plan.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "autonomy_engine",
-    "destination": "soar.hydrosurv.reav-60.reav-60-1.send.mission_plan",
+    "destination": "soar.hydrosurv.reav-60.reav-60-1.to_platform.mission_plan",
     "delivery_type": "publish",
     "encoded": false
   },

examples/hydrosurv_adapter/platform_status.json

@@ -4,7 +4,7 @@
     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "hydrosurv_adapter",
-    "destination": "soar.hydrosurv.reav-60.reav-60-1.receive.platform_status",
+    "destination": "soar.hydrosurv.reav-60.reav-60-1.from_platform.platform_status",
     "delivery_type": "publish",
     "encoded": false
   },

formats/encoded.py

+"""
+    schemas: Encoded (compiled) type messages that are applicable to compiled
+    platform statuses and observations (from the platform), and compiled
+    mission plans (to the platform). This encoded schema is applicable to the
+    different message types: mission_plan_encoded, observation_encoded, and
+    platform_status_encoded.
+"""
+
+encoded_schema = {
+    "type": "object",
+    "properties": {
+        "message_type": {
+            "type": "string",
+            "description": "Type of message",
+        },
+        "data": {
+            "type": "string",
+            "description": "encoded string. E.g. Base64 encoded",
+            "example": "SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcB"
+            + "AAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
+        },
+        "file_name": {
+            "type": "string",
+            "description": "Name of file",
+            "example": "ah1-0238126349247372.bin",
+        },
+        "mime_type": {
+            "type": "string",
+            "description": "MIME type",
+            "example": "application/gzip",
+        },
+        "is_binary": {
+            "type": "boolean",
+            "description": (
+                "True if the data field contains binary format data encoded as base64."
+                + " False if the data field contains ascii content such as NMEA."
+            ),
+            "example": True,
+        },
+    },
+    "required": ["data", "is_binary"],
+}