Resolve "MAS-DT update platform status message"

Closes #47 (closed)

project/soar/swagger.json

             "example": false,
             "type": "boolean"
           },
-          "latitude": {
-            "description": "Latitude (Y-coordinate) in decimal degrees.",
-            "example": 178.2,
-            "format": "float",
-            "type": "number"
-          },
           "localisation_east_error": {

examples/geojson/platform_status.json

+{
+  "header":{
+      "message_ID": "b427003c-0000-11aa-a1eb-bvcdfghjgfdd",
+      "timestamp": "2022-11-16T00:00:00Z",
+      "version": 2,
+      "source": "ecosub_c2",
+      "destination": "soar.planet-ocean.ecosub.ecosub-2.from_platform.platform_status",

project/soar/swagger.json

         "title": "GeoJSON LineString",
         "type": "object"
       },
+      "geojson.org.schema.MultiLineString.json": {
+        "$id": "https://geojson.org/schema/MultiLineString.json",
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "properties": {
+          "bbox": {
+            "items": {
+              "type": "number"
+            },
+            "minItems": 4,
+            "type": "array"
+          },
+          "coordinates": {
+            "items": {
+              "items": {
+                "items": {
+                  "type": "number"
+                },
+                "minItems": 2,
+                "type": "array"
+              },
+              "minItems": 2,
+              "type": "array"
+            },
+            "type": "array"
+          },
+          "type": {
+            "enum": [
+              "MultiLineString"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "type",
+          "coordinates"
+        ],
+        "title": "GeoJSON MultiLineString",
+        "type": "object"
+      },
+      "geojson.org.schema.MultiPoint.json": {
+        "$id": "https://geojson.org/schema/MultiPoint.json",
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "properties": {
+          "bbox": {
+            "items": {
+              "type": "number"
+            },
+            "minItems": 4,
+            "type": "array"
+          },
+          "coordinates": {
+            "items": {
+              "items": {
+                "type": "number"
+              },
+              "minItems": 2,
+              "type": "array"
+            },
+            "type": "array"
+          },
+          "type": {
+            "enum": [
+              "MultiPoint"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "type",
+          "coordinates"
+        ],
+        "title": "GeoJSON MultiPoint",
+        "type": "object"
+      },
+      "geojson.org.schema.MultiPolygon.json": {
+        "$id": "https://geojson.org/schema/MultiPolygon.json",
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "properties": {
+          "bbox": {
+            "items": {
+              "type": "number"
+            },
+            "minItems": 4,
+            "type": "array"
+          },
+          "coordinates": {
+            "items": {
+              "items": {
+                "items": {
+                  "items": {
+                    "type": "number"
+                  },
+                  "minItems": 2,
+                  "type": "array"
+                },
+                "minItems": 4,
+                "type": "array"
+              },
+              "type": "array"
+            },
+            "type": "array"
+          },
+          "type": {
+            "enum": [
+              "MultiPolygon"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "type",
+          "coordinates"
+        ],
+        "title": "GeoJSON MultiPolygon",
+        "type": "object"
+      },
       "geojson.org.schema.Point.json": {
         "$id": "https://geojson.org/schema/Point.json",
         "$schema": "http://json-schema.org/draft-07/schema#",
           "exclusion_zones": {
             "description": "Exclusion zones for all platforms",
             "items": {
-              "description": "GeoJSON Polygon",
-              "properties": {
-                "geometry": {
-                  "$ref": "#/components/schemas/geojson.org.schema.Polygon.json"
-                }
-              },
-              "type": "object"
+              "$ref": "#/components/schemas/geojson.org.schema.Polygon.json"
             },
             "type": "array"
           },
           "region_of_interest": {
             "description": "Region of interest for the entire operation",
             "items": {
-              "description": "GeoJSON Polygon",
-              "properties": {
-                "geometry": {
-                  "$ref": "#/components/schemas/geojson.org.schema.Polygon.json"
-                }
-              },
-              "type": "object"
+              "$ref": "#/components/schemas/geojson.org.schema.Polygon.json"
             },
             "type": "array"
           },
                             "example": "go_home",
                             "type": "string"
                           },
-                          "target_depth": {
-                            "description": "Z-coordinate safe place for respective platform . If platform to NOT stay at depth, key in `0.0`",
-                            "example": 10.0,
-                            "format": "float",
-                            "type": "number"
-                          },
-                          "target_waypoint_latitude": {
-                            "description": "Y-coordinate safe place for respective platform",
-                            "example": 50.365,
-                            "format": "float",
-                            "type": "number"
-                          },
-                          "target_waypoint_longitude": {
-                            "description": "X-coordinate safe place for respective platform",
-                            "example": -7.432,
-                            "format": "float",
-                            "type": "number"
+                          "target_waypoint": {
+                            "$ref": "#/components/schemas/geojson.org.schema.Point.json"
                           }
                         },
                         "required": [
-                          "target_waypoint_latitude",
-                          "target_waypoint_longitude",
-                          "target_depth"
+                          "target_waypoint"
                         ],
                         "type": "object"
                       },
                 "description": "Sensor switched on (true) or off (false)",
                 "example": true,
                 "type": "boolean"
               },
               "sensor_serial": {
                 "description": "serial number of sensor",
                 "example": "mbes-002a",

[Trishna Saeharaseelan]

We should discuss some of these fields that probably aren't useful/needed outside of soar

[Trishna Saeharaseelan]

I know this is just an example, but would be nice to have a mas-dt.x.x.x instead of soar.x.x.x in "destination"

[Dan Jones]

Agreed. Will do.

[Trishna Saeharaseelan]

Approved with small recommended update to example

[Victor Darvariu]

A few comments from my side:

1. On the new waypoint field: this is intended to report the next waypoint that will be followed, right? In the mission_plan message we aim to specify a list of waypoints, with the first one being the planner-derived "clever" waypoint, and the rest being backups. Do we maybe want to report back this entire list of waypoints instead? I don't think it's necessarily needed, but perhaps we want to be consistent.
2. Given that we will allow changing parameters with the instruction_set messages, perhaps we should also report back the values of these parameters in the status messages after the dive (in case changing them might have failed for some reason?). Maybe this would need to be handled in a different issue.

[Dan Jones]

1. The waypoint field in the platform status should contain the target point that the slocum is currently trying to navigate towards. So if you were to send a new plan but that new plan failed to transmit that field would tell you that the slocum performed the last dive based on the previous instructions.

2. We're having a think about how to manage communicating the parameters in the instruction set. So the sbd/tbd data will tell you which parameter values the slocum was operating under. What we need to figure out is how you know what parameter values the instruction set contains. You could decode and parse the ma files but I'm wondering whether we can populate those as part of the instruction set definitions so you have a list of the fixed parameters set by those files.

You would still have to check whether the dive parameters matched the instruction set you sent (in case the file transfer failed)

[Victor Darvariu]

1. Understood, sounds good.
2. For this one, we would prefer to know the parameter values from the instruction sets and not have to extract them ourselves (essentially the same point as #62 (comment 259744)). Agreed that we'd need to check the match with the dive parameters after the fact.