JaiaBot  1.12.0+18+g85da5f82
JaiaBot micro-AUV software
config.proto
Go to the documentation of this file.
1 // Copyright 2021:
2 // JaiaRobotics LLC
3 // File authors:
4 // Toby Schneider <toby@gobysoft.org>
5 //
6 //
7 // This file is part of the JaiaBot Project Binaries
8 // ("The Jaia Binaries").
9 //
10 // The Jaia Binaries are free software: you can redistribute them and/or modify
11 // them under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 2 of the License, or
13 // (at your option) any later version.x
14 //
15 // The Jaia Binaries are distributed in the hope that they will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
19 //
20 // You should have received a copy of the GNU General Public License
21 // along with the Jaia Binaries. If not, see <http://www.gnu.org/licenses/>.
22 
23 syntax = "proto2";
24 
25 import "goby/middleware/protobuf/app_config.proto";
26 import "goby/zeromq/protobuf/interprocess_config.proto";
27 import "goby/middleware/protobuf/transporter_config.proto";
28 import "jaiabot/messages/xbee_extensions.proto";
29 
30 package jaiabot.config;
31 
32 message HubManager
33 {
34  // required parameters for ApplicationBase3 class
35  optional goby.middleware.protobuf.AppConfig app = 1;
36  // required parameters for connecting to 'gobyd'
37  optional goby.zeromq.protobuf.InterProcessPortalConfig interprocess = 2;
38 
39  // use to pre-seed expected bots
40  optional xbee.protobuf.Config xbee = 10;
41 
42  required goby.middleware.protobuf.TransporterConfig status_sub_cfg = 11;
43  required goby.middleware.protobuf.TransporterConfig task_packet_sub_cfg =
44  12;
45  required goby.middleware.protobuf.TransporterConfig
46  engineering_status_sub_cfg = 13;
47 
48  optional int32 hub_id = 14 [default = 0];
49  optional int32 fleet_id = 15 [default = 0];
50  optional int32 health_report_timeout_seconds = 16 [default = 20];
51 
52  message VirtualFleetData
53  {
54  // used by VirtualHub to shut down system after idle (no commands received)
55  // to avoid running up EC2 costs unexpectedly
56  required int32 shutdown_after_last_command_seconds = 1 [default = 3600];
57  // delay shutting down hub after this time since last BotStatus message
58  required int32 hub_shutdown_delay_seconds = 2 [default = 300];
59  }
60  optional VirtualFleetData vfleet = 20;
61 
62  // data offload
63  required string data_offload_script = 30;
64  optional string log_staging_dir = 31 [default = "/var/log/jaiabot/staging"];
65  optional string log_offload_dir = 32
66  [default = "/var/log/jaiabot/bot_offload"];
67  optional int32 bot_start_ip = 33 [default = 100];
68  optional string class_b_network = 34 [default = "10.23"];
69  optional bool use_localhost_for_data_offload = 35 [default = false];
70 
71 }