Skip to content

GitLab

Commit 011b8b15 authored by Trishna Saeharaseelan's avatar Trishna Saeharaseelan
Browse files

refactor: update information for hydrosurv and examples

parent df7f866a
dev 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
2 merge requests!30Resolve "Release v0.2",!24add endurance rating, active status, warmup time
Pipeline #132420 failed with stages
in 51 seconds
Show whitespace changes
Inline Side-by-side
Showing with 1082 additions and 917 deletions
examples/autonomy_engine_adapter/mission_plan_HYDROSURV.json
View file @ 011b8b15
......@@ -4,13 +4,13 @@
"timestamp": "2022-11-16T00:00:00Z",
"version": 2,
"source": "autonomy_engine",
"destination": "soar.hydrosurv.reav-60.reav-60-1.to_platform.mission_plan",
"destination": "soar.hydrosurv.reav60.usvdecibel.to_platform.mission_plan",
"delivery_type": "publish",
"encoded": false
},
"payload":{
"message_type": "mission_plan",
"platform_ID": "reav-60-1",
"platform_ID": "usvdecibel",
"autonomy_engine_plan_ID": 1,
"plan": [
{
......
examples/autonomy_engine_adapter/planning_configuration.json
View file @ 011b8b15
......@@ -5,7 +5,7 @@
"version": 2,
"source": "gui",
"destination": "soar.all.all.all.from_platform.planning_configuration",
"delivery_type": "publish",
"delivery_type": "broadcast",
"encoded": false
},
"payload":{
......@@ -76,24 +76,10 @@
{
"operator": "hydrosurv",
"model": "reav",
"platform_ID": "reav-60-1",
"platform_ID": "usvdecibel",
"active": true,
"emergency": {
"target_waypoint_latitude": 50.33611100020795,
"target_waypoint_longitude": -4.189772466767039,
"safe_command": "go_home",
"target_depth": 10.0
},
"min_altitude": 0.0,
"max_velocity": 0.9,
"min_velocity": 0.1,
"target_altitude": 0.0,
"endurance_relative_to_water_speed": {
"min_battery_rating": 2.25,
"max_battery_rating": 1.23,
"avg_battery_rating": 1.9
},
"additional_data": {}
}
]
},
......
examples/gui_adapter/planning_configuration.json
View file @ 011b8b15
......@@ -75,8 +75,8 @@
"platforms": [
{
"operator": "hydrosurv",
"model": "reav",
"platform_ID": "reav-60-1",
"model": "reav60",
"platform_ID": "usvdecibel",
"active": true,
"emergency": {
"target_waypoint_latitude": 50.33611100020795,
......
examples/hydrosurv_adapter/acknowledgement.json
View file @ 011b8b15
......@@ -4,14 +4,14 @@
"timestamp": "2022-11-16T00:00:00Z",
"version": 1,
"source": "hydrosurv_adapter",
"destination": "soar.hydrosurv.reav-60.reav-60-1.from_platform.acknowledgement",
"destination": "soar.hydrosurv.reav60.usvdecibel.from_platform.acknowledgement",
"delivery_type": "publish",
"encoded": false
},
"payload":{
"message_type": "acknowledgement",
"autonomy_engine_plan_ID": 1,
"platform_ID": "reav-60-1",
"platform_ID": "usvdecibel",
"approved": false
}
}
\ No newline at end of file
examples/hydrosurv_adapter/mission_plan.json
View file @ 011b8b15
......@@ -4,13 +4,13 @@
"timestamp": "2022-11-16T00:00:00Z",
"version": 2,
"source": "autonomy_engine",
"destination": "soar.hydrosurv.reav-60.reav-60-1.to_platform.mission_plan",
"destination": "soar.hydrosurv.reav60.usvdecibel.to_platform.mission_plan",
"delivery_type": "publish",
"encoded": false
},
"payload":{
"message_type": "mission_plan",
"platform_ID": "reav-60-1",
"platform_ID": "usvdecibel",
"autonomy_engine_plan_ID": 1,
"plan": [
{
......
examples/hydrosurv_adapter/platform_status.json
View file @ 011b8b15
......@@ -4,7 +4,7 @@
"timestamp": "2022-11-16T00:00:00Z",
"version": 2,
"source": "hydrosurv_adapter",
"destination": "soar.hydrosurv.reav-60.reav-60-1.from_platform.platform_status",
"destination": "soar.hydrosurv.reav60.usvdecibel.from_platform.platform_status",
"delivery_type": "publish",
"encoded": false
},
......@@ -19,7 +19,7 @@
"longitude": -10.122,
"mission_plan_ID": 1,
"mission_track_ID": 4,
"platform_ID": "reav-60-1",
"platform_ID": "usvdecibel",
"platform_state": "ABORT",
"platform_timestamp": "2022-12-21T00:00:00Z",
"speed_over_ground": 4.5,
......
formats/planning_configuration.py
View file @ 011b8b15
......@@ -8,7 +8,7 @@ emergency_schema = {
"properties": {
"safe_command": {
"type": "string",
"enum": ["go_home", "abort_now", "stop_mission"],
"enum": ["go_home", "abort_now", "stop_now", "surface_now"],
"description": "Command/Action that is native to respective"
+ " partner's platform/C2",
"example": "go_home",
......@@ -178,7 +178,6 @@ platform_schema = {
"platform_ID",
"active",
"model",
"emergency",
"min_altitude",
"min_velocity",
"max_velocity",
......
project/soar/swagger.json
View file @ 011b8b15
......@@ -524,7 +524,8 @@
"enum":[
"go_home",
"abort_now",
"stop_mission"
"stop_now",
"surface_now"
],
"example":"go_home",
"type":"string"
......@@ -666,7 +667,6 @@
"platform_ID",
"active",
"model",
"emergency",
"min_altitude",
"min_velocity",
"max_velocity"
......
tests/fixtures/schemas.py
View file @ 011b8b15
......@@ -250,7 +250,7 @@ emergency_schema = {
"properties": {
"safe_command": {
"type": "string",
"enum": ["go_home", "abort_now", "stop_mission"],
"enum": ["go_home", "abort_now", "stop_now", "surface_now"],
"description": "Command/Action that is native to respective"
+ " partner's platform/C2",
"example": "go_home",
......
tests/fixtures/swagger.json
View file @ 011b8b15
......@@ -126,6 +126,18 @@
"properties":{
"action":{
"description":"Autonomy Engine's action from `move`, `payload`, `dive`, `send_hits`, `scanline`, `scanpoint`.",
"enum":[
"move",
"payload",
"dive",
"send_hits",
"scanline",
"scanpoint",
"go_home",
"surface_now",
"stop_mission",
"abort_now"
],
"example":"move",
"type":"string"
},
......@@ -147,26 +159,26 @@
"type":"number"
},
"start_point_latitude":{
"description":"Start point, x-coordinate",
"example":-4.187143188645706,
"description":"Start point, y-coordinate",
"example":50.37072283932642,
"format":"float",
"type":"number"
},
"start_point_longitude":{
"description":"Start point, y-coordinate",
"example":50.37072283932642,
"description":"Start point, x-coordinate",
"example":-4.187143188645706,
"format":"float",
"type":"number"
},
"target_waypoint_latitude":{
"description":"Target waypoint, x-coordinate",
"example":-4.187143188645706,
"description":"Target waypoint, y-coordinate",
"example":50.37072283932642,
"format":"float",
"type":"number"
},
"target_waypoint_longitude":{
"description":"Target waypoint, y-coordinate",
"example":50.37072283932642,
"description":"Target waypoint, x-coordinate",
"example":-4.187143188645706,
"format":"float",
"type":"number"
},
......@@ -262,13 +274,13 @@
"items":{
"properties":{
"latitude":{
"description":"Identified x-coordinate of point of interest",
"description":"Identified y-coordinate of point of interest",
"example":178.2,
"format":"float",
"type":"number"
},
"longitude":{
"description":"Identified y-coordinate of point of interest",
"description":"Identified x-coordinate of point of interest",
"example":-10.122,
"format":"float",
"type":"number"
......@@ -347,7 +359,9 @@
"observation_encoded":"#/components/schemas/observation_encoded",
"planning_configuration":"#/components/schemas/planning_configuration",
"platform_status":"#/components/schemas/platform_status",
"platform_status_encoded":"#/components/schemas/platform_status_encoded"
"platform_status_encoded":"#/components/schemas/platform_status_encoded",
"survey":"#/components/schemas/survey",
"survey_encoded":"#/components/schemas/survey_encoded"
},
"propertyName":"message_type"
},
......@@ -375,6 +389,12 @@
},
{
"$ref":"#/components/schemas/platform_status_encoded"
},
{
"$ref":"#/components/schemas/survey"
},
{
"$ref":"#/components/schemas/survey_encoded"
}
]
},
......@@ -479,6 +499,11 @@
"description":"Squad consists of these platforms",
"items":{
"properties":{
"active":{
"description":"If platform is active = True, and inactive = False",
"example":true,
"type":"boolean"
},
"additional_data":{
"description":"Any addition fields/data to be added here",
"example":{
......@@ -489,7 +514,7 @@
},
"beacon_ID":{
"description":"Unique identifier (number) for the beacon associated to this platform",
"example":9407,
"example":2407,
"type":"number"
},
"emergency":{
......@@ -499,7 +524,8 @@
"enum":[
"go_home",
"abort_now",
"stop_mission"
"stop_now",
"surface_now"
],
"example":"go_home",
"type":"string"
......@@ -511,14 +537,14 @@
"type":"number"
},
"target_waypoint_latitude":{
"description":"X-coordinate safe place for respective platform",
"example":-7.432,
"description":"Y-coordinate safe place for respective platform",
"example":50.365,
"format":"float",
"type":"number"
},
"target_waypoint_longitude":{
"description":"Y-coordinate safe place for respective platform",
"example":50.365,
"description":"X-coordinate safe place for respective platform",
"example":-7.432,
"format":"float",
"type":"number"
}
......@@ -530,6 +556,29 @@
],
"type":"object"
},
"endurance_relative_to_water_speed":{
"properties":{
"avg_battery_rating":{
"description":"Battery endurance rating during standard operational speed usage (m/s)",
"example":1.9,
"format":"float",
"type":"number"
},
"max_battery_rating":{
"description":"Battery endurance rating during maximum speed usage (m/s)",
"example":1.23,
"format":"float",
"type":"number"
},
"min_battery_rating":{
"description":"Battery endurance rating during maximum speed usage (m/s)",
"example":3.32,
"format":"float",
"type":"number"
}
},
"type":"object"
},
"max_velocity":{
"description":"Maximum velocity set for platform",
"example":0.9,
......@@ -590,6 +639,12 @@
"example":38.0,
"format":"float",
"type":"number"
},
"warmup_time":{
"description":"Warmup time (seconds) for sensor to start up.",
"example":180.0,
"format":"float",
"type":"number"
}
},
"type":"object"
......@@ -610,8 +665,8 @@
"required":[
"operator",
"platform_ID",
"active",
"model",
"emergency",
"min_altitude",
"min_velocity",
"max_velocity"
......@@ -694,7 +749,7 @@
"type":"boolean"
},
"latitude":{
"description":"Latitude in decimal degrees.",
"description":"Latitude (Y-coordinate) in decimal degrees.",
"example":178.2,
"format":"float",
"type":"number"
......@@ -712,7 +767,7 @@
"type":"number"
},
"longitude":{
"description":"Longitude in decimal degrees.",
"description":"Longitude (X-coordinate) in decimal degrees.",
"example":-10.122,
"format":"float",
"type":"number"
......@@ -873,6 +928,131 @@
"is_binary"
],
"type":"object"
},
"survey":{
"properties":{
"latitude_A":{
"description":"Latitude of point A(intersection of normal)from waypoint A to survey line",
"example":178.2,
"format":"float",
"type":"number"
},
"latitude_B":{
"description":"Latitude of point B(intersection of normal)from waypoint B to survey line",
"example":178.2,
"format":"float",
"type":"number"
},
"latitude_C":{
"description":"Latitude of point C(intersection of normal)from waypoint C to survey line",
"example":178.2,
"format":"float",
"type":"number"
},
"latitude_D":{
"description":"Latitude of point D(intersection of normal)from waypoint D to survey line",
"example":178.2,
"format":"float",
"type":"number"
},
"latitude_E":{
"description":"Latitude of point E(intersection of normal)from waypoint E to survey line",
"example":178.2,
"format":"float",
"type":"number"
},
"longitude_A":{
"description":"Longitude of point A(intersection of normal)from waypoint A to survey line",
"example":-10.122,
"format":"float",
"type":"number"
},
"longitude_B":{
"description":"Longitude of point B(intersection of normal)from waypoint B to survey line",
"example":-10.122,
"format":"float",
"type":"number"
},
"longitude_C":{
"description":"Longitude of point C(intersection of normal)from waypoint C to survey line",
"example":-10.122,
"format":"float",
"type":"number"
},
"longitude_D":{
"description":"Longitude of point D(intersection of normal)from waypoint D to survey line",
"example":-10.122,
"format":"float",
"type":"number"
},
"longitude_E":{
"description":"Longitude of point E(intersection of normal)from waypoint E to survey line",
"example":-10.122,
"format":"float",
"type":"number"
},
"platform_ID":{
"description":"Unique identifier for this platform",
"example":"ecosub-2",
"type":"string"
},
"timestamp":{
"description":"Timestamp for onboard message",
"example":"2022-12-21T00:00:00Z",
"format":"date-time",
"type":"string"
},
"track_ID":{
"description":"Track number of action(s) currently executed by platform",
"example":1,
"type":"integer"
}
},
"required":[
"latitude_A",
"longitude_A",
"latitude_B",
"longitude_B",
"platform_ID"
],
"type":"object"
},
"survey_encoded":{
"properties":{
"data":{
"description":"encoded string. E.g. Base64 encoded",
"example":"SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"type":"string"
},
"file_name":{
"description":"Name of file",
"example":"ah1-0238126349247372.bin",
"type":"string"
},
"is_binary":{
"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,
"type":"boolean"
},
"message_type":{
"description":"Type of message",
"enum":[
"survey_encoded"
],
"example":"survey_encoded",
"type":"string"
},
"mime_type":{
"description":"MIME type",
"example":"application/gzip",
"type":"string"
}
},
"required":[
"data",
"is_binary"
],
"type":"object"
}
}
},
......
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