JaiaBot 1.10.0+14+g8dbf2589
JaiaBot micro-AUV software
 
Loading...
Searching...
No Matches
xbee_extensions.proto
Go to the documentation of this file.
1syntax = "proto2";
2import "goby/acomms/protobuf/driver_base.proto"; // load up message DriverBaseConfig
3import "goby/protobuf/option_extensions.proto";
4import "dccl/option_extensions.proto";
5
6package xbee.protobuf;
7
8message Peer
9{
10 oneof id
11 {
12 string node_id = 1 [
13 (goby.field).description =
14 "DEPRECATED (use hub_id or bot_id): set peer modem id as string"
15 ];
16 int32 hub_id = 3 [(goby.field).description =
17 "Hub ID number for this peer (if peer is hub)"];
18 int32 bot_id = 4 [(goby.field).description =
19 "Bot ID number for this peer (if peer is bot)"];
20 }
21
22 required uint64 serial_number = 2 [
23 (goby.field).description =
24 "XBee serial number for this peer (determined by querying ATSH and ATSL)"
25 ];
26}
27
28message Config
29{
30 option (dccl.msg) = {
31 unit_system: "si"
32 };
33
34 optional uint64 network_id = 1 [
35 default = 7,
36 (goby.field).description =
37 "Network ID for this fleet (must match other peers in fleet): sets Xbee ATID=network_id"
38 ];
39 repeated Peer peers = 2 [
40 (goby.field).description =
41 "Mapping of Xbee serial_number to hub/bot id for all peers in the fleet"
42 ];
43 optional bool test_comms = 4 [
44 default = false,
45 (goby.field).description =
46 "If true, enables testing functionality and diagnostics"
47 ];
48 optional string xbee_info_location = 5 [
49 default = "/etc/jaiabot/xbee_info.pb.cfg",
50 (goby.field).description =
51 "Location to write a file with serial number and node id to be used by jaiabot_metadata."
52 ];
53
54 optional int32 hub_id = 6
55 [(goby.field).description =
56 "If this node is a hub, set its hub_id here."];
57
58 optional bool use_xbee_encryption = 7 [
59 default = false,
60 (goby.field).description =
61 "This is used to determine if we should enable encryption."
62 ];
63
64 optional string xbee_encryption_password = 8 [
65 default = "",
66 (goby.field).description =
67 "This is used for the encryption password. Password is a 128 bit value (16 bytes)"
68 ];
69
70 optional string hub_info_location = 9 [
71 default = "/etc/jaiabot/hub_info.pb.cfg",
72 (goby.field).description =
73 "Location to write a file with last hub id received from to initialize to that hub on restart."
74 ];
75}
76
77extend goby.acomms.protobuf.DriverConfig
78{
79 optional Config config = 1500;
80}