2021-05-16 21:40:49 +00:00
<!DOCTYPE html>
2022-09-29 22:02:15 +00:00
< html lang = "en" >
2021-05-16 21:40:49 +00:00
< head >
< meta charset = "utf-8" / >
2022-09-29 22:02:15 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.19: https://docutils.sourceforge.io/" / >
2022-09-06 14:50:33 +00:00
< title > Reticulum Network Stack Manual — Reticulum Network Stack 0.3.12 beta documentation< / title >
2021-05-16 21:40:49 +00:00
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "_static/classic.css" / >
< script data-url_root = "./" id = "documentation_options" src = "_static/documentation_options.js" > < / script >
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
2022-09-29 22:02:15 +00:00
< script src = "_static/_sphinx_javascript_frameworks_compat.js" > < / script >
2021-05-16 21:40:49 +00:00
< script src = "_static/doctools.js" > < / script >
2022-09-29 22:02:15 +00:00
< script src = "_static/sphinx_highlight.js" > < / script >
2021-05-16 21:40:49 +00:00
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "What is Reticulum?" href = "whatis.html" / >
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "whatis.html" title = "What is Reticulum?"
accesskey="N">next< / a > |< / li >
2022-09-06 14:50:33 +00:00
< li class = "nav-item nav-item-0" > < a href = "#" > Reticulum Network Stack 0.3.12 beta documentation< / a > » < / li >
2021-05-17 14:06:25 +00:00
< li class = "nav-item nav-item-this" > < a href = "" > Reticulum Network Stack Manual< / a > < / li >
2021-05-16 21:40:49 +00:00
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2022-09-29 22:02:15 +00:00
< section id = "reticulum-network-stack-manual" >
< h1 > Reticulum Network Stack Manual< a class = "headerlink" href = "#reticulum-network-stack-manual" title = "Permalink to this heading" > ¶< / a > < / h1 >
2021-05-17 18:01:53 +00:00
< p > This manual aims to provide you with all the information you need to
2021-09-25 21:22:33 +00:00
understand Reticulum, build networks or develop programs using it, or
to participate in the development of Reticulum itself.< / p >
2021-05-16 21:40:49 +00:00
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "whatis.html" > What is Reticulum?< / a > < ul >
2021-05-17 15:04:01 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "whatis.html#current-status" > Current Status< / a > < / li >
2021-05-16 21:40:49 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "whatis.html#what-does-reticulum-offer" > What does Reticulum Offer?< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "whatis.html#where-can-reticulum-be-used" > Where can Reticulum be Used?< / a > < / li >
2021-09-25 21:22:33 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "whatis.html#interface-types-and-devices" > Interface Types and Devices< / a > < / li >
2021-12-05 22:24:30 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "whatis.html#caveat-emptor" > Caveat Emptor< / a > < / li >
2021-05-16 21:40:49 +00:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "gettingstartedfast.html" > Getting Started Fast< / a > < ul >
2022-04-28 08:19:43 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#try-using-a-reticulum-based-program" > Try Using a Reticulum-based Program< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "gettingstartedfast.html#nomad-network" > Nomad Network< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "gettingstartedfast.html#sideband" > Sideband< / a > < / li >
< / ul >
< / li >
2021-10-08 16:30:17 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#using-the-included-utilities" > Using the Included Utilities< / a > < / li >
2021-09-25 19:39:31 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#creating-a-network-with-reticulum" > Creating a Network With Reticulum< / a > < / li >
2022-04-07 16:59:42 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#connecting-reticulum-instances-over-the-internet" > Connecting Reticulum Instances Over the Internet< / a > < / li >
2022-04-07 18:15:35 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#connect-to-the-public-testnet" > Connect to the Public Testnet< / a > < / li >
2022-06-22 13:19:18 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#adding-radio-interfaces" > Adding Radio Interfaces< / a > < / li >
2021-05-16 21:40:49 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#develop-a-program-with-reticulum" > Develop a Program with Reticulum< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#participate-in-reticulum-development" > Participate in Reticulum Development< / a > < / li >
2021-12-09 17:12:18 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#reticulum-on-arm64" > Reticulum on ARM64< / a > < / li >
2021-12-05 22:24:30 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#reticulum-on-android" > Reticulum on Android< / a > < / li >
2022-06-22 13:19:18 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "gettingstartedfast.html#pure-python-reticulum" > Pure-Python Reticulum< / a > < / li >
2021-05-16 21:40:49 +00:00
< / ul >
< / li >
2021-09-25 21:22:33 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "using.html" > Using Reticulum on Your System< / a > < ul >
2022-05-17 20:12:21 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "using.html#configuration-data" > Configuration & Data< / a > < / li >
2021-09-25 21:22:33 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "using.html#included-utility-programs" > Included Utility Programs< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#the-rnsd-utility" > The rnsd Utility< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#the-rnstatus-utility" > The rnstatus Utility< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#the-rnpath-utility" > The rnpath Utility< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#the-rnprobe-utility" > The rnprobe Utility< / a > < / li >
2022-05-22 21:44:12 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#the-rncp-utility" > The rncp Utility< / a > < / li >
2022-05-24 18:47:45 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#the-rnx-utility" > The rnx Utility< / a > < / li >
2021-09-25 21:22:33 +00:00
< / ul >
< / li >
2021-12-05 15:05:43 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "using.html#improving-system-configuration" > Improving System Configuration< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#fixed-serial-port-names" > Fixed Serial Port Names< / a > < / li >
2021-12-05 15:07:53 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "using.html#reticulum-as-a-system-service" > Reticulum as a System Service< / a > < / li >
2021-12-05 15:05:43 +00:00
< / ul >
< / li >
2021-09-25 21:22:33 +00:00
< / ul >
< / li >
2021-05-16 21:40:49 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "understanding.html" > Understanding Reticulum< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "understanding.html#motivation" > Motivation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "understanding.html#goals" > Goals< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "understanding.html#introduction-basic-functionality" > Introduction & Basic Functionality< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#destinations" > Destinations< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#public-key-announcements" > Public Key Announcements< / a > < / li >
2021-05-17 12:10:47 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#understanding-identities" > Identities< / a > < / li >
2021-05-16 21:40:49 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#getting-further" > Getting Further< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "understanding.html#reticulum-transport" > Reticulum Transport< / a > < ul >
2022-04-07 16:59:42 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#node-types" > Node Types< / a > < / li >
2021-05-20 16:37:12 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#the-announce-mechanism-in-detail" > The Announce Mechanism in Detail< / a > < / li >
2021-05-17 12:10:47 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#reaching-the-destination" > Reaching the Destination< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#resources" > Resources< / a > < / li >
2021-05-16 21:40:49 +00:00
< / ul >
< / li >
2022-04-07 18:15:35 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "understanding.html#reference-setup" > Reference Setup< / a > < / li >
2021-05-16 21:40:49 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "understanding.html#protocol-specifics" > Protocol Specifics< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#packet-prioritisation" > Packet Prioritisation< / a > < / li >
2022-04-28 13:12:37 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#interface-access-codes" > Interface Access Codes< / a > < / li >
2022-04-20 19:24:01 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#wire-format" > Wire Format< / a > < / li >
2022-05-13 18:19:54 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#announce-propagation-rules" > Announce Propagation Rules< / a > < / li >
2022-06-22 13:19:18 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "understanding.html#cryptographic-primitives" > Cryptographic Primitives< / a > < / li >
2021-05-16 21:40:49 +00:00
< / ul >
< / li >
< / ul >
< / li >
2022-06-22 14:20:01 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "hardware.html" > Communications Hardware< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "hardware.html#rnode" > RNode< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "hardware.html#creating-rnodes" > Creating RNodes< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "hardware.html#supported-boards" > Supported Boards< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "hardware.html#installation" > Installation< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "hardware.html#usage-with-reticulum" > Usage with Reticulum< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "hardware.html#suppliers" > Suppliers< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "hardware.html#wifi-based-hardware" > WiFi-based Hardware< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "hardware.html#combining-hardware-types" > Combining Hardware Types< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "interfaces.html" > Supported Interfaces< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#auto-interface" > Auto Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#i2p-interface" > I2P Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#tcp-server-interface" > TCP Server Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#tcp-client-interface" > TCP Client Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#udp-interface" > UDP Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#rnode-lora-interface" > RNode LoRa Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#serial-interface" > Serial Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#pipe-interface" > Pipe Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#kiss-interface" > KISS Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#ax-25-kiss-interface" > AX.25 KISS Interface< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#common-interface-options" > Common Interface Options< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#interface-modes" > Interface Modes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "interfaces.html#announce-rate-control" > Announce Rate Control< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "networks.html" > Building Networks< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "networks.html#concepts-overview" > Concepts & Overview< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "networks.html#example-scenarios" > Example Scenarios< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "networks.html#interconnected-lora-sites" > Interconnected LoRa Sites< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "networks.html#bridging-over-the-internet" > Bridging Over the Internet< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "networks.html#growth-and-convergence" > Growth and Convergence< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
2021-09-25 21:22:33 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "examples.html" > Code Examples< / a > < ul >
2021-05-20 15:18:38 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#minimal" > Minimal< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#announce" > Announce< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#broadcast" > Broadcast< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#echo" > Echo< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#link" > Link< / a > < / li >
2021-08-19 12:11:22 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#example-identify" > Identification< / a > < / li >
2021-08-20 21:29:06 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#requests-responses" > Requests & Responses< / a > < / li >
2021-05-20 15:18:38 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "examples.html#filetransfer" > Filetransfer< / a > < / li >
< / ul >
< / li >
2022-09-30 11:09:10 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "reference.html" > API Reference< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference.html#classes" > Classes< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.Reticulum" > < code class = "docutils literal notranslate" > < span class = "pre" > Reticulum< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.Identity" > < code class = "docutils literal notranslate" > < span class = "pre" > Identity< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.Destination" > < code class = "docutils literal notranslate" > < span class = "pre" > Destination< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.Packet" > < code class = "docutils literal notranslate" > < span class = "pre" > Packet< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.PacketReceipt" > < code class = "docutils literal notranslate" > < span class = "pre" > PacketReceipt< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.Link" > < code class = "docutils literal notranslate" > < span class = "pre" > Link< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.RequestReceipt" > < code class = "docutils literal notranslate" > < span class = "pre" > RequestReceipt< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.Resource" > < code class = "docutils literal notranslate" > < span class = "pre" > Resource< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "reference.html#RNS.Transport" > < code class = "docutils literal notranslate" > < span class = "pre" > Transport< / span > < / code > < / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
2022-06-22 13:19:18 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "support.html" > Support Reticulum< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "support.html#donations" > Donations< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "support.html#provide-feedback" > Provide Feedback< / a > < / li >
2022-06-22 14:10:54 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "support.html#contribute-code" > Contribute Code< / a > < / li >
2022-06-22 13:19:18 +00:00
< / ul >
< / li >
2021-05-16 21:40:49 +00:00
< / ul >
< / div >
2022-09-29 22:02:15 +00:00
< section id = "indices-and-tables" >
< h2 > Indices and Tables< a class = "headerlink" href = "#indices-and-tables" title = "Permalink to this heading" > ¶< / a > < / h2 >
2021-05-16 21:40:49 +00:00
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "genindex.html" > < span class = "std std-ref" > Index< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "search.html" > < span class = "std std-ref" > Search Page< / span > < / a > < / p > < / li >
< / ul >
2022-09-29 22:02:15 +00:00
< / section >
< / section >
2021-05-16 21:40:49 +00:00
< div class = "clearer" > < / div >
< / div >
< / div >
< / div >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
2022-09-29 22:02:15 +00:00
< div >
< h3 > < a href = "#" > Table of Contents< / a > < / h3 >
< ul >
2021-05-17 14:06:25 +00:00
< li > < a class = "reference internal" href = "#" > Reticulum Network Stack Manual< / a > < ul >
2021-05-16 21:40:49 +00:00
< li > < a class = "reference internal" href = "#indices-and-tables" > Indices and Tables< / a > < / li >
< / ul >
< / li >
< / ul >
2022-09-29 22:02:15 +00:00
< / div >
< div >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "whatis.html"
title="next chapter">What is Reticulum?< / a > < / p >
< / div >
2021-05-16 21:40:49 +00:00
< div role = "note" aria-label = "source link" >
< h3 > This Page< / h3 >
< ul class = "this-page-menu" >
< li > < a href = "_sources/index.rst.txt"
rel="nofollow">Show Source< / a > < / li >
< / ul >
< / div >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "search.html" method = "get" >
2022-09-29 22:02:15 +00:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
2021-05-16 21:40:49 +00:00
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
2022-09-29 22:02:15 +00:00
< script > document . getElementById ( 'searchbox' ) . style . display = "block" < / script >
2021-05-16 21:40:49 +00:00
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "genindex.html" title = "General Index"
>index< / a > < / li >
< li class = "right" >
< a href = "whatis.html" title = "What is Reticulum?"
>next< / a > |< / li >
2022-09-06 14:50:33 +00:00
< li class = "nav-item nav-item-0" > < a href = "#" > Reticulum Network Stack 0.3.12 beta documentation< / a > » < / li >
2021-05-17 14:06:25 +00:00
< li class = "nav-item nav-item-this" > < a href = "" > Reticulum Network Stack Manual< / a > < / li >
2021-05-16 21:40:49 +00:00
< / ul >
< / div >
< div class = "footer" role = "contentinfo" >
2022-05-13 18:19:54 +00:00
© Copyright 2022, Mark Qvist.
2022-09-29 22:02:15 +00:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 5.2.2.
2021-05-16 21:40:49 +00:00
< / div >
< / body >
< / html >
