-
Notifications
You must be signed in to change notification settings - Fork 117
/
mesh.proto
1897 lines (1604 loc) · 47.4 KB
/
mesh.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
syntax = "proto3";
package meshtastic;
import "meshtastic/channel.proto";
import "meshtastic/config.proto";
import "meshtastic/module_config.proto";
import "meshtastic/portnums.proto";
import "meshtastic/telemetry.proto";
import "meshtastic/xmodem.proto";
option csharp_namespace = "Meshtastic.Protobufs";
option go_package = "github.com/meshtastic/go/generated";
option java_outer_classname = "MeshProtos";
option java_package = "com.geeksville.mesh";
option swift_prefix = "";
/*
* a gps position
*/
message Position {
/*
* The new preferred location encoding, multiply by 1e-7 to get degrees
* in floating point
*/
optional sfixed32 latitude_i = 1;
/*
* TODO: REPLACE
*/
optional sfixed32 longitude_i = 2;
/*
* In meters above MSL (but see issue #359)
*/
optional int32 altitude = 3;
/*
* This is usually not sent over the mesh (to save space), but it is sent
* from the phone so that the local device can set its time if it is sent over
* the mesh (because there are devices on the mesh without GPS or RTC).
* seconds since 1970
*/
fixed32 time = 4;
/*
* How the location was acquired: manual, onboard GPS, external (EUD) GPS
*/
enum LocSource {
/*
* TODO: REPLACE
*/
LOC_UNSET = 0;
/*
* TODO: REPLACE
*/
LOC_MANUAL = 1;
/*
* TODO: REPLACE
*/
LOC_INTERNAL = 2;
/*
* TODO: REPLACE
*/
LOC_EXTERNAL = 3;
}
/*
* TODO: REPLACE
*/
LocSource location_source = 5;
/*
* How the altitude was acquired: manual, GPS int/ext, etc
* Default: same as location_source if present
*/
enum AltSource {
/*
* TODO: REPLACE
*/
ALT_UNSET = 0;
/*
* TODO: REPLACE
*/
ALT_MANUAL = 1;
/*
* TODO: REPLACE
*/
ALT_INTERNAL = 2;
/*
* TODO: REPLACE
*/
ALT_EXTERNAL = 3;
/*
* TODO: REPLACE
*/
ALT_BAROMETRIC = 4;
}
/*
* TODO: REPLACE
*/
AltSource altitude_source = 6;
/*
* Positional timestamp (actual timestamp of GPS solution) in integer epoch seconds
*/
fixed32 timestamp = 7;
/*
* Pos. timestamp milliseconds adjustment (rarely available or required)
*/
int32 timestamp_millis_adjust = 8;
/*
* HAE altitude in meters - can be used instead of MSL altitude
*/
optional sint32 altitude_hae = 9;
/*
* Geoidal separation in meters
*/
optional sint32 altitude_geoidal_separation = 10;
/*
* Horizontal, Vertical and Position Dilution of Precision, in 1/100 units
* - PDOP is sufficient for most cases
* - for higher precision scenarios, HDOP and VDOP can be used instead,
* in which case PDOP becomes redundant (PDOP=sqrt(HDOP^2 + VDOP^2))
* TODO: REMOVE/INTEGRATE
*/
uint32 PDOP = 11;
/*
* TODO: REPLACE
*/
uint32 HDOP = 12;
/*
* TODO: REPLACE
*/
uint32 VDOP = 13;
/*
* GPS accuracy (a hardware specific constant) in mm
* multiplied with DOP to calculate positional accuracy
* Default: "'bout three meters-ish" :)
*/
uint32 gps_accuracy = 14;
/*
* Ground speed in m/s and True North TRACK in 1/100 degrees
* Clarification of terms:
* - "track" is the direction of motion (measured in horizontal plane)
* - "heading" is where the fuselage points (measured in horizontal plane)
* - "yaw" indicates a relative rotation about the vertical axis
* TODO: REMOVE/INTEGRATE
*/
optional uint32 ground_speed = 15;
/*
* TODO: REPLACE
*/
optional uint32 ground_track = 16;
/*
* GPS fix quality (from NMEA GxGGA statement or similar)
*/
uint32 fix_quality = 17;
/*
* GPS fix type 2D/3D (from NMEA GxGSA statement)
*/
uint32 fix_type = 18;
/*
* GPS "Satellites in View" number
*/
uint32 sats_in_view = 19;
/*
* Sensor ID - in case multiple positioning sensors are being used
*/
uint32 sensor_id = 20;
/*
* Estimated/expected time (in seconds) until next update:
* - if we update at fixed intervals of X seconds, use X
* - if we update at dynamic intervals (based on relative movement etc),
* but "AT LEAST every Y seconds", use Y
*/
uint32 next_update = 21;
/*
* A sequence number, incremented with each Position message to help
* detect lost updates if needed
*/
uint32 seq_number = 22;
/*
* Indicates the bits of precision set by the sending node
*/
uint32 precision_bits = 23;
}
/*
* Note: these enum names must EXACTLY match the string used in the device
* bin/build-all.sh script.
* Because they will be used to find firmware filenames in the android app for OTA updates.
* To match the old style filenames, _ is converted to -, p is converted to .
*/
enum HardwareModel {
/*
* TODO: REPLACE
*/
UNSET = 0;
/*
* TODO: REPLACE
*/
TLORA_V2 = 1;
/*
* TODO: REPLACE
*/
TLORA_V1 = 2;
/*
* TODO: REPLACE
*/
TLORA_V2_1_1P6 = 3;
/*
* TODO: REPLACE
*/
TBEAM = 4;
/*
* The original heltec WiFi_Lora_32_V2, which had battery voltage sensing hooked to GPIO 13
* (see HELTEC_V2 for the new version).
*/
HELTEC_V2_0 = 5;
/*
* TODO: REPLACE
*/
TBEAM_V0P7 = 6;
/*
* TODO: REPLACE
*/
T_ECHO = 7;
/*
* TODO: REPLACE
*/
TLORA_V1_1P3 = 8;
/*
* TODO: REPLACE
*/
RAK4631 = 9;
/*
* The new version of the heltec WiFi_Lora_32_V2 board that has battery sensing hooked to GPIO 37.
* Sadly they did not update anything on the silkscreen to identify this board
*/
HELTEC_V2_1 = 10;
/*
* Ancient heltec WiFi_Lora_32 board
*/
HELTEC_V1 = 11;
/*
* New T-BEAM with ESP32-S3 CPU
*/
LILYGO_TBEAM_S3_CORE = 12;
/*
* RAK WisBlock ESP32 core: https://docs.rakwireless.com/Product-Categories/WisBlock/RAK11200/Overview/
*/
RAK11200 = 13;
/*
* B&Q Consulting Nano Edition G1: https://uniteng.com/wiki/doku.php?id=meshtastic:nano
*/
NANO_G1 = 14;
/*
* TODO: REPLACE
*/
TLORA_V2_1_1P8 = 15;
/*
* TODO: REPLACE
*/
TLORA_T3_S3 = 16;
/*
* B&Q Consulting Nano G1 Explorer: https://wiki.uniteng.com/en/meshtastic/nano-g1-explorer
*/
NANO_G1_EXPLORER = 17;
/*
* B&Q Consulting Nano G2 Ultra: https://wiki.uniteng.com/en/meshtastic/nano-g2-ultra
*/
NANO_G2_ULTRA = 18;
/*
* LoRAType device: https://loratype.org/
*/
LORA_TYPE = 19;
/*
* wiphone https://www.wiphone.io/
*/
WIPHONE = 20;
/*
* WIO Tracker WM1110 family from Seeed Studio. Includes wio-1110-tracker and wio-1110-sdk
*/
WIO_WM1110 = 21;
/*
* RAK2560 Solar base station based on RAK4630
*/
RAK2560 = 22;
/*
* Heltec HRU-3601: https://heltec.org/project/hru-3601/
*/
HELTEC_HRU_3601 = 23;
/*
* B&Q Consulting Station Edition G1: https://uniteng.com/wiki/doku.php?id=meshtastic:station
*/
STATION_G1 = 25;
/*
* RAK11310 (RP2040 + SX1262)
*/
RAK11310 = 26;
/*
* Makerfabs SenseLoRA Receiver (RP2040 + RFM96)
*/
SENSELORA_RP2040 = 27;
/*
* Makerfabs SenseLoRA Industrial Monitor (ESP32-S3 + RFM96)
*/
SENSELORA_S3 = 28;
/*
* Canary Radio Company - CanaryOne: https://canaryradio.io/products/canaryone
*/
CANARYONE = 29;
/*
* Waveshare RP2040 LoRa - https://www.waveshare.com/rp2040-lora.htm
*/
RP2040_LORA = 30;
/*
* B&Q Consulting Station G2: https://wiki.uniteng.com/en/meshtastic/station-g2
*/
STATION_G2 = 31;
/*
* ---------------------------------------------------------------------------
* Less common/prototype boards listed here (needs one more byte over the air)
* ---------------------------------------------------------------------------
*/
LORA_RELAY_V1 = 32;
/*
* TODO: REPLACE
*/
NRF52840DK = 33;
/*
* TODO: REPLACE
*/
PPR = 34;
/*
* TODO: REPLACE
*/
GENIEBLOCKS = 35;
/*
* TODO: REPLACE
*/
NRF52_UNKNOWN = 36;
/*
* TODO: REPLACE
*/
PORTDUINO = 37;
/*
* The simulator built into the android app
*/
ANDROID_SIM = 38;
/*
* Custom DIY device based on @NanoVHF schematics: https://github.com/NanoVHF/Meshtastic-DIY/tree/main/Schematics
*/
DIY_V1 = 39;
/*
* nRF52840 Dongle : https://www.nordicsemi.com/Products/Development-hardware/nrf52840-dongle/
*/
NRF52840_PCA10059 = 40;
/*
* Custom Disaster Radio esp32 v3 device https://github.com/sudomesh/disaster-radio/tree/master/hardware/board_esp32_v3
*/
DR_DEV = 41;
/*
* M5 esp32 based MCU modules with enclosure, TFT and LORA Shields. All Variants (Basic, Core, Fire, Core2, Paper) https://m5stack.com/
*/
M5STACK = 42;
/*
* New Heltec LoRA32 with ESP32-S3 CPU
*/
HELTEC_V3 = 43;
/*
* New Heltec Wireless Stick Lite with ESP32-S3 CPU
*/
HELTEC_WSL_V3 = 44;
/*
* New BETAFPV ELRS Micro TX Module 2.4G with ESP32 CPU
*/
BETAFPV_2400_TX = 45;
/*
* BetaFPV ExpressLRS "Nano" TX Module 900MHz with ESP32 CPU
*/
BETAFPV_900_NANO_TX = 46;
/*
* Raspberry Pi Pico (W) with Waveshare SX1262 LoRa Node Module
*/
RPI_PICO = 47;
/*
* Heltec Wireless Tracker with ESP32-S3 CPU, built-in GPS, and TFT
* Newer V1.1, version is written on the PCB near the display.
*/
HELTEC_WIRELESS_TRACKER = 48;
/*
* Heltec Wireless Paper with ESP32-S3 CPU and E-Ink display
*/
HELTEC_WIRELESS_PAPER = 49;
/*
* LilyGo T-Deck with ESP32-S3 CPU, Keyboard and IPS display
*/
T_DECK = 50;
/*
* LilyGo T-Watch S3 with ESP32-S3 CPU and IPS display
*/
T_WATCH_S3 = 51;
/*
* Bobricius Picomputer with ESP32-S3 CPU, Keyboard and IPS display
*/
PICOMPUTER_S3 = 52;
/*
* Heltec HT-CT62 with ESP32-C3 CPU and SX1262 LoRa
*/
HELTEC_HT62 = 53;
/*
* EBYTE SPI LoRa module and ESP32-S3
*/
EBYTE_ESP32_S3 = 54;
/*
* Waveshare ESP32-S3-PICO with PICO LoRa HAT and 2.9inch e-Ink
*/
ESP32_S3_PICO = 55;
/*
* CircuitMess Chatter 2 LLCC68 Lora Module and ESP32 Wroom
* Lora module can be swapped out for a Heltec RA-62 which is "almost" pin compatible
* with one cut and one jumper Meshtastic works
*/
CHATTER_2 = 56;
/*
* Heltec Wireless Paper, With ESP32-S3 CPU and E-Ink display
* Older "V1.0" Variant, has no "version sticker"
* E-Ink model is DEPG0213BNS800
* Tab on the screen protector is RED
* Flex connector marking is FPC-7528B
*/
HELTEC_WIRELESS_PAPER_V1_0 = 57;
/*
* Heltec Wireless Tracker with ESP32-S3 CPU, built-in GPS, and TFT
* Older "V1.0" Variant
*/
HELTEC_WIRELESS_TRACKER_V1_0 = 58;
/*
* unPhone with ESP32-S3, TFT touchscreen, LSM6DS3TR-C accelerometer and gyroscope
*/
UNPHONE = 59;
/*
* Teledatics TD-LORAC NRF52840 based M.2 LoRA module
* Compatible with the TD-WRLS development board
*/
TD_LORAC = 60;
/*
* CDEBYTE EoRa-S3 board using their own MM modules, clone of LILYGO T3S3
*/
CDEBYTE_EORA_S3 = 61;
/*
* TWC_MESH_V4
* Adafruit NRF52840 feather express with SX1262, SSD1306 OLED and NEO6M GPS
*/
TWC_MESH_V4 = 62;
/*
* NRF52_PROMICRO_DIY
* Promicro NRF52840 with SX1262/LLCC68, SSD1306 OLED and NEO6M GPS
*/
NRF52_PROMICRO_DIY = 63;
/*
* RadioMaster 900 Bandit Nano, https://www.radiomasterrc.com/products/bandit-nano-expresslrs-rf-module
* ESP32-D0WDQ6 With SX1276/SKY66122, SSD1306 OLED and No GPS
*/
RADIOMASTER_900_BANDIT_NANO = 64;
/*
* Heltec Capsule Sensor V3 with ESP32-S3 CPU, Portable LoRa device that can replace GNSS modules or sensors
*/
HELTEC_CAPSULE_SENSOR_V3 = 65;
/*
* Heltec Vision Master T190 with ESP32-S3 CPU, and a 1.90 inch TFT display
*/
HELTEC_VISION_MASTER_T190 = 66;
/*
* Heltec Vision Master E213 with ESP32-S3 CPU, and a 2.13 inch E-Ink display
*/
HELTEC_VISION_MASTER_E213 = 67;
/*
* Heltec Vision Master E290 with ESP32-S3 CPU, and a 2.9 inch E-Ink display
*/
HELTEC_VISION_MASTER_E290 = 68;
/*
* Heltec Mesh Node T114 board with nRF52840 CPU, and a 1.14 inch TFT display, Ultimate low-power design,
* specifically adapted for the Meshtatic project
*/
HELTEC_MESH_NODE_T114 = 69;
/*
* Sensecap Indicator from Seeed Studio. ESP32-S3 device with TFT and RP2040 coprocessor
*/
SENSECAP_INDICATOR = 70;
/*
* Seeed studio T1000-E tracker card. NRF52840 w/ LR1110 radio, GPS, button, buzzer, and sensors.
*/
TRACKER_T1000_E = 71;
/*
* RAK3172 STM32WLE5 Module (https://store.rakwireless.com/products/wisduo-lpwan-module-rak3172)
*/
RAK3172 = 72;
/*
* Seeed Studio Wio-E5 (either mini or Dev kit) using STM32WL chip.
*/
WIO_E5 = 73;
/*
* RadioMaster 900 Bandit, https://www.radiomasterrc.com/products/bandit-expresslrs-rf-module
* SSD1306 OLED and No GPS
*/
RADIOMASTER_900_BANDIT = 74;
/*
* Minewsemi ME25LS01 (ME25LE01_V1.0). NRF52840 w/ LR1110 radio, buttons and leds and pins.
*/
ME25LS01_4Y10TD = 75;
/*
* RP2040_FEATHER_RFM95
* Adafruit Feather RP2040 with RFM95 LoRa Radio RFM95 with SX1272, SSD1306 OLED
* https://www.adafruit.com/product/5714
* https://www.adafruit.com/product/326
* https://www.adafruit.com/product/938
* ^^^ short A0 to switch to I2C address 0x3C
*
*/
RP2040_FEATHER_RFM95 = 76;
/* M5 esp32 based MCU modules with enclosure, TFT and LORA Shields. All Variants (Basic, Core, Fire, Core2, Paper) https://m5stack.com/ */
M5STACK_COREBASIC=77;
M5STACK_CORE2=78;
/*
* ------------------------------------------------------------------------------------------------------------------------------------------
* Reserved ID For developing private Ports. These will show up in live traffic sparsely, so we can use a high number. Keep it within 8 bits.
* ------------------------------------------------------------------------------------------------------------------------------------------
*/
PRIVATE_HW = 255;
}
/*
* Broadcast when a newly powered mesh node wants to find a node num it can use
* Sent from the phone over bluetooth to set the user id for the owner of this node.
* Also sent from nodes to each other when a new node signs on (so all clients can have this info)
* The algorithm is as follows:
* when a node starts up, it broadcasts their user and the normal flow is for all
* other nodes to reply with their User as well (so the new node can build its nodedb)
* If a node ever receives a User (not just the first broadcast) message where
* the sender node number equals our node number, that indicates a collision has
* occurred and the following steps should happen:
* If the receiving node (that was already in the mesh)'s macaddr is LOWER than the
* new User who just tried to sign in: it gets to keep its nodenum.
* We send a broadcast message of OUR User (we use a broadcast so that the other node can
* receive our message, considering we have the same id - it also serves to let
* observers correct their nodedb) - this case is rare so it should be okay.
* If any node receives a User where the macaddr is GTE than their local macaddr,
* they have been vetoed and should pick a new random nodenum (filtering against
* whatever it knows about the nodedb) and rebroadcast their User.
* A few nodenums are reserved and will never be requested:
* 0xff - broadcast
* 0 through 3 - for future use
*/
message User {
/*
* A globally unique ID string for this user.
* In the case of Signal that would mean +16504442323, for the default macaddr derived id it would be !<8 hexidecimal bytes>.
* Note: app developers are encouraged to also use the following standard
* node IDs "^all" (for broadcast), "^local" (for the locally connected node)
*/
string id = 1;
/*
* A full name for this user, i.e. "Kevin Hester"
*/
string long_name = 2;
/*
* A VERY short name, ideally two characters.
* Suitable for a tiny OLED screen
*/
string short_name = 3;
/*
* Deprecated in Meshtastic 2.1.x
* This is the addr of the radio.
* Not populated by the phone, but added by the esp32 when broadcasting
*/
bytes macaddr = 4 [deprecated = true];
/*
* TBEAM, HELTEC, etc...
* Starting in 1.2.11 moved to hw_model enum in the NodeInfo object.
* Apps will still need the string here for older builds
* (so OTA update can find the right image), but if the enum is available it will be used instead.
*/
HardwareModel hw_model = 5;
/*
* In some regions Ham radio operators have different bandwidth limitations than others.
* If this user is a licensed operator, set this flag.
* Also, "long_name" should be their licence number.
*/
bool is_licensed = 6;
/*
* Indicates that the user's role in the mesh
*/
Config.DeviceConfig.Role role = 7;
/*
* The public key of the user's device.
* This is sent out to other nodes on the mesh to allow them to compute a shared secret key.
*/
bytes public_key = 8;
}
/*
* A message used in a traceroute
*/
message RouteDiscovery {
/*
* The list of nodenums this packet has visited so far to the destination.
*/
repeated fixed32 route = 1;
/*
* The list of SNRs (in dB, scaled by 4) in the route towards the destination.
*/
repeated int32 snr_towards = 2;
/*
* The list of nodenums the packet has visited on the way back from the destination.
*/
repeated fixed32 route_back = 3;
/*
* The list of SNRs (in dB, scaled by 4) in the route back from the destination.
*/
repeated int32 snr_back = 4;
}
/*
* A Routing control Data packet handled by the routing module
*/
message Routing {
/*
* A failure in delivering a message (usually used for routing control messages, but might be provided in addition to ack.fail_id to provide
* details on the type of failure).
*/
enum Error {
/*
* This message is not a failure
*/
NONE = 0;
/*
* Our node doesn't have a route to the requested destination anymore.
*/
NO_ROUTE = 1;
/*
* We received a nak while trying to forward on your behalf
*/
GOT_NAK = 2;
/*
* TODO: REPLACE
*/
TIMEOUT = 3;
/*
* No suitable interface could be found for delivering this packet
*/
NO_INTERFACE = 4;
/*
* We reached the max retransmission count (typically for naive flood routing)
*/
MAX_RETRANSMIT = 5;
/*
* No suitable channel was found for sending this packet (i.e. was requested channel index disabled?)
*/
NO_CHANNEL = 6;
/*
* The packet was too big for sending (exceeds interface MTU after encoding)
*/
TOO_LARGE = 7;
/*
* The request had want_response set, the request reached the destination node, but no service on that node wants to send a response
* (possibly due to bad channel permissions)
*/
NO_RESPONSE = 8;
/*
* Cannot send currently because duty cycle regulations will be violated.
*/
DUTY_CYCLE_LIMIT = 9;
/*
* The application layer service on the remote node received your request, but considered your request somehow invalid
*/
BAD_REQUEST = 32;
/*
* The application layer service on the remote node received your request, but considered your request not authorized
* (i.e you did not send the request on the required bound channel)
*/
NOT_AUTHORIZED = 33;
/*
* The client specified a PKI transport, but the node was unable to send the packet using PKI (and did not send the message at all)
*/
PKI_FAILED = 34;
/*
* The receiving node does not have a Public Key to decode with
*/
PKI_UNKNOWN_PUBKEY = 35;
}
oneof variant {
/*
* A route request going from the requester
*/
RouteDiscovery route_request = 1;
/*
* A route reply
*/
RouteDiscovery route_reply = 2;
/*
* A failure in delivering a message (usually used for routing control messages, but might be provided
* in addition to ack.fail_id to provide details on the type of failure).
*/
Error error_reason = 3;
}
}
/*
* (Formerly called SubPacket)
* The payload portion fo a packet, this is the actual bytes that are sent
* inside a radio packet (because from/to are broken out by the comms library)
*/
message Data {
/*
* Formerly named typ and of type Type
*/
PortNum portnum = 1;
/*
* TODO: REPLACE
*/
bytes payload = 2;
/*
* Not normally used, but for testing a sender can request that recipient
* responds in kind (i.e. if it received a position, it should unicast back it's position).
* Note: that if you set this on a broadcast you will receive many replies.
*/
bool want_response = 3;
/*
* The address of the destination node.
* This field is is filled in by the mesh radio device software, application
* layer software should never need it.
* RouteDiscovery messages _must_ populate this.
* Other message types might need to if they are doing multihop routing.
*/
fixed32 dest = 4;
/*
* The address of the original sender for this message.
* This field should _only_ be populated for reliable multihop packets (to keep
* packets small).
*/
fixed32 source = 5;
/*
* Only used in routing or response messages.
* Indicates the original message ID that this message is reporting failure on. (formerly called original_id)
*/
fixed32 request_id = 6;
/*
* If set, this message is intened to be a reply to a previously sent message with the defined id.
*/
fixed32 reply_id = 7;
/*
* Defaults to false. If true, then what is in the payload should be treated as an emoji like giving
* a message a heart or poop emoji.
*/
fixed32 emoji = 8;
/*
* Bitfield for extra flags. First use is to indicate that user approves the packet being uploaded to MQTT.
*/
optional uint32 bitfield = 9;
}
/*
* Waypoint message, used to share arbitrary locations across the mesh
*/
message Waypoint {
/*
* Id of the waypoint
*/
uint32 id = 1;
/*
* latitude_i
*/
optional sfixed32 latitude_i = 2;
/*
* longitude_i
*/
optional sfixed32 longitude_i = 3;
/*
* Time the waypoint is to expire (epoch)
*/
uint32 expire = 4;
/*
* If greater than zero, treat the value as a nodenum only allowing them to update the waypoint.
* If zero, the waypoint is open to be edited by any member of the mesh.
*/
uint32 locked_to = 5;
/*
* Name of the waypoint - max 30 chars
*/
string name = 6;
/*
* Description of the waypoint - max 100 chars
*/
string description = 7;
/*
* Designator icon for the waypoint in the form of a unicode emoji
*/
fixed32 icon = 8;
}
/*
* This message will be proxied over the PhoneAPI for the client to deliver to the MQTT server
*/
message MqttClientProxyMessage {
/*
* The MQTT topic this message will be sent /received on
*/
string topic = 1;
/*
* The actual service envelope payload or text for mqtt pub / sub
*/
oneof payload_variant {
/*
* Bytes
*/
bytes data = 2;
/*
* Text
*/
string text = 3;
}
/*
* Whether the message should be retained (or not)
*/
bool retained = 4;
}
/*
* A packet envelope sent/received over the mesh
* only payload_variant is sent in the payload portion of the LORA packet.
* The other fields are either not sent at all, or sent in the special 16 byte LORA header.
*/
message MeshPacket {
/*
* The priority of this message for sending.
* Higher priorities are sent first (when managing the transmit queue).
* This field is never sent over the air, it is only used internally inside of a local device node.
* API clients (either on the local node or connected directly to the node)
* can set this parameter if necessary.
* (values must be <= 127 to keep protobuf field to one byte in size.
* Detailed background on this field:
* I noticed a funny side effect of lora being so slow: Usually when making
* a protocol there isn’t much need to use message priority to change the order
* of transmission (because interfaces are fairly fast).
* But for lora where packets can take a few seconds each, it is very important
* to make sure that critical packets are sent ASAP.
* In the case of meshtastic that means we want to send protocol acks as soon as possible
* (to prevent unneeded retransmissions), we want routing messages to be sent next,
* then messages marked as reliable and finally 'background' packets like periodic position updates.
* So I bit the bullet and implemented a new (internal - not sent over the air)
* field in MeshPacket called 'priority'.
* And the transmission queue in the router object is now a priority queue.
*/
enum Priority {