Skip to content

Commit 1bfaf24

Browse files
dreirundNick Dunklee
dreirund
authored and
Nick Dunklee
committed
docs/faq.md: Categorising section 5.14. "Q: Are there are projects built around MeshCore?".
In `[docs/faq.md](https://github.com/meshcore-dev/MeshCore/blob/main/docs/faq.md)`, the entries are now grouped by category. This patch applies on top of meshcore-dev#1822.
1 parent 3cf6e1a commit 1bfaf24

File tree

1 file changed

+55
-38
lines changed

1 file changed

+55
-38
lines changed

‎docs/faq.md‎

Lines changed: 55 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -55,23 +55,28 @@ A list of frequently-asked questions and answers for MeshCore
5555
- [5.12. Q: How do I add a node to the MeshCore Map](#512-q-how-do-i-add-a-node-to-the-meshcore-map)
5656
- [5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?](#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio)
5757
- [5.14. Q: Are there are projects built around MeshCore?](#514-q-are-there-are-projects-built-around-meshcore)
58-
- [5.14.0. awesome-meshcore](#5140-awesome-meshcore)
59-
- [5.14.1. meshcoremqtt](#5141-meshcoremqtt)
60-
- [5.14.2. MeshCore for Home Assistant](#5142-meshcore-for-home-assistant)
61-
- [5.14.3. Python MeshCore](#5143-python-meshcore)
62-
- [5.14.4. meshcore-cli](#5144-meshcore-cli)
63-
- [5.14.5. meshcore.js](#5145-meshcorejs)
64-
- [5.14.6. pyMC\_core](#5146-pymc_core)
65-
- [5.14.7. MeshCore Packet Decoder](#5147-meshcore-packet-decoder)
66-
- [5.14.8. meshcore-pi](#5148-meshcore-pi)
67-
- [5.14.9. pyMC\_Repeater](#5149-pymc_repeater)
68-
- [5.14.10. meshcore-open](#51410-meshcore-open)
69-
- [5.14.11. MeshCore-Cardputer-ADV](#51411-MeshCore-Cardputer-ADV)
70-
- [5.14.12. LunarCore](#51412-LunarCore)
71-
- [5.14.13. MC-Term](#51413-MC-Term)
72-
- [5.14.14. Meck](#51414-Meck)
73-
- [5.14.15. Meshcore for Wio Tracker L1 Pro](#51415-Meshcore-for-Wio-Tracker-L1-Pro)
74-
- [5.14.16. MeshCore map auto uploader](#51416-MeshCore-map-auto-uploader)
58+
- [5.14.1. overview](#5141-overview)
59+
- [5.14.1.1. awesome-meshcore](#51411-awesome-meshcore)
60+
- [5.14.2. programming libraries, command line software](#5142-programming-libraries-command-line-software)
61+
- [5.14.2.1. meshcoremqtt](#51421-meshcoremqtt)
62+
- [5.14.2.2. MeshCore for Home Assistant](#51422-meshcore-for-home-assistant)
63+
- [5.14.2.3. Python MeshCore](#51423-python-meshcore)
64+
- [5.14.2.4. meshcore-cli](#51424-meshcore-cli)
65+
- [5.14.2.5. meshcore.js](#51425-meshcorejs)
66+
- [5.14.2.6. pyMC\_core](#51426-pymc_core)
67+
- [5.14.2.7. MeshCore Packet Decoder](#51427-meshcore-packet-decoder)
68+
- [5.14.2.8. meshcore-pi](#51428-meshcore-pi)
69+
- [5.14.2.9. pyMC\_Repeater](#51429-pymc_repeater)
70+
- [5.14.2.10. MeshCore map auto uploader](#514210-MeshCore-map-auto-uploader)
71+
- [5.14.3. apps, graphical software](#5143-apps-graphical-software)
72+
- [5.14.3.1. meshcore-open](#51431-meshcore-open)
73+
- [5.14.4. firmwares](#5144-firmwares)
74+
- [5.14.4.1. MeshCore-Cardputer-ADV](#51441-MeshCore-Cardputer-ADV)
75+
- [5.14.4.2. LunarCore](#51442-LunarCore)
76+
- [5.14.4.3. MC-Term](#51443-MC-Term)
77+
- [5.14.4.4. Meck](#51444-Meck)
78+
- [5.14.4.5. Meshcore for Wio Tracker L1 Pro](#51445-Meshcore-for-Wio-Tracker-L1-Pro)
79+
- [5.14.5. online services](#5145-online-services)
7580
- [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-client-applications-for-windows-or-mac)
7681
- [5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?](#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems)
7782
- [6. Troubleshooting](#6-troubleshooting)
@@ -612,82 +617,94 @@ From here, reference repeater and room server command line commands on MeshCore
612617

613618
### 5.14. Q: Are there are projects built around MeshCore?
614619

615-
**A:** Yes. See the following:
620+
**A:** Yes. Some of them are listed below.
616621

617-
#### 5.14.0. awesome-meshcore
622+
#### 5.14.1. overview
623+
624+
Some resources that by themselves give overviews about MeshCore related projects:
625+
626+
##### 5.14.1.1. awesome-meshcore
618627
A meta website/ git-repository collecting many projects related to MeshCore, grouped by type. See
619628
https://github.com/samuk/awesome-meshcore.
620629

621-
A few projects are also listed here in the following paragraphs:
630+
#### 5.14.2. programming libraries, command line software
622631

623-
#### 5.14.1. meshcoremqtt
632+
##### 5.14.2.1. meshcoremqtt
624633
A Python script to send meshcore debug and packet capture data to MQTT for analysis. Cisien's version is a fork of Andrew-a-g's and is being used to to collect data for https://map.w0z.is/messages and https://analyzer.letsmesh.net/
625634
https://github.com/Cisien/meshcoretomqtt
626635
https://github.com/Andrew-a-g/meshcoretomqtt
627636

628-
#### 5.14.2. MeshCore for Home Assistant
637+
##### 5.14.2.2. MeshCore for Home Assistant
629638
A custom Home Assistant integration for MeshCore mesh radio nodes. It allows you to monitor and control MeshCore nodes via USB, BLE, or TCP connections.
630639
https://github.com/awolden/meshcore-ha
631640

632-
#### 5.14.3. Python MeshCore
641+
##### 5.14.2.3. Python MeshCore
633642
Bindings to access your MeshCore companion radio nodes in python.
634643
https://github.com/fdlamotte/meshcore_py
635644

636-
#### 5.14.4. meshcore-cli
645+
##### 5.14.2.4. meshcore-cli
637646
CLI interface to MeshCore companion radio over BLE, TCP, or serial. Uses Python MeshCore above.
638647
https://github.com/fdlamotte/meshcore-cli
639648

640-
#### 5.14.5. meshcore.js
649+
##### 5.14.2.5. meshcore.js
641650
A JavaScript library for interacting with a MeshCore device running the companion radio firmware
642651
https://github.com/liamcottle/meshcore.js
643652

644-
#### 5.14.6. pyMC_core
653+
##### 5.14.2.6. pyMC_core
645654
pyMC_Core is a Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI.
646655
https://github.com/rightup/pyMC_core
647656

648-
#### 5.14.7. MeshCore Packet Decoder
657+
##### 5.14.2.7. MeshCore Packet Decoder
649658
A TypeScript library for decoding MeshCore mesh networking packets with full cryptographic support. Uses WebAssembly (WASM) for Ed25519 key derivation through the orlp/ed25519 library. It powers the [MeshCore Packet Analyzer](https://analyzer.letsmesh.net/packets).
650659
https://github.com/michaelhart/meshcore-decoder
651660

652-
#### 5.14.8. meshcore-pi
661+
##### 5.14.2.8. meshcore-pi
653662
meshcore-pi is another Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI or GPIO.
654663
https://github.com/brianwiddas/meshcore-pi
655664

656-
#### 5.14.9. pyMC_Repeater
665+
##### 5.14.2.9. pyMC_Repeater
657666
pyMC_Repeater is a repeater daemon in Python built on top of the [`pymc_core`](#5146-pymc_core) library.
658667
https://github.com/rightup/pyMC_Repeater
659668

660-
#### 5.14.10. meshcore-open
669+
##### 5.14.2.10. MeshCore map auto uploader
670+
A Node.js software that will upload every repeater or room server to [map.meshcore.dev](https://map.meshcore.dev/) when a connected companion hears new advert.
671+
https://github.com/recrof/map.meshcore.dev-uploader
672+
673+
#### 5.14.3. apps, graphical software
674+
675+
##### 5.14.3.1. meshcore-open
661676
Open Source companion app for Android, iOS, GNU/Linux (and maybe other Unixes), Windows, macOS, chromium-based browsers.
662677
https://github.com/zjs81/meshcore-open
663678

664-
#### 5.14.11. MeshCore-Cardputer-ADV
679+
#### 5.14.4. firmwares
680+
681+
##### 5.14.4.1. MeshCore-Cardputer-ADV
665682
Standalone client firmware for the "[M5Stack Cardputer ADV](https://docs.m5stack.com/en/core/Cardputer-Adv)" with the "[M5Stack Cap LoRa-1262](https://docs.m5stack.com/en/cap/Cap_LoRa-1262)" module.
666683

667684
There are two variants:
668685

669686
* https://github.com/Stachugit/MeshCore-Cardputer-ADV,
670687
* https://github.com/sosprz/meshcore-cardputer-adv.
671688

672-
#### 5.14.12. LunarCore
689+
##### 5.14.4.2. LunarCore
673690
Multi-protocol mesh firmware for ESP32-S3 LoRa devices (MeshCore, Meshtastic, RNode/KISS (Reticulum)). Protocol is auto-detected from the first bytes over serial or BLE.
674691
https://github.com/STCisGOOD/lunarcore
675692

676-
#### 5.14.13. MC-Term
693+
##### 5.14.4.3. MC-Term
677694
(Soon to be) Open Source companion firmware for [LilyGO T-Deck (Plus)](https://lilygo.cc/en-us/products/t-deck-plus-1) and [Seeed Studio SenseCap Indicator (TFT / D1Pro)](https://www.seeedstudio.com/SenseCAP-Indicator-D1Pro-p-5644.html), that can be used both standalone and together with a companion app.
678695
https://github.com/dabeani/meshcore
679696

680-
#### 5.14.14. Meck
697+
##### 5.14.4.4. Meck
681698
Companion firmware for [LilyGo T-Deck Pro](https://lilygo.cc/products/t-deck-pro) that allows standalone operation and connection to a companion app via Bluetooth Low Energy (BLE).
682699
https://github.com/pelgraine/Meck
683700

684-
#### 5.14.15. Meshcore for Wio Tracker L1 Pro
701+
##### 5.14.4.5. Meshcore for Wio Tracker L1 Pro
685702
Companion firmware for [Seeed Studio Wio Tracker L1 Pro](https://www.seeedstudio.com/Wio-Tracker-L1-Pro-p-6454.html) with specific UI adjustments that can be used standalone.
686703
https://github.com/sosprz/Meshcore-Wio-Tracker-L1-Pro
687704

688-
#### 5.14.16. MeshCore map auto uploader
689-
A Node.js software that will upload every repeater or room server to [map.meshcore.dev](https://map.meshcore.dev/) when a connected companion hears new advert.
690-
https://github.com/recrof/map.meshcore.dev-uploader
705+
#### 5.14.5. online services
706+
707+
*(None yet listed here. See [overview ressources](#5141-overview).)*
691708

692709

693710
### 5.15. Q: Are there client applications for Windows or Mac?

0 commit comments

Comments
 (0)