Meshtastic

https://meshtastic.org/docs
Admin
Documentation for the Meshtastic project, covering hardware, software, and community aspects.
Tokens:254,855
Snippets:4,354
Trust Score:9.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and start Meshtasticd via Homebrew

Source: https://meshtastic.org/docs/meshtasticd/installation/macos

Commands to add the Meshtastic tap, trust the repository, install the daemon, and start the background service.

```bash
brew tap meshtastic/tap

brew trust meshtastic/tap

brew install meshtasticd

brew services start meshtasticd
```

--------------------------------

### Setup Git Hooks

Source: https://meshtastic.org/docs/software/apple/developer

Install the pre-commit hook to ensure SwiftLint passes before committing changes.

```bash
bash scripts/setup-hooks.sh
```

--------------------------------

### Install Meshtastic Daemon

Source: https://meshtastic.org/docs/development/reference/md_wsl

Install the meshtasticd daemon within your WSL instance. This example assumes an Ubuntu distribution. After installation, run meshtastic to verify.

```bash
sudo meshtastic
```

--------------------------------

### Start Development Server

Source: https://meshtastic.org/docs/development/web

Start the development server using Deno task.

```bash
deno task dev  
```

--------------------------------

### Install Dependencies

Source: https://meshtastic.org/docs/development/web

Install the project dependencies using Deno.

```bash
deno i  
```

--------------------------------

### Install dependencies on Debian/Ubuntu

Source: https://meshtastic.org/docs/development/linux

Install base, web server, and SDL support libraries using apt.

```bash
# Base dependencies  

sudo apt install libgpiod-dev libyaml-cpp-dev libjsoncpp-dev libbluetooth-dev libusb-1.0-0-dev libi2c-dev libuv1-dev libxkbcommon-dev libinput-dev libsqlite3-dev  

# Optional dependencies for web server support  

sudo apt install openssl libssl-dev libulfius-dev liborcania-dev  

# Optional dependencies for sdl support  

sudo apt install libsdl2-dev
```

--------------------------------

### Install and Install Poetry

Source: https://meshtastic.org/docs/development/python/building

Installs the Poetry package manager and then installs Meshtastic using Poetry. This is a prerequisite for building the project.

```bash
pip3 install poetry

poetry install

```

--------------------------------

### Install OpenOCD and Dependencies

Source: https://meshtastic.org/docs/getting-started/flashing-firmware/nrf52/swdio

Installs necessary tools and OpenOCD from source on a Raspberry Pi for SWDIO flashing.

```bash
$ sudo apt update  

$ sudo apt install libtool autoconf automake texinfo telnet gdb-multiarch git  

$ git clone git://repo.or.cz/openocd.git  

$ cd openocd/  

$ ./bootstrap  

$ ./configure --enable-bcm2835gpio  

$ make -j4  

$ sudo make install  

```

--------------------------------

### Install Dependencies

Source: https://meshtastic.org/docs/community/software/harbor-scale

Install the necessary Python dependencies for the Harbor Meshtastic integration.

```bash
pip install -r requirements.txt  
```

--------------------------------

### Start Mosquitto on Raspberry Pi

Source: https://meshtastic.org/docs/software/integrations/mqtt/mosquitto

Starts the Mosquitto service on a Raspberry Pi using systemctl.

```bash
sudo systemctl start mosquitto
```

--------------------------------

### Install Requirements

Source: https://meshtastic.org/docs/software/meshtasticator/discrete-event-sim

Install the necessary Python packages for the simulator. Ensure you are in the Meshtasticator folder.

```bash
pip install -r requirements.txt
```

--------------------------------

### Install local-localizer

Source: https://meshtastic.org/docs/software/apple/user/translate

Commands to clone, build, and install the local-localizer tool required for generating translations.

```bash
git clone https://github.com/JoshuaSullivan/local-localizer.git ~/local-localizer  

cd ~/local-localizer && swift build -c release  

mkdir -p ~/bin && cp .build/release/local-localizer ~/bin/local-localizer
```

--------------------------------

### Meshtastic Repository README Template

Source: https://meshtastic.org/docs/development/reference/github

A template for creating consistent README files across Meshtastic repositories. It includes sections for badges, overview, getting started, documentation, stats, installation, and compatibility.

```markdown
# Repository Name  
  
  
<!--Project specific badges here-->  
  
<!--Crowdin Badge can be generated from https://crowdin.meshtastic.org/u/projects/<project_id>/crowdsource -->  
  
[![Crowdin](https://badges.crowdin.com/e/<badge_id>/localized.svg)](https://crowdin.meshtastic.org/<project>)  
  
[![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/<repo>/ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic/<repo>/actions/workflows/ci.yml)  
  
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/<repo>)](https://cla-assistant.io/meshtastic/<repo>)  
  
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)  
  
[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)  
  
## Overview  
  
A description about the project  
  
**[Getting Started Guide](https://example.com)**  
  
**[Documentation/API Reference](https://example.com)**  
  
## Stats  
  
<!--Repobeats image here-->  
  
Repobeats images can be generated at [repobeats.axiom.co](https://repobeats.axiom.co/)  
  
<!--If the repository is a library, include this section-->  
  
## Installation & Usage  
  
<!--You may optionally include brief install/update instructions here-->  
  
<!--Any other pertinent sections-->  
  
### Compatibility  
  

```

--------------------------------

### Run Development Server

Source: https://meshtastic.org/docs/development/documentation/local-dev

Start the Node.js development server to serve the documentation locally.

```bash
pnpm start
```

--------------------------------

### Configure and Listen to PROTO Mode

Source: https://meshtastic.org/docs/configuration/module/serial

Setup for Protobuf Client API mode and listening to the stream.

```bash
meshtastic --port <USB_PORT> \  

  --set serial.enabled true \  

  --set serial.txd 16 \  

  --set serial.rxd 17 \  

  --set serial.mode PROTO  
```

```bash
meshtastic --port <FTDI_PORT> --listen  
```

--------------------------------

### Clone Harbor Meshtastic Repository

Source: https://meshtastic.org/docs/community/software/harbor-scale

Clone the Harbor Meshtastic repository to your local machine to get started.

```bash
git clone https://github.com/HarborScale/harbor-meshtastic.git  

cd harbor-meshtastic  
```

--------------------------------

### Build and Run Meshtastic Desktop from Source

Source: https://meshtastic.org/docs/software/android/user/desktop

Commands to clone the repository, initialize submodules, and launch the desktop application using Gradle.

```bash
git clone https://github.com/meshtastic/Meshtastic-Android.git  

cd Meshtastic-Android  

git submodule update --init  

./gradlew :desktopApp:run  
```

--------------------------------

### Get Meshtasticd Docker Container ID

Source: https://meshtastic.org/docs/meshtasticd/usage

If the container was not started with a name, use this command to list running containers and find the ID of meshtasticd.

```bash
docker ps
```

--------------------------------

### Build Meshtastic from command line

Source: https://meshtastic.org/docs/development/linux

Set up a virtual environment, clone the repository, and build the native target using PlatformIO.

```bash
python3 -m venv venv  

source venv/bin/activate  

git clone https://github.com/meshtastic/firmware.git  

cd firmware; git submodule init; git submodule update  

pip install platformio  

pio run -e native;
```

--------------------------------

### Install Meshtastic from Beta Repository

Source: https://meshtastic.org/docs/meshtasticd/installation/ubuntu

Installs Meshtastic using the beta APT repository. This is the recommended channel for most users.

```bash
# Install requirements for add-apt-repository  
sudo apt install software-properties-common  

# Add Meshtastic repo  
sudo add-apt-repository ppa:meshtastic/beta  

# Install meshtasticd  
sudo apt install meshtasticd  

```

--------------------------------

### Check Homebrew Installation (macOS)

Source: https://meshtastic.org/docs/getting-started/flashing-firmware/esp32/cli-script

Verify if Homebrew is installed on your macOS system. Homebrew is required for installing Python 3 and pip3.

```bash
brew -v
```

--------------------------------

### Launch Simulator with Seed Variables

Source: https://meshtastic.org/docs/software/apple/developer/swiftdata

Example command to launch the app with specific environment variables to seed 5,000 nodes and reset the store.

```bash
SIMCTL_CHILD_MESHTASTIC_PERF_SEED_NODES=5000 \

SIMCTL_CHILD_MESHTASTIC_PERF_RESET_STORE=true \

SIMCTL_CHILD_MESHTASTIC_PERF_COMPACT_LIST=true \

xcrun simctl launch <UDID> gvh.MeshtasticClient
```

--------------------------------

### Install Pip (Linux)

Source: https://meshtastic.org/docs/software/python/cli/installation

Install pip for Python 3 on Ubuntu-based Linux systems using apt-get. This is required if pip is not already installed.

```bash
sudo apt-get install python3-pip
```

--------------------------------

### Check Pip Version (Linux/macOS)

Source: https://meshtastic.org/docs/software/python/cli/installation

Verify if pip is installed on your system. Pip is the package installer for Python and is required for Meshtastic CLI installation.

```bash
pip3 -V
```

--------------------------------

### Check Python 3 and Pip Installation (Linux)

Source: https://meshtastic.org/docs/getting-started/flashing-firmware/esp32/cli-script

Verify if Python 3 and pip are installed on your Linux system. If not, these commands will help you install them.

```bash
python3 --version
pip3 --version
```

```bash
sudo apt-get update
sudo apt-get install python3
```

```bash
sudo apt-get install python3-pip
```

--------------------------------

### Install Meshtastic CLI with pipx (macOS)

Source: https://meshtastic.org/docs/software/python/cli/installation

Install the Meshtastic CLI using pipx on macOS. The `[cli]` suffix installs optional dependencies for the CLI.

```bash
pipx install "meshtastic[cli]"
```

--------------------------------

### Install Mosquitto on Raspberry Pi

Source: https://meshtastic.org/docs/software/integrations/mqtt/mosquitto

Installs the Mosquitto MQTT server and client tools on a Raspberry Pi using apt-get.

```bash
sudo apt-get install mosquitto mosquitto-clients
```

--------------------------------

### Install Python 3 (Linux)

Source: https://meshtastic.org/docs/software/python/cli/installation

Install Python 3 on Ubuntu-based Linux systems using apt-get. This is required if Python 3 is not already installed.

```bash
sudo apt-get update

sudo apt-get install python3
```

--------------------------------

### Start Simulation with Default Configuration

Source: https://meshtastic.org/docs/software/meshtasticator/discrete-event-sim

Run a single simulation using default parameters. Optionally specify the number of nodes.

```bash
python3 loraMesh.py [nr_nodes]
```

--------------------------------

### Running Meshtasticd with Custom Configuration

Source: https://meshtastic.org/docs/meshtasticd/usage

Example of running meshtasticd with a custom configuration file, virtual filesystem directory, and API port.

```bash
sudo -u meshtasticd meshtasticd -c config.yaml -d ./data -p 4404
```

--------------------------------

### Confirm Python and Pip Installation (Windows)

Source: https://meshtastic.org/docs/getting-started/flashing-firmware/esp32/cli-script

Confirm the installation of Python and pip on your Windows system. Ensure 'Add Python X.Y to PATH' was selected during installation.

```bash
py --version
```

```bash
pip --version
```

--------------------------------

### Install Submodules

Source: https://meshtastic.org/docs/development/documentation/local-dev

Initialize and update all git submodules required for the project.

```git
git submodule update --init --recursive
```

--------------------------------

### Install Python 3 with Homebrew (macOS)

Source: https://meshtastic.org/docs/software/python/cli/installation

Install Python 3, which includes pip3, on macOS using the Homebrew package manager. Ensure Homebrew is installed first.

```bash
brew install python3
```

--------------------------------

### Install Meshtastic Daily on Debian 12 (bookworm)

Source: https://meshtastic.org/docs/meshtasticd/installation/debian

Installs the daily build of Meshtastic on Debian 12. Adds the daily repository and its GPG key, then installs the meshtasticd package.

```bash
[[ "$(. /etc/os-release && echo $NAME)" == Raspbian* ]] && echo "ERROR: Raspberry Pi OS (32-bit) detected, please use the Raspbian repos."

echo 'deb http://download.opensuse.org/repositories/network:/Meshtastic:/daily/Debian_12/ /' | sudo tee /etc/apt/sources.list.d/network:Meshtastic:daily.list

curl -fsSL https://download.opensuse.org/repositories/network:Meshtastic:daily/Debian_12/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/network_Meshtastic_daily.gpg > /dev/null

sudo apt update

sudo apt install meshtasticd

```

--------------------------------

### Install Meshtastic Daily

Source: https://meshtastic.org/docs/meshtasticd/installation/epel

Installs the daily build of meshtasticd by enabling the EPEL repository and the Meshtastic daily COPR repository.

```bash
# Add Meshtastic COPR repos  

sudo dnf config-manager --set-enabled crb  

sudo dnf install epel-release  

sudo dnf copr enable @meshtastic/daily  

# Install meshtasticd  

sudo dnf install meshtasticd  

```

--------------------------------

### Install Meshtastic Daily on Debian 13 (trixie)

Source: https://meshtastic.org/docs/meshtasticd/installation/debian

Installs the daily build of Meshtastic on Debian 13. Adds the daily repository and its GPG key, then installs the meshtasticd package.

```bash
[[ "$(. /etc/os-release && echo $NAME)" == Raspbian* ]] && echo "ERROR: Raspberry Pi OS (32-bit) detected, please use the Raspbian repos."

echo 'deb http://download.opensuse.org/repositories/network:/Meshtastic:/daily/Debian_13/ /' | sudo tee /etc/apt/sources.list.d/network:Meshtastic:daily.list

curl -fsSL https://download.opensuse.org/repositories/network:Meshtastic:daily/Debian_13/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/network_Meshtastic_daily.gpg > /dev/null

sudo apt update

sudo apt install meshtasticd

```

--------------------------------

### Generate Protobuf Documentation

Source: https://meshtastic.org/docs/development/documentation/publish

Navigate to the meshtastic directory and execute the script to generate protobuf documentation.

```bash
cd meshtastic  

./scripts/gen-proto-docs.sh
```

--------------------------------

### Install Meshtastic from Alpha Repository

Source: https://meshtastic.org/docs/meshtasticd/installation/ubuntu

Installs Meshtastic using the alpha APT repository. Use this for early access to the latest features, but expect potential instability.

```bash
# Install requirements for add-apt-repository  
sudo apt install software-properties-common  

# Add Meshtastic repo  
sudo add-apt-repository ppa:meshtastic/alpha  

# Install meshtasticd  
sudo apt install meshtasticd  

```

--------------------------------

### Install Meshtastic Alpha on Debian 12 (bookworm)

Source: https://meshtastic.org/docs/meshtasticd/installation/debian

Installs the alpha version of Meshtastic on Debian 12. Adds the alpha repository and its GPG key, then installs the meshtasticd package.

```bash
[[ "$(. /etc/os-release && echo $NAME)" == Raspbian* ]] && echo "ERROR: Raspberry Pi OS (32-bit) detected, please use the Raspbian repos."

echo 'deb http://download.opensuse.org/repositories/network:/Meshtastic:/alpha/Debian_12/ /' | sudo tee /etc/apt/sources.list.d/network:Meshtastic:alpha.list

curl -fsSL https://download.opensuse.org/repositories/network:Meshtastic:alpha/Debian_12/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/network_Meshtastic_alpha.gpg > /dev/null

sudo apt update

sudo apt install meshtasticd

```

--------------------------------

### Install Meshtastic Alpha on Debian 13 (trixie)

Source: https://meshtastic.org/docs/meshtasticd/installation/debian

Installs the alpha version of Meshtastic on Debian 13. Adds the alpha repository and its GPG key, then installs the meshtasticd package.

```bash
[[ "$(. /etc/os-release && echo $NAME)" == Raspbian* ]] && echo "ERROR: Raspberry Pi OS (32-bit) detected, please use the Raspbian repos."

echo 'deb http://download.opensuse.org/repositories/network:/Meshtastic:/alpha/Debian_13/ /' | sudo tee /etc/apt/sources.list.d/network:Meshtastic:alpha.list

curl -fsSL https://download.opensuse.org/repositories/network:Meshtastic:alpha/Debian_13/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/network_Meshtastic_alpha.gpg > /dev/null

sudo apt update

sudo apt install meshtasticd

```
Tokens:
Raw