29 |
39 | {% endblock %}
40 |
--------------------------------------------------------------------------------
/meshview/templates/index.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block body %}
4 | {% include "search_form.html" %}
5 |
30 | {% for packet in packets %}
31 | {% include 'packet.html' %}
32 | {% else %}
33 | No packets found.
34 | {% endfor %}
35 |
36 |
37 |
38 | See a realtime graph of the network
6 | 7 | 8 | {% endblock %} 9 | -------------------------------------------------------------------------------- /meshview/templates/net.html: -------------------------------------------------------------------------------- 1 | {% extends "base.html" %} 2 | 3 | {% block css %} 4 | #packet_details{ 5 | height: 95vh; 6 | overflow: scroll; 7 | } 8 | {% endblock %} 9 | 10 | {% block body %} 11 |
17 |
27 | {% endblock body %}
28 |
--------------------------------------------------------------------------------
/meshview/templates/net_packet.html:
--------------------------------------------------------------------------------
1 |
18 |
26 |
19 | {% for packet in net_packets %}
20 | {% include 'net_packet.html' %}
21 | {% endfor %}
22 |
23 |
24 |
25 |
2 |
13 |
--------------------------------------------------------------------------------
/meshview/templates/node.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block css %}
4 | #node_info {
5 | height:100%;
6 | }
7 | #map{
8 | height:100%;
9 | min-height: 400px;
10 | }
11 | #packet_details{
12 | height: 95vh;
13 | overflow: scroll;
14 | top: 3em;
15 | }
16 | {% endblock %}
17 |
18 | {% block body %}
19 |
20 | {% include "search_form.html" %}
21 |
22 |
3 | {{packet.from_node.long_name}}
4 | 🔎
5 |
6 |
7 |
12 | -
8 |
{{packet.import_time | format_timestamp}}
9 | {{packet.payload}}
10 |
23 |
72 |
73 | {% if trace %}
74 |
93 | {% endif %}
94 |
95 | {% endblock %}
96 |
--------------------------------------------------------------------------------
/meshview/templates/node_graphs.html:
--------------------------------------------------------------------------------
1 | {% macro graph(name) %}
2 |
29 |
71 |
30 |
58 |
59 |
31 |
54 |
32 | {% if node %}
33 |
53 |
34 | {{node.long_name}} ({{node.node_id|node_id_to_hex}})
35 |
36 |
37 |
47 | {% else %}
48 | -
38 |
- short name 39 |
- {{node.short_name}} 40 |
- hw model 41 |
- {{node.hw_model}} 42 |
- role 43 |
- {{node.role}} 44 |
49 | A NodeInfo has not been seen.
50 |
51 | {% endif %}
52 |
55 |
56 |
57 |
60 |
64 |
65 |
61 | {% include "buttons.html" %}
62 |
63 |
66 | {% include 'packet_list.html' %}
67 |
70 |
68 |
69 |
22 |
39 |
40 |
--------------------------------------------------------------------------------
/meshview/templates/packet.html:
--------------------------------------------------------------------------------
1 |
23 | {{ graph("power") }}
24 | {{ graph("chutil") }}
25 |
26 |
27 | 
28 |
29 |
30 | {{ graph("temperature") }}
31 | {{ graph("humidity") }}
32 | {{ graph("wind_speed") }}
33 | {{ graph("wind_direction") }}
34 |
35 |
36 | {{ graph("power_metrics") }}
37 |
38 |
2 |
3 | {% set from_me = packet.from_node_id == node_id %}
4 | {% set to_me = packet.to_node_id == node_id %}
5 |
6 | {{packet.from_node.long_name}}(
7 | {%- if not from_me -%}
8 |
9 | {%- endif -%}
10 | {{packet.from_node_id|node_id_to_hex}}
11 | {%- if not from_me -%}
12 |
13 | {%- endif -%}
14 | )
15 |
16 | ->
17 |
18 | {{packet.to_node.long_name}}(
19 | {%- if not to_me -%}
20 |
21 | {%- endif -%}
22 | {{packet.to_node_id|node_id_to_hex}}
23 | {%- if not to_me -%}
24 |
25 | {%- endif -%}
26 | )
27 |
28 |
29 |
30 |
35 | ";
18 |
19 |
20 | /*
21 | * Position with static location information only for NodeDBLite
22 | */
23 | message PositionLite {
24 | /*
25 | * The new preferred location encoding, multiply by 1e-7 to get degrees
26 | * in floating point
27 | */
28 | sfixed32 latitude_i = 1;
29 |
30 | /*
31 | * TODO: REPLACE
32 | */
33 | sfixed32 longitude_i = 2;
34 |
35 | /*
36 | * In meters above MSL (but see issue #359)
37 | */
38 | int32 altitude = 3;
39 |
40 | /*
41 | * This is usually not sent over the mesh (to save space), but it is sent
42 | * from the phone so that the local device can set its RTC If it is sent over
43 | * the mesh (because there are devices on the mesh without GPS), it will only
44 | * be sent by devices which has a hardware GPS clock.
45 | * seconds since 1970
46 | */
47 | fixed32 time = 4;
48 |
49 | /*
50 | * TODO: REPLACE
51 | */
52 | Position.LocSource location_source = 5;
53 | }
54 |
55 | message UserLite {
56 | /*
57 | * This is the addr of the radio.
58 | */
59 | bytes macaddr = 1 [deprecated = true];
60 |
61 | /*
62 | * A full name for this user, i.e. "Kevin Hester"
63 | */
64 | string long_name = 2;
65 |
66 | /*
67 | * A VERY short name, ideally two characters.
68 | * Suitable for a tiny OLED screen
69 | */
70 | string short_name = 3;
71 |
72 | /*
73 | * TBEAM, HELTEC, etc...
74 | * Starting in 1.2.11 moved to hw_model enum in the NodeInfo object.
75 | * Apps will still need the string here for older builds
76 | * (so OTA update can find the right image), but if the enum is available it will be used instead.
77 | */
78 | HardwareModel hw_model = 4;
79 |
80 | /*
81 | * In some regions Ham radio operators have different bandwidth limitations than others.
82 | * If this user is a licensed operator, set this flag.
83 | * Also, "long_name" should be their licence number.
84 | */
85 | bool is_licensed = 5;
86 |
87 | /*
88 | * Indicates that the user's role in the mesh
89 | */
90 | Config.DeviceConfig.Role role = 6;
91 |
92 | /*
93 | * The public key of the user's device.
94 | * This is sent out to other nodes on the mesh to allow them to compute a shared secret key.
95 | */
96 | bytes public_key = 7;
97 | }
98 |
99 | message NodeInfoLite {
100 | /*
101 | * The node number
102 | */
103 | uint32 num = 1;
104 |
105 | /*
106 | * The user info for this node
107 | */
108 | UserLite user = 2;
109 |
110 | /*
111 | * This position data. Note: before 1.2.14 we would also store the last time we've heard from this node in position.time, that is no longer true.
112 | * Position.time now indicates the last time we received a POSITION from that node.
113 | */
114 | PositionLite position = 3;
115 |
116 | /*
117 | * Returns the Signal-to-noise ratio (SNR) of the last received message,
118 | * as measured by the receiver. Return SNR of the last received message in dB
119 | */
120 | float snr = 4;
121 |
122 | /*
123 | * Set to indicate the last time we received a packet from this node
124 | */
125 | fixed32 last_heard = 5;
126 | /*
127 | * The latest device metrics for the node.
128 | */
129 | DeviceMetrics device_metrics = 6;
130 |
131 | /*
132 | * local channel index we heard that node on. Only populated if its not the default channel.
133 | */
134 | uint32 channel = 7;
135 |
136 | /*
137 | * True if we witnessed the node over MQTT instead of LoRA transport
138 | */
139 | bool via_mqtt = 8;
140 |
141 | /*
142 | * Number of hops away from us this node is (0 if adjacent)
143 | */
144 | uint32 hops_away = 9;
145 |
146 | /*
147 | * True if node is in our favorites list
148 | * Persists between NodeDB internal clean ups
149 | */
150 | bool is_favorite = 10;
151 | }
152 |
153 | /*
154 | * Font sizes for the device screen
155 | */
156 | enum ScreenFonts {
157 | /*
158 | * TODO: REPLACE
159 | */
160 | FONT_SMALL = 0;
161 |
162 | /*
163 | * TODO: REPLACE
164 | */
165 | FONT_MEDIUM = 1;
166 |
167 | /*
168 | * TODO: REPLACE
169 | */
170 | FONT_LARGE = 2;
171 | }
172 |
173 |
174 | /*
175 | * This message is never sent over the wire, but it is used for serializing DB
176 | * state to flash in the device code
177 | * FIXME, since we write this each time we enter deep sleep (and have infinite
178 | * flash) it would be better to use some sort of append only data structure for
179 | * the receive queue and use the preferences store for the other stuff
180 | */
181 | message DeviceState {
182 | /*
183 | * Read only settings/info about this node
184 | */
185 | MyNodeInfo my_node = 2;
186 |
187 | /*
188 | * My owner info
189 | */
190 | User owner = 3;
191 |
192 | /*
193 | * Received packets saved for delivery to the phone
194 | */
195 | repeated MeshPacket receive_queue = 5;
196 |
197 | /*
198 | * A version integer used to invalidate old save files when we make
199 | * incompatible changes This integer is set at build time and is private to
200 | * NodeDB.cpp in the device code.
201 | */
202 | uint32 version = 8;
203 |
204 | /*
205 | * We keep the last received text message (only) stored in the device flash,
206 | * so we can show it on the screen.
207 | * Might be null
208 | */
209 | MeshPacket rx_text_message = 7;
210 |
211 | /*
212 | * Used only during development.
213 | * Indicates developer is testing and changes should never be saved to flash.
214 | * Deprecated in 2.3.1
215 | */
216 | bool no_save = 9 [deprecated = true];
217 |
218 | /*
219 | * Some GPS receivers seem to have bogus settings from the factory, so we always do one factory reset.
220 | */
221 | bool did_gps_reset = 11;
222 |
223 | /*
224 | * We keep the last received waypoint stored in the device flash,
225 | * so we can show it on the screen.
226 | * Might be null
227 | */
228 | MeshPacket rx_waypoint = 12;
229 |
230 | /*
231 | * The mesh's nodes with their available gpio pins for RemoteHardware module
232 | */
233 | repeated NodeRemoteHardwarePin node_remote_hardware_pins = 13;
234 |
235 | /*
236 | * New lite version of NodeDB to decrease memory footprint
237 | */
238 | repeated NodeInfoLite node_db_lite = 14 [(nanopb).callback_datatype = "std::vector"];
239 | }
240 |
241 | /*
242 | * The on-disk saved channels
243 | */
244 | message ChannelFile {
245 | /*
246 | * The channels our node knows about
247 | */
248 | repeated Channel channels = 1;
249 |
250 | /*
251 | * A version integer used to invalidate old save files when we make
252 | * incompatible changes This integer is set at build time and is private to
253 | * NodeDB.cpp in the device code.
254 | */
255 | uint32 version = 2;
256 | }
257 |
258 | /*
259 | * This can be used for customizing the firmware distribution. If populated,
260 | * show a secondary bootup screen with custom logo and text for 2.5 seconds.
261 | */
262 | message OEMStore {
263 | /*
264 | * The Logo width in Px
265 | */
266 | uint32 oem_icon_width = 1;
267 |
268 | /*
269 | * The Logo height in Px
270 | */
271 | uint32 oem_icon_height = 2;
272 |
273 | /*
274 | * The Logo in XBM bytechar format
275 | */
276 | bytes oem_icon_bits = 3;
277 |
278 | /*
279 | * Use this font for the OEM text.
280 | */
281 | ScreenFonts oem_font = 4;
282 |
283 | /*
284 | * Use this font for the OEM text.
285 | */
286 | string oem_text = 5;
287 |
288 | /*
289 | * The default device encryption key, 16 or 32 byte
290 | */
291 | bytes oem_aes_key = 6;
292 |
293 | /*
294 | * A Preset LocalConfig to apply during factory reset
295 | */
296 | LocalConfig oem_local_config = 7;
297 |
298 | /*
299 | * A Preset LocalModuleConfig to apply during factory reset
300 | */
301 | LocalModuleConfig oem_local_module_config = 8;
302 | }
303 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/localonly.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | import "meshtastic/config.proto";
6 | import "meshtastic/module_config.proto";
7 |
8 | option csharp_namespace = "Meshtastic.Protobufs";
9 | option go_package = "github.com/meshtastic/go/generated";
10 | option java_outer_classname = "LocalOnlyProtos";
11 | option java_package = "com.geeksville.mesh";
12 | option swift_prefix = "";
13 |
14 | /*
15 | * Protobuf structures common to apponly.proto and deviceonly.proto
16 | * This is never sent over the wire, only for local use
17 | */
18 |
19 | message LocalConfig {
20 | /*
21 | * The part of the config that is specific to the Device
22 | */
23 | Config.DeviceConfig device = 1;
24 |
25 | /*
26 | * The part of the config that is specific to the GPS Position
27 | */
28 | Config.PositionConfig position = 2;
29 |
30 | /*
31 | * The part of the config that is specific to the Power settings
32 | */
33 | Config.PowerConfig power = 3;
34 |
35 | /*
36 | * The part of the config that is specific to the Wifi Settings
37 | */
38 | Config.NetworkConfig network = 4;
39 |
40 | /*
41 | * The part of the config that is specific to the Display
42 | */
43 | Config.DisplayConfig display = 5;
44 |
45 | /*
46 | * The part of the config that is specific to the Lora Radio
47 | */
48 | Config.LoRaConfig lora = 6;
49 |
50 | /*
51 | * The part of the config that is specific to the Bluetooth settings
52 | */
53 | Config.BluetoothConfig bluetooth = 7;
54 |
55 | /*
56 | * A version integer used to invalidate old save files when we make
57 | * incompatible changes This integer is set at build time and is private to
58 | * NodeDB.cpp in the device code.
59 | */
60 | uint32 version = 8;
61 |
62 | /*
63 | * The part of the config that is specific to Security settings
64 | */
65 | Config.SecurityConfig security = 9;
66 | }
67 |
68 | message LocalModuleConfig {
69 | /*
70 | * The part of the config that is specific to the MQTT module
71 | */
72 | ModuleConfig.MQTTConfig mqtt = 1;
73 |
74 | /*
75 | * The part of the config that is specific to the Serial module
76 | */
77 | ModuleConfig.SerialConfig serial = 2;
78 |
79 | /*
80 | * The part of the config that is specific to the ExternalNotification module
81 | */
82 | ModuleConfig.ExternalNotificationConfig external_notification = 3;
83 |
84 | /*
85 | * The part of the config that is specific to the Store & Forward module
86 | */
87 | ModuleConfig.StoreForwardConfig store_forward = 4;
88 |
89 | /*
90 | * The part of the config that is specific to the RangeTest module
91 | */
92 | ModuleConfig.RangeTestConfig range_test = 5;
93 |
94 | /*
95 | * The part of the config that is specific to the Telemetry module
96 | */
97 | ModuleConfig.TelemetryConfig telemetry = 6;
98 |
99 | /*
100 | * The part of the config that is specific to the Canned Message module
101 | */
102 | ModuleConfig.CannedMessageConfig canned_message = 7;
103 |
104 | /*
105 | * The part of the config that is specific to the Audio module
106 | */
107 | ModuleConfig.AudioConfig audio = 9;
108 |
109 | /*
110 | * The part of the config that is specific to the Remote Hardware module
111 | */
112 | ModuleConfig.RemoteHardwareConfig remote_hardware = 10;
113 |
114 | /*
115 | * The part of the config that is specific to the Neighbor Info module
116 | */
117 | ModuleConfig.NeighborInfoConfig neighbor_info = 11;
118 |
119 | /*
120 | * The part of the config that is specific to the Ambient Lighting module
121 | */
122 | ModuleConfig.AmbientLightingConfig ambient_lighting = 12;
123 |
124 | /*
125 | * The part of the config that is specific to the Detection Sensor module
126 | */
127 | ModuleConfig.DetectionSensorConfig detection_sensor = 13;
128 |
129 | /*
130 | * Paxcounter Config
131 | */
132 | ModuleConfig.PaxcounterConfig paxcounter = 14;
133 |
134 | /*
135 | * A version integer used to invalidate old save files when we make
136 | * incompatible changes This integer is set at build time and is private to
137 | * NodeDB.cpp in the device code.
138 | */
139 | uint32 version = 8;
140 | }
141 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/mesh.options:
--------------------------------------------------------------------------------
1 | # options for nanopb
2 | # https://jpa.kapsi.fi/nanopb/docs/reference.html#proto-file-options
3 |
4 | *macaddr max_size:6 fixed_length:true # macaddrs
5 | *id max_size:16 # node id strings
6 | *public_key max_size:32 # public key
7 |
8 | *User.long_name max_size:40
9 | *User.short_name max_size:5
10 |
11 | *RouteDiscovery.route max_count:8
12 | *RouteDiscovery.snr_towards max_count:8
13 | *RouteDiscovery.snr_towards int_size:8
14 | *RouteDiscovery.route_back max_count:8
15 | *RouteDiscovery.snr_back max_count:8
16 | *RouteDiscovery.snr_back int_size:8
17 |
18 | # note: this payload length is ONLY the bytes that are sent inside of the Data protobuf (excluding protobuf overhead). The 16 byte header is
19 | # outside of this envelope
20 | *Data.payload max_size:237
21 |
22 | *NodeInfo.channel int_size:8
23 | *NodeInfo.hops_away int_size:8
24 |
25 | # Big enough for 1.2.28.568032c-d
26 | *MyNodeInfo.firmware_version max_size:18
27 |
28 | *MyNodeInfo.air_period_tx max_count:8
29 | *MyNodeInfo.air_period_rx max_count:8
30 |
31 | # Note: the actual limit (because of header bytes) on the size of encrypted payloads is 251 bytes, but I use 256
32 | # here because we might need to fill with zeros for padding to encryption block size (16 bytes per block)
33 | *MeshPacket.encrypted max_size:256
34 | *MeshPacket.payload_variant anonymous_oneof:true
35 | *MeshPacket.hop_limit int_size:8
36 | *MeshPacket.hop_start int_size:8
37 | *MeshPacket.channel int_size:8
38 |
39 | *QueueStatus.res int_size:8
40 | *QueueStatus.free int_size:8
41 | *QueueStatus.maxlen int_size:8
42 |
43 | *ToRadio.payload_variant anonymous_oneof:true
44 |
45 | *FromRadio.payload_variant anonymous_oneof:true
46 |
47 | *Routing.variant anonymous_oneof:true
48 |
49 | *LogRecord.message max_size:384
50 | *LogRecord.source max_size:32
51 |
52 | *FileInfo.file_name max_size:228
53 |
54 | *ClientNotification.message max_size:400
55 |
56 | # MyMessage.name max_size:40
57 | # or fixed_length or fixed_count, or max_count
58 |
59 | #This value may want to be a few bytes smaller to compensate for the parent fields.
60 | *Compressed.data max_size:237
61 |
62 | *Waypoint.name max_size:30
63 | *Waypoint.description max_size:100
64 |
65 | *NeighborInfo.neighbors max_count:10
66 |
67 | *DeviceMetadata.firmware_version max_size:18
68 |
69 | *MqttClientProxyMessage.topic max_size:60
70 | *MqttClientProxyMessage.data max_size:435
71 | *MqttClientProxyMessage.text max_size:435
72 |
73 | *ChunkedPayload.chunk_count int_size:16
74 | *ChunkedPayload.chunk_index int_size:16
75 | *ChunkedPayload.payload_chunk max_size:228
--------------------------------------------------------------------------------
/proto_def/meshtastic/module_config.options:
--------------------------------------------------------------------------------
1 | *CannedMessageConfig.allow_input_source max_size:16
2 |
3 | *MQTTConfig.address max_size:64
4 | *MQTTConfig.username max_size:64
5 | *MQTTConfig.password max_size:64
6 | *MQTTConfig.root max_size:32
7 |
8 | *AudioConfig.ptt_pin int_size:8
9 | *AudioConfig.i2s_ws int_size:8
10 | *AudioConfig.i2s_sd int_size:8
11 | *AudioConfig.i2s_din int_size:8
12 | *AudioConfig.i2s_sck int_size:8
13 |
14 | *ExternalNotificationConfig.output_vibra int_size:8
15 | *ExternalNotificationConfig.output_buzzer int_size:8
16 | *ExternalNotificationConfig.nag_timeout int_size:16
17 |
18 | *RemoteHardwareConfig.available_pins max_count:4
19 | *RemoteHardwarePin.name max_size:15
20 | *RemoteHardwarePin.gpio_pin int_size:8
21 |
22 | *AmbientLightingConfig.current int_size:8
23 | *AmbientLightingConfig.red int_size:8
24 | *AmbientLightingConfig.green int_size:8
25 | *AmbientLightingConfig.blue int_size:8
26 |
27 | *DetectionSensorConfig.monitor_pin int_size:8
28 | *DetectionSensorConfig.name max_size:20
29 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/mqtt.options:
--------------------------------------------------------------------------------
1 | *ServiceEnvelope.packet type:FT_POINTER
2 | *ServiceEnvelope.channel_id type:FT_POINTER
3 | *ServiceEnvelope.gateway_id type:FT_POINTER
4 |
5 | *MapReport.long_name max_size:40
6 | *MapReport.short_name max_size:5
7 | *MapReport.firmware_version max_size:18
8 | *MapReport.num_online_local_nodes int_size:16
--------------------------------------------------------------------------------
/proto_def/meshtastic/mqtt.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | import "meshtastic/config.proto";
6 | import "meshtastic/mesh.proto";
7 |
8 | option csharp_namespace = "Meshtastic.Protobufs";
9 | option go_package = "github.com/meshtastic/go/generated";
10 | option java_outer_classname = "MQTTProtos";
11 | option java_package = "com.geeksville.mesh";
12 | option swift_prefix = "";
13 |
14 | /*
15 | * This message wraps a MeshPacket with extra metadata about the sender and how it arrived.
16 | */
17 | message ServiceEnvelope {
18 | /*
19 | * The (probably encrypted) packet
20 | */
21 | MeshPacket packet = 1;
22 |
23 | /*
24 | * The global channel ID it was sent on
25 | */
26 | string channel_id = 2;
27 |
28 | /*
29 | * The sending gateway node ID. Can we use this to authenticate/prevent fake
30 | * nodeid impersonation for senders? - i.e. use gateway/mesh id (which is authenticated) + local node id as
31 | * the globally trusted nodenum
32 | */
33 | string gateway_id = 3;
34 | }
35 |
36 | /*
37 | * Information about a node intended to be reported unencrypted to a map using MQTT.
38 | */
39 | message MapReport {
40 | /*
41 | * A full name for this user, i.e. "Kevin Hester"
42 | */
43 | string long_name = 1;
44 |
45 | /*
46 | * A VERY short name, ideally two characters.
47 | * Suitable for a tiny OLED screen
48 | */
49 | string short_name = 2;
50 |
51 | /*
52 | * Role of the node that applies specific settings for a particular use-case
53 | */
54 | Config.DeviceConfig.Role role = 3;
55 |
56 | /*
57 | * Hardware model of the node, i.e. T-Beam, Heltec V3, etc...
58 | */
59 | HardwareModel hw_model = 4;
60 |
61 | /*
62 | * Device firmware version string
63 | */
64 | string firmware_version = 5;
65 |
66 | /*
67 | * The region code for the radio (US, CN, EU433, etc...)
68 | */
69 | Config.LoRaConfig.RegionCode region = 6;
70 |
71 | /*
72 | * Modem preset used by the radio (LongFast, MediumSlow, etc...)
73 | */
74 | Config.LoRaConfig.ModemPreset modem_preset = 7;
75 |
76 | /*
77 | * Whether the node has a channel with default PSK and name (LongFast, MediumSlow, etc...)
78 | * and it uses the default frequency slot given the region and modem preset.
79 | */
80 | bool has_default_channel = 8;
81 |
82 | /*
83 | * Latitude: multiply by 1e-7 to get degrees in floating point
84 | */
85 | sfixed32 latitude_i = 9;
86 |
87 | /*
88 | * Longitude: multiply by 1e-7 to get degrees in floating point
89 | */
90 | sfixed32 longitude_i = 10;
91 |
92 | /*
93 | * Altitude in meters above MSL
94 | */
95 | int32 altitude = 11;
96 |
97 | /*
98 | * Indicates the bits of precision for latitude and longitude set by the sending node
99 | */
100 | uint32 position_precision = 12;
101 |
102 | /*
103 | * Number of online nodes (heard in the last 2 hours) this node has in its list that were received locally (not via MQTT)
104 | */
105 | uint32 num_online_local_nodes = 13;
106 | }
107 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/paxcount.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | option csharp_namespace = "Meshtastic.Protobufs";
6 | option go_package = "github.com/meshtastic/go/generated";
7 | option java_outer_classname = "PaxcountProtos";
8 | option java_package = "com.geeksville.mesh";
9 | option swift_prefix = "";
10 |
11 | /*
12 | * TODO: REPLACE
13 | */
14 | message Paxcount {
15 | /*
16 | * seen Wifi devices
17 | */
18 | uint32 wifi = 1;
19 |
20 | /*
21 | * Seen BLE devices
22 | */
23 | uint32 ble = 2;
24 |
25 | /*
26 | * Uptime in seconds
27 | */
28 | uint32 uptime = 3;
29 | }
30 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/portnums.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | option csharp_namespace = "Meshtastic.Protobufs";
6 | option go_package = "github.com/meshtastic/go/generated";
7 | option java_outer_classname = "Portnums";
8 | option java_package = "com.geeksville.mesh";
9 | option swift_prefix = "";
10 |
11 | /*
12 | * For any new 'apps' that run on the device or via sister apps on phones/PCs they should pick and use a
13 | * unique 'portnum' for their application.
14 | * If you are making a new app using meshtastic, please send in a pull request to add your 'portnum' to this
15 | * master table.
16 | * PortNums should be assigned in the following range:
17 | * 0-63 Core Meshtastic use, do not use for third party apps
18 | * 64-127 Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application
19 | * 256-511 Use one of these portnums for your private applications that you don't want to register publically
20 | * All other values are reserved.
21 | * Note: This was formerly a Type enum named 'typ' with the same id #
22 | * We have change to this 'portnum' based scheme for specifying app handlers for particular payloads.
23 | * This change is backwards compatible by treating the legacy OPAQUE/CLEAR_TEXT values identically.
24 | */
25 | enum PortNum {
26 | /*
27 | * Deprecated: do not use in new code (formerly called OPAQUE)
28 | * A message sent from a device outside of the mesh, in a form the mesh does not understand
29 | * NOTE: This must be 0, because it is documented in IMeshService.aidl to be so
30 | * ENCODING: binary undefined
31 | */
32 | UNKNOWN_APP = 0;
33 |
34 | /*
35 | * A simple UTF-8 text message, which even the little micros in the mesh
36 | * can understand and show on their screen eventually in some circumstances
37 | * even signal might send messages in this form (see below)
38 | * ENCODING: UTF-8 Plaintext (?)
39 | */
40 | TEXT_MESSAGE_APP = 1;
41 |
42 | /*
43 | * Reserved for built-in GPIO/example app.
44 | * See remote_hardware.proto/HardwareMessage for details on the message sent/received to this port number
45 | * ENCODING: Protobuf
46 | */
47 | REMOTE_HARDWARE_APP = 2;
48 |
49 | /*
50 | * The built-in position messaging app.
51 | * Payload is a Position message.
52 | * ENCODING: Protobuf
53 | */
54 | POSITION_APP = 3;
55 |
56 | /*
57 | * The built-in user info app.
58 | * Payload is a User message.
59 | * ENCODING: Protobuf
60 | */
61 | NODEINFO_APP = 4;
62 |
63 | /*
64 | * Protocol control packets for mesh protocol use.
65 | * Payload is a Routing message.
66 | * ENCODING: Protobuf
67 | */
68 | ROUTING_APP = 5;
69 |
70 | /*
71 | * Admin control packets.
72 | * Payload is a AdminMessage message.
73 | * ENCODING: Protobuf
74 | */
75 | ADMIN_APP = 6;
76 |
77 | /*
78 | * Compressed TEXT_MESSAGE payloads.
79 | * ENCODING: UTF-8 Plaintext (?) with Unishox2 Compression
80 | * NOTE: The Device Firmware converts a TEXT_MESSAGE_APP to TEXT_MESSAGE_COMPRESSED_APP if the compressed
81 | * payload is shorter. There's no need for app developers to do this themselves. Also the firmware will decompress
82 | * any incoming TEXT_MESSAGE_COMPRESSED_APP payload and convert to TEXT_MESSAGE_APP.
83 | */
84 | TEXT_MESSAGE_COMPRESSED_APP = 7;
85 |
86 | /*
87 | * Waypoint payloads.
88 | * Payload is a Waypoint message.
89 | * ENCODING: Protobuf
90 | */
91 | WAYPOINT_APP = 8;
92 |
93 | /*
94 | * Audio Payloads.
95 | * Encapsulated codec2 packets. On 2.4 GHZ Bandwidths only for now
96 | * ENCODING: codec2 audio frames
97 | * NOTE: audio frames contain a 3 byte header (0xc0 0xde 0xc2) and a one byte marker for the decompressed bitrate.
98 | * This marker comes from the 'moduleConfig.audio.bitrate' enum minus one.
99 | */
100 | AUDIO_APP = 9;
101 |
102 | /*
103 | * Same as Text Message but originating from Detection Sensor Module.
104 | * NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9
105 | */
106 | DETECTION_SENSOR_APP = 10;
107 |
108 | /*
109 | * Provides a 'ping' service that replies to any packet it receives.
110 | * Also serves as a small example module.
111 | * ENCODING: ASCII Plaintext
112 | */
113 | REPLY_APP = 32;
114 |
115 | /*
116 | * Used for the python IP tunnel feature
117 | * ENCODING: IP Packet. Handled by the python API, firmware ignores this one and pases on.
118 | */
119 | IP_TUNNEL_APP = 33;
120 |
121 | /*
122 | * Paxcounter lib included in the firmware
123 | * ENCODING: protobuf
124 | */
125 | PAXCOUNTER_APP = 34;
126 |
127 | /*
128 | * Provides a hardware serial interface to send and receive from the Meshtastic network.
129 | * Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic
130 | * network is forwarded to the RX pin while sending a packet to TX will go out to the Mesh network.
131 | * Maximum packet size of 240 bytes.
132 | * Module is disabled by default can be turned on by setting SERIAL_MODULE_ENABLED = 1 in SerialPlugh.cpp.
133 | * ENCODING: binary undefined
134 | */
135 | SERIAL_APP = 64;
136 |
137 | /*
138 | * STORE_FORWARD_APP (Work in Progress)
139 | * Maintained by Jm Casler (MC Hamster) : jm@casler.org
140 | * ENCODING: Protobuf
141 | */
142 | STORE_FORWARD_APP = 65;
143 |
144 | /*
145 | * Optional port for messages for the range test module.
146 | * ENCODING: ASCII Plaintext
147 | * NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9
148 | */
149 | RANGE_TEST_APP = 66;
150 |
151 | /*
152 | * Provides a format to send and receive telemetry data from the Meshtastic network.
153 | * Maintained by Charles Crossan (crossan007) : crossan007@gmail.com
154 | * ENCODING: Protobuf
155 | */
156 | TELEMETRY_APP = 67;
157 |
158 | /*
159 | * Experimental tools for estimating node position without a GPS
160 | * Maintained by Github user a-f-G-U-C (a Meshtastic contributor)
161 | * Project files at https://github.com/a-f-G-U-C/Meshtastic-ZPS
162 | * ENCODING: arrays of int64 fields
163 | */
164 | ZPS_APP = 68;
165 |
166 | /*
167 | * Used to let multiple instances of Linux native applications communicate
168 | * as if they did using their LoRa chip.
169 | * Maintained by GitHub user GUVWAF.
170 | * Project files at https://github.com/GUVWAF/Meshtasticator
171 | * ENCODING: Protobuf (?)
172 | */
173 | SIMULATOR_APP = 69;
174 |
175 | /*
176 | * Provides a traceroute functionality to show the route a packet towards
177 | * a certain destination would take on the mesh. Contains a RouteDiscovery message as payload.
178 | * ENCODING: Protobuf
179 | */
180 | TRACEROUTE_APP = 70;
181 |
182 | /*
183 | * Aggregates edge info for the network by sending out a list of each node's neighbors
184 | * ENCODING: Protobuf
185 | */
186 | NEIGHBORINFO_APP = 71;
187 |
188 | /*
189 | * ATAK Plugin
190 | * Portnum for payloads from the official Meshtastic ATAK plugin
191 | */
192 | ATAK_PLUGIN = 72;
193 |
194 | /*
195 | * Provides unencrypted information about a node for consumption by a map via MQTT
196 | */
197 | MAP_REPORT_APP = 73;
198 |
199 | /*
200 | * PowerStress based monitoring support (for automated power consumption testing)
201 | */
202 | POWERSTRESS_APP = 74;
203 |
204 | /*
205 | * Private applications should use portnums >= 256.
206 | * To simplify initial development and testing you can use "PRIVATE_APP"
207 | * in your code without needing to rebuild protobuf files (via [regen-protos.sh](https://github.com/meshtastic/firmware/blob/master/bin/regen-protos.sh))
208 | */
209 | PRIVATE_APP = 256;
210 |
211 | /*
212 | * ATAK Forwarder Module https://github.com/paulmandal/atak-forwarder
213 | * ENCODING: libcotshrink
214 | */
215 | ATAK_FORWARDER = 257;
216 |
217 | /*
218 | * Currently we limit port nums to no higher than this value
219 | */
220 | MAX = 511;
221 | }
--------------------------------------------------------------------------------
/proto_def/meshtastic/powermon.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | option csharp_namespace = "Meshtastic.Protobufs";
4 | option go_package = "github.com/meshtastic/go/generated";
5 | option java_outer_classname = "PowerMonProtos";
6 | option java_package = "com.geeksville.mesh";
7 | option swift_prefix = "";
8 |
9 | package meshtastic;
10 |
11 | /* Note: There are no 'PowerMon' messages normally in use (PowerMons are sent only as structured logs - slogs).
12 | But we wrap our State enum in this message to effectively nest a namespace (without our linter yelling at us)
13 | */
14 | message PowerMon {
15 | /* Any significant power changing event in meshtastic should be tagged with a powermon state transition.
16 | If you are making new meshtastic features feel free to add new entries at the end of this definition.
17 | */
18 | enum State {
19 | None = 0;
20 |
21 | CPU_DeepSleep = 0x01;
22 | CPU_LightSleep = 0x02;
23 |
24 | /*
25 | The external Vext1 power is on. Many boards have auxillary power rails that the CPU turns on only
26 | occasionally. In cases where that rail has multiple devices on it we usually want to have logging on
27 | the state of that rail as an independent record.
28 | For instance on the Heltec Tracker 1.1 board, this rail is the power source for the GPS and screen.
29 |
30 | The log messages will be short and complete (see PowerMon.Event in the protobufs for details).
31 | something like "S:PM:C,0x00001234,REASON" where the hex number is the bitmask of all current states.
32 | (We use a bitmask for states so that if a log message gets lost it won't be fatal)
33 | */
34 | Vext1_On = 0x04;
35 |
36 | Lora_RXOn = 0x08;
37 | Lora_TXOn = 0x10;
38 | Lora_RXActive = 0x20;
39 | BT_On = 0x40;
40 | LED_On = 0x80;
41 |
42 | Screen_On = 0x100;
43 | Screen_Drawing = 0x200;
44 | Wifi_On = 0x400;
45 |
46 | /*
47 | GPS is actively trying to find our location
48 | See GPSPowerState for more details
49 | */
50 | GPS_Active = 0x800;
51 | }
52 | }
53 |
54 |
55 | /*
56 | * PowerStress testing support via the C++ PowerStress module
57 | */
58 | message PowerStressMessage {
59 | /*
60 | * What operation would we like the UUT to perform.
61 | note: senders should probably set want_response in their request packets, so that they can know when the state
62 | machine has started processing their request
63 | */
64 | enum Opcode {
65 | /*
66 | * Unset/unused
67 | */
68 | UNSET = 0;
69 |
70 | PRINT_INFO = 1; // Print board version slog and send an ack that we are alive and ready to process commands
71 | FORCE_QUIET = 2; // Try to turn off all automatic processing of packets, screen, sleeping, etc (to make it easier to measure in isolation)
72 | END_QUIET = 3; // Stop powerstress processing - probably by just rebooting the board
73 |
74 | SCREEN_ON = 16; // Turn the screen on
75 | SCREEN_OFF = 17; // Turn the screen off
76 |
77 | CPU_IDLE = 32; // Let the CPU run but we assume mostly idling for num_seconds
78 | CPU_DEEPSLEEP = 33; // Force deep sleep for FIXME seconds
79 | CPU_FULLON = 34; // Spin the CPU as fast as possible for num_seconds
80 |
81 | LED_ON = 48; // Turn the LED on for num_seconds (and leave it on - for baseline power measurement purposes)
82 | LED_OFF = 49; // Force the LED off for num_seconds
83 |
84 | LORA_OFF = 64; // Completely turn off the LORA radio for num_seconds
85 | LORA_TX = 65; // Send Lora packets for num_seconds
86 | LORA_RX = 66; // Receive Lora packets for num_seconds (node will be mostly just listening, unless an external agent is helping stress this by sending packets on the current channel)
87 |
88 | BT_OFF = 80; // Turn off the BT radio for num_seconds
89 | BT_ON = 81; // Turn on the BT radio for num_seconds
90 |
91 | WIFI_OFF = 96; // Turn off the WIFI radio for num_seconds
92 | WIFI_ON = 97; // Turn on the WIFI radio for num_seconds
93 |
94 | GPS_OFF = 112; // Turn off the GPS radio for num_seconds
95 | GPS_ON = 113; // Turn on the GPS radio for num_seconds
96 | }
97 |
98 | /*
99 | * What type of HardwareMessage is this?
100 | */
101 | Opcode cmd = 1;
102 |
103 | float num_seconds = 2;
104 | }
--------------------------------------------------------------------------------
/proto_def/meshtastic/remote_hardware.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | option csharp_namespace = "Meshtastic.Protobufs";
6 | option go_package = "github.com/meshtastic/go/generated";
7 | option java_outer_classname = "RemoteHardware";
8 | option java_package = "com.geeksville.mesh";
9 | option swift_prefix = "";
10 |
11 | /*
12 | * An example app to show off the module system. This message is used for
13 | * REMOTE_HARDWARE_APP PortNums.
14 | * Also provides easy remote access to any GPIO.
15 | * In the future other remote hardware operations can be added based on user interest
16 | * (i.e. serial output, spi/i2c input/output).
17 | * FIXME - currently this feature is turned on by default which is dangerous
18 | * because no security yet (beyond the channel mechanism).
19 | * It should be off by default and then protected based on some TBD mechanism
20 | * (a special channel once multichannel support is included?)
21 | */
22 | message HardwareMessage {
23 | /*
24 | * TODO: REPLACE
25 | */
26 | enum Type {
27 | /*
28 | * Unset/unused
29 | */
30 | UNSET = 0;
31 |
32 | /*
33 | * Set gpio gpios based on gpio_mask/gpio_value
34 | */
35 | WRITE_GPIOS = 1;
36 |
37 | /*
38 | * We are now interested in watching the gpio_mask gpios.
39 | * If the selected gpios change, please broadcast GPIOS_CHANGED.
40 | * Will implicitly change the gpios requested to be INPUT gpios.
41 | */
42 | WATCH_GPIOS = 2;
43 |
44 | /*
45 | * The gpios listed in gpio_mask have changed, the new values are listed in gpio_value
46 | */
47 | GPIOS_CHANGED = 3;
48 |
49 | /*
50 | * Read the gpios specified in gpio_mask, send back a READ_GPIOS_REPLY reply with gpio_value populated
51 | */
52 | READ_GPIOS = 4;
53 |
54 | /*
55 | * A reply to READ_GPIOS. gpio_mask and gpio_value will be populated
56 | */
57 | READ_GPIOS_REPLY = 5;
58 | }
59 |
60 | /*
61 | * What type of HardwareMessage is this?
62 | */
63 | Type type = 1;
64 |
65 | /*
66 | * What gpios are we changing. Not used for all MessageTypes, see MessageType for details
67 | */
68 | uint64 gpio_mask = 2;
69 |
70 | /*
71 | * For gpios that were listed in gpio_mask as valid, what are the signal levels for those gpios.
72 | * Not used for all MessageTypes, see MessageType for details
73 | */
74 | uint64 gpio_value = 3;
75 | }
76 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/rtttl.options:
--------------------------------------------------------------------------------
1 | *RTTTLConfig.ringtone max_size:230
2 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/rtttl.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | option csharp_namespace = "Meshtastic.Protobufs";
6 | option go_package = "github.com/meshtastic/go/generated";
7 | option java_outer_classname = "RTTTLConfigProtos";
8 | option java_package = "com.geeksville.mesh";
9 | option swift_prefix = "";
10 |
11 | /*
12 | * Canned message module configuration.
13 | */
14 | message RTTTLConfig {
15 | /*
16 | * Ringtone for PWM Buzzer in RTTTL Format.
17 | */
18 | string ringtone = 1;
19 | }
20 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/storeforward.options:
--------------------------------------------------------------------------------
1 | *StoreAndForward.text max_size:237
--------------------------------------------------------------------------------
/proto_def/meshtastic/storeforward.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | option csharp_namespace = "Meshtastic.Protobufs";
6 | option go_package = "github.com/meshtastic/go/generated";
7 | option java_outer_classname = "StoreAndForwardProtos";
8 | option java_package = "com.geeksville.mesh";
9 | option swift_prefix = "";
10 |
11 | /*
12 | * TODO: REPLACE
13 | */
14 | message StoreAndForward {
15 | /*
16 | * 001 - 063 = From Router
17 | * 064 - 127 = From Client
18 | */
19 | enum RequestResponse {
20 | /*
21 | * Unset/unused
22 | */
23 | UNSET = 0;
24 |
25 | /*
26 | * Router is an in error state.
27 | */
28 | ROUTER_ERROR = 1;
29 |
30 | /*
31 | * Router heartbeat
32 | */
33 | ROUTER_HEARTBEAT = 2;
34 |
35 | /*
36 | * Router has requested the client respond. This can work as a
37 | * "are you there" message.
38 | */
39 | ROUTER_PING = 3;
40 |
41 | /*
42 | * The response to a "Ping"
43 | */
44 | ROUTER_PONG = 4;
45 |
46 | /*
47 | * Router is currently busy. Please try again later.
48 | */
49 | ROUTER_BUSY = 5;
50 |
51 | /*
52 | * Router is responding to a request for history.
53 | */
54 | ROUTER_HISTORY = 6;
55 |
56 | /*
57 | * Router is responding to a request for stats.
58 | */
59 | ROUTER_STATS = 7;
60 |
61 | /*
62 | * Router sends a text message from its history that was a direct message.
63 | */
64 | ROUTER_TEXT_DIRECT = 8;
65 |
66 | /*
67 | * Router sends a text message from its history that was a broadcast.
68 | */
69 | ROUTER_TEXT_BROADCAST = 9;
70 |
71 | /*
72 | * Client is an in error state.
73 | */
74 | CLIENT_ERROR = 64;
75 |
76 | /*
77 | * Client has requested a replay from the router.
78 | */
79 | CLIENT_HISTORY = 65;
80 |
81 | /*
82 | * Client has requested stats from the router.
83 | */
84 | CLIENT_STATS = 66;
85 |
86 | /*
87 | * Client has requested the router respond. This can work as a
88 | * "are you there" message.
89 | */
90 | CLIENT_PING = 67;
91 |
92 | /*
93 | * The response to a "Ping"
94 | */
95 | CLIENT_PONG = 68;
96 |
97 | /*
98 | * Client has requested that the router abort processing the client's request
99 | */
100 | CLIENT_ABORT = 106;
101 | }
102 |
103 | /*
104 | * TODO: REPLACE
105 | */
106 | message Statistics {
107 | /*
108 | * Number of messages we have ever seen
109 | */
110 | uint32 messages_total = 1;
111 |
112 | /*
113 | * Number of messages we have currently saved our history.
114 | */
115 | uint32 messages_saved = 2;
116 |
117 | /*
118 | * Maximum number of messages we will save
119 | */
120 | uint32 messages_max = 3;
121 |
122 | /*
123 | * Router uptime in seconds
124 | */
125 | uint32 up_time = 4;
126 |
127 | /*
128 | * Number of times any client sent a request to the S&F.
129 | */
130 | uint32 requests = 5;
131 |
132 | /*
133 | * Number of times the history was requested.
134 | */
135 | uint32 requests_history = 6;
136 |
137 | /*
138 | * Is the heartbeat enabled on the server?
139 | */
140 | bool heartbeat = 7;
141 |
142 | /*
143 | * Maximum number of messages the server will return.
144 | */
145 | uint32 return_max = 8;
146 |
147 | /*
148 | * Maximum history window in minutes the server will return messages from.
149 | */
150 | uint32 return_window = 9;
151 | }
152 |
153 | /*
154 | * TODO: REPLACE
155 | */
156 | message History {
157 | /*
158 | * Number of that will be sent to the client
159 | */
160 | uint32 history_messages = 1;
161 |
162 | /*
163 | * The window of messages that was used to filter the history client requested
164 | */
165 | uint32 window = 2;
166 |
167 | /*
168 | * Index in the packet history of the last message sent in a previous request to the server.
169 | * Will be sent to the client before sending the history and can be set in a subsequent request to avoid getting packets the server already sent to the client.
170 | */
171 | uint32 last_request = 3;
172 | }
173 |
174 | /*
175 | * TODO: REPLACE
176 | */
177 | message Heartbeat {
178 | /*
179 | * Period in seconds that the heartbeat is sent out that will be sent to the client
180 | */
181 | uint32 period = 1;
182 |
183 | /*
184 | * If set, this is not the primary Store & Forward router on the mesh
185 | */
186 | uint32 secondary = 2;
187 | }
188 |
189 | /*
190 | * TODO: REPLACE
191 | */
192 | RequestResponse rr = 1;
193 |
194 | /*
195 | * TODO: REPLACE
196 | */
197 | oneof variant {
198 | /*
199 | * TODO: REPLACE
200 | */
201 | Statistics stats = 2;
202 |
203 | /*
204 | * TODO: REPLACE
205 | */
206 | History history = 3;
207 |
208 | /*
209 | * TODO: REPLACE
210 | */
211 | Heartbeat heartbeat = 4;
212 |
213 | /*
214 | * Text from history message.
215 | */
216 | bytes text = 5;
217 | }
218 | }
219 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/telemetry.options:
--------------------------------------------------------------------------------
1 | # options for nanopb
2 | # https://jpa.kapsi.fi/nanopb/docs/reference.html#proto-file-options
3 |
4 | *EnvironmentMetrics.iaq int_size:16
5 | *EnvironmentMetrics.wind_direction int_size:16
6 |
7 | *LocalStats.num_online_nodes int_size:16
8 | *LocalStats.num_total_nodes int_size:16
9 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/telemetry.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | option csharp_namespace = "Meshtastic.Protobufs";
6 | option go_package = "github.com/meshtastic/go/generated";
7 | option java_outer_classname = "TelemetryProtos";
8 | option java_package = "com.geeksville.mesh";
9 | option swift_prefix = "";
10 |
11 | /*
12 | * Key native device metrics such as battery level
13 | */
14 | message DeviceMetrics {
15 | /*
16 | * 0-100 (>100 means powered)
17 | */
18 | optional uint32 battery_level = 1;
19 |
20 | /*
21 | * Voltage measured
22 | */
23 | optional float voltage = 2;
24 |
25 | /*
26 | * Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise).
27 | */
28 | optional float channel_utilization = 3;
29 |
30 | /*
31 | * Percent of airtime for transmission used within the last hour.
32 | */
33 | optional float air_util_tx = 4;
34 |
35 | /*
36 | * How long the device has been running since the last reboot (in seconds)
37 | */
38 | optional uint32 uptime_seconds = 5;
39 | }
40 |
41 | /*
42 | * Weather station or other environmental metrics
43 | */
44 | message EnvironmentMetrics {
45 | /*
46 | * Temperature measured
47 | */
48 | optional float temperature = 1;
49 |
50 | /*
51 | * Relative humidity percent measured
52 | */
53 | optional float relative_humidity = 2;
54 |
55 | /*
56 | * Barometric pressure in hPA measured
57 | */
58 | optional float barometric_pressure = 3;
59 |
60 | /*
61 | * Gas resistance in MOhm measured
62 | */
63 | optional float gas_resistance = 4;
64 |
65 | /*
66 | * Voltage measured (To be depreciated in favor of PowerMetrics in Meshtastic 3.x)
67 | */
68 | optional float voltage = 5;
69 |
70 | /*
71 | * Current measured (To be depreciated in favor of PowerMetrics in Meshtastic 3.x)
72 | */
73 | optional float current = 6;
74 |
75 | /*
76 | * relative scale IAQ value as measured by Bosch BME680 . value 0-500.
77 | * Belongs to Air Quality but is not particle but VOC measurement. Other VOC values can also be put in here.
78 | */
79 | optional uint32 iaq = 7;
80 |
81 | /*
82 | * RCWL9620 Doppler Radar Distance Sensor, used for water level detection. Float value in mm.
83 | */
84 | optional float distance = 8;
85 |
86 | /*
87 | * VEML7700 high accuracy ambient light(Lux) digital 16-bit resolution sensor.
88 | */
89 | optional float lux = 9;
90 |
91 | /*
92 | * VEML7700 high accuracy white light(irradiance) not calibrated digital 16-bit resolution sensor.
93 | */
94 | optional float white_lux = 10;
95 |
96 | /*
97 | * Infrared lux
98 | */
99 | optional float ir_lux = 11;
100 |
101 | /*
102 | * Ultraviolet lux
103 | */
104 | optional float uv_lux = 12;
105 |
106 | /*
107 | * Wind direction in degrees
108 | * 0 degrees = North, 90 = East, etc...
109 | */
110 | optional uint32 wind_direction = 13;
111 |
112 | /*
113 | * Wind speed in m/s
114 | */
115 | optional float wind_speed = 14;
116 |
117 | /*
118 | * Weight in KG
119 | */
120 | optional float weight = 15;
121 |
122 | /*
123 | * Wind gust in m/s
124 | */
125 | optional float wind_gust = 16;
126 |
127 | /*
128 | * Wind lull in m/s
129 | */
130 | optional float wind_lull = 17;
131 | }
132 |
133 | /*
134 | * Power Metrics (voltage / current / etc)
135 | */
136 | message PowerMetrics {
137 | /*
138 | * Voltage (Ch1)
139 | */
140 | optional float ch1_voltage = 1;
141 |
142 | /*
143 | * Current (Ch1)
144 | */
145 | optional float ch1_current = 2;
146 |
147 | /*
148 | * Voltage (Ch2)
149 | */
150 | optional float ch2_voltage = 3;
151 |
152 | /*
153 | * Current (Ch2)
154 | */
155 | optional float ch2_current = 4;
156 |
157 | /*
158 | * Voltage (Ch3)
159 | */
160 | optional float ch3_voltage = 5;
161 |
162 | /*
163 | * Current (Ch3)
164 | */
165 | optional float ch3_current = 6;
166 | }
167 |
168 | /*
169 | * Air quality metrics
170 | */
171 | message AirQualityMetrics {
172 | /*
173 | * Concentration Units Standard PM1.0
174 | */
175 | optional uint32 pm10_standard = 1;
176 |
177 | /*
178 | * Concentration Units Standard PM2.5
179 | */
180 | optional uint32 pm25_standard = 2;
181 |
182 | /*
183 | * Concentration Units Standard PM10.0
184 | */
185 | optional uint32 pm100_standard = 3;
186 |
187 | /*
188 | * Concentration Units Environmental PM1.0
189 | */
190 | optional uint32 pm10_environmental = 4;
191 |
192 | /*
193 | * Concentration Units Environmental PM2.5
194 | */
195 | optional uint32 pm25_environmental = 5;
196 |
197 | /*
198 | * Concentration Units Environmental PM10.0
199 | */
200 | optional uint32 pm100_environmental = 6;
201 |
202 | /*
203 | * 0.3um Particle Count
204 | */
205 | optional uint32 particles_03um = 7;
206 |
207 | /*
208 | * 0.5um Particle Count
209 | */
210 | optional uint32 particles_05um = 8;
211 |
212 | /*
213 | * 1.0um Particle Count
214 | */
215 | optional uint32 particles_10um = 9;
216 |
217 | /*
218 | * 2.5um Particle Count
219 | */
220 | optional uint32 particles_25um = 10;
221 |
222 | /*
223 | * 5.0um Particle Count
224 | */
225 | optional uint32 particles_50um = 11;
226 |
227 | /*
228 | * 10.0um Particle Count
229 | */
230 | optional uint32 particles_100um = 12;
231 | }
232 |
233 | /*
234 | * Local device mesh statistics
235 | */
236 | message LocalStats {
237 | /*
238 | * How long the device has been running since the last reboot (in seconds)
239 | */
240 | uint32 uptime_seconds = 1;
241 | /*
242 | * Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise).
243 | */
244 | float channel_utilization = 2;
245 | /*
246 | * Percent of airtime for transmission used within the last hour.
247 | */
248 | float air_util_tx = 3;
249 |
250 | /*
251 | * Number of packets sent
252 | */
253 | uint32 num_packets_tx = 4;
254 |
255 | /*
256 | * Number of packets received good
257 | */
258 | uint32 num_packets_rx = 5;
259 |
260 | /*
261 | * Number of packets received that are malformed or violate the protocol
262 | */
263 | uint32 num_packets_rx_bad = 6;
264 |
265 | /*
266 | * Number of nodes online (in the past 2 hours)
267 | */
268 | uint32 num_online_nodes = 7;
269 |
270 | /*
271 | * Number of nodes total
272 | */
273 | uint32 num_total_nodes = 8;
274 | }
275 |
276 | /*
277 | * Types of Measurements the telemetry module is equipped to handle
278 | */
279 | message Telemetry {
280 | /*
281 | * Seconds since 1970 - or 0 for unknown/unset
282 | */
283 | fixed32 time = 1;
284 |
285 | oneof variant {
286 | /*
287 | * Key native device metrics such as battery level
288 | */
289 | DeviceMetrics device_metrics = 2;
290 |
291 | /*
292 | * Weather station or other environmental metrics
293 | */
294 | EnvironmentMetrics environment_metrics = 3;
295 |
296 | /*
297 | * Air quality metrics
298 | */
299 | AirQualityMetrics air_quality_metrics = 4;
300 |
301 | /*
302 | * Power Metrics
303 | */
304 | PowerMetrics power_metrics = 5;
305 |
306 | /*
307 | * Local device mesh statistics
308 | */
309 | LocalStats local_stats = 6;
310 | }
311 | }
312 |
313 | /*
314 | * Supported I2C Sensors for telemetry in Meshtastic
315 | */
316 | enum TelemetrySensorType {
317 | /*
318 | * No external telemetry sensor explicitly set
319 | */
320 | SENSOR_UNSET = 0;
321 |
322 | /*
323 | * High accuracy temperature, pressure, humidity
324 | */
325 | BME280 = 1;
326 |
327 | /*
328 | * High accuracy temperature, pressure, humidity, and air resistance
329 | */
330 | BME680 = 2;
331 |
332 | /*
333 | * Very high accuracy temperature
334 | */
335 | MCP9808 = 3;
336 |
337 | /*
338 | * Moderate accuracy current and voltage
339 | */
340 | INA260 = 4;
341 |
342 | /*
343 | * Moderate accuracy current and voltage
344 | */
345 | INA219 = 5;
346 |
347 | /*
348 | * High accuracy temperature and pressure
349 | */
350 | BMP280 = 6;
351 |
352 | /*
353 | * High accuracy temperature and humidity
354 | */
355 | SHTC3 = 7;
356 |
357 | /*
358 | * High accuracy pressure
359 | */
360 | LPS22 = 8;
361 |
362 | /*
363 | * 3-Axis magnetic sensor
364 | */
365 | QMC6310 = 9;
366 |
367 | /*
368 | * 6-Axis inertial measurement sensor
369 | */
370 | QMI8658 = 10;
371 |
372 | /*
373 | * 3-Axis magnetic sensor
374 | */
375 | QMC5883L = 11;
376 |
377 | /*
378 | * High accuracy temperature and humidity
379 | */
380 | SHT31 = 12;
381 |
382 | /*
383 | * PM2.5 air quality sensor
384 | */
385 | PMSA003I = 13;
386 |
387 | /*
388 | * INA3221 3 Channel Voltage / Current Sensor
389 | */
390 | INA3221 = 14;
391 |
392 | /*
393 | * BMP085/BMP180 High accuracy temperature and pressure (older Version of BMP280)
394 | */
395 | BMP085 = 15;
396 |
397 | /*
398 | * RCWL-9620 Doppler Radar Distance Sensor, used for water level detection
399 | */
400 | RCWL9620 = 16;
401 |
402 | /*
403 | * Sensirion High accuracy temperature and humidity
404 | */
405 | SHT4X = 17;
406 |
407 | /*
408 | * VEML7700 high accuracy ambient light(Lux) digital 16-bit resolution sensor.
409 | */
410 | VEML7700 = 18;
411 |
412 | /*
413 | * MLX90632 non-contact IR temperature sensor.
414 | */
415 | MLX90632 = 19;
416 |
417 | /*
418 | * TI OPT3001 Ambient Light Sensor
419 | */
420 | OPT3001 = 20;
421 |
422 | /*
423 | * Lite On LTR-390UV-01 UV Light Sensor
424 | */
425 | LTR390UV = 21;
426 |
427 | /*
428 | * AMS TSL25911FN RGB Light Sensor
429 | */
430 | TSL25911FN = 22;
431 |
432 | /*
433 | * AHT10 Integrated temperature and humidity sensor
434 | */
435 | AHT10 = 23;
436 |
437 | /*
438 | * DFRobot Lark Weather station (temperature, humidity, pressure, wind speed and direction)
439 | */
440 | DFROBOT_LARK = 24;
441 |
442 | /*
443 | * NAU7802 Scale Chip or compatible
444 | */
445 | NAU7802 = 25;
446 |
447 | /*
448 | * BMP3XX High accuracy temperature and pressure
449 | */
450 | BMP3XX = 26;
451 |
452 | /*
453 | * ICM-20948 9-Axis digital motion processor
454 | */
455 | ICM20948 = 27;
456 |
457 | /*
458 | * MAX17048 1S lipo battery sensor (voltage, state of charge, time to go)
459 | */
460 | MAX17048 = 28;
461 | }
462 |
463 | /*
464 | * NAU7802 Telemetry configuration, for saving to flash
465 | */
466 | message Nau7802Config {
467 | /*
468 | * The offset setting for the NAU7802
469 | */
470 | int32 zeroOffset = 1;
471 |
472 | /*
473 | * The calibration factor for the NAU7802
474 | */
475 | float calibrationFactor = 2;
476 | }
477 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/xmodem.options:
--------------------------------------------------------------------------------
1 | # options for nanopb
2 | # https://jpa.kapsi.fi/nanopb/docs/reference.html#proto-file-options
3 |
4 | *XModem.buffer max_size:128
5 | *XModem.seq int_size:16
6 | *XModem.crc16 int_size:16
7 |
--------------------------------------------------------------------------------
/proto_def/meshtastic/xmodem.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package meshtastic;
4 |
5 | option csharp_namespace = "Meshtastic.Protobufs";
6 | option go_package = "github.com/meshtastic/go/generated";
7 | option java_outer_classname = "XmodemProtos";
8 | option java_package = "com.geeksville.mesh";
9 | option swift_prefix = "";
10 |
11 | message XModem {
12 | enum Control {
13 | NUL = 0;
14 | SOH = 1;
15 | STX = 2;
16 | EOT = 4;
17 | ACK = 6;
18 | NAK = 21;
19 | CAN = 24;
20 | CTRLZ = 26;
21 | }
22 |
23 | Control control = 1;
24 | uint32 seq = 2;
25 | uint32 crc16 = 3;
26 | bytes buffer = 4;
27 | }
28 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | protobuf
2 | aiomqtt
3 | sqlalchemy[asyncio]
4 | cryptography
5 | aiosqlite
6 | aiohttp
7 | aiodns
8 | Jinja2
9 | aiohttp-sse
10 | asyncpg
11 | seaborn
12 | pydot
13 | plotly
14 |
--------------------------------------------------------------------------------
36 |
69 |
--------------------------------------------------------------------------------
/meshview/templates/packet_details.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% for seen in packets_seen %}
4 | -
37 |
- import_time 38 |
- {{packet.import_time | format_timestamp}} 39 |
- packet 40 |
{{packet.data}}
41 | - payload 42 |
-
43 | {% if packet.pretty_payload %}
44 | {{packet.pretty_payload}}68 |45 | {% endif %} 46 | {% if packet.raw_mesh_packet.decoded and packet.raw_mesh_packet.decoded.portnum == 70 %} 47 |67 |
-
48 | {% for node_id in packet.raw_payload.route %}
49 |
- 52 | {{node_id | node_id_to_hex}} 53 | 54 | 55 | {% endfor %} 56 |
{{packet.payload}}64 | 65 | 66 |
5 |
35 | {% endfor %}
36 |
37 | {% if map_center %}
38 |
60 | {% endif %}
61 |
--------------------------------------------------------------------------------
/meshview/templates/packet_index.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block body %}
4 |
6 | {{seen.node.long_name}}(
7 |
8 | {{seen.node_id|node_id_to_hex}}
9 |
10 | )
11 |
12 |
13 |
34 |
14 |
33 | -
15 |
- import_time 16 |
- {{seen.import_time|format_timestamp}} 17 |
- rx_time 18 |
- {{seen.rx_time|format_timestamp}} 19 |
- hop_limit 20 |
- {{seen.hop_limit}} 21 |
- hop_start 22 |
- {{seen.hop_start}} 23 |
- channel 24 |
- {{seen.channel}} 25 |
- rx_snr 26 |
- {{seen.rx_snr}} 27 |
- rx_rssi 28 |
- {{seen.rx_rssi}} 29 |
- topic 30 |
- {{seen.topic}} 31 |
5 |
18 | {% endblock %}
19 |
--------------------------------------------------------------------------------
/meshview/templates/packet_list.html:
--------------------------------------------------------------------------------
1 |
6 |
17 |
7 | {% include 'packet.html' %}
8 |
9 |
15 |
16 |
2 | {% for packet in packets %}
3 | {% include 'packet.html' %}
4 | {% else %}
5 | No packets found.
6 | {% endfor %}
7 |
8 |
--------------------------------------------------------------------------------
/meshview/templates/search.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 |
4 | {% block body %}
5 |
6 | {% include "search_form.html" %}
7 |
8 | -
9 | {% for node in nodes %}
10 |
- 11 | 12 | {{node.node_id | node_id_to_hex}} 13 | {% if node.long_name %} 14 | {{node.short_name}} — {{node.long_name}} 15 | {% endif %} 16 | 17 | 18 | {% endfor %} 19 |