JaiaBot 3.0.0
JaiaBot micro-AUV software
Loading...
Searching...
No Matches
fleet_config.proto
Go to the documentation of this file.
1// Copyright 2025:
2// JaiaRobotics LLC
3// File authors:
4// Toby Schneider <toby@gobysoft.org>
5//
6//
7// This file is part of the JaiaBot Project Libraries
8// ("The Jaia Libraries").
9//
10// The Jaia Libraries are free software: you can redistribute them and/or modify
11// them under the terms of the GNU Lesser General Public License as published by
12// the Free Software Foundation, either version 2.1 of the License, or
13// (at your option) any later version.
14//
15// The Jaia Libraries 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 Lesser General Public License for more details.
19//
20// You should have received a copy of the GNU Lesser General Public License
21// along with the Jaia Libraries. If not, see <http://www.gnu.org/licenses/>.
22
23syntax = "proto2";
24import "jaiabot/messages/option_extensions.proto";
25
26package jaiabot.protobuf;
27
28option (jaia.file).fleet_config_version = 1;
29
30message FleetConfig
31{
32 // Fleet config contract version, independent of the software version.
33 // Files that predate this field are version 1. Bump
34 // PROJECT_FLEET_CONFIG_VERSION (cmake/JaiaVersions.cmake) together with a
35 // migration when the build-time contract check reports a breaking change.
36 // Fields are never removed or renamed, only marked [deprecated = true],
37 // so that every earlier version still parses.
38 optional uint32 version = 10 [default = 1];
39
40 required int32 fleet = 1;
41 repeated int32 hubs = 2;
42 repeated int32 bots = 3;
43
44 message SSHKeys
45 {
46 repeated string permanent_authorized_keys = 1;
47 message HubKey
48 {
49 required int32 id = 1;
50 required string private_key = 2;
51 required string public_key = 3;
52 }
53 repeated HubKey hub = 2;
54 message VPNTempKey
55 {
56 required string private_key = 2;
57 required string public_key = 3;
58 }
59 optional VPNTempKey vpn_tmp = 3;
60 }
61 required SSHKeys ssh = 4;
62
63 message Debconf
64 {
65 enum DebconfType
66 {
67 SELECT = 0;
68 MULTISELECT = 1;
69 STRING = 2;
70 BOOLEAN = 3;
71 NOTE = 4;
72 TEXT = 5;
73 PASSWORD = 6;
74 }
75
76 required string key = 1;
77 optional DebconfType type = 2 [default = SELECT];
78 required string value = 3;
79 }
80 repeated Debconf debconf = 5;
81 required string wlan_password = 6;
82 required bool service_vpn_enabled = 7;
83
84 message DebconfOverride
85 {
86 enum NodeType
87 {
88 HUB = 0;
89 BOT = 1;
90 }
91
92 required NodeType type = 1;
93 required int32 id = 2;
94 repeated Debconf debconf = 3;
95 }
96 repeated DebconfOverride debconf_override = 8;
97
98
99 message Communications
100 {
101 message IridiumSBD
102 {
103 message BotToIMEI
104 {
105 required int32 id = 1;
106 required string imei = 2;
107 }
108 repeated BotToIMEI bot = 1;
109 // Matches enum in Goby driver
110 enum SBDType
111 {
112 SBD_DIRECTIP = 1;
113 SBD_ROCKBLOCK = 2;
114 }
115 required SBDType sbd_type = 2;
116 message RockBLOCKParams
117 {
118 required string username = 1;
119 required string password = 2;
120 }
121 optional RockBLOCKParams rockblock = 3;
122 }
123 optional IridiumSBD iridium_sbd = 1;
124 }
125 optional Communications comms = 9;
126
127 message CloudHub
128 {
129 // Authentication front end: Authelia behind Caddy
130 required string base_uri = 1;
131 required string admin_email = 2;
132 required string smtp_address = 3;
133 }
134 optional CloudHub cloudhub = 11;
135}