JaiaBot 3.0.0
JaiaBot micro-AUV software
Loading...
Searching...
No Matches
simulator.proto
Go to the documentation of this file.
1// Copyright 2024:
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 "dccl/option_extensions.proto";
25
26package jaiabot.protobuf;
27
28message SimulatorCommand
29{
30 option (dccl.msg) = {
31 unit_system: "si"
32 };
33 message GPSDropOut
34 {
35 required double dropout_duration = 2
36 [(dccl.field) = { units { derived_dimensions: "time" } }];
37 }
38
39 message StopForwardProgress
40 {
41 required double duration = 2
42 [(dccl.field) = { units { derived_dimensions: "time" } }];
43 }
44
45 oneof command
46 {
47 GPSDropOut gps_dropout = 1;
48 StopForwardProgress stop_forward_progress = 2;
49 }
50}
51
52// Ground truth the simulator computes from the vehicle's state, for the Python drivers to
53// convert into sensor readings the way they convert real ones in the field.
54message SimEnvironment
55{
56 option (dccl.msg) = {
57 unit_system: "si"
58 };
59
60 optional double depth = 1 [(dccl.field) = { units { derived_dimensions: "length" } }];
61 optional double temperature = 2 [(dccl.field) = {
62 units { derived_dimensions: "temperature" system: "celsius" }
63 }];
64 optional double salinity = 3;
65 optional double pressure = 4
66 [(dccl.field) = { units { prefix: "deci" unit: "metric::bar" } }];
67 optional double pitch = 5 [(dccl.field) = { units { derived_dimensions: "plane_angle" } }];
68 optional double roll = 6 [(dccl.field) = { units { derived_dimensions: "plane_angle" } }];
69 // microsiemens/cm; zero out of the water
70 optional double conductivity = 7;
71}