Commit 63c68473 authored by Trishna Saeharaseelan's avatar Trishna Saeharaseelan
Browse files

refactor: better field names in status and remove pitch field

parent 2e630184
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
"start_point_longitude": 60.00000000000000, "start_point_longitude": 60.00000000000000,
"target_waypoint_latitude": -0.237143188645706, "target_waypoint_latitude": -0.237143188645706,
"target_waypoint_longitude": 52.37072283932642, "target_waypoint_longitude": 52.37072283932642,
"depth": 0, "depth": 0.0,
"activate_payload": false, "activate_payload": false,
"send_environmental_data": true "send_environmental_data": true
} }
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
"start_point_longitude": 60.00000000000000, "start_point_longitude": 60.00000000000000,
"target_waypoint_latitude": -0.237143188645706, "target_waypoint_latitude": -0.237143188645706,
"target_waypoint_longitude": 52.37072283932642, "target_waypoint_longitude": 52.37072283932642,
"depth": 0, "depth": 0.0,
"activate_payload": false, "activate_payload": false,
"send_environmental_data": true "send_environmental_data": true
} }
......
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
"target_waypoint_latitude": -7.432, "target_waypoint_latitude": -7.432,
"target_waypoint_longitude": 50.365, "target_waypoint_longitude": 50.365,
"safe_command": "go_home", "safe_command": "go_home",
"target_depth": 10 "target_depth": 10.0
}, },
"max_velocity": 0.9, "max_velocity": 0.9,
"min_altitude": 15.2, "min_altitude": 15.2,
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
"status_source": "usbl", "status_source": "usbl",
"latitude": 178.2, "latitude": 178.2,
"longitude": -10.122, "longitude": -10.122,
"depth": 50, "depth": 50.0,
"altitude": 20 "altitude": 20.0
} }
} }
...@@ -21,11 +21,12 @@ ...@@ -21,11 +21,12 @@
"mission_track_ID": 4, "mission_track_ID": 4,
"latitude": 178.2, "latitude": 178.2,
"longitude": -10.122, "longitude": -10.122,
"depth": 50, "depth": 50.0,
"altitude": 20, "altitude": 20,
"heading": 90.0, "heading": 90.0,
"health_status": "Warning", "health_status": false,
"localisation_error": 0, "localisation_north_error": 0,
"localisation_east_error": 0,
"usbl_fix_seconds_ago": 0, "usbl_fix_seconds_ago": 0,
"range_to_go": 124.3, "range_to_go": 124.3,
"sensor_config": { "sensor_config": {
...@@ -36,7 +37,6 @@ ...@@ -36,7 +37,6 @@
"whiskers_on": true "whiskers_on": true
} }
}, },
"current_pitch": -4,
"speed_over_ground": 4.3, "speed_over_ground": 4.3,
"thrust_applied": 124.3, "thrust_applied": 124.3,
"water_current_velocity": 124.3 "water_current_velocity": 124.3
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
"start_point_longitude": 60.00000000000000, "start_point_longitude": 60.00000000000000,
"target_waypoint_latitude": -0.237143188645706, "target_waypoint_latitude": -0.237143188645706,
"target_waypoint_longitude": 52.37072283932642, "target_waypoint_longitude": 52.37072283932642,
"depth": 0, "depth": 0.0,
"activate_payload": false, "activate_payload": false,
"send_environmental_data": true "send_environmental_data": true
} }
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
"status_source": "usbl", "status_source": "usbl",
"latitude": 178.2, "latitude": 178.2,
"longitude": -10.122, "longitude": -10.122,
"depth": 50, "depth": 50.0,
"altitude": 20 "altitude": 20.0
} }
} }
...@@ -17,15 +17,16 @@ ...@@ -17,15 +17,16 @@
"battery_remaining_capacity": 80.2, "battery_remaining_capacity": 80.2,
"active": true, "active": true,
"platform_state": "ABORT", "platform_state": "ABORT",
"mission_action_ID": 1, "mission_plan_ID": 1,
"mission_track_ID": 4, "mission_track_ID": 4,
"latitude": 178.2, "latitude": 178.2,
"longitude": -10.122, "longitude": -10.122,
"depth": 50, "depth": 50.0,
"altitude": 20, "altitude": 20,
"heading": 90.0, "heading": 90.0,
"health_status": "Warning", "health_status": false,
"localisation_error": 0, "localisation_north_error": 0,
"localisation_east_error": 0,
"usbl_fix_seconds_ago": 0, "usbl_fix_seconds_ago": 0,
"range_to_go": 124.3, "range_to_go": 124.3,
"sensor_config": { "sensor_config": {
...@@ -36,7 +37,6 @@ ...@@ -36,7 +37,6 @@
"whiskers_on": true "whiskers_on": true
} }
}, },
"current_pitch": -4,
"speed_over_ground": 4.3, "speed_over_ground": 4.3,
"thrust_applied": 124.3, "thrust_applied": 124.3,
"water_current_velocity": 124.3 "water_current_velocity": 124.3
......
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
"target_waypoint_latitude": -7.432, "target_waypoint_latitude": -7.432,
"target_waypoint_longitude": 50.365, "target_waypoint_longitude": 50.365,
"safe_command": "go_home", "safe_command": "go_home",
"target_depth": 10 "target_depth": 10.0
}, },
"max_velocity": 0.9, "max_velocity": 0.9,
"min_altitude": 15.2, "min_altitude": 15.2,
......
...@@ -15,10 +15,10 @@ ...@@ -15,10 +15,10 @@
"status_source": "onboard_platform", "status_source": "onboard_platform",
"battery_remaining_capacity": 80.2, "battery_remaining_capacity": 80.2,
"heading": 310.0, "heading": 310.0,
"health_status": "Lost Connection", "health_status": false,
"latitude": 178.2, "latitude": 178.2,
"longitude": -10.122, "longitude": -10.122,
"mission_action_ID": 1, "mission_plan_ID": 1,
"mission_track_ID": 4, "mission_track_ID": 4,
"platform_ID": "reav-60-1", "platform_ID": "reav-60-1",
"platform_state": "ABORT", "platform_state": "ABORT",
......
...@@ -30,7 +30,7 @@ emergency_schema = { ...@@ -30,7 +30,7 @@ emergency_schema = {
"format": "float", "format": "float",
"description": "Z-coordinate safe place for respective platform" "description": "Z-coordinate safe place for respective platform"
+ " . If platform to NOT stay at depth, key in `0.0`", + " . If platform to NOT stay at depth, key in `0.0`",
"example": 10, "example": 10.0,
}, },
"additional_data": { "additional_data": {
"description": "Any addition fields/data to be added here", "description": "Any addition fields/data to be added here",
......
...@@ -86,14 +86,14 @@ platform_status_schema = { ...@@ -86,14 +86,14 @@ platform_status_schema = {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "Target depth in metres", "description": "Target depth in metres",
"example": 50, "example": 50.0,
"default": 0, "default": 0.0,
}, },
"altitude": { "altitude": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "Target altitude in metres", "description": "Target altitude in metres",
"example": 20, "example": 20.0,
}, },
"mission_track_ID": { "mission_track_ID": {
"type": "integer", "type": "integer",
...@@ -101,9 +101,9 @@ platform_status_schema = { ...@@ -101,9 +101,9 @@ platform_status_schema = {
+ "4 --> Waypoint 3 to Waypoint 4)", + "4 --> Waypoint 3 to Waypoint 4)",
"example": 4, "example": 4,
}, },
"mission_action_ID": { "mission_plan_ID": {
"type": "integer", "type": "integer",
"description": "", # TODO: Add description "description": "Mission plan ID according to local platform-C2 system",
"example": 1, "example": 1,
}, },
"range_to_go": { "range_to_go": {
...@@ -115,19 +115,18 @@ platform_status_schema = { ...@@ -115,19 +115,18 @@ platform_status_schema = {
"speed_over_ground": { "speed_over_ground": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "", # TODO: Add description "description": "Speed over ground",
"example": 124.3, "example": 124.3,
}, },
"water_current_velocity": { "water_current_velocity": {
"type": "number", "type": "string",
"format": "float", "description": "Water current magnitude and direction",
"description": "", # TODO: Add description "example": "124.3NE",
"example": 124.3,
}, },
"thrust_applied": { "thrust_applied": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "", # TODO: Add description "description": "Thrust applied",
"example": 124.3, "example": 124.3,
}, },
"heading": { "heading": {
...@@ -138,15 +137,20 @@ platform_status_schema = { ...@@ -138,15 +137,20 @@ platform_status_schema = {
"example": 124.3, "example": 124.3,
}, },
"health_status": { "health_status": {
"type": "string", "type": "boolean",
"description": "Health status extracted by respective platform " "description": "Health status where 0 is OK, 1 is platform has an ERROR",
+ "if any diagnosis is available to check sensors", "example": False,
"example": "Warning",
}, },
"localisation_error": { "localisation_north_error": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "Localisation error at last USBL update.", "description": "Difference in NORTH between deadreckoning and USBL update.",
"example": 0.000129,
},
"localisation_east_error": {
"type": "number",
"format": "float",
"description": "Difference in EAST between deadreckoning and USBL update.",
"example": 0.000129, "example": 0.000129,
}, },
"usbl_fix_seconds_ago": { "usbl_fix_seconds_ago": {
...@@ -161,12 +165,6 @@ platform_status_schema = { ...@@ -161,12 +165,6 @@ platform_status_schema = {
"description": "Battery remaining % provided by respective C2", "description": "Battery remaining % provided by respective C2",
"example": 80.2, "example": 80.2,
}, },
"current_pitch": {
"type": "number",
"format": "float",
"description": "Current pitch of platform",
"example": -4.0,
},
"sensor_config": sensor_schema, "sensor_config": sensor_schema,
}, },
"required": [ "required": [
......
...@@ -375,7 +375,7 @@ ...@@ -375,7 +375,7 @@
}, },
"target_depth": { "target_depth": {
"description": "Z-coordinate safe place for respective platform . If platform to NOT stay at depth, key in `0.0`", "description": "Z-coordinate safe place for respective platform . If platform to NOT stay at depth, key in `0.0`",
"example": 10, "example": 10.0,
"format": "float", "format": "float",
"type": "number" "type": "number"
} }
...@@ -522,12 +522,6 @@ ...@@ -522,12 +522,6 @@
"format": "float", "format": "float",
"type": "number" "type": "number"
}, },
"current_pitch": {
"description": "Current pitch of platform",
"example": -4.0,
"format": "float",
"type": "number"
},
"depth": { "depth": {
"default": 0, "default": 0,
"description": "Target depth in metres", "description": "Target depth in metres",
...@@ -542,9 +536,9 @@ ...@@ -542,9 +536,9 @@
"type": "number" "type": "number"
}, },
"health_status": { "health_status": {
"description": "Health status extracted by respective platform if any diagnosis is available to check sensors", "description": "Health status where 0 is OK, 1 is platform has an ERROR",
"example": "Warning", "example": false,
"type": "string" "type": "boolean"
}, },
"latitude": { "latitude": {
"description": "Latitude in decimal degrees.", "description": "Latitude in decimal degrees.",
...@@ -552,12 +546,18 @@ ...@@ -552,12 +546,18 @@
"format": "float", "format": "float",
"type": "number" "type": "number"
}, },
"localisation_error": { "localisation_north_error": {
"description": "Localisation error at last USBL update.", "description": "Localisation error at last USBL update.",
"example": 0.000129, "example": 0.000129,
"format": "float", "format": "float",
"type": "number" "type": "number"
}, },
"localisation_east_error": {
"type": "number",
"format": "float",
"description": "Difference in EAST between deadreckoning and USBL update.",
"example": 0.000129
},
"longitude": { "longitude": {
"description": "Longitude in decimal degrees.", "description": "Longitude in decimal degrees.",
"example": -10.122, "example": -10.122,
...@@ -569,8 +569,8 @@ ...@@ -569,8 +569,8 @@
"example": "platform_status", "example": "platform_status",
"type": "string" "type": "string"
}, },
"mission_action_ID": { "mission_plan_ID": {
"description": "", "description": "Mission plan ID according to local platform-C2 system",
"example": 1, "example": 1,
"type": "integer" "type": "integer"
}, },
...@@ -627,7 +627,7 @@ ...@@ -627,7 +627,7 @@
"type": "object" "type": "object"
}, },
"speed_over_ground": { "speed_over_ground": {
"description": "", "description": "Speed over ground",
"example": 124.3, "example": 124.3,
"format": "float", "format": "float",
"type": "number" "type": "number"
...@@ -642,7 +642,7 @@ ...@@ -642,7 +642,7 @@
"type": "string" "type": "string"
}, },
"thrust_applied": { "thrust_applied": {
"description": "", "description": "Thrust applied",
"example": 124.3, "example": 124.3,
"format": "float", "format": "float",
"type": "number" "type": "number"
...@@ -665,7 +665,7 @@ ...@@ -665,7 +665,7 @@
"type": "number" "type": "number"
}, },
"water_current_velocity": { "water_current_velocity": {
"description": "", "description": "Water current magnitude and direction",
"example": 124.3, "example": 124.3,
"format": "float", "format": "float",
"type": "number" "type": "number"
......
...@@ -265,7 +265,7 @@ emergency_schema = { ...@@ -265,7 +265,7 @@ emergency_schema = {
"format": "float", "format": "float",
"description": "Z-coordinate safe place for respective platform" "description": "Z-coordinate safe place for respective platform"
+ " . If platform to NOT stay at depth, key in `0.0`", + " . If platform to NOT stay at depth, key in `0.0`",
"example": 10, "example": 10.0,
}, },
"additional_data": { "additional_data": {
"description": "Any addition fields/data to be added here", "description": "Any addition fields/data to be added here",
...@@ -504,7 +504,7 @@ platform_status_schema = { ...@@ -504,7 +504,7 @@ platform_status_schema = {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "Target depth in metres", "description": "Target depth in metres",
"example": 50, "example": 50.0,
"default": 0, "default": 0,
}, },
"altitude": { "altitude": {
...@@ -519,9 +519,9 @@ platform_status_schema = { ...@@ -519,9 +519,9 @@ platform_status_schema = {
+ "4 --> Waypoint 3 to Waypoint 4)", + "4 --> Waypoint 3 to Waypoint 4)",
"example": 4, "example": 4,
}, },
"mission_action_ID": { "mission_plan_ID": {
"type": "integer", "type": "integer",
"description": "", # TODO: Add description "description": "Mission plan ID according to local platform-C2 system",
"example": 1, "example": 1,
}, },
"range_to_go": { "range_to_go": {
...@@ -533,19 +533,19 @@ platform_status_schema = { ...@@ -533,19 +533,19 @@ platform_status_schema = {
"speed_over_ground": { "speed_over_ground": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "", # TODO: Add description "description": "Speed over ground",
"example": 124.3, "example": 124.3,
}, },
"water_current_velocity": { "water_current_velocity": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "", # TODO: Add description "description": "Water current magnitude and direction",
"example": 124.3, "example": 124.3,
}, },
"thrust_applied": { "thrust_applied": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "", # TODO: Add description "description": "Thrust applied",
"example": 124.3, "example": 124.3,
}, },
"heading": { "heading": {
...@@ -556,15 +556,20 @@ platform_status_schema = { ...@@ -556,15 +556,20 @@ platform_status_schema = {
"example": 124.3, "example": 124.3,
}, },
"health_status": { "health_status": {
"type": "string", "type": "boolean",
"description": "Health status extracted by respective platform " "description": "Health status where 0 is OK, 1 is platform has an ERROR",
+ "if any diagnosis is available to check sensors", "example": False,
"example": "Warning",
}, },
"localisation_error": { "localisation_north_error": {
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "Localisation error at last USBL update.", "description": "Difference in NORTH between deadreckoning and USBL update.",
"example": 0.000129,
},
"localisation_east_error": {
"type": "number",
"format": "float",
"description": "Difference in EAST between deadreckoning and USBL update.",
"example": 0.000129, "example": 0.000129,
}, },
"usbl_fix_seconds_ago": { "usbl_fix_seconds_ago": {
...@@ -579,12 +584,6 @@ platform_status_schema = { ...@@ -579,12 +584,6 @@ platform_status_schema = {
"description": "Battery remaining % provided by respective C2", "description": "Battery remaining % provided by respective C2",
"example": 80.2, "example": 80.2,
}, },
"current_pitch": {
"type": "number",
"format": "float",
"description": "Current pitch of platform",
"example": -4.0,
},
"sensor_config": sensor_schema, "sensor_config": sensor_schema,
}, },
"required": [ "required": [
......
...@@ -362,7 +362,7 @@ ...@@ -362,7 +362,7 @@
}, },
"target_depth": { "target_depth": {
"description": "Z-coordinate safe place for respective platform . If platform to NOT stay at depth, key in `0.0`", "description": "Z-coordinate safe place for respective platform . If platform to NOT stay at depth, key in `0.0`",
"example": 10, "example": 10.0,
"format": "float", "format": "float",
"type": "number" "type": "number"
} }
...@@ -509,16 +509,10 @@ ...@@ -509,16 +509,10 @@
"format": "float", "format": "float",
"type": "number" "type": "number"
}, },
"current_pitch": {
"description": "Current pitch of platform",
"example": -4.0,
"format": "float",
"type": "number"
},
"depth": { "depth": {
"default": 0, "default": 0.0,
"description": "Target depth in metres", "description": "Target depth in metres",
"example": 50, "example": 50.0,
"format": "float", "format": "float",
"type": "number" "type": "number"
}, },
...@@ -529,9 +523,9 @@ ...@@ -529,9 +523,9 @@
"type": "number" "type": "number"
}, },
"health_status": { "health_status": {
"description": "Health status extracted by respective platform if any diagnosis is available to check sensors", "description": "Health status where 0 is OK, 1 is platform has an ERROR",
"example": "Warning", "example": false,
"type": "string" "type": "boolean"
}, },
"latitude": { "latitude": {
"description": "Latitude in decimal degrees.", "description": "Latitude in decimal degrees.",
...@@ -540,7 +534,7 @@ ...@@ -540,7 +534,7 @@
"type": "number" "type": "number"
}, },
"localisation_error": { "localisation_error": {
"description": "Localisation error at last USBL update.", "description": "Difference in NORTH between deadreckoning and USBL update.",
"example": 0.000129, "example": 0.000129,
"format": "float", "format": "float",
"type": "number" "type": "number"
...@@ -556,8 +550,8 @@ ...@@ -556,8 +550,8 @@
"example": "platform_status", "example": "platform_status",
"type": "string" "type": "string"
}, },
"mission_action_ID": { "mission_plan_ID": {
"description": "", "description": "Mission plan ID according to local platform-C2 system",
"example": 1, "example": 1,
"type": "integer" "type": "integer"
}, },
...@@ -614,7 +608,7 @@ ...@@ -614,7 +608,7 @@
"type": "object" "type": "object"
}, },
"speed_over_ground": { "speed_over_ground": {
"description": "", "description": "Speed over ground",
"example": 124.3, "example": 124.3,
"format": "float", "format": "float",
"type": "number" "type": "number"
...@@ -629,7 +623,7 @@ ...@@ -629,7 +623,7 @@
"type": "string" "type": "string"
}, },
"thrust_applied": { "thrust_applied": {
"description": "", "description": "Thrust applied",
"example": 124.3, "example": 124.3,
"format": "float", "format": "float",
"type": "number" "type": "number"
...@@ -652,7 +646,7 @@ ...@@ -652,7 +646,7 @@
"type": "number" "type": "number"
}, },
"water_current_velocity": { "water_current_velocity": {
"description": "", "description": "Water current magnitude and direction",
"example": 124.3, "example": 124.3,
"format": "float", "format": "float",
"type": "number" "type": "number"
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
"start_point_longitude": 60.00000000000000, "start_point_longitude": 60.00000000000000,
"target_waypoint_latitude": -0.237143188645706, "target_waypoint_latitude": -0.237143188645706,
"target_waypoint_longitude": 52.37072283932642, "target_waypoint_longitude": 52.37072283932642,
"depth": 0, "depth": 0.0,
"activate_payload": false, "activate_payload": false,
"send_environmental_data": true "send_environmental_data": true
} }
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
"start_point_longitude": 60.00000000000000, "start_point_longitude": 60.00000000000000,
"target_waypoint_latitude": -0.237143188645706, "target_waypoint_latitude": -0.237143188645706,
"target_waypoint_longitude": 52.37072283932642, "target_waypoint_longitude": 52.37072283932642,
"depth": 0, "depth": 0.0,
"activate_payload": false, "activate_payload": false,
"send_environmental_data": true "send_environmental_data": true
} }
......
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
"target_waypoint_latitude": -7.432, "target_waypoint_latitude": -7.432,
"target_waypoint_longitude": 50.365, "target_waypoint_longitude": 50.365,
"safe_command": "go_home", "safe_command": "go_home",
"target_depth": 10 "target_depth": 10.0
}, },
"max_velocity": 0.9, "max_velocity": 0.9,
"min_altitude": 15.2, "min_altitude": 15.2,
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
"status_source": "usbl", "status_source": "usbl",
"latitude": 178.2, "latitude": 178.2,
"longitude": -10.122, "longitude": -10.122,
"depth": 50, "depth": 50.0,
"altitude": 20 "altitude": 20.0
} }
} }
...@@ -17,15 +17,16 @@ ...@@ -17,15 +17,16 @@
"battery_remaining_capacity": 80.2, "battery_remaining_capacity": 80.2,
"active": true, "active": true,
"platform_state": "ABORT", "platform_state": "ABORT",
"mission_action_ID": 1, "mission_plan_ID": 1,
"mission_track_ID": 4, "mission_track_ID": 4,
"latitude": 178.2, "latitude": 178.2,
"longitude": -10.122, "longitude": -10.122,
"depth": 50, "depth": 50.0,
"altitude": 20, "altitude": 20.0,
"heading": 90.0, "heading": 90.0,
"health_status": "Warning", "health_status": false,
"localisation_error": 0, "localisation_north_error": 0,
"localisation_east_error": 0,
"usbl_fix_seconds_ago": 0, "usbl_fix_seconds_ago": 0,
"range_to_go": 124.3, "range_to_go": 124.3,
"sensor_config": { "sensor_config": {
...@@ -36,7 +37,6 @@ ...@@ -36,7 +37,6 @@
"whiskers_on": true "whiskers_on": true
} }
}, },
"current_pitch": -4,
"speed_over_ground": 4.3, "speed_over_ground": 4.3,
"thrust_applied": 124.3, "thrust_applied": 124.3,
"water_current_velocity": 124.3 "water_current_velocity": 124.3
......
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