You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/faq.md
+63-43Lines changed: 63 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
**MeshCore-FAQ**<!-- omit from toc -->
2
2
A list of frequently-asked questions and answers for MeshCore
3
3
4
-
The current version of this MeshCore FAQ is at https://github.com/ripplebiz/MeshCore/blob/main/docs/faq.md.
4
+
The current version of this MeshCore FAQ is at https://github.com/meshcore-dev/MeshCore/blob/main/docs/faq.md.
5
5
This MeshCore FAQ is also mirrored at https://github.com/LitBomb/MeshCore-FAQ and might have newer updates if pull requests on Scott's MeshCore repo are not approved yet.
6
6
7
7
author: https://github.com/LitBomb<!-- omit from toc -->
@@ -27,18 +27,20 @@ author: https://github.com/LitBomb<!-- omit from toc -->
27
27
-[3.3. Q: What is the password to administer a repeater or a room server?](#33-q-what-is-the-password-to-administer-a-repeater-or-a-room-server)
28
28
-[3.4. Q: What is the password to join a room server?](#34-q-what-is-the-password-to-join-a-room-server)
29
29
-[4. T-Deck Related](#4-t-deck-related)
30
-
-[4.1. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?](#41-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode)
31
-
-[4.2. Q: Why is my T-Deck Plus not getting any satellite lock?](#42-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock)
32
-
-[4.3. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?](#43-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock)
33
-
-[4.4. Q: What size of SD card does the T-Deck support?](#44-q-what-size-of-sd-card-does-the-t-deck-support)
34
-
-[4.5. Q: What is the public key for the default public channel?](#45-q-what-is-the-public-key-for-the-default-public-channel)
35
-
-[4.6. Q: How do I get maps on T-Deck?](#46-q-how-do-i-get-maps-on-t-deck)
36
-
-[4.7. Q: Where do the map tiles go?](#47-q-where-do-the-map-tiles-go)
37
-
-[4.8. Q: How to unlock deeper map zoom and server management features on T-Deck?](#48-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck)
38
-
-[4.9. Q: How to decipher the diagnostics screen on T-Deck?](#49-q-how-to-decipher-the-diagnostics-screen-on-t-deck)
39
-
-[4.10. Q: The T-Deck sound is too loud?](#410-q-the-t-deck-sound-is-too-loud)
40
-
-[4.11. Q: Can you customize the sound?](#411-q-can-you-customize-the-sound)
41
-
-[4.12. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?](#412-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts)
30
+
-[4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?](#41-q-is-there-a-user-guide-for-t-deck-t-pager-t-watch-or-t-display-pro)
31
+
-[4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?](#42-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode)
32
+
-[4.3. Q: Why is my T-Deck Plus not getting any satellite lock?](#43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock)
33
+
-[4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?](#44-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock)
34
+
-[4.5. Q: What size of SD card does the T-Deck support?](#45-q-what-size-of-sd-card-does-the-t-deck-support)
35
+
-[4.6. Q: what is the public key for the default public channel?](#46-q-what-is-the-public-key-for-the-default-public-channel)
36
+
-[4.7. Q: How do I get maps on T-Deck?](#47-q-how-do-i-get-maps-on-t-deck)
37
+
-[4.8. Q: Where do the map tiles go?](#48-q-where-do-the-map-tiles-go)
38
+
-[4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?](#49-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck)
39
+
-[4.10. Q: How to decipher the diagnostics screen on T-Deck?](#410-q-how-to-decipher-the-diagnostics-screen-on-t-deck)
40
+
-[4.11. Q: The T-Deck sound is too loud?](#411-q-the-t-deck-sound-is-too-loud)
41
+
-[4.12. Q: Can you customize the sound?](#412-q-can-you-customize-the-sound)
42
+
-[4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?](#413-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts)
43
+
-[4.14. Q: How to capture a screenshot on T-Deck?](#414-q-how-to-capture-a-screenshot-on-t-deck)
42
44
-[5. General](#5-general)
43
45
-[5.1. Q: What are BW, SF, and CR?](#51-q-what-are-bw-sf-and-cr)
44
46
-[5.2. Q: Do MeshCore clients repeat?](#52-q-do-meshcore-clients-repeat)
@@ -68,10 +70,10 @@ author: https://github.com/LitBomb<!-- omit from toc -->
68
70
-[6.6. Q: My RAK/T1000-E/xiao\_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh?](#66-q-my-rakt1000-exiao_nrf52-device-seems-to-be-corrupted-how-do-i-wipe-it-clean-to-start-fresh)
69
71
-[6.7. Q: WebFlasher fails on Linux with failed to open](#67-q-webflasher-fails-on-linux-with-failed-to-open)
70
72
-[7. Other Questions:](#7-other-questions)
71
-
-[7.1 Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?](#71-q-how-to-update-nrf-rak-t114-seed-xiao-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app)
72
-
-[7.2 Q: How to update ESP32-based devices over the air?](#72-q-how-to-update-esp32-based-devices-over-the-air)
73
-
-[7.3 Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?](#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu)
74
-
-[7.4 Q are the MeshCore logo and font available?](#74-q-are-the-meshcore-logo-and-font-available)
73
+
-[7.1. Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?](#71-q-how-to-update-nrf-rak-t114-seed-xiao-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app)
74
+
-[7.2. Q: How to update ESP32-based devices over the air?](#72-q-how-to-update-esp32-based-devices-over-the-air)
75
+
-[7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?](#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu)
76
+
-[7.4. Q are the MeshCore logo and font available?](#74-q-are-the-meshcore-logo-and-font-available)
75
77
76
78
## 1. Introduction
77
79
@@ -105,9 +107,11 @@ Anyone is able to build anything they like on top of MeshCore without paying any
105
107
You need LoRa hardware devices to run MeshCore firmware as clients or server (repeater and room server).
106
108
107
109
#### 1.2.1. Hardware
108
-
To use MeshCore without using a phone as the client interface, you can run MeshCore on a T-Deck or T-Deck Plus. It is a complete off-grid secure communication solution.
110
+
MeshCore is available on a variety of 433MHz, 868MHz and 915MHz LoRa devices. For example, Lilygo T-Deck, T-Pager, RAK Wireless WisBlock RAK4631 devices (e.g. 19003, 19007, 19026), Heltec V3, Xiao S3 WIO, Xiao C3, Heltec T114, Station G2, Nano G2 Ultra, Seeed Studio T1000-E. More devices are being added regularly.
109
111
110
-
MeshCore is also available on a variety of 868MHz and 915MHz LoRa devices. For example, RAK4631 devices (19003, 19007, 19026), Heltec V3, Xiao S3 WIO, Xiao C3, Heltec T114, Station G2, Seeed Studio T1000-E. More devices will be supported later.
112
+
For an up-to-date list of supported devices, please go to https://flasher.meshcore.co.uk/
113
+
114
+
To use MeshCore without using a phone as the client interface, you can run MeshCore on a LiLygo's T-Deck, T-Deck Plus, T-Pager, T-Watch, or T-Display Pro. MeshCore Ultra firmware running on these devices are a complete off-grid secure communication solution.
111
115
112
116
#### 1.2.2. Firmware
113
117
MeshCore has four firmware types that are not available on other LoRa systems. MeshCore has the following:
@@ -116,7 +120,7 @@ MeshCore has four firmware types that are not available on other LoRa systems. M
116
120
Companion radios are for connecting to the Android app or web app as a messenger client. There are two different companion radio firmware versions:
117
121
118
122
1.**BLE Companion**
119
-
BLE Companion firmware runs on a supported LoRa device and connects to a smart device running the Android MeshCore client over BLE (iOS MeshCore client will be available soon)
123
+
BLE Companion firmware runs on a supported LoRa device and connects to a smart device running the Android or iOS MeshCore client over BLE
120
124
<https://meshcore.co.uk/apps.html>
121
125
122
126
2.**USB Serial Companion**
@@ -147,7 +151,7 @@ A room server can also take on the repeater role. To enable repeater role on a
147
151
## 2. Initial Setup
148
152
149
153
### 2.1. Q: How many devices do I need to start using MeshCore?
150
-
**A:** If you have one supported device, flash the BLE Companion firmware and use your device as a client. You can connect to the device using the Android client via Bluetooth (iOS client will be available later). You can start communicating with other MeshCore users near you.
154
+
**A:** If you have one supported device, flash the BLE Companion firmware and use your device as a client. You can connect to the device using the Android or iOS client via Bluetooth. You can start communicating with other MeshCore users near you.
151
155
152
156
If you have two supported devices, and there are not many MeshCore users near you, flash both to BLE Companion firmware so you can use your devices to communicate with your near-by friends and family.
153
157
@@ -157,7 +161,7 @@ After you flashed the latest firmware onto your repeater device, keep the device
157
161
158
162
`set freq {frequency}`
159
163
160
-
The repeater and room server CLI reference is here: https://github.com/ripplebiz/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference
164
+
The repeater and room server CLI reference is here: https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference
161
165
162
166
If you have more supported devices, you can use your additional devices with the room server firmware.
163
167
@@ -255,7 +259,11 @@ You can get the latitude and longitude from Google Maps by right-clicking the lo
255
259
256
260
## 4. T-Deck Related
257
261
258
-
### 4.1. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?
262
+
### 4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?
263
+
264
+
**A:** Yes, it is available on https://buymeacoffee.com/ripplebiz/ultra-v7-7-guide-meshcore-users
265
+
266
+
### 4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?
259
267
**A:**
260
268
1. Device off
261
269
2. Connect USB cable to device
@@ -266,20 +274,20 @@ You can get the latitude and longitude from Google Maps by right-clicking the lo
266
274
7. T-Deck in DFU mode now
267
275
8. At this point you can begin flashing using <https://flasher.meshcore.co.uk/>
268
276
269
-
### 4.2. Q: Why is my T-Deck Plus not getting any satellite lock?
277
+
### 4.3. Q: Why is my T-Deck Plus not getting any satellite lock?
270
278
**A:** For T-Deck Plus, the GPS baud rate should be set to **38400**. Also, some T-Deck Plus devices were found to have the GPS module installed upside down, with the GPS antenna facing down instead of up. If your T-Deck Plus still doesn't get any satellite lock after setting the baud rate to 38400, you might need to open the device to check the GPS orientation.
271
279
272
280
GPS on T-Deck is always enabled. You can skip the "GPS clock sync" and the T-Deck will continue to try to get a GPS lock. You can go to the `GPS Info` screen; you should see the `Sentences:` counter increasing if the baud rate is correct.
### 4.3. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?
284
+
### 4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?
277
285
**A:** The OG (non-Plus) T-Deck doesn't come with a GPS. If you added a GPS to your OG T-Deck, please refer to the manual of your GPS to see what baud rate it requires. Alternatively, you can try to set the baud rate from 9600, 19200, etc., and up to 115200 to see which one works.
278
286
279
-
### 4.4. Q: What size of SD card does the T-Deck support?
287
+
### 4.5. Q: What size of SD card does the T-Deck support?
280
288
**A:** Users have had no issues using 16GB or 32GB SD cards. Format the SD card to **FAT32**.
281
289
282
-
### 4.5. Q: what is the public key for the default public channel?
290
+
### 4.6. Q: what is the public key for the default public channel?
283
291
**A:**
284
292
T-Deck uses the same key the smartphone apps use but in base64
285
293
`izOH6cXN6mrJ5e26oRXNcg==`
@@ -290,7 +298,7 @@ The smartphone app key is in hex:
Once you have the tiles downloaded, copy the `\tiles` folder to the root of your T-Deck's SD card.
309
317
310
-
### 4.8. Q: How to unlock deeper map zoom and server management features on T-Deck?
318
+
### 4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?
311
319
**A:** You can download, install, and use the T-Deck firmware for free, but it has some features (map zoom, server administration) that are enabled if you purchase an unlock code for \$10 per T-Deck device.
See here for packet-type: [https://github.com/ripplebiz/MeshCore/blob/main/src/Packet.h#L19](https://github.com/ripplebiz/MeshCore/blob/main/src/Packet.h#L19"https://github.com/ripplebiz/MeshCore/blob/main/src/Packet.h#L19")
**A:** You can customise the sounds on the T-Deck, just by placing `.mp3` files onto the `root` dir of the SD card. `startup.mp3`, `alert.mp3` and `new-advert.mp3`
345
+
**A:** You can customise the sounds on the T-Deck, by placing `.mp3` files onto the `root` dir of the SD card. The files are:
337
346
338
-
### 4.12. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?
347
+
*`startup.mp3`
348
+
*`error.mp3`
349
+
*`alert.mp3`
350
+
*`new-advert.mp3`
351
+
*`existing-advert.mp3`
352
+
353
+
### 4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?
339
354
340
355
**A:** 'Import from Clipboard' is for importing a contact via a file named 'clipboard.txt' on the SD card. The opposite, is in the Identity screen, the 'Card to Clipboard' menu, which writes to 'clipboard.txt' so you can share yourself (call these 'biz cards', that start with "meshcore://...")
341
356
357
+
### 4.14. Q: How to capture a screenshot on T-Deck?
358
+
359
+
**A:** To capture a screenshot on a T-Deck, long press the top-left corner of the screen. The screenshot is saved to the microSD card, if one is inserted into the device.
360
+
342
361
---
343
362
344
363
## 5. General
@@ -393,7 +412,7 @@ The third character is the capital letter 'O', not zero `0`
393
412
394
413
### 5.7. Q: Is MeshCore open source?
395
414
**A:** Most of the firmware is freely available. Everything is open source except the T-Deck firmware and Liam's native mobile apps.
**A:** Provide your honest feedback on GitHub and on [MeshCore Discord server](https://discord.gg/BMwCtwHj5V). Spread the word of MeshCore to your friends and communities; help them get started with MeshCore. Support Scott's MeshCore development at <https://buymeacoffee.com/ripplebiz>.
@@ -521,7 +540,7 @@ To start managing your USB serial-connected device using picocom, use the follow
521
540
- `picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf`
522
541
523
542
From here, reference repeater and room server command line commands on MeshCore github wiki here:
### 5.14. Q: Are there are projects built around MeshCore?
@@ -603,7 +622,7 @@ Allow the browser user on it:
603
622
---
604
623
## 7. Other Questions:
605
624
606
-
### 7.1 Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?
625
+
### 7.1. Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?
607
626
608
627
**A:** The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms:
609
628
@@ -622,7 +641,7 @@ Allow the browser user on it:
622
641
14. Wait for the update to complete. It can take a few minutes.
623
642
624
643
625
-
### 7.2 Q: How to update ESP32-based devices over the air?
644
+
### 7.2. Q: How to update ESP32-based devices over the air?
626
645
627
646
**A:** For ESP32-based devices (e.g. Heltec V3):
628
647
1. On flasher.meshcore.co.uk, download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name)
@@ -634,7 +653,7 @@ Allow the browser user on it:
634
653
8. From a browser, go to http://192.168.4.1/update and upload the non-merged bin from the flasher
635
654
636
655
637
-
### 7.3 Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?
656
+
### 7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?
638
657
639
658
**A:** Yes, developer `che aporeps` has an enhanced OTA DFU bootloader for nRF52 based devices. With this bootloader, if it detects that the application firmware is invalid, it falls back to OTA DFU mode so you can attempt to flash again to recover. This bootloader has other changes to make the OTA DFU process more fault tolerant.
640
659
@@ -646,9 +665,10 @@ Currently, the following boards are supported:
646
665
- Seeed Studio XIAO nRF52840 BLE SENSE
647
666
- RAK 4631
648
667
649
-
### 7.4 Q are the MeshCore logo and font available?
668
+
### 7.4. Q are the MeshCore logo and font available?
650
669
651
-
**A:** Yes, it is on the MeshCore github repo here: https://github.com/ripplebiz/MeshCore/tree/main/logo
670
+
**A:** Yes, it is on the MeshCore github repo here:
0 commit comments