├── .gitignore
├── LICENSE
├── MQTT
├── mqtt-client.py
├── receive-mqtt-packets.py
├── send-mqtt-packets.py
└── serial-mqtt.py
├── README.md
├── autoresponder.py
├── decode-protobuf.py
├── foxhunt.py
├── get-channels.py
├── get-config-modem-preset.py
├── list-protos.py
├── print-messages.py
├── print-myNodeInfo
├── print-nodedb.py
├── print-packets-basic.py
├── print-packets-json-log-and-plot.py
├── print-packets-json-log.py
├── print-packets-json.py
├── print-packets.py
├── print-traceroute.py
├── request-telemetry-simple.py
├── save-admin-keys.py
├── save-channel.py
├── send-and-receive.py
├── send-device-metrics.py
├── send-direct-message.py
├── send-environment-metrics.py
├── send-nodeinfo.py
├── send-position.py
├── send-telemetry.py
├── send-traceroute-simple.py
├── tcp_watchdog.py
└── test-rssi-snr.py
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | received_data.json
3 | .venv/
4 | venv/
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/MQTT/mqtt-client.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | """
3 | Powered by Meshtastic™ https://meshtastic.org/
4 | """
5 |
6 | from meshtastic.protobuf import mesh_pb2, mqtt_pb2, portnums_pb2
7 | from meshtastic import BROADCAST_NUM, protocols
8 | import paho.mqtt.client as mqtt
9 | import random
10 | import time
11 | import ssl
12 | from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
13 | from cryptography.hazmat.backends import default_backend
14 | import base64
15 | import re
16 |
17 | #### Debug Options
18 | debug = True
19 | auto_reconnect = True
20 | auto_reconnect_delay = 1 # seconds
21 | print_service_envelope = False
22 | print_message_packet = False
23 |
24 | print_node_info = True
25 | print_node_position = True
26 | print_node_telemetry = True
27 |
28 | ### Default settings
29 | mqtt_broker = "mqtt.meshtastic.org"
30 | mqtt_port = 1883
31 | mqtt_username = "meshdev"
32 | mqtt_password = "large4cats"
33 | # root_topic = "msh/US/2/e/"
34 | root_topic = "msh/US/Bots/2/e/"
35 | channel = "LongFast"
36 | key = "AQ=="
37 | message_text = "Person man, person man Hit on the head with a frying pan Lives his life in a garbage can"
38 |
39 | # Generate 4 random hexadecimal characters to create a unique node name
40 | random_hex_chars = ''.join(random.choices('0123456789abcdef', k=4))
41 | node_name = '!abcd' + random_hex_chars
42 | node_number = int(node_name.replace("!", ""), 16)
43 | global_message_id = random.getrandbits(32)
44 | client_short_name = "BOT"
45 | client_long_name = "Bottastic"
46 | lat = "0"
47 | lon = "0"
48 | alt = "0"
49 | client_hw_model = 255
50 |
51 | #################################
52 | ### Program variables
53 |
54 | default_key = "1PG7OiApB1nwvP+rz05pAQ==" # AKA AQ==
55 |
56 | #################################
57 | # Program Base Functions
58 |
59 | def set_topic():
60 | if debug: print("set_topic")
61 | global subscribe_topic, publish_topic
62 | node_name = '!' + hex(node_number)[2:]
63 | subscribe_topic = root_topic + channel + "/#"
64 | publish_topic = root_topic + channel + "/" + node_name
65 |
66 | def xor_hash(data):
67 | result = 0
68 | for char in data:
69 | result ^= char
70 | return result
71 |
72 | def generate_hash(name, key):
73 | replaced_key = key.replace('-', '+').replace('_', '/')
74 | key_bytes = base64.b64decode(replaced_key.encode('utf-8'))
75 | h_name = xor_hash(bytes(name, 'utf-8'))
76 | h_key = xor_hash(key_bytes)
77 | result = h_name ^ h_key
78 | return result
79 |
80 |
81 | #################################
82 | # Receive Messages
83 |
84 | def on_message(client, userdata, msg):
85 | se = mqtt_pb2.ServiceEnvelope()
86 | try:
87 | se.ParseFromString(msg.payload)
88 | if print_service_envelope:
89 | print ("")
90 | print ("Service Envelope:")
91 | print (se)
92 | mp = se.packet
93 | if print_message_packet:
94 | print ("")
95 | print ("Message Packet:")
96 | print(mp)
97 | except Exception as e:
98 | print(f"*** ServiceEnvelope: {str(e)}")
99 | return
100 |
101 | if mp.HasField("encrypted") and not mp.HasField("decoded"):
102 | decode_encrypted(mp)
103 |
104 | # Attempt to process the decrypted or encrypted payload
105 | portNumInt = mp.decoded.portnum if mp.HasField("decoded") else None
106 | handler = protocols.get(portNumInt) if portNumInt else None
107 |
108 | pb = None
109 | if handler is not None and handler.protobufFactory is not None:
110 | pb = handler.protobufFactory()
111 | pb.ParseFromString(mp.decoded.payload)
112 |
113 | if pb:
114 | # Clean and update the payload
115 | pb_str = str(pb).replace('\n', ' ').replace('\r', ' ').strip()
116 | mp.decoded.payload = pb_str.encode("utf-8")
117 | print(mp)
118 |
119 |
120 | def decode_encrypted(mp):
121 | try:
122 | key_bytes = base64.b64decode(key.encode('ascii'))
123 | nonce_packet_id = getattr(mp, "id").to_bytes(8, "little")
124 | nonce_from_node = getattr(mp, "from").to_bytes(8, "little")
125 | nonce = nonce_packet_id + nonce_from_node
126 | cipher = Cipher(algorithms.AES(key_bytes), modes.CTR(nonce), backend=default_backend())
127 | decryptor = cipher.decryptor()
128 | decrypted_bytes = decryptor.update(getattr(mp, "encrypted")) + decryptor.finalize()
129 | data = mesh_pb2.Data()
130 | data.ParseFromString(decrypted_bytes)
131 | mp.decoded.CopyFrom(data)
132 | except Exception as e:
133 | if print_message_packet: print(f"failed to decrypt: \n{mp}")
134 | if debug: print(f"*** Decryption failed: {str(e)}")
135 | return
136 |
137 | #################################
138 | # Send Messages
139 |
140 | def direct_message(destination_id):
141 | if debug: print("direct_message")
142 | if destination_id:
143 | try:
144 | destination_id = int(destination_id[1:], 16)
145 | send_message(destination_id)
146 | except Exception as e:
147 | if debug: print(f"Error converting destination_id: {e}")
148 |
149 | def send_message(destination_id, message_text):
150 | if not client.is_connected():
151 | connect_mqtt()
152 |
153 | if message_text:
154 | encoded_message = mesh_pb2.Data()
155 | encoded_message.portnum = portnums_pb2.TEXT_MESSAGE_APP
156 | encoded_message.payload = message_text.encode("utf-8")
157 | generate_mesh_packet(destination_id, encoded_message)
158 | else:
159 | return
160 |
161 | def send_traceroute(destination_id):
162 | if not client.is_connected():
163 | connect_mqtt()
164 | if debug: print(f"Sending Traceroute Packet to {str(destination_id)}")
165 |
166 | encoded_message = mesh_pb2.Data()
167 | encoded_message.portnum = portnums_pb2.TRACEROUTE_APP
168 | encoded_message.want_response = True
169 |
170 | destination_id = int(destination_id[1:], 16)
171 | generate_mesh_packet(destination_id, encoded_message)
172 |
173 | def send_node_info(destination_id, want_response):
174 | if client.is_connected():
175 | user_payload = mesh_pb2.User()
176 | setattr(user_payload, "id", node_name)
177 | setattr(user_payload, "long_name", client_long_name)
178 | setattr(user_payload, "short_name", client_short_name)
179 | setattr(user_payload, "hw_model", client_hw_model)
180 |
181 | user_payload = user_payload.SerializeToString()
182 |
183 | encoded_message = mesh_pb2.Data()
184 | encoded_message.portnum = portnums_pb2.NODEINFO_APP
185 | encoded_message.payload = user_payload
186 | encoded_message.want_response = want_response # Request NodeInfo back
187 | generate_mesh_packet(destination_id, encoded_message)
188 |
189 | def send_position(destination_id):
190 | if client.is_connected():
191 | pos_time = int(time.time())
192 | latitude = int(float(lat) * 1e7)
193 | longitude = int(float(lon) * 1e7)
194 | altitude_units = 1 / 3.28084 if 'ft' in str(alt) else 1.0
195 | altitude = int(altitude_units * float(re.sub('[^0-9.]', '', str(alt))))
196 |
197 | position_payload = mesh_pb2.Position()
198 | setattr(position_payload, "latitude_i", latitude)
199 | setattr(position_payload, "longitude_i", longitude)
200 | setattr(position_payload, "altitude", altitude)
201 | setattr(position_payload, "time", pos_time)
202 |
203 | position_payload = position_payload.SerializeToString()
204 |
205 | encoded_message = mesh_pb2.Data()
206 | encoded_message.portnum = portnums_pb2.POSITION_APP
207 | encoded_message.payload = position_payload
208 | encoded_message.want_response = True
209 |
210 | generate_mesh_packet(destination_id, encoded_message)
211 |
212 | def generate_mesh_packet(destination_id, encoded_message):
213 | global global_message_id
214 | mesh_packet = mesh_pb2.MeshPacket()
215 |
216 | # Use the global message ID and increment it for the next call
217 | mesh_packet.id = global_message_id
218 | global_message_id += 1
219 |
220 | setattr(mesh_packet, "from", node_number)
221 | mesh_packet.to = destination_id
222 | mesh_packet.want_ack = False
223 | mesh_packet.channel = generate_hash(channel, key)
224 | mesh_packet.hop_limit = 3
225 |
226 | if key == "":
227 | mesh_packet.decoded.CopyFrom(encoded_message)
228 | else:
229 | mesh_packet.encrypted = encrypt_message(channel, key, mesh_packet, encoded_message)
230 |
231 | service_envelope = mqtt_pb2.ServiceEnvelope()
232 | service_envelope.packet.CopyFrom(mesh_packet)
233 | service_envelope.channel_id = channel
234 | service_envelope.gateway_id = node_name
235 |
236 | payload = service_envelope.SerializeToString()
237 | client.publish(publish_topic, payload)
238 |
239 | def encrypt_message(channel, key, mesh_packet, encoded_message):
240 | mesh_packet.channel = generate_hash(channel, key)
241 | key_bytes = base64.b64decode(key.encode('ascii'))
242 | nonce_packet_id = mesh_packet.id.to_bytes(8, "little")
243 | nonce_from_node = node_number.to_bytes(8, "little")
244 | nonce = nonce_packet_id + nonce_from_node
245 | cipher = Cipher(algorithms.AES(key_bytes), modes.CTR(nonce), backend=default_backend())
246 | encryptor = cipher.encryptor()
247 | encrypted_bytes = encryptor.update(encoded_message.SerializeToString()) + encryptor.finalize()
248 | return encrypted_bytes
249 |
250 | def send_ack(destination_id, message_id):
251 | if debug: print("Sending ACK")
252 | encoded_message = mesh_pb2.Data()
253 | encoded_message.portnum = portnums_pb2.ROUTING_APP
254 | encoded_message.request_id = message_id
255 | encoded_message.payload = b"\030\000"
256 | generate_mesh_packet(destination_id, encoded_message)
257 |
258 |
259 | #################################
260 | # MQTT Server
261 |
262 | def connect_mqtt():
263 | if "tls_configured" not in connect_mqtt.__dict__: #Persistent variable to remember if we've configured TLS yet
264 | connect_mqtt.tls_configured = False
265 |
266 | if debug: print("connect_mqtt")
267 | global mqtt_broker, mqtt_port, mqtt_username, mqtt_password, root_topic, channel, node_number, db_file_path, key
268 | if not client.is_connected():
269 | try:
270 | if ':' in mqtt_broker:
271 | mqtt_broker,mqtt_port = mqtt_broker.split(':')
272 | mqtt_port = int(mqtt_port)
273 |
274 | if key == "AQ==":
275 | if debug: print("key is default, expanding to AES128")
276 | key = "1PG7OiApB1nwvP+rz05pAQ=="
277 |
278 | padded_key = key.ljust(len(key) + ((4 - (len(key) % 4)) % 4), '=')
279 | replaced_key = padded_key.replace('-', '+').replace('_', '/')
280 | key = replaced_key
281 |
282 | client.username_pw_set(mqtt_username, mqtt_password)
283 | if mqtt_port == 8883 and connect_mqtt.tls_configured == False:
284 | client.tls_set(ca_certs="cacert.pem", tls_version=ssl.PROTOCOL_TLSv1_2)
285 | client.tls_insecure_set(False)
286 | connect_mqtt.tls_configured = True
287 | client.connect(mqtt_broker, mqtt_port, 60)
288 | client.loop_start()
289 |
290 | except Exception as e:
291 | print (e)
292 |
293 | def disconnect_mqtt():
294 | if debug: print("disconnect_mqtt")
295 | if client.is_connected():
296 | client.disconnect()
297 |
298 | def on_connect(client, userdata, flags, reason_code, properties):
299 | set_topic()
300 | if client.is_connected():
301 | print("client is connected")
302 |
303 | if reason_code == 0:
304 | if debug: print(f"Connected to sever: {mqtt_broker}")
305 | if debug: print(f"Subscribe Topic is: {subscribe_topic}")
306 | if debug: print(f"Publish Topic is: {publish_topic}\n")
307 | client.subscribe(subscribe_topic)
308 |
309 | def on_disconnect(client, userdata, flags, reason_code, properties):
310 | if debug: print("on_disconnect")
311 | if reason_code != 0:
312 | if auto_reconnect == True:
313 | print("attempting to reconnect in " + str(auto_reconnect_delay) + " second(s)")
314 | time.sleep(auto_reconnect_delay)
315 | connect_mqtt()
316 |
317 | ############################
318 | # Main
319 |
320 | def main():
321 | global client
322 | client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id="", clean_session=True, userdata=None)
323 | client.on_connect = on_connect
324 | client.on_disconnect = on_disconnect
325 | client.on_message = on_message
326 |
327 | connect_mqtt()
328 | time.sleep(1)
329 |
330 | if client.is_connected:
331 | send_node_info(BROADCAST_NUM, want_response=False)
332 | time.sleep(4)
333 | send_position(BROADCAST_NUM)
334 | time.sleep(4)
335 | send_message(BROADCAST_NUM, message_text)
336 | time.sleep(4)
337 |
338 | while True:
339 | time.sleep(1)
340 |
341 | if __name__ == "__main__":
342 | main()
--------------------------------------------------------------------------------
/MQTT/receive-mqtt-packets.py:
--------------------------------------------------------------------------------
1 | import paho.mqtt.client as mqtt
2 | import base64
3 | from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
4 | from cryptography.hazmat.backends import default_backend
5 | from meshtastic.protobuf import mqtt_pb2, mesh_pb2
6 | from meshtastic import protocols
7 |
8 | BROKER = "mqtt.meshtastic.org"
9 | USER = "meshdev"
10 | PASS = "large4cats"
11 | PORT = 1883
12 | TOPICS = ["msh/US/2/e/PKI/#","msh/US/2/e/LongFast/#"]
13 | KEY = "AQ=="
14 | KEY = "1PG7OiApB1nwvP+rz05pAQ==" if KEY == "AQ==" else KEY
15 |
16 | # Callback when the client connects to the broker
17 | def on_connect(client, userdata, flags, rc):
18 | if rc == 0:
19 | print("Connected to MQTT broker!")
20 | for topic in TOPICS:
21 | client.subscribe(topic)
22 | print(f"Subscribed to topic: {topic}")
23 | else:
24 | print(f"Failed to connect, return code {rc}")
25 |
26 | # Callback when a message is received
27 | def on_message(client, userdata, msg):
28 | se = mqtt_pb2.ServiceEnvelope()
29 | se.ParseFromString(msg.payload)
30 | decoded_mp = se.packet
31 |
32 | # Try to decrypt the payload if it is encrypted
33 | if decoded_mp.HasField("encrypted") and not decoded_mp.HasField("decoded"):
34 | decoded_data = decrypt_packet(decoded_mp, KEY)
35 | if decoded_data is None:
36 | print("Decryption failed; retaining original encrypted payload")
37 | else:
38 | decoded_mp.decoded.CopyFrom(decoded_data)
39 |
40 | # Attempt to process the decrypted or encrypted payload
41 | portNumInt = decoded_mp.decoded.portnum if decoded_mp.HasField("decoded") else None
42 | handler = protocols.get(portNumInt) if portNumInt else None
43 |
44 | pb = None
45 | if handler is not None and handler.protobufFactory is not None:
46 | pb = handler.protobufFactory()
47 | pb.ParseFromString(decoded_mp.decoded.payload)
48 |
49 | if pb:
50 | # Clean and update the payload
51 | pb_str = str(pb).replace('\n', ' ').replace('\r', ' ').strip()
52 | decoded_mp.decoded.payload = pb_str.encode("utf-8")
53 | print(decoded_mp)
54 |
55 |
56 | def decrypt_packet(mp, key):
57 | try:
58 | key_bytes = base64.b64decode(key.encode('ascii'))
59 |
60 | # Build the nonce from message ID and sender
61 | nonce_packet_id = getattr(mp, "id").to_bytes(8, "little")
62 | nonce_from_node = getattr(mp, "from").to_bytes(8, "little")
63 | nonce = nonce_packet_id + nonce_from_node
64 |
65 | # Decrypt the encrypted payload
66 | cipher = Cipher(algorithms.AES(key_bytes), modes.CTR(nonce), backend=default_backend())
67 | decryptor = cipher.decryptor()
68 | decrypted_bytes = decryptor.update(getattr(mp, "encrypted")) + decryptor.finalize()
69 |
70 | # Parse the decrypted bytes into a Data object
71 | data = mesh_pb2.Data()
72 | data.ParseFromString(decrypted_bytes)
73 | return data
74 |
75 | except Exception as e:
76 | return None
77 |
78 | client = mqtt.Client()
79 | client.on_connect = on_connect
80 | client.on_message = on_message
81 | client.username_pw_set(USER, PASS)
82 | try:
83 | client.connect(BROKER, PORT, keepalive=60)
84 | client.loop_forever()
85 | except Exception as e:
86 | print(f"An error occurred: {e}")
--------------------------------------------------------------------------------
/MQTT/send-mqtt-packets.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | """
3 | Powered by Meshtastic™ https://meshtastic.org/
4 | """
5 |
6 | from meshtastic.protobuf import mesh_pb2, mqtt_pb2, portnums_pb2
7 | from meshtastic import BROADCAST_NUM
8 | import paho.mqtt.client as mqtt
9 | import random
10 | import time
11 | import ssl
12 | from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
13 | from cryptography.hazmat.backends import default_backend
14 | import base64
15 | import re
16 |
17 | #### Debug Options
18 | debug = True
19 |
20 | ### Default settings
21 | mqtt_broker = "mqtt.meshtastic.org"
22 | mqtt_port = 1883
23 | mqtt_username = "meshdev"
24 | mqtt_password = "large4cats"
25 | root_topic = "msh/US/Bots/2/e/"
26 | channel = "LongFast"
27 | key = "AQ=="
28 | message_text = "Person man, person man Hit on the head with a frying pan Lives his life in a garbage can"
29 |
30 | # Generate 4 random hexadecimal characters to create a unique node name
31 | random_hex_chars = ''.join(random.choices('0123456789abcdef', k=4))
32 | node_name = '!abcd' + random_hex_chars
33 | node_number = int(node_name.replace("!", ""), 16)
34 | global_message_id = random.getrandbits(32)
35 | client_short_name = "BOT"
36 | client_long_name = "Bottastic"
37 | lat = "0"
38 | lon = "0"
39 | alt = "0"
40 | client_hw_model = 255
41 |
42 | #################################
43 | ### Program variables
44 |
45 | default_key = "1PG7OiApB1nwvP+rz05pAQ==" # AKA AQ==
46 |
47 | #################################
48 | # Program Base Functions
49 |
50 | def set_topic():
51 | global publish_topic
52 | node_name = '!' + hex(node_number)[2:]
53 | publish_topic = root_topic + channel + "/" + node_name
54 |
55 | def xor_hash(data):
56 | result = 0
57 | for char in data:
58 | result ^= char
59 | return result
60 |
61 | def generate_hash(name, key):
62 | replaced_key = key.replace('-', '+').replace('_', '/')
63 | key_bytes = base64.b64decode(replaced_key.encode('utf-8'))
64 | h_name = xor_hash(bytes(name, 'utf-8'))
65 | h_key = xor_hash(key_bytes)
66 | result = h_name ^ h_key
67 | return result
68 |
69 | #################################
70 | # Send Messages
71 |
72 | def direct_message(destination_id):
73 | if debug: print("direct_message")
74 | if destination_id:
75 | try:
76 | destination_id = int(destination_id[1:], 16)
77 | send_message(destination_id)
78 | except Exception as e:
79 | if debug: print(f"Error converting destination_id: {e}")
80 |
81 | def send_message(destination_id, message_text):
82 | if not client.is_connected():
83 | connect_mqtt()
84 |
85 | if debug: print(f"Sending Text Message Packet to {str(destination_id)}")
86 | if message_text:
87 | encoded_message = mesh_pb2.Data()
88 | encoded_message.portnum = portnums_pb2.TEXT_MESSAGE_APP
89 | encoded_message.payload = message_text.encode("utf-8")
90 | generate_mesh_packet(destination_id, encoded_message)
91 | else:
92 | return
93 |
94 | def send_traceroute(destination_id):
95 | if not client.is_connected():
96 | connect_mqtt()
97 | if debug: print(f"Sending Traceroute Packet to {str(destination_id)}")
98 |
99 | encoded_message = mesh_pb2.Data()
100 | encoded_message.portnum = portnums_pb2.TRACEROUTE_APP
101 | encoded_message.want_response = True
102 |
103 | destination_id = int(destination_id[1:], 16)
104 | generate_mesh_packet(destination_id, encoded_message)
105 |
106 | def send_node_info(destination_id, want_response):
107 | if client.is_connected():
108 | if debug: print(f"Sending NodeInfo Packet to {str(destination_id)}")
109 | user_payload = mesh_pb2.User()
110 | setattr(user_payload, "id", node_name)
111 | setattr(user_payload, "long_name", client_long_name)
112 | setattr(user_payload, "short_name", client_short_name)
113 | setattr(user_payload, "hw_model", client_hw_model)
114 |
115 | user_payload = user_payload.SerializeToString()
116 |
117 | encoded_message = mesh_pb2.Data()
118 | encoded_message.portnum = portnums_pb2.NODEINFO_APP
119 | encoded_message.payload = user_payload
120 | encoded_message.want_response = want_response # Request NodeInfo back
121 | generate_mesh_packet(destination_id, encoded_message)
122 |
123 | def send_position(destination_id):
124 | if client.is_connected():
125 | if debug: print(f"Sending Position Packet to {str(destination_id)}")
126 | pos_time = int(time.time())
127 | latitude = int(float(lat) * 1e7)
128 | longitude = int(float(lon) * 1e7)
129 | altitude_units = 1 / 3.28084 if 'ft' in str(alt) else 1.0
130 | altitude = int(altitude_units * float(re.sub('[^0-9.]', '', str(alt))))
131 |
132 | position_payload = mesh_pb2.Position()
133 | setattr(position_payload, "latitude_i", latitude)
134 | setattr(position_payload, "longitude_i", longitude)
135 | setattr(position_payload, "altitude", altitude)
136 | setattr(position_payload, "time", pos_time)
137 |
138 | position_payload = position_payload.SerializeToString()
139 |
140 | encoded_message = mesh_pb2.Data()
141 | encoded_message.portnum = portnums_pb2.POSITION_APP
142 | encoded_message.payload = position_payload
143 | encoded_message.want_response = True
144 |
145 | generate_mesh_packet(destination_id, encoded_message)
146 |
147 | def generate_mesh_packet(destination_id, encoded_message):
148 | global global_message_id
149 | mesh_packet = mesh_pb2.MeshPacket()
150 |
151 | # Use the global message ID and increment it for the next call
152 | mesh_packet.id = global_message_id
153 | global_message_id += 1
154 |
155 | setattr(mesh_packet, "from", node_number)
156 | mesh_packet.to = destination_id
157 | mesh_packet.want_ack = False
158 | mesh_packet.channel = generate_hash(channel, key)
159 | mesh_packet.hop_limit = 3
160 |
161 | if key == "":
162 | mesh_packet.decoded.CopyFrom(encoded_message)
163 | else:
164 | mesh_packet.encrypted = encrypt_message(channel, key, mesh_packet, encoded_message)
165 |
166 | service_envelope = mqtt_pb2.ServiceEnvelope()
167 | service_envelope.packet.CopyFrom(mesh_packet)
168 | service_envelope.channel_id = channel
169 | service_envelope.gateway_id = node_name
170 |
171 | payload = service_envelope.SerializeToString()
172 | client.publish(publish_topic, payload)
173 |
174 | def encrypt_message(channel, key, mesh_packet, encoded_message):
175 | mesh_packet.channel = generate_hash(channel, key)
176 | key_bytes = base64.b64decode(key.encode('ascii'))
177 | nonce_packet_id = mesh_packet.id.to_bytes(8, "little")
178 | nonce_from_node = node_number.to_bytes(8, "little")
179 | nonce = nonce_packet_id + nonce_from_node
180 | cipher = Cipher(algorithms.AES(key_bytes), modes.CTR(nonce), backend=default_backend())
181 | encryptor = cipher.encryptor()
182 | encrypted_bytes = encryptor.update(encoded_message.SerializeToString()) + encryptor.finalize()
183 | return encrypted_bytes
184 |
185 | def send_ack(destination_id, message_id):
186 | if debug: print("Sending ACK")
187 | encoded_message = mesh_pb2.Data()
188 | encoded_message.portnum = portnums_pb2.ROUTING_APP
189 | encoded_message.request_id = message_id
190 | encoded_message.payload = b"\030\000"
191 | generate_mesh_packet(destination_id, encoded_message)
192 |
193 |
194 | #################################
195 | # MQTT Server
196 |
197 | def connect_mqtt():
198 | if "tls_configured" not in connect_mqtt.__dict__: #Persistent variable to remember if we've configured TLS yet
199 | connect_mqtt.tls_configured = False
200 |
201 | if debug: print("connect_mqtt")
202 | global mqtt_broker, mqtt_port, mqtt_username, mqtt_password, root_topic, channel, node_number, db_file_path, key
203 | if not client.is_connected():
204 | try:
205 | if ':' in mqtt_broker:
206 | mqtt_broker,mqtt_port = mqtt_broker.split(':')
207 | mqtt_port = int(mqtt_port)
208 |
209 | if key == "AQ==":
210 | if debug: print("key is default, expanding to AES128")
211 | key = "1PG7OiApB1nwvP+rz05pAQ=="
212 |
213 | padded_key = key.ljust(len(key) + ((4 - (len(key) % 4)) % 4), '=')
214 | replaced_key = padded_key.replace('-', '+').replace('_', '/')
215 | key = replaced_key
216 |
217 | client.username_pw_set(mqtt_username, mqtt_password)
218 | if mqtt_port == 8883 and connect_mqtt.tls_configured == False:
219 | client.tls_set(ca_certs="cacert.pem", tls_version=ssl.PROTOCOL_TLSv1_2)
220 | client.tls_insecure_set(False)
221 | connect_mqtt.tls_configured = True
222 | client.connect(mqtt_broker, mqtt_port, 60)
223 | client.loop_start()
224 |
225 | except Exception as e:
226 | print (e)
227 |
228 | def disconnect_mqtt():
229 | if client.is_connected():
230 | client.disconnect()
231 | if debug: print("Client Disconnected")
232 |
233 | def on_connect(client, userdata, flags, reason_code, properties):
234 | set_topic()
235 | if client.is_connected():
236 | print("client is connected")
237 |
238 | if reason_code == 0:
239 | if debug: print(f"Connected to sever: {mqtt_broker}")
240 | if debug: print(f"Publish Topic is: {publish_topic}\n")
241 |
242 | ############################
243 | # Main
244 |
245 | def main():
246 | global client
247 | client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id="", clean_session=True, userdata=None)
248 | client.on_connect = on_connect
249 |
250 | connect_mqtt()
251 | time.sleep(1)
252 |
253 | if client.is_connected:
254 | send_node_info(BROADCAST_NUM, want_response=False)
255 | time.sleep(4)
256 | send_position(BROADCAST_NUM)
257 | time.sleep(4)
258 | send_message(BROADCAST_NUM, message_text)
259 | time.sleep(4)
260 |
261 | disconnect_mqtt()
262 |
263 | if __name__ == "__main__":
264 | main()
--------------------------------------------------------------------------------
/MQTT/serial-mqtt.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | import paho.mqtt.client as mqtt
3 | from pubsub import pub
4 | import json
5 | import time
6 |
7 | # Configure MQTT broker
8 | mqtt_broker = 'mqtt.meshtastic.org'
9 | mqtt_port = 1883
10 | mqtt_user = "meshdev"
11 | mqtt_pass = "large4cats"
12 | mqtt_topic = "msh/sMQTT/2/json/LongFast/"
13 | virtual_node = "!deadbeef"
14 |
15 | def on_connect(client, userdata, flags, reason_code, properties):
16 | print(f"Connected with result code {reason_code}")
17 |
18 | def onReceive(packet, interface):
19 | if 'decoded' not in packet:
20 | return
21 |
22 | data = {
23 | 'channel': 0,
24 | 'from': packet.get('from', ''),
25 | 'hop_start': None,
26 | 'hops_away': None,
27 | 'id': packet.get('id', ''),
28 | 'payload': {},
29 | 'rssi': packet.get('rxRssi', None),
30 | 'sender': virtual_node,
31 | 'snr': packet.get('snr', None),
32 | 'timestamp': packet.get('rxTime', None),
33 | 'to': packet.get('to', None),
34 | 'type': ''
35 | }
36 |
37 | portnum = packet['decoded'].get('portnum')
38 | payload = data['payload']
39 |
40 | if portnum == 'NODEINFO_APP':
41 | data['type'] = 'nodeinfo'
42 | user = packet['decoded']['user']
43 | payload.update({
44 | 'hardware': user['hwModel'],
45 | 'id': user['id'],
46 | 'longname': user['longName'],
47 | 'shortname': user['shortName']
48 | })
49 |
50 | elif portnum == 'POSITION_APP':
51 | data['type'] = 'position'
52 | position = packet['decoded']['position']
53 | payload.update({
54 | 'PDOP': position.get('pdop'),
55 | 'altitude': position.get('altitude'),
56 | 'groundSpeed': position.get('ground_speed'),
57 | 'latitude_i': position['latitudeI'],
58 | 'longitude_i': position['longitudeI'],
59 | 'precision_bits': position.get('precisionBits'),
60 | 'satsInView': position.get('sats_in_view'),
61 | 'time': position.get('time')
62 | })
63 |
64 | elif portnum == 'TEXT_MESSAGE_APP':
65 | data['type'] = 'textMessage'
66 | payload['text'] = packet['decoded']['text']
67 |
68 | elif portnum == 'TELEMETRY_APP':
69 | data['type'] = 'telemetry'
70 | telemetry = packet['decoded']['telemetry']
71 |
72 | if 'deviceMetrics' in telemetry:
73 | device_metrics = telemetry['deviceMetrics']
74 | payload.update({
75 | 'air_util_tx': device_metrics.get('airUtilTx'),
76 | 'battery_level': device_metrics.get('batteryLevel'),
77 | 'channel_utilization': device_metrics.get('channelUtilization'),
78 | 'uptime_seconds': device_metrics.get('uptimeSeconds'),
79 | 'voltage': device_metrics.get('voltage')
80 | })
81 |
82 | if 'powerMetrics' in telemetry:
83 | power_metrics = telemetry['powerMetrics']
84 | payload.update({
85 | 'current_ch1': power_metrics.get('ch1Current'),
86 | 'current_ch2': power_metrics.get('ch2Current'),
87 | 'current_ch3': power_metrics.get('ch3Current'),
88 | 'voltage_ch1': power_metrics.get('ch1Voltage'),
89 | 'voltage_ch2': power_metrics.get('ch2Voltage'),
90 | 'voltage_ch3': power_metrics.get('ch3Voltage')
91 | })
92 |
93 | if 'environmentMetrics' in telemetry:
94 | environment_metrics = telemetry['environmentMetrics']
95 | payload.update({
96 | 'barometric_pressure': environment_metrics.get('barometricPressure'),
97 | 'current': environment_metrics.get('current'),
98 | 'gas_resistance': environment_metrics.get('gasResistance'),
99 | 'iaq': environment_metrics.get('iaq'),
100 | 'lux': environment_metrics.get('lux'),
101 | 'temperature': environment_metrics.get('temperature'),
102 | 'voltage': environment_metrics.get('voltage'),
103 | 'white_lux': environment_metrics.get('whiteLux'),
104 | 'wind_direction': environment_metrics.get('windDirection'),
105 | 'wind_speed': environment_metrics.get('windSpeed')
106 | })
107 | else:
108 | data['type'] = 'todo'
109 |
110 | # TODO
111 | # REMOTE_HARDWARE_APP
112 | # ROUTING_APP
113 | # ADMIN_APP
114 | # TEXT_MESSAGE_COMPRESSED_APP
115 | # WAYPOINT_APP
116 | # AUDIO_APP
117 | # DETECTION_SENSOR_APP
118 | # REPLY_APP
119 | # IP_TUNNEL_APP
120 | # PAXCOUNTER_APP
121 | # SERIAL_APP
122 | # STORE_FORWARD_APP
123 | # RANGE_TEST_APP
124 | # TRACEROUT_APP
125 | # NEIGHBORINFO_APP
126 | # ATAK_PLUGIN
127 | # MAP_REPORT_APP
128 | # POWERSTRESS_APP
129 | # PRIVATE_APP
130 | # ATAK_FORWARDER
131 |
132 | # Remove keys with None values
133 | data = {key: value for key, value in data.items() if value is not None}
134 | payload = {key: value for key, value in payload.items() if value not in (None, '')}
135 | data['payload'] = payload
136 |
137 | json_data = json.dumps(data, indent=2)
138 | print(json_data)
139 |
140 |
141 | # if 'decoded' in packet:
142 | # print (packet)
143 | print ("")
144 |
145 |
146 | # Publish the message to the MQTT broker
147 | client.publish(mqtt_topic + virtual_node, json_data)
148 |
149 |
150 | # Initialize MQTT client
151 | client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id="", clean_session=True, userdata=None)
152 | client.username_pw_set(mqtt_user, mqtt_pass)
153 | client.connect(mqtt_broker, mqtt_port, 60)
154 | # client.on_disconnect = on_disconnect
155 | # client.on_message = on_message
156 | client.loop_start()
157 | client.on_connect = on_connect
158 |
159 | # Initialize serial connection
160 | interface = meshtastic.serial_interface.SerialInterface()
161 | pub.subscribe(onReceive, 'meshtastic.receive')
162 |
163 | while True:
164 | time.sleep(1)
165 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | ### autoresponder.py
3 | Send a message `reply_message` every time a message is received by the connected node.
4 |
5 | ### get-channels.py
6 | Get and print all the channels saved on the connected node.
7 |
8 | ### get-config-modem-preset.py
9 | Get and print the active modem preset on the connected node.
10 |
11 | ### print-messages.py
12 | Print all messages received by your node
13 |
14 | ### print-nodedb.py
15 | List the nodes with telemetry in the nodedb of the connected node.
16 |
17 | ### print-packets-basic.py
18 | This script print all data packets.
19 |
20 | ### print-packets-json-log-and-plot.py
21 | This script print all data packets in json format, saves to a file and creates bar charts for portnum and node number.
22 |
23 | ### print-packets-json-log.py
24 | This script print all data packets in json format, and saves to a json file.
25 |
26 | ### print-packets-json.py
27 | This script print all data packets in json format.
28 |
29 | ### print-packets.py
30 | Parse and print all data packets.
31 |
32 | ### print-traceroute.py
33 | print out all traceroutes heard by your node
34 |
35 | ### request-telemetry-simple.py
36 | send a request for a telemetry packet to a node of your choice
37 |
38 | ### send-and-receive.py
39 | Send messages typed into the terminal, and display any message received by the connected node.
40 |
41 | ### send-device-metrics.py
42 | Send device telemetry to the mesh from the connected node
43 |
44 | ### send-environment-metrics.py
45 | Send environment telemetry to the mesh from the connected node
46 |
47 | ### send-nodeinfo.py
48 | broadcast your node's nodeinfo packet
49 |
50 | ### send-position.py
51 | Send a location to the mesh from your connected node.
52 |
53 | ### send-traceroute-simple.py
54 | send a traceroute request to a node of your choosing and wait for a response.
55 |
56 | ## MQTT
57 | ### mqtt-client.py
58 | Pseudo-client to publish predetermined message, location, and nodeinfo packets and print all received packets.
59 |
60 | ### receive-mqtt-packets.py
61 | Print all received packets
62 |
63 | ### send-mqtt-packets.py
64 | Publish predetermined message, location, and nodeinfo packets.
65 |
66 | ### serial-mqtt.py
67 | Send JSON formatted packets to an MQTT broker from your connected node. Useful for nRF's without WiFi, and for LAN-less configurations such as a node connected via USB to a Raspberry Pi running Mosquitto.
68 |
69 |
--------------------------------------------------------------------------------
/autoresponder.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 | import time
4 |
5 | reply_message = "Message Received"
6 |
7 | interface = meshtastic.serial_interface.SerialInterface()
8 | def onReceive(packet, interface):
9 | try:
10 | if 'decoded' in packet and packet['decoded']['portnum'] == 'TEXT_MESSAGE_APP':
11 | message_bytes = packet['decoded']['payload']
12 | message_string = message_bytes.decode('utf-8')
13 | print(f"Received: {message_string}")
14 | send_message(reply_message)
15 |
16 | except KeyError as e:
17 | print(f"Error processing packet: {e}")
18 |
19 | pub.subscribe(onReceive, 'meshtastic.receive')
20 |
21 | def send_message(message):
22 | interface.sendText(message)
23 | print (f"Sent: {reply_message}")
24 |
25 | while True:
26 | time.sleep(1)
--------------------------------------------------------------------------------
/decode-protobuf.py:
--------------------------------------------------------------------------------
1 | from meshtastic.protobuf import telemetry_pb2
2 |
3 | data= b"\r\232+Dg\032\n\r\341z \301\025\000\200\241B"
4 | telem = telemetry_pb2.Telemetry()
5 | telem.ParseFromString(data)
6 |
7 | print (telem)
--------------------------------------------------------------------------------
/foxhunt.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from meshtastic.protobuf import telemetry_pb2, portnums_pb2
3 | from pubsub import pub
4 | import time
5 | import argparse # Import the argparse library
6 |
7 | # Setup the argument parser
8 | parser = argparse.ArgumentParser(description='Send and receive RSSI/SNR data.')
9 | parser.add_argument('remote_node', type=int, help='Remote node ID to communicate with.')
10 | args = parser.parse_args()
11 |
12 | # Use the remote_node from the command line arguments
13 | remote_node = args.remote_node
14 | want_response = True
15 | channel = 0
16 |
17 | interface = meshtastic.serial_interface.SerialInterface()
18 |
19 | telemetry_data = telemetry_pb2.Telemetry()
20 | telemetry_data.device_metrics.battery_level = 69
21 |
22 | response_received = False
23 | last_request_time = None
24 |
25 | def signalReport():
26 | global last_request_time
27 | global response_received
28 | print("Requesting data...")
29 | response_received = False
30 | last_request_time = time.time() # Update last request time
31 | interface.sendData(
32 | telemetry_data,
33 | destinationId=remote_node,
34 | portNum=portnums_pb2.PortNum.TELEMETRY_APP,
35 | wantResponse=want_response
36 | )
37 |
38 | def onReceive(packet, interface):
39 | global response_received
40 | if packet['from'] == remote_node:
41 | print(f"\nSNR: {packet['rxSnr']} RSSI: {packet['rxRssi']} \n\n")
42 | response_received = True
43 |
44 | pub.subscribe(onReceive, 'meshtastic.receive')
45 |
46 | signalReport() # Initial request
47 |
48 | try:
49 | while True:
50 | time.sleep(0.1) # Short sleep to allow quick response check
51 | if response_received:
52 | signalReport() # Send another request after receiving a response
53 | elif time.time() - last_request_time > 10:
54 | print("No response received for 10 seconds, retrying...")
55 | signalReport() # Retry if no response received for 10 seconds
56 | except KeyboardInterrupt:
57 | print("Exiting program...")
58 | finally:
59 | interface.close()
60 | print("Interface closed. Goodbye!")
61 |
--------------------------------------------------------------------------------
/get-channels.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | import base64
3 |
4 | # Initialize Meshtastic interface
5 | interface = meshtastic.serial_interface.SerialInterface()
6 |
7 | # Get node information
8 | node = interface.getNode('^local')
9 | channels = node.channels
10 |
11 | if channels:
12 | print("Channels:")
13 | for channel in channels:
14 | if channel.role:
15 | psk_base64 = base64.b64encode(channel.settings.psk).decode('utf-8')
16 | print(f"Index: {channel.index}, Role: {channel.role}, PSK (Base64): {psk_base64}, Name: {channel.settings.name}")
17 | else:
18 | print("No channels found.")
19 |
20 |
--------------------------------------------------------------------------------
/get-config-modem-preset.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 |
3 | try:
4 | from meshtastic.protobuf import config_pb2
5 | except ImportError:
6 | from meshtastic import config_pb2
7 |
8 | interface = meshtastic.serial_interface.SerialInterface()
9 |
10 | ourNode = interface.getNode('^local')
11 |
12 | lora_config = ourNode.localConfig.lora
13 |
14 | # Get the enum value of modem_preset
15 | modem_preset_enum = lora_config.modem_preset
16 |
17 | # Get the string representation of the enum value
18 | modem_preset_string = config_pb2._CONFIG_LORACONFIG_MODEMPRESET.values_by_number[modem_preset_enum].name
19 |
20 | print(modem_preset_string)
21 |
--------------------------------------------------------------------------------
/list-protos.py:
--------------------------------------------------------------------------------
1 | from meshtastic.protobuf import mesh_pb2, channel_pb2, config_pb2, module_config_pb2
2 |
3 | def generate_menu_from_protobuf(message_instance):
4 | if not hasattr(message_instance, "DESCRIPTOR"):
5 | return None # Return None for non-protobuf instances
6 | menu = {}
7 |
8 | field_names = message_instance.DESCRIPTOR.fields_by_name.keys()
9 | for field_name in field_names:
10 | field_descriptor = message_instance.DESCRIPTOR.fields_by_name[field_name]
11 | if field_descriptor is not None:
12 | value = getattr(message_instance, field_name)
13 | if value is not None: # Exclude None values
14 | if hasattr(value, "DESCRIPTOR"): # Handle nested protobuf
15 | menu[field_name] = generate_menu_from_protobuf(value)
16 | else:
17 | menu[field_name] = str(value) if isinstance(value, bytes) else value # Convert binary strings
18 | return menu
19 |
20 | # Instantiate protobuf objects
21 | user = mesh_pb2.User()
22 | user_settings = ["long_name", "short_name", "is_licensed"]
23 | user_config = generate_menu_from_protobuf(user)
24 | user_config = {key: value if value != "" else "" for key, value in user_config.items() if key in user_settings}
25 |
26 | channel = channel_pb2.ChannelSettings()
27 | channel_config = generate_menu_from_protobuf(channel)
28 | channel_config = [{key: (value if value != "" else "") for key, value in channel_config.items()} for _ in range(8)]
29 |
30 | radio = config_pb2.Config()
31 | radio_config = generate_menu_from_protobuf(radio)
32 |
33 | module = module_config_pb2.ModuleConfig()
34 | module_config = generate_menu_from_protobuf(module)
35 |
36 | # Pretty print function for JSON-like output
37 | def pretty_print(title, data, indent=0):
38 | spacing = " " * indent
39 | if isinstance(data, dict):
40 | print(f"{spacing}{title}: {{")
41 | for i, (key, value) in enumerate(data.items()):
42 | is_last = i == len(data) - 1
43 | if isinstance(value, (dict, list)):
44 | pretty_print(f'"{key}"', value, indent + 2)
45 | else:
46 | print(f'{spacing} "{key}": {repr(value).lower() if isinstance(value, bool) else repr(value)}{"," if not is_last else ""}')
47 | print(f"{spacing}}}{',' if indent > 0 else ''}")
48 | elif isinstance(data, list):
49 | print(f"{spacing}{title}: [")
50 | for i, item in enumerate(data):
51 | is_last = i == len(data) - 1
52 | if isinstance(item, (dict, list)):
53 | pretty_print("", item, indent + 2)
54 | else:
55 | print(f"{spacing} {repr(item)}{',' if not is_last else ''}")
56 | print(f"{spacing}]{',' if indent > 0 else ''}")
57 | else:
58 | print(f'{spacing}{title}: {repr(data)}')
59 |
60 | # Print the final structured data
61 | print("{")
62 | pretty_print('"User Config"', user_config, 2)
63 | pretty_print('"Channel Config"', channel_config, 2)
64 | pretty_print('"Radio Config"', radio_config, 2)
65 | pretty_print('"Module Config"', module_config, 2)
66 | print("}")
--------------------------------------------------------------------------------
/print-messages.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 | import time
4 |
5 | interface = meshtastic.serial_interface.SerialInterface()
6 |
7 | def onReceive(packet, interface):
8 | if 'decoded' in packet:
9 | message_bytes = packet['decoded']['payload']
10 | message_string = message_bytes.decode('utf-8')
11 | print(message_string)
12 |
13 | pub.subscribe(onReceive, 'meshtastic.receive.text')
14 |
15 | while True:
16 | time.sleep(1)
--------------------------------------------------------------------------------
/print-myNodeInfo:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | import json
3 |
4 | interface = meshtastic.serial_interface.SerialInterface()
5 |
6 | my_node_info = interface.getMyNodeInfo()
7 |
8 | # print (my_node_info)
9 | # print (my_node_info['position']['latitude'])
10 |
11 | print(json.dumps(my_node_info, indent=4))
12 |
13 | interface.close()
--------------------------------------------------------------------------------
/print-nodedb.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | iface = meshtastic.serial_interface.SerialInterface()
3 | if iface.nodes:
4 | for node in iface.nodes.values():
5 | # print (node)
6 |
7 | print("Node Num:", node["num"])
8 | print("Node ID:", node["user"]["id"])
9 | print("Long Name:", node["user"]["longName"])
10 | print("Short Name:", node["user"]["shortName"])
11 | print("Hardware Model:", node["user"]["hwModel"])
12 | if "role" in node["user"]:
13 | print("Role:", node["user"]["role"])
14 | if "macaddr" in node["user"]:
15 | print("MAC Address:", node["user"]["macaddr"])
16 | if "publicKey" in node["user"]:
17 | print("Public Key: ", node["user"]["publicKey"])
18 |
19 | if "snr" in node:
20 | print("SNR:", node["snr"])
21 | if "lastHeard" in node:
22 | print("Last Heard:", node["lastHeard"])
23 | if "hopsAway" in node:
24 | print("Hops Away:", node["hopsAway"])
25 |
26 | if "position" in node:
27 | if "latitude" in node["position"]:
28 | print("Latitude:", node["position"]["latitude"])
29 | if "longitude" in node["position"]:
30 | print("Longitude:", node["position"]["longitude"])
31 | if "altitude" in node["position"]:
32 | print("Altitude:", node["position"]["altitude"])
33 | if "time" in node["position"]:
34 | print("Time:", node["position"]["time"])
35 |
36 | if "deviceMetrics" in node:
37 | if "batteryLevel" in node["deviceMetrics"]:
38 | print("Battery Level:", node["deviceMetrics"]["batteryLevel"])
39 | if "voltage" in node["deviceMetrics"]:
40 | print("Voltage:", node["deviceMetrics"]["voltage"])
41 | if "channelUtilization" in node["deviceMetrics"]:
42 | print("Channel Utilization:", node["deviceMetrics"]["channelUtilization"])
43 | if "airUtilTx" in node["deviceMetrics"]:
44 | print("Air Util Tx:", node["deviceMetrics"]["airUtilTx"])
45 | if "uptimeSeconds" in node["deviceMetrics"]:
46 | print("Uptime Seconds: ", node["deviceMetrics"]["uptimeSeconds"])
47 |
48 | print("\n")
49 | iface.close()
50 |
--------------------------------------------------------------------------------
/print-packets-basic.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 | import time
4 |
5 | interface = meshtastic.serial_interface.SerialInterface()
6 |
7 | def onReceive(packet, interface):
8 | print(f"{packet} \n\n")
9 |
10 | pub.subscribe(onReceive, 'meshtastic.receive')
11 |
12 | while True:
13 | time.sleep(1)
--------------------------------------------------------------------------------
/print-packets-json-log-and-plot.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 | import json
4 | import time
5 | import os
6 | import matplotlib.pyplot as plt
7 | from matplotlib.animation import FuncAnimation
8 | from collections import Counter
9 |
10 | interface = meshtastic.serial_interface.SerialInterface()
11 | local_node_id = interface.getNode('^local').nodeNum
12 | file_path = 'received_data.json'
13 |
14 | def onReceive(packet, interface):
15 |
16 | if packet['from'] != local_node_id:
17 | json_packet = json.dumps(packet, indent=2, default=lambda s: " ".join(str(s).split()))
18 |
19 | # Read the existing content and update it
20 | if os.path.exists(file_path):
21 | with open(file_path, 'r+') as json_file:
22 | content = json_file.read().strip()
23 | if content:
24 | if content.endswith(']'):
25 | content = content[:-1].rstrip() + ',\n'
26 | else:
27 | content = '['
28 | json_file.seek(0)
29 | json_file.write(content + json_packet + '\n]')
30 | else:
31 | json_file.seek(0)
32 | json_file.write('[' + json_packet + '\n]')
33 | json_file.truncate()
34 | else:
35 | with open(file_path, 'w') as json_file:
36 | json_file.write('[\n' + json_packet + '\n]')
37 |
38 | print(f"Received and saved packet:\n{json_packet}\n\n")
39 |
40 | pub.subscribe(onReceive, 'meshtastic.receive')
41 |
42 | def update_plots(frame):
43 | if os.path.exists(file_path):
44 | with open(file_path, 'r') as json_file:
45 | data = json.load(json_file)
46 |
47 | # Extract 'portnum' values, count occurrences
48 | portnums = [item.get('decoded', {}).get('portnum', 'Unknown') for item in data]
49 | portnum_counts = Counter(portnums)
50 |
51 | # Extract 'from' values, count occurrences
52 | from_values = [item.get('from', 'Unknown') for item in data]
53 | from_counts = Counter(from_values)
54 |
55 | # Plot portnum counts
56 | ax1.clear()
57 | ax1.bar(portnum_counts.keys(), portnum_counts.values(), color='b', label='Portnums')
58 | # ax1.set_xlabel('Portnums')
59 | ax1.set_ylabel('Count')
60 | ax1.set_title('Portnums Frequency')
61 | ax1.legend()
62 | ax1.tick_params(axis='x', rotation=90) # Rotate x-axis labels to vertical
63 |
64 | # Plot from counts
65 | ax2.clear()
66 | from_counts_str = {str(key): value for key, value in from_counts.items()}
67 | ax2.bar(from_counts_str.keys(), from_counts_str.values(), color='r', label='From Numbers')
68 | # ax2.set_xlabel('From Numbers')
69 | ax2.set_ylabel('Count')
70 | ax2.set_title('From Numbers Frequency')
71 | ax2.legend()
72 | ax2.tick_params(axis='x', rotation=90) # Rotate x-axis labels to vertical
73 |
74 | # Set up the plots
75 | fig, (ax1, ax2) = plt.subplots(1, 2, figsize=(14, 7))
76 | plt.subplots_adjust(bottom=0.2)
77 | ani = FuncAnimation(fig, update_plots, interval=1000)
78 | plt.show()
79 |
80 | while True:
81 | time.sleep(1)
82 |
--------------------------------------------------------------------------------
/print-packets-json-log.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 | import json
4 | import time
5 | import os
6 |
7 | interface = meshtastic.serial_interface.SerialInterface()
8 | local_node_id = interface.getNode('^local')
9 | file_path = 'received_data.json'
10 |
11 | def onReceive(packet, interface):
12 | if packet['from'] is not local_node_id:
13 | json_packet = json.dumps(packet, indent=4, default=lambda s: " ".join(str(s).split()))
14 | if os.path.exists(file_path):
15 | with open(file_path, 'r+') as json_file:
16 | content = json_file.read().strip()
17 | if content:
18 | if content.endswith(']'):
19 | content = content[:-1].rstrip() + ',\n'
20 | else:
21 | content = '['
22 | json_file.seek(0)
23 | json_file.write(content + json_packet + '\n]')
24 | else:
25 | json_file.seek(0)
26 | json_file.write('[' + json_packet + '\n]')
27 | json_file.truncate()
28 | else:
29 | with open(file_path, 'w') as json_file:
30 | json_file.write('[\n' + json_packet + '\n]')
31 |
32 | print(f"{json_packet}\n\n")
33 |
34 | pub.subscribe(onReceive, 'meshtastic.receive')
35 |
36 | while True:
37 | time.sleep(1)
38 |
--------------------------------------------------------------------------------
/print-packets-json.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 | import json
4 | import time
5 |
6 | interface = meshtastic.serial_interface.SerialInterface()
7 |
8 | def onReceive(packet, interface):
9 | packet = json.dumps(packet, indent=2, default=lambda s: " ".join(str(s).split()))
10 | print(f"{packet} \n\n")
11 |
12 | pub.subscribe(onReceive, 'meshtastic.receive')
13 |
14 | while True:
15 | time.sleep(1)
--------------------------------------------------------------------------------
/print-packets.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 | from meshtastic.protobuf import mesh_pb2, storeforward_pb2, paxcount_pb2
4 | from meshtastic import BROADCAST_NUM
5 | import time
6 |
7 |
8 | interface = meshtastic.serial_interface.SerialInterface()
9 |
10 | def idToHex(nodeId):
11 | return '!' + hex(nodeId)[2:]
12 |
13 | def onReceive(packet, interface):
14 | # Print all packets
15 | # print(f"{packet} \n\n")
16 |
17 | print("Received packet:")
18 | print(f" From: {packet['from']} / {idToHex(packet['from'])}")
19 | print(f" To: {packet['to']} / {idToHex(packet['to'])}")
20 | if 'channel' in packet:
21 | print(f" Channel: {packet['channel']}")
22 | if 'rxSnr' in packet:
23 | print(f" SNR: {packet['rxSnr']}")
24 | if 'rxRssi' in packet:
25 | print(f" RSSI: {packet['rxRssi']}")
26 | if 'hopLimit' in packet:
27 | print(f" Hop Limit: {packet['hopLimit']}")
28 | if 'hopStart' in packet:
29 | print(f" Hop Start: {packet['hopStart']}")
30 | if 'priority' in packet:
31 | print(f" Priority: {packet['priority']}")
32 | if 'viaMqtt' in packet:
33 | print(f" via MQTT: {packet['viaMqtt']}")
34 |
35 | if 'decoded' in packet:
36 | print(f" Port Number: {packet['decoded'].get('portnum', 'N/A')}")
37 |
38 | if packet['decoded'].get('portnum') == 'NODEINFO_APP':
39 | print(" Node Information:")
40 | node_info = packet['decoded'].get('user', {})
41 | print(f" ID: {node_info.get('id', 'N/A')}")
42 | print(f" Long Name: {node_info.get('longName', 'N/A')}")
43 | print(f" Short Name: {node_info.get('shortName', 'N/A')}")
44 | print(f" MAC Address: {node_info.get('macaddr', 'N/A')}")
45 | print(f" Hardware Model: {node_info.get('hwModel', 'N/A')}")
46 | if 'role' in packet:
47 | print(f" Role: {node_info.get('role', 'N/A')}")
48 | if 'isLicensed' in packet:
49 | print(f" Role: {node_info.get('isLicensed', 'N/A')}")
50 | if 'hopsAway' in packet:
51 | print(f" Hops Away: {packet['hopsAway']}")
52 |
53 | elif packet['decoded'].get('portnum') == 'POSITION_APP':
54 | print(" Position:")
55 | position = packet['decoded']['position']
56 | print(f" Latitude: {position.get('latitude', 'N/A')}")
57 | print(f" Longitude: {position.get('longitude', 'N/A')}")
58 | print(f" Altitude: {position.get('altitude', 'N/A')}")
59 | if 'PDOP' in position:
60 | print(f" PDOP: {position.get('PDOP', 'N/A')}")
61 | if 'ground_track' in position:
62 | print(f" Ground Track: {position.get('ground_track', 'N/A')}")
63 | if 'sats_in_view:' in position:
64 | print(f" Satellites in View: {position.get('sats_in_view:', 'N/A')}")
65 |
66 |
67 | elif packet['decoded'].get('portnum') == 'TEXT_MESSAGE_APP':
68 | print(" Text Message:")
69 | print(f" Text: {packet['decoded']['text']}")
70 |
71 | elif packet['decoded'].get('portnum') == 'TELEMETRY_APP':
72 | print(" Telemetry:")
73 | telemetry = packet['decoded'].get('telemetry', {})
74 | print(f" Time: {telemetry.get('time', 'N/A')}")
75 | print(" Device Metrics:")
76 |
77 | device_metrics = telemetry.get('deviceMetrics', {})
78 | if device_metrics:
79 | print(f" Battery Level: {device_metrics.get('batteryLevel', 'N/A')}")
80 | print(f" Voltage: {device_metrics.get('voltage', 'N/A')}")
81 | print(f" Channel Utilization: {device_metrics.get('channelUtilization', 'N/A')}")
82 | print(f" Air Utilization Tx: {device_metrics.get('airUtilTx', 'N/A')}")
83 | print(f" Uptime Seconds: {device_metrics.get('uptimeSeconds', 'N/A')}")
84 |
85 | power_metrics = telemetry.get('powerMetrics', {})
86 | if power_metrics:
87 | print(" Power Metrics:")
88 | print(f" CH1 Voltage: {power_metrics.get('ch1_voltage', 'N/A')}")
89 | print(f" CH1 Current: {power_metrics.get('ch1_current', 'N/A')}")
90 | print(f" CH2 Voltage: {power_metrics.get('ch2_voltage', 'N/A')}")
91 | print(f" CH2 Current: {power_metrics.get('ch2_current', 'N/A')}")
92 |
93 | environment_metrics = telemetry.get('environmentMetrics', {})
94 | if environment_metrics:
95 | print(" Environment Metrics:")
96 | print(f" Temperature: {environment_metrics.get('temperature', 'N/A')}")
97 | print(f" Relative Humidity: {environment_metrics.get('relativeHumidity', 'N/A')}")
98 | print(f" Barometric Pressure: {environment_metrics.get('barometricPressure', 'N/A')}")
99 |
100 | elif packet['decoded'].get('portnum') == 'NEIGHBORINFO_APP':
101 | # Neighbor Information
102 | print(" Neighbor Information:")
103 | message = mesh_pb2.NeighborInfo()
104 | payload_bytes = packet['decoded'].get('payload', b'')
105 | message.ParseFromString(payload_bytes)
106 | print(f" Node ID: {message.node_id} / {idToHex(message.node_id)}")
107 | print(f" Last Sent By ID: {message.last_sent_by_id}")
108 | print(f" Node Broadcast Interval (secs): {message.node_broadcast_interval_secs}")
109 | print(" Neighbors:")
110 | for neighbor in message.neighbors:
111 | print(f" Neighbor ID: {neighbor.node_id} / {idToHex(neighbor.node_id)}")
112 | print(f" SNR: {neighbor.snr}")
113 |
114 | elif packet['decoded'].get('portnum') == 'RANGE_TEST_APP':
115 | print(" Range Test Information:")
116 | payload = packet['decoded'].get('payload', b'')
117 | print(f" Payload: {payload.decode()}")
118 |
119 | elif packet['decoded'].get('portnum') == 'STORE_FORWARD_APP':
120 | print(" Store Forward Information:")
121 | message = storeforward_pb2.StoreAndForward()
122 | payload_bytes = packet['decoded'].get('payload', b'')
123 | message.ParseFromString(payload_bytes)
124 | if message.HasField('stats'):
125 | print(f" Statistics: {message.stats}")
126 | if message.HasField('history'):
127 | print(f" History: {message.history}")
128 | if message.HasField('heartbeat'):
129 | print(f" Heartbeat: {message.heartbeat}")
130 |
131 | elif packet['decoded'].get('portnum') == 'ADMIN_APP':
132 | print(" Administrative Information:")
133 | payload = packet['decoded'].get('payload', b'')
134 | print(f" Payload: {payload}")
135 | admin_info = packet['decoded'].get('admin', {})
136 | if 'getChannelResponse' in admin_info:
137 | response = admin_info['getChannelResponse']
138 | print(" Get Channel Response:")
139 | print(f" Index: {response.get('index', 'N/A')}")
140 | print(" Settings:")
141 | settings = response.get('settings', {})
142 | for key, value in settings.items():
143 | print(f" {key}: {value}")
144 |
145 | elif packet['decoded'].get('portnum') == 'PAXCOUNTER_APP':
146 | print(" Paxcounter Information:")
147 | message = paxcount_pb2.Paxcount()
148 | payload_bytes = packet['decoded'].get('payload', b'')
149 | message.ParseFromString(payload_bytes)
150 | print(f" Wifi: {message.wifi}")
151 | print(f" BLE: {message.ble}")
152 | print(f" Uptime: {message.uptime}")
153 |
154 | else:
155 | print(f" Decoded packet does not contain data we are looking for: {packet['decoded'].get('portnum', 'N/A')}")
156 | else:
157 | print(" No 'decoded' key found in the packet. Our node doesn't have the encryption key!")
158 |
159 | print()
160 |
161 | pub.subscribe(onReceive, 'meshtastic.receive')
162 |
163 | while True:
164 | time.sleep(1)
--------------------------------------------------------------------------------
/print-traceroute.py:
--------------------------------------------------------------------------------
1 |
2 | from pubsub import pub
3 | import time
4 | import meshtastic.serial_interface, meshtastic.tcp_interface
5 | interface = meshtastic.serial_interface.SerialInterface()
6 | # interface = meshtastic.tcp_interface.TCPInterface(hostname="192.168.86.39")
7 |
8 | dest = 1623194643
9 | hopLimit = 5
10 | channelIndex = 0
11 |
12 | interface.sendTraceRoute(dest, hopLimit, channelIndex=channelIndex)
13 |
14 | def onReceive(packet, interface):
15 | if 'decoded' in packet and packet['decoded']['portnum'] == 'TRACEROUTE_APP':
16 |
17 | routeBack = packet['decoded']['traceroute'].get('routeBack', [])
18 | route = packet['decoded']['traceroute'].get('route', [])
19 |
20 | message = f"{packet['to']}"
21 |
22 | if routeBack:
23 | message += f" --> {' --> '.join(map(str, routeBack))}"
24 |
25 | message += f" --> {packet['from']}"
26 |
27 | if route:
28 | message += f" --> {' --> '.join(map(str, route))}"
29 |
30 | message += f" --> {packet['to']}"
31 |
32 | print(message)
33 |
34 | pub.subscribe(onReceive, 'meshtastic.receive')
35 |
36 | while True:
37 | time.sleep(1)
--------------------------------------------------------------------------------
/request-telemetry-simple.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 |
3 | remote_node = 1623194643
4 | want_response = True
5 | channel = 0
6 |
7 | interface = meshtastic.serial_interface.SerialInterface()
8 | interface.sendTelemetry(remote_node, want_response, channel)
9 | interface.close()
--------------------------------------------------------------------------------
/save-admin-keys.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | import base64
3 | import logging
4 | import time
5 |
6 | logging.basicConfig(level=logging.INFO)
7 |
8 | new_keys = [
9 | 'D4Xi3qdGihJj1gTo2T6lyw6fqKudb/3aWncKJAdZikE=',
10 | 'K7Pm5qGWiKd5K8XpK2+7DwJFlL3aZG5D8F+eC34U5DY=',
11 | 'zQvX5UuY0V7qMgF2PvAlV+5OMqUQ8DdKkHE7GvVJEBU='
12 | ]
13 |
14 | # Remove "base64:" prefix and decode
15 | decoded_keys = [base64.b64decode(key) for key in new_keys]
16 |
17 | interface = meshtastic.serial_interface.SerialInterface()
18 | ourNode = interface.getNode('^local')
19 |
20 | # Get reference to security config
21 | security_config = ourNode.localConfig.security
22 |
23 | # Clear existing keys if needed
24 | if len(security_config.admin_key) > 0:
25 | logging.info("Clearing existing admin keys...")
26 | del security_config.admin_key[:]
27 | ourNode.writeConfig("security")
28 | time.sleep(1) # Give time for device to process
29 |
30 | # Append new keys
31 | for key in decoded_keys:
32 | logging.info(f"Adding admin key: {key}")
33 | security_config.admin_key.append(key)
34 |
35 | ourNode.writeConfig("security")
36 |
37 | logging.info("Admin keys updated successfully!")
--------------------------------------------------------------------------------
/save-channel.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from meshtastic.protobuf import channel_pb2
3 | import base64
4 |
5 | interface = meshtastic.serial_interface.SerialInterface()
6 | node = interface.getNode('^local')
7 |
8 | edit_channel = 1
9 | new_settings = {'psk': 'AQ==', 'name': 'NBC', 'uplink_enabled': True, 'downlink_enabled': True, 'position_precision': 13}
10 |
11 | channel = node.channels[edit_channel]
12 |
13 | for key, value in new_settings.items():
14 | if key == 'psk': # Special case: decode Base64 for psk
15 | channel.settings.psk = base64.b64decode(value)
16 | elif key == 'position_precision': # Special case: module_settings
17 | channel.settings.module_settings.position_precision = value
18 | else:
19 | setattr(channel.settings, key, value) # Use setattr for other fields
20 |
21 | if edit_channel == 0:
22 | channel.role = channel_pb2.Channel.Role.PRIMARY
23 | else:
24 | channel.role = channel_pb2.Channel.Role.SECONDARY
25 |
26 | node.writeChannel(edit_channel)
27 | print(node.channels)
28 |
29 | interface.close()
--------------------------------------------------------------------------------
/send-and-receive.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from pubsub import pub
3 |
4 | interface = meshtastic.serial_interface.SerialInterface()
5 |
6 | def onReceive(packet, interface):
7 | try:
8 | if 'decoded' in packet and packet['decoded']['portnum'] == 'TEXT_MESSAGE_APP':
9 | message_bytes = packet['decoded']['payload']
10 | message_string = message_bytes.decode('utf-8')
11 | print(f"{message_string} \n> ", end="", flush=True)
12 | except KeyError as e:
13 | print(f"Error processing packet: {e}")
14 |
15 | pub.subscribe(onReceive, 'meshtastic.receive')
16 |
17 | def send_message(message):
18 | interface.sendText(message)
19 |
20 | while True:
21 | text = input("> ")
22 | send_message(text)
--------------------------------------------------------------------------------
/send-device-metrics.py:
--------------------------------------------------------------------------------
1 | try:
2 | from meshtastic.protobuf import portnums_pb2, telemetry_pb2
3 | from meshtastic import BROADCAST_NUM
4 | except ImportError:
5 | from meshtastic import portnums_pb2, telemetry_pb2, BROADCAST_NUM
6 |
7 | import time
8 |
9 | # For connection over serial
10 | import meshtastic.serial_interface
11 | interface = meshtastic.serial_interface.SerialInterface()
12 |
13 | # For connection over TCP
14 | # import meshtastic.tcp_interface
15 | # interface = meshtastic.tcp_interface.TCPInterface(hostname='192.168.1.42', noProto=False)
16 |
17 | telemetry_data = telemetry_pb2.Telemetry()
18 | telemetry_data.device_metrics.battery_level = 69
19 | telemetry_data.device_metrics.voltage = 4.1
20 | telemetry_data.device_metrics.channel_utilization = 42
21 | telemetry_data.device_metrics.air_util_tx = 1
22 | telemetry_data.time = int(time.time())
23 |
24 | interface.sendData(
25 | telemetry_data,
26 | destinationId=BROADCAST_NUM,
27 | portNum=portnums_pb2.PortNum.TELEMETRY_APP,
28 | wantResponse=False,
29 | onResponse=False,
30 | )
31 |
32 | interface.close()
--------------------------------------------------------------------------------
/send-direct-message.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | import time
3 |
4 | message = "Test Message"
5 | sender_node_id = 3718164584
6 |
7 | interface = meshtastic.serial_interface.SerialInterface()
8 |
9 | def send_message(message):
10 | interface.sendText(
11 | text=message,
12 | destinationId=sender_node_id,
13 | wantAck=True,
14 | wantResponse=True
15 | )
16 |
17 | send_message(message)
18 |
19 | while True:
20 | time.sleep(0.1)
--------------------------------------------------------------------------------
/send-environment-metrics.py:
--------------------------------------------------------------------------------
1 | from meshtastic.protobuf import portnums_pb2, telemetry_pb2
2 | from meshtastic import BROADCAST_ADDR
3 | import time
4 |
5 | # For connection over serial
6 | import meshtastic.serial_interface
7 | interface = meshtastic.serial_interface.SerialInterface()
8 |
9 | # For connection over TCP
10 | # import meshtastic.tcp_interface
11 | # interface = meshtastic.tcp_interface.TCPInterface(hostname='192.168.1.42', noProto=False)
12 |
13 | telemetry_data = telemetry_pb2.Telemetry()
14 | telemetry_data.time = int(time.time())
15 | telemetry_data.environment_metrics.temperature = 352.222
16 | telemetry_data.environment_metrics.relative_humidity = 69
17 | # telemetry_data.environment_metrics.barometric_pressure = 0
18 | # telemetry_data.environment_metrics.gas_resistance = 0
19 | # telemetry_data.environment_metrics.voltage = 0
20 | # telemetry_data.environment_metrics.current = 0
21 | # telemetry_data.environment_metrics.iaq = 0
22 | # telemetry_data.environment_metrics.distance = 0
23 | # telemetry_data.environment_metrics.lux = 0
24 | # telemetry_data.environment_metrics.white_lux = 0
25 | # telemetry_data.environment_metrics.ir_lux = 0
26 | # telemetry_data.environment_metrics.uv_lux = 0
27 | # telemetry_data.environment_metrics.wind_direction = 0
28 | # telemetry_data.environment_metrics.wind_speed = 0
29 | # telemetry_data.environment_metrics.wind_gust = 0
30 | # telemetry_data.environment_metrics.wind_lull = 0
31 | # telemetry_data.environment_metrics.weight = 0
32 |
33 | interface.sendData(
34 | telemetry_data,
35 | destinationId=BROADCAST_ADDR,
36 | portNum=portnums_pb2.PortNum.TELEMETRY_APP,
37 | wantResponse=False,
38 | )
39 |
40 | interface.close()
--------------------------------------------------------------------------------
/send-nodeinfo.py:
--------------------------------------------------------------------------------
1 |
2 | from meshtastic.protobuf import mesh_pb2, config_pb2
3 | from meshtastic import BROADCAST_NUM
4 | import meshtastic.serial_interface
5 |
6 | interface = meshtastic.serial_interface.SerialInterface()
7 |
8 | user = mesh_pb2.User()
9 | me = interface.nodesByNum[interface.localNode.nodeNum]['user']
10 | user.id = me['id']
11 | user.long_name = me['longName']
12 | user.short_name = me['shortName']
13 | user.hw_model = mesh_pb2.HardwareModel.Value(me['hwModel'])
14 | if user.role:
15 | user.role = config_pb2.Config.DeviceConfig.Role.Value(me['role'])
16 |
17 | interface.sendData(
18 | user,
19 | destinationId=BROADCAST_NUM,
20 | portNum=meshtastic.portnums_pb2.NODEINFO_APP,
21 | wantAck=False,
22 | wantResponse=False
23 | )
24 | interface.close()
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/send-position.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from meshtastic import BROADCAST_NUM
3 |
4 | interface = meshtastic.serial_interface.SerialInterface()
5 |
6 | interface.sendPosition(
7 | latitude = 45,
8 | longitude = -120,
9 | altitude = 100,
10 | destinationId = BROADCAST_NUM,
11 | wantAck = False,
12 | wantResponse = False,
13 | )
14 |
15 | interface.close()
--------------------------------------------------------------------------------
/send-telemetry.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | from meshtastic import BROADCAST_NUM
3 |
4 | telemetry_type = "device_metrics" # environment_metrics, air_quality_metrics, power_metrics, local_stats
5 | want_response = False
6 | channel = 0
7 |
8 | interface = meshtastic.serial_interface.SerialInterface()
9 | interface.sendTelemetry(BROADCAST_NUM, want_response, channel, telemetry_type)
10 | interface.close()
--------------------------------------------------------------------------------
/send-traceroute-simple.py:
--------------------------------------------------------------------------------
1 | import meshtastic.serial_interface
2 | interface = meshtastic.serial_interface.SerialInterface()
3 | dest = 1623194643
4 | hopLimit = 3
5 | channelIndex = 0
6 |
7 | interface.sendTraceRoute(dest, hopLimit, channelIndex=channelIndex)
--------------------------------------------------------------------------------
/tcp_watchdog.py:
--------------------------------------------------------------------------------
1 | import asyncio
2 | import io
3 | import contextlib
4 | import socket
5 | from pubsub import pub
6 | import meshtastic.tcp_interface
7 |
8 | host = '192.168.86.45'
9 | test_connection_seconds = 10
10 | retry_connection_seconds = 3
11 |
12 | # Function to get firmware version
13 | def getNodeFirmware(interface):
14 | try:
15 | output_capture = io.StringIO()
16 | with contextlib.redirect_stdout(output_capture), contextlib.redirect_stderr(output_capture):
17 | interface.localNode.getMetadata()
18 |
19 | console_output = output_capture.getvalue()
20 |
21 | if "firmware_version" in console_output:
22 | return console_output.split("firmware_version: ")[1].split("\n")[0]
23 |
24 | return -1
25 | except (socket.error, BrokenPipeError, ConnectionResetError, Exception) as e:
26 | print(f"Error retrieving firmware: {e}")
27 | raise e # Propagate the error to handle reconnection
28 |
29 | # Async function to retry connection
30 | async def retry_interface():
31 | print("Retrying connection to the interface...")
32 | await asyncio.sleep(retry_connection_seconds) # Wait before retrying
33 |
34 | try:
35 | interface = meshtastic.tcp_interface.TCPInterface(hostname=host)
36 | print("Interface reinitialized successfully.")
37 | return interface
38 | except (ConnectionRefusedError, socket.error, Exception) as e:
39 | print(f"Failed to reinitialize interface: {e}")
40 | return None
41 |
42 | # Function to check connection and reconnect if needed
43 | async def check_and_reconnect(interface):
44 | if interface is None:
45 | print("No valid interface. Attempting to reconnect...")
46 | interface = await retry_interface()
47 | return interface
48 |
49 | try:
50 | print("Checking interface connection...")
51 | fw_ver = getNodeFirmware(interface)
52 | if fw_ver != -1:
53 | print(f"Firmware Version: {fw_ver}")
54 | return interface
55 | else:
56 | raise Exception("Failed to retrieve firmware version.")
57 |
58 | except (socket.error, BrokenPipeError, ConnectionResetError, Exception) as e:
59 | print(f"Error with the interface, setting to None and attempting reconnect: {e}")
60 | return await retry_interface()
61 |
62 | # Main watchdog loop
63 | async def watchdog(interface):
64 | while True:
65 | await asyncio.sleep(test_connection_seconds)
66 | interface = await check_and_reconnect(interface)
67 | if interface:
68 | print("Interface is connected.")
69 | else:
70 | print("Interface connection failed. Retrying...")
71 |
72 | # Handle received messages
73 | def onReceive(packet, interface):
74 | if 'decoded' in packet and packet['decoded']['portnum'] == 'TEXT_MESSAGE_APP':
75 | print(packet)
76 |
77 | # Main function
78 | async def main():
79 | try:
80 | interface = meshtastic.tcp_interface.TCPInterface(hostname=host)
81 | print("Interface initialized.")
82 | except (ConnectionRefusedError, socket.error) as e:
83 | print(f"Failed to initialize interface: {e}")
84 | interface = None
85 |
86 | pub.subscribe(onReceive, 'meshtastic.receive')
87 | await watchdog(interface)
88 |
89 | # Run the program
90 | if __name__ == "__main__":
91 | try:
92 | asyncio.run(main())
93 | except KeyboardInterrupt:
94 | print("Shutting down...")
--------------------------------------------------------------------------------
/test-rssi-snr.py:
--------------------------------------------------------------------------------
1 |
2 | import meshtastic.serial_interface, meshtastic.tcp_interface
3 | from meshtastic.protobuf import telemetry_pb2, portnums_pb2
4 | from pubsub import pub
5 | import time
6 |
7 |
8 | # dest = 147281321 ## DUMMY RAK
9 | dest = 963936390 ## MESHSTICK
10 |
11 | want_response = True
12 | channel = 0
13 |
14 | interface = meshtastic.serial_interface.SerialInterface()
15 | interface = meshtastic.tcp_interface.TCPInterface(hostname="192.168.86.39")
16 |
17 | telemetry_data = telemetry_pb2.Telemetry()
18 | telemetry_data.device_metrics.battery_level = 69
19 |
20 | response_received = False
21 | last_request_time = None
22 |
23 | def signalReport():
24 | global last_request_time
25 | global response_received
26 | # print("Requesting data...")
27 | response_received = False
28 | last_request_time = time.time() # Update last request time
29 | interface.sendData(
30 | telemetry_data,
31 | destinationId=dest,
32 | portNum=portnums_pb2.PortNum.TELEMETRY_APP,
33 | wantResponse=want_response
34 | )
35 |
36 | def onReceive(packet, interface):
37 | global response_received
38 | if packet['from'] == dest:
39 | print(f"SNR: {packet['rxSnr']} RSSI: {packet['rxRssi']}")
40 | response_received = True
41 |
42 | pub.subscribe(onReceive, 'meshtastic.receive')
43 |
44 | signalReport() # Initial request
45 |
46 | try:
47 | while True:
48 | time.sleep(0.1) # Short sleep to allow quick response check
49 | if response_received:
50 | signalReport() # Send another request after receiving a response
51 | elif time.time() - last_request_time > 15:
52 | print("No response received for 10 seconds, retrying...")
53 | signalReport() # Retry if no response received for 10 seconds
54 | except KeyboardInterrupt:
55 | print("Exiting program...")
56 | finally:
57 | interface.close()
58 | print("Interface closed. Goodbye!")
59 |
--------------------------------------------------------------------------------