Documentation
- Getting Started - Official Meshtastic.org Getting Started Guide. This guide has the following sections:
- Install Serial Drivers
- Flash Firmware - There are constant releases with bug-fixes, general improvements and new features. Please update often to stable releases!
- Initial Configuration
- Meshtastic Documentation
- Simple one-page documentation
Meshtastic Official Tools
- https://flasher.meshtastic.org - Meshtastic web flasher (firmware updater)
- https://client.meshtastic.org/ - Meshtastic web client
Node Setup Tips
- Number of hops
- Default: 3
- Set your Number of hops to
3
or4
Meshtastic App > LoRa > Number of hops
NOTE: The default of
3
should be sufficient in a healthy mesh. “Really, 3 is fine.”4
or5
if running CLIENT_MUTE and/or having particular difficulties, but with such a small and densely packed geographic area you are quite likely to have those higher hopped packets leave the Metro area and end up rebroadcasting over 100 miles away! Hello Catskills! This prevents the reverse of the effect we occasionally encounter where Meshes in North PA or CT will show up on the Mesh in NYC, even though they’re 100 miles away, because they’re running7
hops.
- MQTT Server Information
- Address: mqtt.nyme.sh
- Port: 1883
- Username: meshdev
- Password: large4cats
- Topic: msh/US/NY
Meshtastic App > MQTT > Enabled
NOTE: Enable the ‘Uplink Enabled’ option on your default channel to share info about nodes seen (only packets with the OK to MQTT flag will be sent). The ‘Downlink Enabled’ option will not work with this server by design. We want the mesh to stay on radio communication only.
- Device Role
- Default: Client
- Set your Device Role to
CLIENT
orCLIENT_MUTE
Meshtastic App > Device > Device Role
NOTE: Unless you have access to 100th floor of 1 World Trade Center or Empire State Building, you should not be using an “infrastructure” role such as
REPEATER
,ROUTER
,ROUTER_CLIENT
orROUTER_LATE
. While you may have the most honest and pure of intentions in choosing such a role the reality is they will pre-empt the large and ever-increasing number of clients from retransmitting resulting in an over-all diminishment of the mesh’s full potential. Please, don’t be that person and read up on the importance of choosing the right device role.
- Rebroadcast Mode
- Default: All
- Set to
Core Portnums Only
to only rebroadcast packets with standard portnums: NodeInfo, Text, Position, Telemetry, and Routing. Meshtastic App > Device > Rebroadcast Mode
NOTE: Ignores packets from non-standard portnums such as: TAK, RangeTest, PaxCounter, etc. Should help lower high channel utilization.
Software Setup
These instructions have been written for connecting to a Sense Cap T1000-E (v2.6.11) via Bluetooth, but should be similar for other devices as well. Please see the Getting Started guide for more information.
Your T1000-E may arrive with an older version of the Meshtastic firmware. Upgrading this device “over the air” is not currently supported from mobile, so you’ll need a computer to do this. Please see the Getting Started - Flash Firmware guide for more information.
Android App
Install
- Download the Meshtastic app from Google Play Store.
- Optional: You can join the beta channel to test the latest features and improvements.
Configure
- Connect to node in Meshtastic app
- Enable Bluetooth on your Android device.
- Within the Meshtastic app, tap the lower right corner button to connect to a node.
- Select: Bluetooth > Available Radios > scan/select node > enter pair code
- If your node does not have a screen, the PIN is ‘123456’
- If your node has a screen, look at it for the PIN
- You may be prompted with a Bluetooth security warning when connecting to your node for the first time. Accept it to proceed.
-
Once connected, you should see the node’s name in the upper right corner of the app. Tap the name to view the node’s details. Scroll down and tap “Remote Administration” to access the configuration options.
- Set LoRa Region
- Options
- Set LoRa Region (LoRa Config) > Options > Region > United States (required)
- Use Preset: Enabled
- Presets: Long Range - Fast
- Advanced
- Ignore MQTT: (default: Disabled)
- Ok to MQTT: (default: Disabled)
NOTE: For MQTT configuration information, please visit https://nyme.sh/setup.html
- Transmit Enabled: Enabled
- Number of hops: 3 or 4
- Frequency Slot: 20
NOTE: If you have Frequency Slot set to 0, you must name your primary channel ‘LongFast’
- Options
-
Scroll to the bottom and tap Save
-
The node will disconnect, reboot, and reconnect.
Your node now has a basic LongFast configuration.
- Recommended: Set your Bluetooth Password (for devices without a screen)
- The default password on most devices without a screen is ‘123456’, for devices with a screen it is randomly generated and shown on the screen.
- If you would like to change this, tap the Bluetooth button, and enter a new password.
- You will need to reconnect with the new password after the node reboots.
- Optional: Change your node’s name
- In the Remote Administration screen, tap the User button, and enter a new name for your node.
Backup
While viewing your node’s Remote Administration, scroll all the way to the bottom. There’s a Backup button that will save a .cfg backup file to the Downloads directory on your device.
Restore
While viewing your node’s Remote Administration, scroll all the way to the bottom. There’s a Restore button that allows you to select and restore a previously saved .cfg backup file from your device.
Misc
The backup .cfg files contain your node’s complete configuration including channels, settings, and keys. Store these files securely as they contain sensitive information.
Apple iOS App
In the following sections, we are setting up a Sense Cap T1000-E (v2.6.11) for use over Bluetooth with an iPhone.
Configure
-
Download the Meshtastic app from the App Store
- Connect to the node in Meshtastic app.
- Enable Bluetooth on your iOS device.
- Within the Meshtastic app, select: Bluetooth > Available Radios > select node > enter pair code
- If your node does not have a screen, the PIN is ‘123456’
- If your node has a screen, look at it for the PIN
- Set LoRa Region
- Options
- Set LoRa Region (LoRa Config) > Options > Region > United States (required)
- Use Preset: Enabled
- Presets: Long Range - Fast
- Advanced
- Ignore MQTT: (default: Disabled)
- Ok to MQTT: (default: Disabled)
NOTE: For MQTT configuration information, please visit https://nyme.sh/setup.html
- Transmit Enabled: Enabled
- Number of hops: 3 or 4
- Frequency Slot: 20
NOTE: If you have Frequency Slot set to 0, you must name your primary channel ‘LongFast’
- Options
-
Scroll to the bottom and tap Save
-
The node will disconnect, reboot, and reconnect.
Your node now has a basic LongFast configuration.
Backup
Private Key - backup your private key to your iCloud keychain.
- Within the Meshtastic app, select: Settings > Key Backup > Backup
- If successful, ‘Private Key saved successfully to iCloud keychain’ will appear in green.
Restore
Private Key - restore your private key from your iCloud keychain.
- Within the Meshtastic app, select: Settings > Key Backup > Restore
- If successful, ‘Private Key restored successfully from iCloud keychain’ will appear in green.
Misc
Private Key - delete your private key in your iCloud keychain.
- Within the Meshtastic app, select: Settings > Key Backup > Delete icon
- If successful, ‘Private Key deleted successfully from iCloud keychain’ will appear in green.
macOS Desktop App
The macOS desktop app provides the same functionality as the iOS app but is designed for Mac computers.
Install
- Download the Meshtastic app from the Mac App Store.
Configure
Configuration steps are similar to the mobile app:
- Connect to your node via Bluetooth
- Follow the same LoRa region and configuration steps as outlined in the mobile app section
Backup/Restore
The macOS app uses the same iCloud keychain backup functionality as iOS:
- Backup: Settings > Key Backup > Backup
- Restore: Settings > Key Backup > Restore
- Delete: Settings > Key Backup > Delete icon
Web Client
https://client.meshtastic.org/
Configure
https://meshtastic.org/docs/software/web-client/ - Official Documentation
Backup
- Let the interface remind you!
- There will be a pop-up in the lower right hand corner asking you to backup your keys, remind you in 7 days, or to never remind you. Back your keys up, it takes <15 seconds.
- Navigation > Radio Config > Security > Private Key
- Copy and paste into backup file of your choosing.
- Navigation > Radio Config > Security > Public Key
- Copy and paste into backup file of your choosing.
Restore
- Navigation > Radio Config > Security > Private Key
- Copy private key from backup file and paste here.
- Navigation > Radio Config > Security > Public Key
- Copy public key from backup file and paste here.
Misc
Meshtastic UI (MUI)
https://meshtastic.org/docs/software/meshtastic-ui/ - Meshtastic UI (MUI) is an independent user interface for Meshtastic devices, designed to provide direct interaction with the network without requiring a phone app for most basic settings.
Configure
Backup
Restore
Misc
Python CLI
https://meshtastic.org/docs/software/python/cli/ - Offcial Documentation
Configure
Backup
meshtastic --export-config > MyNodeNameOrWhatever_config_04072025.yaml
Restore
meshtastic --configure MyNodeNameOrWhatever_config_04072025.yaml
Misc Node DB Export
meshtastic --nodes › MyNodeNameOrWhatever_nodedb_04072025.yaml
Misc UTF-8 Error
If you use the Python CLI and have seen the following error:
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xe0 in position 8: 'utf-8' codec can't decode byte 0xe0 in position 8: unexpected end of data in field: meshtastic.protobuf.User.long_name```
What is happening is someone managed to use a non-UTF8 char in their device name (both long and short) so the fix is to run:
meshtastic --remove-node '!0c3a9bb0' && meshtastic --set-ignored-node '!0c3a9bb0'
Linux Native
Configure
- https://meshtastic.org/docs/hardware/devices/linux-native-hardware/ - “This page outlines the setup of Meshtastic on Linux-native devices, utilizing portduino to run the Meshtastic firmware under Linux.”
Backup
Restore
Misc
- https://github.com/chrismyers2000/MeshAdv-Mini/tree/main/Data/Misc/Installer%20Scripts - “This is a helper script designed to help you choose which channel (beta/alpha/daily) of meshtasticd to install for raspberry pi OS”