refactor: implement primitive list

- geometries are geojson features
- classified with an instruction to the automation

CHANGELOG.md

@@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Inject remote geojson schema definitions
 - Use geojson Polygon instead of region_schema
+- Refactored planning_configuration message definition
+  - Remove region_of_interest and exclusion_zones 
+  - Add primitives array of classified geojson Features
 - Upgraded openapi-spec-validator to latest release (0.7.1)
 - Upgraded openapi-schema-validator to latest release (0.6.2)
 

examples/autonomy_engine_adapter/planning_configuration.json

@@ -11,8 +11,16 @@
   "payload":{
     "message_type": "planning_configuration",
     "planning_config_ID": 1,
-    "exclusion_zones": [
+    "primitives": [
       {
+        "instruction": "stay_outside",
+        "feature": {
+          "type": "Feature",
+          "properties": {
+            "name": "The Rock",
+            "type": "exclusion_zone"
+          },
+          "geometry": {
             "type": "Polygon", 
             "coordinates": [
               [
@@ -39,9 +47,17 @@
               ]
             ]
           }
-    ],
-    "region_of_interest": [
+        }
+      },
       {
+        "instruction": "stay_inside",
+        "feature": {
+          "type": "Feature",
+          "properties": {
+            "name": "Survey Zone Charlie",
+            "type": "operating area"
+          },
+          "geometry": {
             "type": "Polygon", 
             "coordinates": [
               [
@@ -68,6 +84,8 @@
               ]
             ]
           }
+        }
+      }
     ],   
     "squads": [
       {

examples/gui_adapter/planning_configuration.json

@@ -11,8 +11,16 @@
   "payload":{
     "message_type": "planning_configuration",
     "planning_config_ID": 1,
-    "exclusion_zones": [
+    "primitives": [
       {
+        "instruction": "stay_outside",
+        "feature": {
+          "type": "Feature",
+          "properties": {
+            "name": "The Rock",
+            "type": "exclusion_zone"
+          },
+          "geometry": {
             "type": "Polygon", 
             "coordinates": [
               [
@@ -39,9 +47,17 @@
               ]
             ]
           }
-    ],
-    "region_of_interest": [
+        }
+      },
       {
+        "instruction": "stay_inside",
+        "feature": {
+          "type": "Feature",
+          "properties": {
+            "name": "Survey Zone Charlie",
+            "type": "operating area"
+          },
+          "geometry": {
             "type": "Polygon", 
             "coordinates": [
               [
@@ -68,6 +84,8 @@
               ]
             ]
           }
+        }
+      }
     ],   
     "squads": [
       {

formats/planning_configuration.py

@@ -214,6 +214,30 @@ squad_metadata_schema = {
     ],
 }
 
+primitive_schema = {
+    "type": "object",
+    "properties": {
+        "instruction": {
+            "type": "string",
+            "enum": [
+                "stay_inside", 
+                "stay_outside", 
+                "navigate_to",
+                "follow",
+                "repeat",
+                "cover",
+            ],
+            "description": "How the associated feature should be used",
+        },
+        "feature": {
+            "$ref": "https://geojson.org/schema/Feature.json",
+        },
+    },
+    "required": [
+      "feature"
+    ]
+}
+
 planning_configuration_schema = {
     "type": "object",
     "properties": {
@@ -229,19 +253,10 @@ planning_configuration_schema = {
             + " configuration plan",
             "example": 3,
         },
-        "region_of_interest": {
+        "primitives": {
             "type": "array",
-            "items": {
-                "$ref": "https://geojson.org/schema/Polygon.json",
-            },
-            "description": "Region of interest for the entire operation",
-        },
-        "exclusion_zones": {
-            "type": "array",
-            "items": {
-                "$ref": "https://geojson.org/schema/Polygon.json",
-            },
-            "description": "Exclusion zones for all platforms",
+            "items": primitive_schema,
+            "description": "Specification primitives",
         },
         "squads": {
             "type": "array",
@@ -252,7 +267,6 @@ planning_configuration_schema = {
         "message_type",
         "planning_config_ID",
         "squads",
-        "exclusion_zones",
-        "region_of_interest",
+        "primitives",
     ],
 }

project/soar/swagger.json

@@ -1696,13 +1696,6 @@
       },
       "planning_configuration": {
         "properties": {
-          "exclusion_zones": {
-            "description": "Exclusion zones for all platforms",
-            "items": {
-              "$ref": "#/components/schemas/geojson.org.schema.Polygon.json"
-            },
-            "type": "array"
-          },
           "message_type": {
             "description": "Type of message",
             "enum": [
@@ -1716,10 +1709,30 @@
             "example": 3,
             "type": "integer"
           },
-          "region_of_interest": {
-            "description": "Region of interest for the entire operation",
+          "primitives": {
+            "description": "Specification primitives",
             "items": {
-              "$ref": "#/components/schemas/geojson.org.schema.Polygon.json"
+              "properties": {
+                "feature": {
+                  "$ref": "#/components/schemas/geojson.org.schema.Feature.json"
+                },
+                "instruction": {
+                  "description": "How the associated feature should be used",
+                  "enum": [
+                    "stay_inside",
+                    "stay_outside",
+                    "navigate_to",
+                    "follow",
+                    "repeat",
+                    "cover"
+                  ],
+                  "type": "string"
+                }
+              },
+              "required": [
+                "feature"
+              ],
+              "type": "object"
             },
             "type": "array"
           },
@@ -1938,8 +1951,7 @@
           "message_type",
           "planning_config_ID",
           "squads",
-          "exclusion_zones",
-          "region_of_interest"
+          "primitives"
         ],
         "type": "object"
       },