Reticulum Network Stack Manual

This manual aims to provide you with all the information you need to understand Reticulum, build networks or develop programs using it, or to participate in the development of Reticulum itself.

Table Of Contents

• What is Reticulum?
  • Current Status
  • What does Reticulum Offer?
  • Where can Reticulum be Used?
  • Interface Types and Devices
  • Caveat Emptor
• Getting Started Fast
  • Standalone Reticulum Installation
  • Try Using a Reticulum-based Program
    • Nomad Network
    • Sideband
  • Using the Included Utilities
  • Creating a Network With Reticulum
  • Connecting Reticulum Instances Over the Internet
  • Connect to the Public Testnet
  • Adding Radio Interfaces
  • Develop a Program with Reticulum
  • Participate in Reticulum Development
  • Reticulum on ARM64
  • Reticulum on Raspberry Pi
  • Reticulum on Android
  • Pure-Python Reticulum
• Using Reticulum on Your System
  • Configuration & Data
  • Included Utility Programs
    • The rnsd Utility
    • The rnstatus Utility
    • The rnpath Utility
    • The rnprobe Utility
    • The rncp Utility
    • The rnx Utility
    • The rnodeconf Utility
  • Improving System Configuration
    • Fixed Serial Port Names
    • Reticulum as a System Service
• Understanding Reticulum
  • Motivation
  • Goals
  • Introduction & Basic Functionality
    • Destinations
    • Public Key Announcements
    • Identities
    • Getting Further
  • Reticulum Transport
    • Node Types
    • The Announce Mechanism in Detail
    • Reaching the Destination
    • Resources
  • Reference Setup
  • Protocol Specifics
    • Packet Prioritisation
    • Interface Access Codes
    • Wire Format
    • Announce Propagation Rules
    • Cryptographic Primitives
• Communications Hardware
  • RNode
    • Creating RNodes
    • Supported Boards
    • Installation
    • Usage with Reticulum
    • Suppliers
  • WiFi-based Hardware
  • Combining Hardware Types
• Supported Interfaces
  • Auto Interface
  • I2P Interface
  • TCP Server Interface
  • TCP Client Interface
  • UDP Interface
  • RNode LoRa Interface
  • Serial Interface
  • Pipe Interface
  • KISS Interface
  • AX.25 KISS Interface
  • Common Interface Options
  • Interface Modes
  • Announce Rate Control
• Building Networks
  • Concepts & Overview
  • Example Scenarios
    • Interconnected LoRa Sites
    • Bridging Over the Internet
    • Growth and Convergence
• Code Examples
  • Minimal
  • Announce
  • Broadcast
  • Echo
  • Link
  • Identification
  • Requests & Responses
  • Filetransfer
• Support Reticulum
  • Donations
  • Provide Feedback
  • Contribute Code

• API Reference
  • Reticulum
  • Identity
  • Destination
  • Packet
  • PacketReceipt
  • Link
  • RequestReceipt
  • Resource
  • Transport

Indices and Tables

• Index

• Search Page