Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions docs/mqtt-main.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
# MeshMapper MQTT Setup

An **MQTT observer** is a MeshCore node that acts as the "ears" of MeshMapper — it listens for mesh traffic and publishes it to an MQTT broker, where MeshMapper picks it up for processing. Each region requires at least one observer connected to either the **LetsMesh** or **MeshMapper** broker (or both for redundancy).
An **MQTT observer** is a MeshCore node that acts as the "ears" of MeshMapper — it listens for mesh traffic and publishes it to an MQTT broker, where MeshMapper picks it up for processing. Each region needs at least one observer connected to the **MeshMapper** broker.

## Available Brokers
## MeshMapper Broker

An observer can connect to one or both of the following brokers:

| Broker | Host | Port | Transport | Authentication |
| --- | --- | --- | --- | --- |
| **MeshMapper** | `mqtt.meshmapper.net` | 443 | WebSockets + TLS | Device signing |
| **LetsMesh** | `mqtt-us-v1.letsmesh.net` / `mqtt-eu-v1.letsmesh.net` | 443 | WebSockets + TLS | Device signing |

!!! tip "Redundancy"
Connecting to both brokers is recommended but not required. Data received from multiple brokers is automatically deduplicated by MeshMapper.
| Host | Port | Transport | Authentication |
| --- | --- | --- | --- |
| `mqtt.meshmapper.net` | 443 | WebSockets + TLS | Device signing |

## MQTT Observer Methods

There are four ways to set up a MeshCore MQTT observer that collects packets and forwards them to LetsMesh or MeshMapper.
There are four ways to set up a MeshCore MQTT observer that collects packets and forwards them to MeshMapper.

### 1. MeshCore Packet Capture (Python)

Expand Down
2 changes: 1 addition & 1 deletion docs/mqtt-pymc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ These instructions cover adding the MeshMapper MQTT broker to an existing pyMC-R

## Prerequisites

- A Raspberry Pi running pyMC-Repeater with LetsMesh already configured and working
- A Raspberry Pi with pyMC-Repeater installed and working

## Adding the MeshMapper Broker

Expand Down
16 changes: 6 additions & 10 deletions docs/mqtt-python.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MeshCore Packet Capture

These instructions are for the community [meshcore-packet-capture](https://github.com/agessaman/meshcore-packet-capture) project from agessaman/HerculesMulligan. A single observer can connect to both the LetsMesh and MeshMapper brokers.
These instructions are for the community [meshcore-packet-capture](https://github.com/agessaman/meshcore-packet-capture) project from agessaman/HerculesMulligan.

## Prerequisites

Expand All @@ -24,7 +24,7 @@ sudo apt install -y python3 python3.12-venv curl git

### 3. Install the MeshCore Decoder

The MeshCore decoder is required for authentication when sending packets to the brokers:
The MeshCore decoder is required for authentication when sending packets to the broker:

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
Expand Down Expand Up @@ -68,19 +68,15 @@ Enter your region's **3-letter IATA code** (e.g., `SEA`, `LAX`, `YOW`, `LON`). T
You may optionally configure:

- **Owner Public Key**: The public key of the observer owner (64 hex characters)
- **Owner Email**: Contact email for the LetsMesh Analyzer
- **Owner Email**: A contact email

These are optional, apply to LetsMesh only, and can be skipped if you wish.
MeshMapper doesn't use these, so you can skip them.

### 8. MQTT Broker Configuration

#### LetsMesh Broker
The script will ask whether to enable the LetsMesh Packet Analyzer. MeshMapper doesn't need it, so that's up to you.

The script will ask whether to enable the LetsMesh Packet Analyzer. This connects to both the US and EU LetsMesh servers for redundancy. Recommended to enable.

#### MeshMapper Broker

When prompted to configure additional brokers, select "1" additonal, and add the MeshMapper broker with the following settings:
When prompted to configure additional brokers, select "1" additional, and add the MeshMapper broker with the following settings:

| Setting | Value |
| --- | --- |
Expand Down
Loading