3import "jaiabot/messages/geographic_coordinate.proto";
4import "dccl/option_extensions.proto";
5import "goby/middleware/protobuf/gpsd.proto";
6import "jaiabot/messages/option_extensions.proto";
8package jaiabot.protobuf;
12 PRE_DEPLOYMENT__STARTING_UP = 0 [(jaia.ev).rest_api.presence = GUARANTEED];
13 PRE_DEPLOYMENT__IDLE = 1 [(jaia.ev).rest_api.presence = GUARANTEED];
14 PRE_DEPLOYMENT__SELF_TEST = 2 [(jaia.ev).rest_api.presence = GUARANTEED];
15 PRE_DEPLOYMENT__FAILED = 3 [(jaia.ev).rest_api.presence = GUARANTEED];
16 PRE_DEPLOYMENT__WAIT_FOR_MISSION_PLAN = 4
17 [(jaia.ev).rest_api.presence = GUARANTEED];
18 PRE_DEPLOYMENT__READY = 5 [(jaia.ev).rest_api.presence = GUARANTEED];
20 IN_MISSION__UNDERWAY__REPLAN = 100
21 [(jaia.ev).rest_api.presence = GUARANTEED];
23 IN_MISSION__UNDERWAY__MOVEMENT__TRANSIT = 110
24 [(jaia.ev).rest_api.presence = GUARANTEED];
25 IN_MISSION__UNDERWAY__MOVEMENT__REMOTE_CONTROL__SETPOINT = 112
26 [(jaia.ev).rest_api.presence = GUARANTEED];
27 IN_MISSION__UNDERWAY__MOVEMENT__REMOTE_CONTROL__STATION_KEEP = 113
28 [(jaia.ev).rest_api.presence = GUARANTEED];
29 IN_MISSION__UNDERWAY__MOVEMENT__REMOTE_CONTROL__SURFACE_DRIFT = 114
30 [(jaia.ev).rest_api.presence = GUARANTEED];
31 IN_MISSION__UNDERWAY__MOVEMENT__TRAIL = 115
32 [(jaia.ev).rest_api.presence = GUARANTEED];
34 IN_MISSION__UNDERWAY__TASK__STATION_KEEP = 120
35 [(jaia.ev).rest_api.presence = GUARANTEED];
36 IN_MISSION__UNDERWAY__TASK__SURFACE_DRIFT = 121
37 [(jaia.ev).rest_api.presence = GUARANTEED];
38 IN_MISSION__UNDERWAY__TASK__DIVE__DIVE_PREP = 123
39 [(jaia.ev).rest_api.presence = GUARANTEED];
40 IN_MISSION__UNDERWAY__TASK__DIVE__POWERED_DESCENT = 124
41 [(jaia.ev).rest_api.presence = GUARANTEED];
42 IN_MISSION__UNDERWAY__TASK__DIVE__HOLD = 125
43 [(jaia.ev).rest_api.presence = GUARANTEED];
44 IN_MISSION__UNDERWAY__TASK__DIVE__UNPOWERED_ASCENT = 126
45 [(jaia.ev).rest_api.presence = GUARANTEED];
46 IN_MISSION__UNDERWAY__TASK__DIVE__POWERED_ASCENT = 127
47 [(jaia.ev).rest_api.presence = GUARANTEED];
48 IN_MISSION__UNDERWAY__TASK__DIVE__REACQUIRE_GPS = 128
49 [(jaia.ev).rest_api.presence = GUARANTEED];
50 IN_MISSION__UNDERWAY__TASK__DIVE__SURFACE_DRIFT = 129
51 [(jaia.ev).rest_api.presence = GUARANTEED];
52 IN_MISSION__UNDERWAY__TASK__DIVE__CONSTANT_HEADING = 130
53 [(jaia.ev).rest_api.presence = GUARANTEED];
54 IN_MISSION__UNDERWAY__TASK__CONSTANT_HEADING = 131
55 [(jaia.ev).rest_api.presence = GUARANTEED];
57 IN_MISSION__UNDERWAY__RECOVERY__TRANSIT = 140
58 [(jaia.ev).rest_api.presence = GUARANTEED];
59 IN_MISSION__UNDERWAY__RECOVERY__STATION_KEEP = 141
60 [(jaia.ev).rest_api.presence = GUARANTEED];
61 IN_MISSION__UNDERWAY__RECOVERY__STOPPED = 142
62 [(jaia.ev).rest_api.presence = GUARANTEED];
64 IN_MISSION__UNDERWAY__ABORT = 150;
66 IN_MISSION__UNDERWAY__SLEEP__PREP = 170
67 [(jaia.ev).rest_api.presence = GUARANTEED];
69 IN_MISSION__PAUSE__IMU_RESTART = 160;
70 IN_MISSION__PAUSE__REACQUIRE_GPS = 161
71 [(jaia.ev).rest_api.presence = GUARANTEED];
72 IN_MISSION__PAUSE__MANUAL = 162 [(jaia.ev).rest_api.presence = GUARANTEED];
73 IN_MISSION__PAUSE__RESOLVE_NO_FORWARD_PROGRESS = 163;
75 POST_DEPLOYMENT__RECOVERED = 200 [(jaia.ev).rest_api.presence = GUARANTEED];
76 POST_DEPLOYMENT__DATA_OFFLOAD = 202
77 [(jaia.ev).rest_api.presence = GUARANTEED];
78 POST_DEPLOYMENT__IDLE = 203 [(jaia.ev).rest_api.presence = GUARANTEED];
79 POST_DEPLOYMENT__SHUTTING_DOWN = 204
80 [(jaia.ev).rest_api.presence = GUARANTEED];
81 POST_DEPLOYMENT__FAILED = 205 [(jaia.ev).rest_api.presence = GUARANTEED];
90 optional uint32 transit = 1 [
96 units { base_dimensions: "LT^-1" }
99 optional uint32 stationkeep_outer = 2 [
105 units { base_dimensions: "LT^-1" }
110message BottomDepthSafetyParams
112 option (dccl.msg) = {
116 required double constant_heading = 1 [
122 units { derived_dimensions: "plane_angle" system: "angle::degree" }
126 required int32 constant_heading_time = 2 [
132 units { base_dimensions: "T" }
136 required uint32 constant_heading_speed = 3 [
142 units { base_dimensions: "LT^-1" }
146 required double safety_depth = 4 [
152 units { base_dimensions: "L" }
159 option (dccl.msg) = {
163 required MissionState state = 10;
164 optional int32 active_goal = 11;
165 optional GeographicCoordinate active_goal_location = 12;
166 optional double distance_to_active_goal = 13 [(dccl.field) = {
170 units: { derived_dimensions: "length" }
172 optional uint32 active_goal_timeout = 14 [(dccl.field) = {
176 units { base_dimensions: "T" }
178 optional int32 data_offload_percentage = 15
179 [(dccl.field) = { min: 0 max: 100 precision: 0 }];
180 optional int32 repeat_index = 16
181 [(dccl.field) = { min: 0 max: 1000 precision: 0 }];
182 optional uint32 command_from_hub_id = 70
183 [(dccl.field) = { min: 0 max: 30 }];
184 optional uint64 mission_command_time = 71 [
187 units { prefix: "micro" derived_dimensions: "time" },
194 option (dccl.msg) = {
200 NONE = 0 [(jaia.ev).rest_api.presence = GUARANTEED];
201 DIVE = 1 [(jaia.ev).rest_api.presence = GUARANTEED];
202 STATION_KEEP = 2 [(jaia.ev).rest_api.presence = GUARANTEED];
203 SURFACE_DRIFT = 3 [(jaia.ev).rest_api.presence = GUARANTEED];
204 CONSTANT_HEADING = 4 [(jaia.ev).rest_api.presence = GUARANTEED];
205 STORM_AIR_DESCENT = 5 [(jaia.ev).rest_api.presence = GUARANTEED];
206 STORM_CTD_PROFILE = 6 [(jaia.ev).rest_api.presence = GUARANTEED];
208 optional TaskType type = 1
209 [default = NONE, (jaia.field).rest_api.presence = GUARANTEED];
211 message DiveParameters
213 optional double max_depth = 1 [
219 units { base_dimensions: "L" }
221 (jaia.field).rest_api.presence = GUARANTEED
223 optional double depth_interval = 2 [
229 units { base_dimensions: "L" }
231 (jaia.field).rest_api.presence = GUARANTEED
233 optional double hold_time = 3 [
239 units { base_dimensions: "T" }
241 (jaia.field).rest_api.presence = GUARANTEED
243 optional bool bottom_dive = 4
244 [default = false, (jaia.field).rest_api.presence = GUARANTEED];
248 optional DiveParameters dive = 2
249 [(jaia.field).rest_api.presence = GUARANTEED];
251 message DriftParameters
253 optional int32 drift_time = 3 [
259 units { base_dimensions: "T" }
261 (jaia.field).rest_api.presence = GUARANTEED
265 // for type == SURFACE_DRIFT and type == DIVE
266 optional DriftParameters surface_drift = 3
267 [(jaia.field).rest_api.presence = GUARANTEED];
269 message ConstantHeadingParameters
271 optional double constant_heading = 1 [
277 derived_dimensions: "plane_angle"
278 system: "angle::degree"
281 (jaia.field).rest_api.presence = GUARANTEED
284 optional int32 constant_heading_time = 2 [
290 units { base_dimensions: "T" }
292 (jaia.field).rest_api.presence = GUARANTEED
295 optional uint32 constant_heading_speed = 3 [
301 units { base_dimensions: "LT^-1" }
303 (jaia.field).rest_api.presence = GUARANTEED
307 // for type == CONSTANT_HEADING
308 optional ConstantHeadingParameters constant_heading = 4
309 [(jaia.field).rest_api.presence = GUARANTEED];
310 optional bool start_pam = 5
311 [default = false, (jaia.field).rest_api.presence = GUARANTEED];
313 message StationKeepParameters
315 optional int32 station_keep_time = 1 [
321 units { base_dimensions: "T" }
323 (jaia.field).rest_api.presence = GUARANTEED
327 // for type == STATION_KEEP
328 optional StationKeepParameters station_keep = 6
329 [(jaia.field).rest_api.presence = GUARANTEED];
334 option (dccl.msg) = {
340 START_IMMEDIATELY = 1 [(jaia.ev).rest_api.presence = GUARANTEED];
341 START_ON_COMMAND = 2 [(jaia.ev).rest_api.presence = GUARANTEED];
342 // START_IN_WATER_DETECT = 3;
343 // START_AFTER_DELAY = 4;
345 optional MissionStart start = 1 [
346 default = START_ON_COMMAND,
347 (jaia.field).rest_api.presence = GUARANTEED
352 TRANSIT = 1 [(jaia.ev).rest_api.presence = GUARANTEED];
353 REMOTE_CONTROL = 2 [(jaia.ev).rest_api.presence = GUARANTEED];
354 TRAIL = 3 [(jaia.ev).rest_api.presence = GUARANTEED];
356 optional MovementType movement = 2
357 [default = TRANSIT, (jaia.field).rest_api.presence = GUARANTEED];
361 optional string name = 1 [(dccl.field).omit = true];
362 required GeographicCoordinate location = 2
363 [(jaia.field).rest_api.presence = GUARANTEED];
364 optional MissionTask task = 3
365 [(jaia.field).rest_api.presence = GUARANTEED];
366 optional bool moveWptMode = 4;
369 repeated Goal goal = 3 [
370 (dccl.field).max_repeat = 10,
371 (jaia.field).rest_api.presence = GUARANTEED
376 optional bool recover_at_final_goal = 1
377 [default = true, (jaia.field).rest_api.presence = GUARANTEED];
378 optional GeographicCoordinate location = 2
379 [(jaia.field).rest_api.presence = GUARANTEED];
380 optional bool sleep_once_goal_reached = 3 [default = false];
382 optional Recovery recovery = 4
383 [(jaia.field).rest_api.presence = GUARANTEED];
385 optional Speeds speeds = 5 [(jaia.field).rest_api.presence = GUARANTEED];
386 optional BottomDepthSafetyParams bottom_depth_safety_params = 6
387 [(jaia.field).rest_api.presence = GUARANTEED];
388 optional uint32 fragment_index = 7 [(dccl.field) = { min: 0 max: 7 }];
389 optional uint32 expected_fragments = 8 [(dccl.field) = { min: 1 max: 8 }];
393 option (dccl.msg) = {
397 optional int32 contact = 1
398 [default = 0, (dccl.field) = { min: 0, max: 7 }];
400 optional double angle = 2 [
407 derived_dimensions: "plane_angle"
408 system: "angle::degree"
412 optional bool angle_relative = 3 [default = true];
413 optional double range = 4 [
419 units: { derived_dimensions: "length" }
424 oneof movement_params
426 TrailParam trail = 10;
429 optional uint32 repeats = 9 [
431 (jaia.field).rest_api.presence = GUARANTEED,
432 (dccl.field) = { min: 1 max: 100 }
435 optional string mission_name = 11
437 true]; // not sent over radio, only saved to the hub
439 // A Segment groups a contiguous range of goals (by global index) and
440 // carries the metadata that applies to that range.
443 // Start of this segment (inclusive). End is inferred from the
444 // next segment's start_goal_index, or the total goal count for
446 required uint32 start_goal_index = 2
447 [(dccl.field) = { min: 0, max: 79 }];
449 // Global goal indices marking the start of each survey lane within
451 repeated uint32 lane_start_goal_indices = 6
452 [(dccl.field) = { max_repeat: 7, min: 1, max: 80 }];
454 // Per-segment transit speed override (m/s). A segment that omits this
455 // keeps the speed already in effect: the previous segment's value, or
456 // MissionPlan.speeds.transit when the mission is received and at the
457 // start of each repeat.
458 optional uint32 speed = 4 [
464 units { base_dimensions: "LT^-1" }
468 // Per-segment safety return parameters. A segment that omits this keeps
469 // the params already in effect rather than clearing them, so it inherits
470 // the previous segment's. MissionPlan.bottom_depth_safety_params is
471 // applied when the mission is received and at the start of each repeat.
472 optional BottomDepthSafetyParams bottom_depth_safety_params = 5;
475 // Segments in mission execution order. Non-overlapping goal index
476 // ranges are enforced by the UI before sending.
477 repeated Segment segments = 12
478 [(dccl.field).max_repeat = 5, (jaia.field).rest_api.presence = GUARANTEED];
482message IvPBehaviorUpdate
484 message TransitUpdate
486 // unit dimensions must match those used by MOOS-IvP
487 option (dccl.msg) = {
490 required bool active = 1;
492 optional double x = 2
493 [(dccl.field).units = { base_dimensions: "L" }]; // meters
494 optional double y = 3
495 [(dccl.field).units = { base_dimensions: "L" }]; // meters
496 optional double speed = 4 [
497 (dccl.field).units = { base_dimensions: "LT^-1" }
500 optional int32 slip_radius = 5;
503 message StationkeepUpdate
505 // unit dimensions must match those used by MOOS-IvP
506 option (dccl.msg) = {
510 required bool active = 1;
512 optional double x = 2
513 [(dccl.field).units = { base_dimensions: "L" }]; // meters
514 optional double y = 3
515 [(dccl.field).units = { base_dimensions: "L" }]; // meters
516 optional double outer_speed = 4 [
517 (dccl.field).units = { base_dimensions: "LT^-1" }
519 optional double transit_speed = 5 [
520 (dccl.field).units = { base_dimensions: "LT^-1" }
522 optional bool center_activate = 6 [default = false];
525 message ConstantHeadingUpdate
527 // unit dimensions must match those used by MOOS-IvP
528 option (dccl.msg) = {
532 required bool active = 1;
534 optional double heading = 2 [(dccl.field) = {
538 units { derived_dimensions: "plane_angle" system: "angle::degree" }
542 message ConstantSpeedUpdate
544 // unit dimensions must match those used by MOOS-IvP
545 option (dccl.msg) = {
549 required bool active = 1;
551 optional double speed = 2 [
552 (dccl.field).units = { base_dimensions: "LT^-1" }
558 // unit dimensions must match those used by MOOS-IvP
559 option (dccl.msg) = {
563 required bool active = 1;
565 optional MissionPlan.TrailParam param = 2;
568 message ContactUpdate
570 // unit dimensions must match those used by MOOS-IvP
571 option (dccl.msg) = {
574 optional int32 contact = 1;
575 optional double x = 2
576 [(dccl.field).units = { base_dimensions: "L" }]; // meters
577 optional double y = 3
578 [(dccl.field).units = { base_dimensions: "L" }]; // meters
579 optional double speed = 4 [
580 (dccl.field).units = { base_dimensions: "LT^-1" }
582 optional double heading_or_cog = 5 [(dccl.field).units = {
583 derived_dimensions: "plane_angle"
584 system: "angle::degree"
590 TransitUpdate transit = 1;
591 StationkeepUpdate stationkeep = 2;
592 ConstantHeadingUpdate constantHeading = 3;
593 ConstantSpeedUpdate constantSpeed = 4;
594 TrailUpdate trail = 5;
595 ContactUpdate contact = 6;
599message IvPBehaviorReport
601 message TransitReport
603 optional bool waypoint_reached = 1 [default = false];
608 TransitReport transit = 1;
612message MissionTpvMeetsGpsReq
614 option (dccl.msg) = {
618 optional goby.middleware.protobuf.gpsd.TimePositionVelocity tpv = 1;
621// Represents a summary of a mission, for use in mission querying results.
622message MissionSummary
624 optional string mission_name = 1;
625 optional uint64 start_time = 2;
626 optional uint64 end_time = 3;
627 optional uint32 task_packet_count = 4;
630message MissionStateChange
632 required MissionState state = 1;
640 required Direction direction = 2;
646 CAN_BE_DELEGATED = 1;
649message MissionStateDelegateRequest
651 required MissionState state = 1;
654message MissionStateDelegateResponse
656 required MissionState state = 1;
660 EV_SELF_TEST_FAILS = 1;
661 EV_SELF_TEST_SUCCESSFUL = 2;
666 required MissionEvent event = 2;