mirror of https://github.com/LFManifesto/ReticulumHF synced 2026-08-14 19:31:48 -04:00

No description

Find a file

Light-Fighter-Manifesto 4322efacf8 Fix README with accurate FreeDV/Reticulum/LXMF specifications		2026-01-31 00:40:54 -05:00
.github/ISSUE_TEMPLATE	ReticulumHF: Reticulum mesh networking over HF radio	2025-12-17 05:40:19 -05:00
beacon	v0.3.2-alpha: Multi-interface transport with TX gating	2026-01-30 17:26:11 -05:00
configs	Fix I2P reseed on first boot	2026-01-30 21:55:27 -05:00
docs	v0.3.1-alpha: Dashboard, JS8Call integration, beacon scheduler	2026-01-30 15:44:43 -05:00
image	v0.3.2-alpha: Multi-interface transport with TX gating	2026-01-30 17:26:11 -05:00
scripts	Fix I2P reseed on first boot	2026-01-30 21:55:27 -05:00
services	v0.3.1-alpha: Dashboard, JS8Call integration, beacon scheduler	2026-01-30 15:44:43 -05:00
setup-portal	Remove JS8Call and TAK, add complete N0NBH solar data	2026-01-31 00:30:55 -05:00
Testing/Postman Collections	Create ReticulumHF.postman_collection.json	2026-01-12 10:04:18 -05:00
.gitignore	v0.3.2-alpha: Multi-interface transport with TX gating	2026-01-30 17:26:11 -05:00
CONTRIBUTING.md	Update project name in CONTRIBUTING.md	2026-01-29 08:58:22 -05:00
LICENSE	ReticulumHF: Reticulum mesh networking over HF radio	2025-12-17 05:40:19 -05:00
README.md	Fix README with accurate FreeDV/Reticulum/LXMF specifications	2026-01-31 00:40:54 -05:00

README.md

ReticulumHF

v0.4.0-alpha - Reticulum mesh networking over HF radio using FreeDV data modes.

What This Is

A Raspberry Pi image that creates a WiFi gateway for Reticulum mesh networking over HF radio. Connect Sideband, MeshChat, or NomadNet to the Pi's WiFi, and it bridges your traffic to HF using FreeDV digital modes.

Technical Specifications

FreeDV Data Modes

Mode	Data Rate	Bandwidth	Bytes/Frame	Frame Time	Min SNR
DATAC1	980 bps	1700 Hz	510	4.18s	5 dB
DATAC4	87 bps	250 Hz	56	5.17s	-4 dB

Source: codec2 README_data.md

Throughput (DATAC1)

Raw throughput: 122 bytes/second
LXMF overhead: 111 bytes per message
Short message (200 chars): ~2.5 seconds TX time
Full frame (510 bytes): 4.18 seconds TX time

Reticulum Requirements

MTU: 500 bytes
Minimum throughput: 5 bps (DATAC1 provides 980 bps)
Half-duplex supported

Source: Reticulum Manual

What Works

LXMF messaging: Asynchronous encrypted messages with store-and-forward
Mesh discovery: Beacon announces find other nodes
Multi-path routing: HF + I2P internet transport
Offline operation: Works without any internet infrastructure

What Doesn't Work Well

Real-time chat: HF propagation causes variable latency
Large transfers: 122 bytes/sec means files take a long time
Guaranteed delivery: Propagation is unpredictable

Quick Start

Flash image to SD card
Boot Pi with radio + Digirig connected
Connect to WiFi: ReticulumHF / reticulumhf
Open http://192.168.4.1 - complete setup wizard
Connect Sideband/MeshChat to 192.168.4.1:4242 (TCP Client Interface)

Operating Modes

Mode	HF TX	I2P	Description
Hybrid	Beacon windows	Enabled	I2P for bulk, HF for discovery
HF Only	Full	Disabled	Field ops, no internet
Internet Only	Disabled	Enabled	Radio off/maintenance

Hardware

Required:

Raspberry Pi 4 (2GB+)
HF radio with data port
Audio interface (Digirig Mobile)
Antenna for your band
Amateur radio license

Tested Radios:

Radio	Interface	CAT Control
Xiegu G90	Digirig Mobile	Hamlib 3088
Yaesu FT-818	Digirig Mobile	Hamlib 1020
(tr)uSDX	Digirig Lite	VOX only

Network

Setting	Value
WiFi AP	`ReticulumHF` / `reticulumhf`
Portal	`http://192.168.4.1`
Client Port	4242
SSH	`pi` / `reticulumhf`

Dashboard

Solar/propagation data (N0NBH)
RX level monitor
Network health score
Beacon scheduler
Station map (grid squares)

Architecture

Sideband/MeshChat ──WiFi:4242──► Pi Gateway ──Audio/PTT──► HF Radio
                                     │
                                     └──I2P──► Internet (optional)