JaiaBot 3.0.0
JaiaBot micro-AUV software
Loading...
Searching...
No Matches
storm_mcu.proto
Go to the documentation of this file.
1syntax = "proto2";
2
3import "nanopb.proto";
4import "dccl/option_extensions.proto";
5
6package jaiabot.protobuf;
7
8message StormAirDescentData
9{
10 option (dccl.msg) = {
11 unit_system: "si"
12 };
13
14 message Sample
15 {
16 optional float temperature = 1 [(dccl.field) = {
17 units { derived_dimensions: "temperature" system: "celsius" }
18 min: -70 // TODO verify
19 max: 130 // TODO verify
20 precision: 1 // TODO verify
21 }];
22
23 // TODO add additional fields for air data
24 }
25
26 required uint32 packet_index = 1 [
27 (dccl.field) = { min: 0 max: 99 }
28 // must match bounds in AirDescentMetadata num_packets
29 ];
30
31 repeated Sample sample = 2 [
32 (nanopb).max_count = 100,
33 (dccl.field) = { max_repeat: 100 } // must be same as nanopb max_count
34 ]; // TODO verify max_count / max_repeat
35}
36
37message StormMCURequest
38{
39 enum Type
40 {
41 AIR_DESCENT_METADATA_REQUEST = 1;
42 AIR_DESCENT_DATA_REQUEST = 2;
43 SLEEP_REQUEST = 3;
44 }
45
46 required Type type = 1;
47
48 // for AIR_DESCENT_DATA_REQUEST
49 optional int32 packet_index = 2;
50
51 // for SLEEP_REQUEST
52 optional int32 sleep_for_minutes = 3
53 [(dccl.field) = { units { unit: "metric::minute" } }];
54}
55
56// sent once before streaming data in StormAirDescentData
57message StormAirDescentMetadata
58{
59 option (dccl.msg) = {
60 unit_system: "si"
61 };
62 required uint64 start_time = 1 [(dccl.field) = {
63 codec: "dccl.time"
64 units { prefix: "micro" derived_dimensions: "time" }
65 }];
66 required uint64 end_time = 2 [(dccl.field) = {
67 codec: "dccl.time"
68 units { prefix: "micro" derived_dimensions: "time" }
69 }];
70 required float sample_rate = 3 [(dccl.field) = {
71 units { derived_dimensions: "frequency" }
72 min: 0.1 // TODO verify
73 max: 100 // TODO verify
74 precision: 1 // TODO verify
75 }];
76
77 required uint32 num_packets = 4
78 [(dccl.field) = { min: 1 max: 100 }]; // TODO verify bounds
79}
80
81message StormMCUResponse
82{
83 oneof payload
84 {
85 StormAirDescentMetadata air_descent_metadata = 1;
86 StormAirDescentData air_descent_data = 2;
87 bool sleep_initiated = 3 [default = false];
88 }
89}