3import "dccl/option_extensions.proto";
4import "jaiabot/messages/mission.proto";
5import "jaiabot/messages/geographic_coordinate.proto";
6import "jaiabot/messages/high_control.proto";
7import "goby/middleware/protobuf/coroner.proto";
8import "jaiabot/messages/health.proto";
9import "jaiabot/messages/imu.proto";
10import "jaiabot/messages/option_extensions.proto";
11import "jaiabot/messages/link.proto";
12import "jaiabot/messages/storm.proto";
13import "jaiabot/messages/storm_mcu.proto";
14import "jaiabot/messages/node.proto";
15import "jaiabot/messages/hub.proto";
17package jaiabot.protobuf;
22 Actual maximum size of message: 196 bytes / 1568 bits
23 dccl.id head...........................8
24 user head..............................0
25 body................................1556
26 padding to full byte...................4
27 Allowed maximum size of message: 250 bytes / 2000 bits
36 required uint32 bot_id = 1 [
37 (dccl.field) = { min: 0 max: 255 },
38 (jaia.field).rest_api.presence = OMITTED // specified in 'targets'
41 required uint64 time = 2 [
44 units { prefix: "micro" derived_dimensions: "time" }
45 precision: -6 // second precision
48 (jaia.field).rest_api.presence = OMITTED // written by API server
51 // Special case: not sent in message - written upon receipt
52 // link: which link this message traversed from hub to bot
53 optional Link link = 3 [(dccl.field).omit = true];
55 optional uint32 from_hub_id = 4 [(dccl.field) = { min: 0 max: 30 }];
60 MISSION_PLAN = 1 [(jaia.ev).rest_api.presence = GUARANTEED];
61 ACTIVATE = 2 [(jaia.ev).rest_api.presence = GUARANTEED];
62 START_MISSION = 3 [(jaia.ev).rest_api.presence = GUARANTEED];
63 MISSION_PLAN_FRAGMENT = 4;
66 NEXT_TASK = 10 [(jaia.ev).rest_api.presence = GUARANTEED];
67 RETURN_TO_HOME = 11 [(jaia.ev).rest_api.presence = GUARANTEED];
68 STOP = 12 [(jaia.ev).rest_api.presence = GUARANTEED];
69 PAUSE = 13 [(jaia.ev).rest_api.presence = GUARANTEED];
70 RESUME = 14 [(jaia.ev).rest_api.presence = GUARANTEED];
72 // during remote control mission
73 REMOTE_CONTROL_SETPOINT = 20;
74 REMOTE_CONTROL_TASK = 21;
75 REMOTE_CONTROL_RESUME_MOVEMENT = 22;
77 // during STORM mission
78 STORM_DYNAMIC_MISSION_UPDATE = 25;
81 RECOVERED = 30 [(jaia.ev).rest_api.presence = GUARANTEED];
82 SHUTDOWN = 31 [(jaia.ev).rest_api.presence = GUARANTEED];
83 RETRY_DATA_OFFLOAD = 32;
84 DATA_OFFLOAD_COMPLETE = 33;
85 DATA_OFFLOAD_FAILED = 34;
87 // debugging low level commands
88 RESTART_ALL_SERVICES = 40;
90 SHUTDOWN_COMPUTER = 42;
93 required CommandType type = 10
94 [(jaia.field).rest_api.presence = GUARANTEED];
98 // required for type == MISSION_PLAN
99 MissionPlan plan = 20 [(jaia.field).rest_api = {
100 presence: GUARANTEED,
101 doc: "Used with \"command\": { \"type\" : \"MISSION_PLAN\" }"
104 // required for type == REMOTE_CONTROL_SETPOINT
105 RemoteControl rc = 30 [(jaia.field).rest_api = {
106 presence: GUARANTEED,
107 doc: "Used with \"command\": { \"type\" : \"REMOTE_CONTROL_SETPOINT\" }"
110 // required for type == REMOTE_CONTROL_TASK
111 MissionTask rc_task = 31;
113 // required for type == STORM_DYNAMIC_MISSION_UPDATE
114 StormMissionUpdate storm = 40;
120 option (dccl.msg) = {
124 required uint32 hub_id = 1 [(jaia.field).rest_api.presence = OMITTED];
125 required uint64 time = 2 [
126 (dccl.field) = { units { prefix: "micro" derived_dimensions: "time" } },
127 (jaia.field).rest_api.presence = OMITTED
133 CTD_DATA_OFFLOAD = 6;
135 // debugging low level commands
136 RESTART_ALL_SERVICES = 40;
137 REBOOT_COMPUTER = 41;
138 SHUTDOWN_COMPUTER = 42;
140 // simulator commands
141 SET_HUB_LOCATION = 80 [(jaia.ev).rest_api.presence = GUARANTEED];
144 required HubCommandType type = 10
145 [(jaia.field).rest_api.presence = GUARANTEED];
147 optional uint32 scan_for_bot_id = 11;
149 optional GeographicCoordinate hub_location = 80
150 [(jaia.field).rest_api.presence = GUARANTEED];
156 Actual maximum size of message: 48 bytes / 384 bits
157 dccl.id head...........................8
158 user head..............................0
159 body.................................369
160 padding to full byte...................7
161 Allowed maximum size of message: 250 bytes / 2000 bits
163 option (dccl.msg) = {
170 required uint32 bot_id = 1 [
171 (dccl.field) = { min: 0 max: 255 },
172 (jaia.field).rest_api.presence = GUARANTEED
174 required uint64 time = 2 [
177 units { prefix: "micro" derived_dimensions: "time" },
179 (jaia.field).rest_api.presence = GUARANTEED
181 optional uint64 last_command_time = 3 [
184 units { prefix: "micro" derived_dimensions: "time" }
186 (jaia.field).rest_api.presence = GUARANTEED
189 optional goby.middleware.protobuf.HealthState health_state = 4
190 [(jaia.field).rest_api.presence = GUARANTEED];
191 repeated Error error = 5 [
192 (dccl.field).max_repeat = 5,
193 (jaia.field).rest_api.presence = GUARANTEED
195 repeated Warning warning = 6 [
196 (dccl.field).max_repeat = 5,
197 (jaia.field).rest_api.presence = GUARANTEED
199 optional BotType bot_type = 7 [(jaia.field).rest_api.presence = GUARANTEED];
201 // Special case: not sent in message - written upon receipt
202 // link: which link this message traversed from bot to hub
203 optional Link link = 8 [(dccl.field).omit = true];
205 // Active links with last-received time per link (time written on hub upon receipt, not transmitted over air)
207 required Link link = 1;
208 optional uint64 last_received_time = 2 [
211 units { prefix: "micro" derived_dimensions: "time" }
216 // list of all active links on the Bot (based on BotStatus subscription messages)
217 repeated ActiveLink active_links = 9 [
218 (dccl.field).max_repeat = 10
221 optional GeographicCoordinate location = 10
222 [(jaia.field).rest_api.presence = GUARANTEED];
224 optional double sensor_depth = 11 [
229 units: { derived_dimensions: "length" }
231 (jaia.field).rest_api.presence = GUARANTEED
234 optional double depth = 12 [
239 units: { derived_dimensions: "length" }
241 (jaia.field).rest_api.presence = GUARANTEED
246 optional double roll = 1 [
252 derived_dimensions: "plane_angle"
253 system: "angle::degree"
256 (jaia.field).rest_api.presence = GUARANTEED
258 optional double pitch = 2 [
264 derived_dimensions: "plane_angle"
265 system: "angle::degree"
268 (jaia.field).rest_api.presence = GUARANTEED
270 optional double heading = 3 [
276 derived_dimensions: "plane_angle"
277 system: "angle::degree"
280 (jaia.field).rest_api.presence = GUARANTEED
282 optional double course_over_ground = 4 [
288 derived_dimensions: "plane_angle"
289 system: "angle::degree"
292 (jaia.field).rest_api.presence = GUARANTEED
295 optional Attitude attitude = 20
296 [(jaia.field).rest_api.presence = GUARANTEED];
300 optional double over_ground = 1 [
305 units { derived_dimensions: "velocity" }
307 (jaia.field).rest_api.presence = GUARANTEED
309 optional double over_water = 2 [(dccl.field) = {
313 units { derived_dimensions: "velocity" }
316 optional Speed speed = 30 [(jaia.field).rest_api.presence = GUARANTEED];
318 optional MissionState mission_state = 40
319 [(jaia.field).rest_api.presence = GUARANTEED];
321 // bounds should match MissionPlan.goal max_repeat value *
322 // expected_fragments max
323 optional int32 active_goal = 41 [
324 (dccl.field) = { min: 0 max: 80 },
325 (jaia.field).rest_api.presence = GUARANTEED
327 optional double distance_to_active_goal = 42 [
332 units: { derived_dimensions: "length" }
334 (jaia.field).rest_api.presence = GUARANTEED
336 optional uint32 active_goal_timeout = 43 [
341 units { base_dimensions: "T" }
343 (jaia.field).rest_api.presence = GUARANTEED
345 optional int32 repeat_index = 44 [
346 (dccl.field) = { min: 0 max: 1000 precision: 0 },
347 (jaia.field).rest_api.presence = GUARANTEED
350 optional double salinity = 51
351 [(dccl.field) = { min: 0 max: 100 precision: 1 }];
353 optional double temperature = 52 [(dccl.field) = {
357 units { derived_dimensions: "temperature" system: "celsius" }
360 optional double battery_percent = 53 [
361 (dccl.field) = { min: 0 max: 100 precision: 0 },
362 (jaia.field).rest_api.presence = GUARANTEED
365 optional int32 calibration_status = 54 [(dccl.field) = { min: 0 max: 3 }];
367 optional IMUCalibrationState calibration_state = 55;
369 optional double hdop = 56 [(dccl.field) = { min: 0 max: 100 precision: 2 }];
371 optional double pdop = 57 [(dccl.field) = { min: 0 max: 100 precision: 2 }];
373 optional int32 wifi_link_quality_percentage = 58 [
374 (dccl.field) = { min: 0 max: 100 precision: 0 },
375 (jaia.field).rest_api.presence = GUARANTEED
378 optional uint64 received_time = 59 [
381 units { prefix: "micro" derived_dimensions: "time" }
383 (jaia.field).rest_api.presence = GUARANTEED
386 optional uint64 mission_command_time = 71 [
389 units { prefix: "micro" derived_dimensions: "time" }
391 (jaia.field).rest_api.presence = GUARANTEED
394 optional string mission_name = 72
395 [(dccl.field).omit = true]; // not sent, restored on Hub from map
397 oneof bot_type_status
399 StormStatus storm = 100;
405 option (dccl.msg) = {
409 optional int32 drift_duration = 1 [
415 units { base_dimensions: "T" }
417 (jaia.field).rest_api.presence = GUARANTEED
420 message EstimatedDrift
422 required double speed = 1 [
427 units { derived_dimensions: "velocity" }
429 (jaia.field).rest_api.presence = GUARANTEED
432 optional double heading = 3 [
438 derived_dimensions: "plane_angle"
439 system: "angle::degree"
442 (jaia.field).rest_api.presence = GUARANTEED
446 // should correspond to ocean current velocity
447 optional EstimatedDrift estimated_drift = 10
448 [(jaia.field).rest_api.presence = GUARANTEED];
451 optional GeographicCoordinate start_location = 11
452 [(jaia.field).rest_api.presence = GUARANTEED];
454 optional GeographicCoordinate end_location = 12
455 [(jaia.field).rest_api.presence = GUARANTEED];
457 // Significant wave height is defined as the average wave height,
458 // from trough to crest, of the highest one-third of the waves
459 optional double significant_wave_height = 13 [
464 units: { derived_dimensions: "length" }
466 (jaia.field).rest_api.presence = GUARANTEED
472 option (dccl.msg) = {
476 required double dive_rate = 10 [
481 units { derived_dimensions: "velocity" }
483 (jaia.field).rest_api.presence = GUARANTEED
486 optional double unpowered_rise_rate = 11 [
491 units { derived_dimensions: "velocity" }
493 (jaia.field).rest_api.presence = GUARANTEED
496 optional double powered_rise_rate = 12 [
501 units { derived_dimensions: "velocity" }
503 (jaia.field).rest_api.presence = GUARANTEED
506 required double depth_achieved = 13 [
511 units: { derived_dimensions: "length" }
513 (jaia.field).rest_api.presence = GUARANTEED
518 optional double mean_depth = 1 [
523 units: { derived_dimensions: "length" }
525 (jaia.field).rest_api.presence = GUARANTEED
528 optional double mean_temperature = 2 [
533 units { derived_dimensions: "temperature" system: "celsius" }
535 (jaia.field).rest_api.presence = GUARANTEED
538 optional double mean_salinity = 3 [
539 (dccl.field) = { min: 0 max: 45 precision: 1 },
540 (jaia.field).rest_api.presence = GUARANTEED
544 repeated Measurements measurement = 14 [
545 (dccl.field) = { max_repeat: 50 },
546 (jaia.field).rest_api.presence = GUARANTEED
550 optional GeographicCoordinate start_location = 15
551 [(jaia.field).rest_api.presence = GUARANTEED];
553 optional double duration_to_acquire_gps = 16 [
558 units { base_dimensions: "T" }
560 (jaia.field).rest_api.presence = GUARANTEED
563 // Did we reach seafloor?
564 optional bool bottom_dive = 17
565 [default = false, (jaia.field).rest_api.presence = GUARANTEED];
567 // Did we reach min depth?
568 optional bool reached_min_depth = 18
569 [default = false, (jaia.field).rest_api.presence = GUARANTEED];
571 // If we reached bottom, what was the bottom type
574 HARD = 1 [(jaia.ev).rest_api.presence = GUARANTEED];
575 SOFT = 2 [(jaia.ev).rest_api.presence = GUARANTEED];
578 optional BottomType bottom_type = 19
579 [(jaia.field).rest_api.presence = GUARANTEED];
581 // For bottom characterization
582 optional double max_acceleration = 20 [
587 units { derived_dimensions: "acceleration" }
589 (jaia.field).rest_api.presence = GUARANTEED
592 message SubsurfaceCurrentVector
594 required double velocity = 1 [
599 units { derived_dimensions: "velocity" }
601 (jaia.field).rest_api.presence = GUARANTEED
604 required double heading = 2 [
610 derived_dimensions: "plane_angle"
611 system: "angle::degree"
614 (jaia.field).rest_api.presence = GUARANTEED
618 optional SubsurfaceCurrentVector subsurface_current = 21
619 [(jaia.field).rest_api.presence = GUARANTEED];
622message StormCTDProfile
624 option (dccl.msg) = { unit_system: "si" };
626 required uint64 profile_time = 1 [(dccl.field) = {
628 units { prefix: "micro" derived_dimensions: "time" }
631 required GeographicCoordinate location = 2;
635 required double depth = 1 [(dccl.field) = {
639 units { derived_dimensions: "length" }
642 required double temperature = 2 [(dccl.field) = {
646 units { derived_dimensions: "temperature" system: "celsius" }
649 required double salinity = 3
650 [(dccl.field) = { min: 0 max: 60 precision: 2 }];
653 repeated Sample sample = 3 [(dccl.field).max_repeat = 30];
655 // a profile too large for one TaskPacket is split into num_parts TaskPackets, all
656 // sharing the same profile_time; the hub reassembles them in part_index order
657 required uint32 part_index = 4 [(dccl.field) = { min: 0 max: 9 }];
658 required uint32 num_parts = 5 [(dccl.field) = { min: 1 max: 10 }];
664 Actual maximum size of message: 224 bytes / 1792 bits
665 dccl.id head..........................16
666 user head..............................0
667 body................................1776
668 padding to full byte...................0
669 Allowed maximum size of message: 250 bytes / 2000 bits
671 option (dccl.msg) = {
678 required uint32 bot_id = 1 [
679 (dccl.field) = { min: 0 max: 255 },
680 (jaia.field).rest_api.presence = GUARANTEED
682 required uint64 start_time = 2 [
685 units { prefix: "micro" derived_dimensions: "time" }
687 (jaia.field).rest_api.presence = GUARANTEED
689 required uint64 end_time = 3 [
692 units { prefix: "micro" derived_dimensions: "time" }
694 (jaia.field).rest_api.presence = GUARANTEED
696 required MissionTask.TaskType type = 4
697 [(jaia.field).rest_api.presence = GUARANTEED];
699 // Special case: not sent in message - written upon receipt based on the
701 optional Link link = 5 [(dccl.field).omit = true];
703 // used by storm manager to ensure all packets are ack'd
704 optional int32 storm_id = 6 [(dccl.field) = { min: 0 max: 10000 }];
708 DivePacket dive = 10 [(jaia.field).rest_api.presence = GUARANTEED];
709 StormAirDescentData storm_air_descent = 12;
710 StormCTDProfile storm_ctd_profile = 14;
713 optional DriftPacket drift = 11
714 [(jaia.field).rest_api.presence = GUARANTEED];
716 // The command_time is the time that the command associated with this task
717 // was sent from the Hub. This is used, along with the bot_id, to populate
718 // the mission_name on the Hub.
719 optional uint64 mission_command_time = 71 [
722 units { prefix: "micro" derived_dimensions: "time" }
724 (jaia.field).rest_api.presence = GUARANTEED
726 optional string mission_name = 72
727 [(dccl.field).omit = true]; // not sent, restored on Hub from map
732 option (dccl.msg) = {
739 optional int32 contact = 1 [(dccl.field) = { min: 1, max: 15 }];
740 required GeographicCoordinate location = 2;
741 optional double speed_over_ground = 3 [(dccl.field) = {
745 units { derived_dimensions: "velocity" }
747 optional double heading_or_cog = 5 [(dccl.field) = {
751 units { derived_dimensions: "plane_angle" system: "angle::degree" }
757 option (dccl.msg) = {
764 required uint32 hub_id = 1 [(dccl.field) = { min: 0 max: 30 }];
765 required uint64 time = 2 [(dccl.field) = {
767 units { prefix: "micro" derived_dimensions: "time" }
768 precision: -5 // deci-second precision
771 optional Link bot_link = 3; // which link did this originally come over
772 // from the bot (for BotStatus/TaskPacket)?
776 BotStatus bot_status = 10;
777 TaskPacket task_packet = 11;
778 Command command_for_bot = 12;
779 CommandCommsResult command_comms_result = 13;
780 HubStatus hub_status = 14;
784message CommandCommsResult
791 required CommsResult result = 1;
792 required Link link = 2;
793 required Command orig_command = 3;