Merge branch '86-add-new-additional-field-in-platform-status' into '67-mas-dt'

Add new additional_data field (platform status)

See merge request !54

CHANGELOG.md

@@ -13,12 +13,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-<<<<<<< HEAD
+- Additional_data field to platform_status to input any other data from a platform to be published
 - Goal object in mission_plan message that consists of a GeoJSON feature (representing the part of primitive that is currently the goal of the given mission plan).
 - A `partial` flag that indicates if a mission plan is a partial plan or the entire mission plan
-=======
 - Added "informational" to enum for primitive's instruction enum (planning configuration)
->>>>>>> 7f768c7 (refactor(planning_configuration): update primitive instruction's enum and new goal obj)
 - Options to primitives (under planning_configuration message) which is only a property when a primitive has an instruction of "follow" or "navigate_to"
 - Validate message_ID matches uuid format
 - Add definition of instruction_set message

examples/mas-dt/platform_status_branch.json

@@ -19,6 +19,18 @@
         "latitude": 78.2,
         "longitude": -10.122,
         "depth": 50.0,
-        "altitude": 20
+        "altitude": 20,
+        "additional_data": {
+            "m_coulomb_amphr_total_amp-hrs": 95.45837241,
+            "m_surf_water_vx_m/s": 0.14628909,
+            "m_surf_water_vy_m/s": -0.29900273,
+            "x_last_wpt_lat": 5918.8097,
+            "x_last_wpt_lon": -33.7354,
+            "m_water_vx_m/s": 0.02802813404,
+            "m_water_vy_m/s": -0.158598628590847
+
+        }
     }
 }
+
+

examples/mas-dt/platform_status_commit.json

@@ -19,6 +19,16 @@
         "latitude": 78.2,
         "longitude": -10.122,
         "depth": 50.0,
-        "altitude": 20
+        "altitude": 20,
+        "additional_data": {
+            "m_coulomb_amphr_total_amp-hrs": 95.45837241,
+            "m_surf_water_vx_m/s": 0.14628909,
+            "m_surf_water_vy_m/s": -0.29900273,
+            "x_last_wpt_lat": 5918.8097,
+            "x_last_wpt_lon": -33.7354,
+            "m_water_vx_m/s": 0.02802813404,
+            "m_water_vy_m/s": -0.158598628590847
+
+        }
     }
 }

examples/mas-dt/platform_status_semver.json

@@ -2,7 +2,7 @@
     "header":{
         "message_ID": "b427003c-0000-11aa-a1eb-b1cdf2342fdd",
         "timestamp": "2024-09-05T00:00:00Z",
-        "version": "v2.0.0-beta.1",
+        "version": "v2.0.0-beta.9",
         "source": "noc-sfmc",
         "destination": "mas-dt.noc.slocum.unit_xxx.from_platform.platform_status",
         "delivery_type": "publish",
@@ -19,6 +19,16 @@
         "latitude": 78.2,
         "longitude": -10.122,
         "depth": 50.0,
-        "altitude": 20
+        "altitude": 20,
+        "additional_data": {
+            "m_coulomb_amphr_total_amp-hrs": 95.45837241,
+            "m_surf_water_vx_m/s": 0.14628909,
+            "m_surf_water_vy_m/s": -0.29900273,
+            "x_last_wpt_lat": 5918.8097,
+            "x_last_wpt_lon": -33.7354,
+            "m_water_vx_m/s": 0.02802813404,
+            "m_water_vy_m/s": -0.158598628590847
+
+        }
     }
 }

formats/platform_status.py

@@ -175,6 +175,11 @@ platform_status_schema = {
             + "based on present output or performance",
             "example": 7.4,
         },
+        "additional_data": {
+            "type": "object",
+            "description": "Any addition fields/data to be added here",
+            "example": {"m_coulomb_amphr_total": 95.45837},
+        },
         "sensor_config": sensor_schema,
     },
     "oneOf": [

project/soar/swagger.json

@@ -2465,6 +2465,13 @@
           }
         ],
         "properties": {
+          "additional_data": {
+            "description": "Any addition fields/data to be added here",
+            "example": {
+              "m_coulomb_amphr_total": 95.45837
+            },
+            "type": "object"
+          },
           "autonomy_engine_plan_ID": {
             "description": "Last mission plan ID (according to Autonomy Engine's mission plan number sent) executed by platform",
             "example": 1,