links:meshcore:quickstart:home
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| links:meshcore:quickstart:home [2026/09/10 21:00] – va7fi | links:meshcore:quickstart:home [2026/09/10 22:54] (current) – [Connect to your MeshCore Device] va7fi | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== MeshCore Quick Start Guide ====== | ====== MeshCore Quick Start Guide ====== | ||
| - | |||
| <WRAP group> | <WRAP group> | ||
| - | < | + | < |
| - | + | ||
| <WRAP center round info 100%> | <WRAP center round info 100%> | ||
| This page was adapted from Liam Cottle' | This page was adapted from Liam Cottle' | ||
| </ | </ | ||
| </ | </ | ||
| - | + | < | |
| - | < | + | |
| <WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
| Download an up-to-date [[mpdf> | Download an up-to-date [[mpdf> | ||
| </ | </ | ||
| - | |||
| </ | </ | ||
| </ | </ | ||
| Line 22: | Line 18: | ||
| * You can send text messages to other mesh nodes that are in radio range without the internet. This means it still works even when WiFi, Cellular and Starlink are down. | * You can send text messages to other mesh nodes that are in radio range without the internet. This means it still works even when WiFi, Cellular and Starlink are down. | ||
| * Solar powered repeater nodes can be placed on high points to increase messaging range. | * Solar powered repeater nodes can be placed on high points to increase messaging range. | ||
| + | |||
| <WRAP centeralign> | <WRAP centeralign> | ||
| <WRAP half column> | <WRAP half column> | ||
| - | {{: | + | {{: |
| </ | </ | ||
| <WRAP half column> | <WRAP half column> | ||
| - | {{: | + | {{: |
| </ | </ | ||
| </ | </ | ||
| - | |||
| - | |||
| ===== What is needed to use MeshCore? ===== | ===== What is needed to use MeshCore? ===== | ||
| * The MeshCore app downloaded to your phone or computer. | * The MeshCore app downloaded to your phone or computer. | ||
| * A mesh node with the MeshCore // | * A mesh node with the MeshCore // | ||
| - | * A mesh node with the MeshCore // | + | * If needed, a mesh node with the MeshCore // |
| * Each person that wants to send messages will need their own companion node. | * Each person that wants to send messages will need their own companion node. | ||
| - | ===== Download the MeshCore App ===== | + | ==== Download the MeshCore App ==== |
| * Search for " | * Search for " | ||
| * Alternatively, | * Alternatively, | ||
| * You should save an offline copy of the software so it’s available without the internet. | * You should save an offline copy of the software so it’s available without the internet. | ||
| - | ===== Where to buy MeshCore nodes? | + | ==== Where to buy MeshCore nodes? ==== |
| * Recommended devices are listed at [[https:// | * Recommended devices are listed at [[https:// | ||
| * Alternatively, | * Alternatively, | ||
| - | ===== Getting Started | + | ===== Flash the Firmware |
| + | <WRAP group> | ||
| + | <WRAP twothirds column> | ||
| + | <WRAP center round tip 100%> | ||
| + | On Linux, you may have to add the " | ||
| + | sudo usermod -a -G dialout USER | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | <WRAP center round important 100%> | ||
| + | You should also use a Chromium based web browser like [[https:// | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | If you already have Meshcore installed, download your current settings: | ||
| + | * Open the MeshCore app ([[https:// | ||
| + | * Navigate to the Settings (the gear in the top right corner) | ||
| + | * Scroll down to the "Extra Tools" section and select " | ||
| + | * " | ||
| + | |||
| + | Flash the Meshcore Firmware: | ||
| + | * Connect the companion device to your computer via USB. | ||
| + | * Go to https:// | ||
| + | * Select your device | ||
| + | * Select Companion Bluetooth | ||
| + | * Select Enter DFU Mode | ||
| + | * Select Erase Flash | ||
| + | * Select Flash | ||
| + | |||
| + | To re-load the config file: | ||
| + | * Open the MeshCore App | ||
| + | * Connect to the companion device, but it probably had a different bluetooth name now | ||
| + | * The PIN might be listed on your companion' | ||
| + | * Skip Setup | ||
| + | * Navigate to the Settings (the gear in the top right corner) | ||
| + | * Scroll down to the "Extra Tools" section and select " | ||
| + | * Click on " | ||
| + | * Select the " | ||
| + | * " | ||
| + | |||
| + | See [[https:// | ||
| - | ==== Connect to your MeshCore Device ==== | + | < |
| + | ===== Connect to your MeshCore Device | ||
| * Turn on your node. | * Turn on your node. | ||
| * Open the MeshCore App. | * Open the MeshCore App. | ||
| - | * Tap the '' | + | * Tap the "Connect" |
| - | * Tap the '' | + | * Tap the "MeshCore-XXXX" |
| * Enter the PIN displayed on your MeshCore device’s screen. | * Enter the PIN displayed on your MeshCore device’s screen. | ||
| * If your device doesn’t have a screen, the default pin is 123456. | * If your device doesn’t have a screen, the default pin is 123456. | ||
| Line 62: | Line 101: | ||
| <WRAP centeralign> | <WRAP centeralign> | ||
| <WRAP third column> | <WRAP third column> | ||
| - | {{: | + | {{: |
| </ | </ | ||
| <WRAP third column> | <WRAP third column> | ||
| - | {{: | + | {{: |
| </ | </ | ||
| <WRAP third column> | <WRAP third column> | ||
| - | {{: | + | {{: |
| </ | </ | ||
| </ | </ | ||
| Line 74: | Line 113: | ||
| <WRAP center round tip 70%> | <WRAP center round tip 70%> | ||
| - | Note: If you’re having trouble pairing with Bluetooth, try rebooting your phone. | + | If you’re having trouble pairing with Bluetooth, try rebooting your phone. |
| </ | </ | ||
| - | + | < | |
| - | ==== Set your Public Display Name ==== | + | ===== Set your Public Display Name ===== |
| - | You should now rename your MeshCore node. | + | You should now rename your MeshCore node. The name you choose will be seen by other users on the MeshCore network. |
| - | The name you choose will be seen by other users on the MeshCore network. | + | |
| * Tap the settings icon in the top right corner. | * Tap the settings icon in the top right corner. | ||
| * Tap the name field, backspace until it’s empty, then type your name. | * Tap the name field, backspace until it’s empty, then type your name. | ||
| * After entering your name, tap the tick icon in the top right to save it. | * After entering your name, tap the tick icon in the top right to save it. | ||
| - | Tap the settings icon in the top | ||
| - | right corner. | ||
| - | Tap the name field, and enter | ||
| - | your name. | ||
| - | Tap the tick icon in the top | ||
| - | right to save. | ||
| - | *Note: The device name in Bluetooth results will not update until you reboot your node. | ||
| - | ==== Configure Radio Settings ==== | + | <WRAP group> |
| - | MeshCore can be used all over the world. Different countries have different regulations on | + | <WRAP centeralign> |
| - | which radio frequencies can be used for public, license free communication. To ensure | + | <WRAP third column> |
| - | your node is operating legally, please make sure to select radio settings that are compliant | + | {{: |
| - | in your country. | + | </ |
| - | The MeshCore app provides a list of radio presets that have been suggested by the | + | <WRAP third column> |
| - | community for use in specific countries/ | + | {{: |
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 70%> | ||
| + | The device name in Bluetooth results will not update until you reboot your node. | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== Configure Radio Settings | ||
| + | MeshCore can be used all over the world. Different countries have different regulations on which radio frequencies can be used for public, license free communication. To ensure your node is operating legally, please make sure to select radio settings that are compliant in your country. | ||
| + | |||
| + | The MeshCore app provides a list of radio presets that have been suggested by the community for use in specific countries/ | ||
| To configure the radio settings for your MeshCore node: | To configure the radio settings for your MeshCore node: | ||
| * Tap the settings icon in the top right corner. | * Tap the settings icon in the top right corner. | ||
| Line 104: | Line 152: | ||
| * You will be taken back to the settings screen. | * You will be taken back to the settings screen. | ||
| * Tap the tick icon in the top right corner to save your settings. | * Tap the tick icon in the top right corner to save your settings. | ||
| - | Tap the settings icon in the top | ||
| - | right corner. | ||
| - | Tap the " | ||
| - | button in the radio settings | ||
| - | section. | ||
| - | Tap the radio settings that | ||
| - | match the name of your | ||
| - | country/ | ||
| - | *Note: If there are no presets available for your country/ | ||
| - | the MeshCore Project: https:// | ||
| - | users can manually enter a frequency and LoRa settings in the "Radio Settings" | ||
| - | ==== Send a public broadcast message ==== | + | <WRAP group> |
| - | Messages sent to the Public channel can be seen by anyone on the MeshCore network. | + | <WRAP centeralign> |
| - | They are repeated across the mesh by all repeaters that hear them. Other mesh nodes in | + | <WRAP third column> |
| - | range of you or a repeater that rebroadcasted | + | {{: |
| - | The public channel can be used as a large group chat for general conversation amongst | + | </ |
| - | all users on the mesh. It could also be used to send emergency alerts. | + | <WRAP third column> |
| - | It’s not recommended to send confidential information on the public channel as anyone | + | {{: |
| - | can read these messages. | + | </ |
| - | Try sending | + | <WRAP third column> |
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round important 70%> | ||
| + | In the South West BC area, edit the settings to the following: | ||
| + | | |**Until Sept 30, 2026** |**From Oct 1, 2026**| | ||
| + | |**Frequency** | ||
| + | |**Bandwidth** | ||
| + | |**Spreading Factor**|7 | ||
| + | |**Coding Rate** | ||
| + | |||
| + | See [[https:// | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== Send a public broadcast message | ||
| + | Messages sent to the Public channel can be seen by anyone on the MeshCore network. They are repeated across the mesh by all repeaters that hear them. Other mesh nodes in range of you or a repeater that rebroadcast | ||
| + | |||
| + | The public channel can be used as a large group chat for general conversation amongst all users on the mesh. It could also be used to send emergency alerts. | ||
| + | |||
| + | It’s not recommended to send confidential information on the public channel as anyone can read these messages. | ||
| + | |||
| + | To send a message: | ||
| * Tap the channels tab at the bottom of the screen. | * Tap the channels tab at the bottom of the screen. | ||
| * Tap the " | * Tap the " | ||
| * Type a message and press the send icon. | * Type a message and press the send icon. | ||
| - | Tap the channels tab at the | ||
| - | bottom of the screen. | ||
| - | Tap the " | ||
| - | the send icon. | ||
| - | *Note: Outgoing messages will show "Heard 1 repeat" | ||
| - | repeater passing on your message. If there are no nearby repeaters, it will show " | ||
| - | It’s not possible to know who received a channel message. | ||
| - | ==== Share your Contact Details (via QR Code) ==== | + | <WRAP group> |
| - | Before you can send private, encrypted, direct messages to someone, you and the person | + | <WRAP centeralign> |
| - | you send the message to must both add each other as contacts. If the other person | + | <WRAP third column> |
| - | doesn’t also add you as a contact, your messages to them will fail to deliver. | + | {{: |
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 70%> | ||
| + | Outgoing messages will show "Heard 1 repeat" | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== Share your Contact Details (via QR Code) ===== | ||
| + | Before you can send private, encrypted, direct messages to someone, you and the person you send the message to must both add each other as contacts. If the other person doesn’t also add you as a contact, your messages to them will fail to deliver. | ||
| Contacts can be added in multiple ways: | Contacts can be added in multiple ways: | ||
| * Privately in person by scanning QR Codes. | * Privately in person by scanning QR Codes. | ||
| * Publicly via the mesh by sending and receiving an " | * Publicly via the mesh by sending and receiving an " | ||
| + | |||
| To share your contact details privately via QR Code: | To share your contact details privately via QR Code: | ||
| * Tap the 3 dot menu in the top right. | * Tap the 3 dot menu in the top right. | ||
| * Tap the "My Contact Code" menu item. | * Tap the "My Contact Code" menu item. | ||
| * Show the QR Code to the other person. | * Show the QR Code to the other person. | ||
| - | Tap the 3 dot menu in the top | + | |
| - | right. | + | <WRAP group> |
| - | Tap the "My Contact Code" | + | <WRAP centeralign> |
| - | menu item. | + | <WRAP third column> |
| - | Show the QR Code to the | + | {{: |
| - | other person. | + | </ |
| - | *Note: | + | <WRAP third column> |
| - | contact details will not be transmitted over the mesh. Only the person who scans your QR | + | {{: |
| - | Code will receive your contact details. | + | </ |
| - | To add a contact via QR Code: | + | <WRAP third column> |
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 70%> | ||
| + | The QR Code contains your Node Name, Node Type and Public Identity Key. Your contact details will not be transmitted over the mesh. Only the person who scans your QR Code will receive your contact details. | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ==== To add a contact via QR Code: ==== | ||
| * Tap the 3 dot menu in the top right. | * Tap the 3 dot menu in the top right. | ||
| * Tap the "Add Contact" | * Tap the "Add Contact" | ||
| Line 163: | Line 248: | ||
| * Point the device’s camera at the QR Code. | * Point the device’s camera at the QR Code. | ||
| * The contact details will be automatically added to your contacts list. | * The contact details will be automatically added to your contacts list. | ||
| - | Tap the 3 dot menu in the top | ||
| - | right. | ||
| - | Tap the "Add Contact" | ||
| - | item. | ||
| - | Tap the "Scan QR Code" | ||
| - | button and point the camera at | ||
| - | the QR Code. | ||
| - | *Note: You may need to accept a permissions request for the MeshCore app to access | ||
| - | your camera. This permission must be granted to be able to scan the QR Code. | ||
| - | ==== Share your Contact Details (via Advert) ==== | + | <WRAP group> |
| + | <WRAP centeralign> | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 70%> | ||
| + | You may need to accept a permissions request for the MeshCore app to access your camera. This permission must be granted to be able to scan the QR Code. | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== Share your Contact Details (via Advert) ===== | ||
| + | If you are unable to privately share your contact details in person via a QR Code, you may alternatively share them publicly to everyone on the mesh by sending an " | ||
| + | |||
| + | An advert is an unencrypted packet transmitted by your MeshCore node. It includes your node name, node type, public identity key and a cryptographic signature to prevent anyone from tampering with the information as it’s sent across the mesh. | ||
| - | If you are unable to privately share your contact details in person via a QR Code, you may | ||
| - | alternatively share them publicly to everyone on the mesh by sending an " | ||
| - | An advert is an unencrypted packet transmitted by your MeshCore node. It includes your | ||
| - | node name, node type, public identity key and a cryptographic signature to prevent anyone | ||
| - | from tampering with the information as it’s sent across the mesh. | ||
| You can send two types of adverts: | You can send two types of adverts: | ||
| - | * Zero Hop: | + | ^ |
| - | | + | |The advert won’t be retransmitted by any repeaters. |
| - | * Your contact details will only be received by nearby nodes. | + | |Your contact details will only be received by nearby nodes. |Your contact details could be received by everyone on the mesh.| |
| - | * Flood Routed: | + | |
| - | * The advert will be rebroadcast by all repeaters that hear it. | + | |
| - | | + | |
| To share your contact details publicly via the mesh: | To share your contact details publicly via the mesh: | ||
| * Tap the signal icon in the top right. | * Tap the signal icon in the top right. | ||
| * Tap the " | * Tap the " | ||
| * Your contact details will be transmitted to the mesh. | * Your contact details will be transmitted to the mesh. | ||
| - | Tap the signal icon in the top | ||
| - | right. | ||
| - | Tap the " | ||
| - | " | ||
| - | item. | ||
| - | Your contact details will be | ||
| - | transmitted to the mesh. | ||
| - | *Note: Adverts are not encrypted. Sending an advert will share your contact details with | ||
| - | everyone in range. | ||
| - | ==== Send Private Messages ==== | + | <WRAP group> |
| - | Once you’ve added a contact, and that contact has added you back, you can send private | + | <WRAP centeralign> |
| - | messages to each other across the mesh. These messages are encrypted and only the | + | <WRAP third column> |
| - | intended recipient can read the message contents. | + | {{: |
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 70%> | ||
| + | Adverts are not encrypted. Sending an advert will share your contact details with everyone in range. | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== Send Private Messages | ||
| + | Once you’ve added a contact, and that contact has added you back, you can send private messages to each other across the mesh. These messages are encrypted and only the intended recipient can read the message contents. | ||
| To send a private message: | To send a private message: | ||
| * Tap the contact you want to send a message to. | * Tap the contact you want to send a message to. | ||
| Line 210: | Line 310: | ||
| * The app will try several times to deliver your message to the recipient. | * The app will try several times to deliver your message to the recipient. | ||
| * If it’s successful, it will show " | * If it’s successful, it will show " | ||
| - | * If an automatic acknowledgement from the recipient is not received after some time, | + | * If an automatic acknowledgement from the recipient is not received after some time, the message will turn red and show as " |
| - | the message will turn red and show as " | + | |
| * When messages are received, they will show up in the conversation viewer. | * When messages are received, they will show up in the conversation viewer. | ||
| - | Tap the contact you want to | ||
| - | send a message to. | ||
| - | Type a message and press | ||
| - | the send icon. | ||
| - | Received messages will show | ||
| - | up in the conversation viewer. | ||
| - | *Note: A message may get marked as failed even though it was successfully delivered to | ||
| - | the recipient. This happens if we did not receive the acknowledgment reply from the | ||
| - | recipient node. In this case, it’s recommended to send the message again. Once you see | ||
| - | the delivered check mark, you know for sure it was received. | ||
| - | ==== Retry sending a failed Direct Message ==== | + | <WRAP group> |
| - | When you send a direct message to someone, it’s possible that it may not go through after | + | <WRAP centeralign> |
| - | several automatic attempts. This can happen for many different reasons, such as: | + | <WRAP third column> |
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 70%> | ||
| + | A message may get marked as failed even though it was successfully delivered to the recipient. This happens if we did not receive the acknowledgement reply from the recipient node. In this case, it’s recommended to send the message again. Once you see the delivered check mark, you know for sure it was received. | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== Retry sending a failed Direct Message | ||
| + | When you send a direct message to someone, it’s possible that it may not go through after several automatic attempts. This can happen for many different reasons, such as: | ||
| * Being out of range of the intended recipient. | * Being out of range of the intended recipient. | ||
| * There are no repeaters in between you and the intended recipient. | * There are no repeaters in between you and the intended recipient. | ||
| * The intended recipient’s radio might be turned off. | * The intended recipient’s radio might be turned off. | ||
| * There might be interference on the radio spectrum. | * There might be interference on the radio spectrum. | ||
| + | |||
| To try sending the failed message again: | To try sending the failed message again: | ||
| * Long press the failed message shown in red. | * Long press the failed message shown in red. | ||
| * Tap the "Retry Sending" | * Tap the "Retry Sending" | ||
| * Your message will try sending again. | * Your message will try sending again. | ||
| - | Long press the failed | ||
| - | message shown in red. | ||
| - | Tap the "Retry Sending" | ||
| - | message action. | ||
| - | Your message will try sending | ||
| - | again. | ||
| - | *Note: When sending direct messages, you must both add each other as contacts first. | ||
| - | The recipient' | ||
| - | a delivery report. You must also be in radio range of each other, or have a working path of | ||
| - | repeaters between each other. | ||
| - | ==== Ping a Repeater ==== | + | <WRAP group> |
| + | <WRAP centeralign> | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round important 70%> | ||
| + | When sending direct messages, **you must both add each other as contacts** first. The recipient' | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== Ping a Repeater | ||
| To check the signal strength to and from a nearby repeater, you can run a ping test. | To check the signal strength to and from a nearby repeater, you can run a ping test. | ||
| * Tap the 3 dot menu icon next to a repeater contact. | * Tap the 3 dot menu icon next to a repeater contact. | ||
| Line 252: | Line 369: | ||
| * A green popup will show signal strengths if successful. | * A green popup will show signal strengths if successful. | ||
| * A red popup will show " | * A red popup will show " | ||
| - | Tap the 3 dot menu icon next | ||
| - | to a repeater contact. | ||
| - | Tap the "Ping (Zero Hop)" | ||
| - | menu item. | ||
| - | A green popup will show | ||
| - | signal strengths if successful. | ||
| - | *Note: Ping tests do not hop through multiple repeaters. You must be in range of the | ||
| - | specific repeater you are ping testing. For a ping test to be successful, the repeater must | ||
| - | hear your companion signal directly, and your companion must hear the repeater signal | ||
| - | directly. If you’re not in range of the repeater, the ping test will fail with a timeout error. | ||
| - | TODO: This guide is still in progress... | + | <WRAP group> |
| + | <WRAP centeralign> | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | <WRAP third column> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP center round info 70%> | ||
| + | Ping tests do not hop through multiple repeaters. You must be in range of the specific repeater you are ping testing. For a ping test to be successful, the repeater must hear your companion signal directly, and your companion must hear the repeater signal directly. If you’re not in range of the repeater, the ping test will fail with a timeout error. | ||
| + | </ | ||
| + | < | ||
| + | |||
| + | ===== TODO: This guide is still in progress... | ||
| * Create/Join Private Channels | * Create/Join Private Channels | ||
| * Create/Join Public Hashtag Channels | * Create/Join Public Hashtag Channels | ||
| - | * Backup / Export Config | + | * <del>Backup / Export Config</ |
| - | * Restore / Import Config | + | * <del>Restore / Import Config</ |
| * Repeater Trace Tools | * Repeater Trace Tools | ||
| * Discover Nearby Nodes | * Discover Nearby Nodes | ||
links/meshcore/quickstart/home.1789099225.txt.gz · Last modified: by va7fi
