Goby3  3.1.5a
2024.05.23
frontseat_config.proto
Go to the documentation of this file.
1 syntax = "proto2";
2 import "dccl/option_extensions.proto";
3 
4 import "goby/protobuf/option_extensions.proto";
5 import "goby/middleware/protobuf/frontseat_data.proto";
6 import "goby/middleware/protobuf/geographic.proto";
7 
8 package goby.middleware.frontseat.protobuf;
9 
10 message Config
11 {
12  option (dccl.msg).unit_system = "si";
13 
14  optional string name = 1;
15  optional .goby.middleware.protobuf.LatLonPoint origin = 2;
16  optional VehicleType type = 3 [default = AUV];
17 
18  optional bool require_helm = 10 [
19  default = true,
20  (goby.field).description =
21  "Require the IvP Helm even for listening mission where the "
22  "frontseat is in control."
23  ];
24 
25  optional double helm_running_timeout = 11 [
26  default = 10,
27  (dccl.field).units = {base_dimensions: "T"},
28  (goby.field).description =
29  "If `require_helm`, how long (in seconds) to wait for the IvP Helm "
30  "to start before moving to the Helm Error state."
31  ];
32 
33  optional double frontseat_connected_timeout = 12 [
34  default = 10,
35  (dccl.field).units = {base_dimensions: "T"},
36  (goby.field).description =
37  "How long (in seconds) to wait for the Frontseat to be connected "
38  "before moving to the Frontseat Error state."
39  ];
40 
41  optional uint32 status_period = 13 [
42  default = 5,
43  (dccl.field).units = {base_dimensions: "T"},
44  (goby.field).description =
45  "Seconds between publishing the status of iFrontseat. The special "
46  "value 0 disables posting of the status message."
47  ];
48 
49  optional bool exit_on_error = 21 [
50  default = false,
51  (goby.field).description =
52  "If true, exit the application if it enters one of the error "
53  "states."
54  ];
55 
56  optional int32 sim_warp_factor = 30 [default = 1];
57 
58  // Bluefin: 1000
59  // Basic Simulator: 1001
60  // Nemo: 1002
61  // Iver3: 1003
62  extensions 1000 to max;
63 }