2022-09-30 16:43:04 +00:00
|
|
|
<!doctype html>
|
|
|
|
|
<html class="no-js" lang="en">
|
|
|
|
|
<head><meta charset="utf-8"/>
|
|
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
|
|
|
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" />
|
2021-05-16 21:40:49 +00:00
|
|
|
|
2024-10-01 21:53:53 +00:00
|
|
|
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29.dev1"/><title>Search - Reticulum Network Stack 0.8.1 beta documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
2023-06-29 14:52:06 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=189ec851f9bb375a2509b67be1f64f0cf212b702" />
|
2024-05-05 17:56:33 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
2022-09-30 16:43:04 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
2024-05-05 17:56:33 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
|
2021-05-16 21:40:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-09-30 16:43:04 +00:00
|
|
|
<style>
|
|
|
|
|
body {
|
|
|
|
|
--color-code-background: #f8f8f8;
|
|
|
|
|
--color-code-foreground: black;
|
2021-05-16 21:40:49 +00:00
|
|
|
|
2022-09-30 16:43:04 +00:00
|
|
|
}
|
|
|
|
|
@media not print {
|
|
|
|
|
body[data-theme="dark"] {
|
|
|
|
|
--color-code-background: #202020;
|
|
|
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
|
--color-background-primary: #202b38;
|
|
|
|
|
--color-background-secondary: #161f27;
|
|
|
|
|
--color-foreground-primary: #dbdbdb;
|
|
|
|
|
--color-foreground-secondary: #a9b1ba;
|
|
|
|
|
--color-brand-primary: #41adff;
|
|
|
|
|
--color-background-hover: #161f27;
|
|
|
|
|
--color-api-name: #ffbe85;
|
|
|
|
|
--color-api-pre-name: #efae75;
|
2021-05-16 21:40:49 +00:00
|
|
|
|
2022-09-30 16:43:04 +00:00
|
|
|
}
|
|
|
|
|
@media (prefers-color-scheme: dark) {
|
|
|
|
|
body:not([data-theme="light"]) {
|
|
|
|
|
--color-code-background: #202020;
|
|
|
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
|
--color-background-primary: #202b38;
|
|
|
|
|
--color-background-secondary: #161f27;
|
|
|
|
|
--color-foreground-primary: #dbdbdb;
|
|
|
|
|
--color-foreground-secondary: #a9b1ba;
|
|
|
|
|
--color-brand-primary: #41adff;
|
|
|
|
|
--color-background-hover: #161f27;
|
|
|
|
|
--color-api-name: #ffbe85;
|
|
|
|
|
--color-api-pre-name: #efae75;
|
2021-05-16 21:40:49 +00:00
|
|
|
|
2022-09-30 16:43:04 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
</style></head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
|
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
|
|
|
<title>Contents</title>
|
|
|
|
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
|
|
|
|
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
|
|
|
|
</svg>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
|
|
|
<title>Menu</title>
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
|
|
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
|
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
|
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
|
|
|
</svg>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
|
|
|
<title>Expand</title>
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
|
|
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
|
|
|
|
</svg>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
|
|
|
<title>Light mode</title>
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
|
|
|
|
<circle cx="12" cy="12" r="5"></circle>
|
|
|
|
|
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
|
|
|
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
|
|
|
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
|
|
|
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
|
|
|
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
|
|
|
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
|
|
|
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
|
|
|
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
|
|
|
</svg>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
|
|
|
<title>Dark mode</title>
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
|
|
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
|
|
|
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
|
|
|
|
</svg>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
|
|
|
|
<title>Auto light/dark mode</title>
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
|
|
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
|
|
|
|
<circle cx="12" cy="12" r="9" />
|
|
|
|
|
<path d="M13 12h5" />
|
|
|
|
|
<path d="M13 15h4" />
|
|
|
|
|
<path d="M13 18h1" />
|
|
|
|
|
<path d="M13 9h4" />
|
|
|
|
|
<path d="M13 6h1" />
|
|
|
|
|
</svg>
|
|
|
|
|
</symbol>
|
|
|
|
|
</svg>
|
|
|
|
|
|
|
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
|
|
|
<label class="overlay sidebar-overlay" for="__navigation">
|
|
|
|
|
<div class="visually-hidden">Hide navigation sidebar</div>
|
|
|
|
|
</label>
|
|
|
|
|
<label class="overlay toc-overlay" for="__toc">
|
|
|
|
|
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
|
|
|
</label>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="page">
|
|
|
|
|
<header class="mobile-header">
|
|
|
|
|
<div class="header-left">
|
|
|
|
|
<label class="nav-overlay-icon" for="__navigation">
|
|
|
|
|
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
|
|
|
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
|
|
|
</label>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="header-center">
|
2024-10-01 21:53:53 +00:00
|
|
|
<a href="index.html"><div class="brand">Reticulum Network Stack 0.8.1 beta documentation</div></a>
|
2022-09-30 16:43:04 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="header-right">
|
|
|
|
|
<div class="theme-toggle-container theme-toggle-header">
|
|
|
|
|
<button class="theme-toggle">
|
|
|
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
|
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
|
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
|
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
|
|
|
|
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
|
|
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
|
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
|
|
|
</label>
|
|
|
|
|
</div>
|
|
|
|
|
</header>
|
|
|
|
|
<aside class="sidebar-drawer">
|
|
|
|
|
<div class="sidebar-container">
|
|
|
|
|
|
2024-05-05 17:56:33 +00:00
|
|
|
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
|
2021-05-16 21:40:49 +00:00
|
|
|
|
2022-09-30 16:43:04 +00:00
|
|
|
<div class="sidebar-logo-container">
|
|
|
|
|
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
|
2021-05-16 21:40:49 +00:00
|
|
|
</div>
|
|
|
|
|
|
2024-10-01 21:53:53 +00:00
|
|
|
<span class="sidebar-brand-text">Reticulum Network Stack 0.8.1 beta documentation</span>
|
2022-09-30 16:43:04 +00:00
|
|
|
|
|
|
|
|
</a><form class="sidebar-search-container" method="get" action="#" role="search">
|
2023-06-29 14:52:06 +00:00
|
|
|
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
2022-09-30 16:43:04 +00:00
|
|
|
<input type="hidden" name="check_keywords" value="yes">
|
|
|
|
|
<input type="hidden" name="area" value="default">
|
|
|
|
|
</form>
|
|
|
|
|
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="whatis.html">What is Reticulum?</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="gettingstartedfast.html">Getting Started Fast</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="using.html">Using Reticulum on Your System</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a></li>
|
2023-09-30 23:35:00 +00:00
|
|
|
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Configuring Interfaces</a></li>
|
2022-09-30 16:43:04 +00:00
|
|
|
<li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="examples.html">Code Examples</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="support.html">Support Reticulum</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
|
|
|
|
|
</ul>
|
2021-05-16 21:40:49 +00:00
|
|
|
|
2022-09-30 16:43:04 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="main">
|
|
|
|
|
<div class="content">
|
|
|
|
|
<div class="article-container">
|
|
|
|
|
<a href="#" class="back-to-top muted-link">
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
|
|
|
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
|
|
|
</svg>
|
|
|
|
|
<span>Back to top</span>
|
|
|
|
|
</a>
|
|
|
|
|
<div class="content-icon-container">
|
|
|
|
|
<div class="theme-toggle-container theme-toggle-content">
|
|
|
|
|
<button class="theme-toggle">
|
|
|
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
|
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
|
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
|
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
|
|
|
</button>
|
2021-05-16 21:40:49 +00:00
|
|
|
</div>
|
2022-09-30 16:43:04 +00:00
|
|
|
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
|
|
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
|
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
|
|
|
</label>
|
2021-05-16 21:40:49 +00:00
|
|
|
</div>
|
2022-09-30 16:43:04 +00:00
|
|
|
<article role="main">
|
|
|
|
|
|
|
|
|
|
<noscript>
|
|
|
|
|
<div class="admonition error">
|
|
|
|
|
<p class="admonition-title">Error</p>
|
|
|
|
|
<p>
|
|
|
|
|
Please activate JavaScript to enable the search functionality.
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
</noscript>
|
|
|
|
|
|
|
|
|
|
<div id="search-results"></div>
|
|
|
|
|
|
|
|
|
|
</article>
|
2021-05-16 21:40:49 +00:00
|
|
|
</div>
|
2022-09-30 16:43:04 +00:00
|
|
|
<footer>
|
|
|
|
|
|
|
|
|
|
<div class="related-pages">
|
|
|
|
|
|
|
|
|
|
|
2021-05-16 21:40:49 +00:00
|
|
|
</div>
|
2022-09-30 16:43:04 +00:00
|
|
|
<div class="bottom-of-page">
|
|
|
|
|
<div class="left-details">
|
|
|
|
|
<div class="copyright">
|
2023-02-23 16:25:38 +00:00
|
|
|
Copyright © 2023, Mark Qvist
|
2022-09-30 16:43:04 +00:00
|
|
|
</div>
|
|
|
|
|
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
|
|
|
|
|
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<div class="right-details">
|
|
|
|
|
<div class="icons">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</footer>
|
2021-05-16 21:40:49 +00:00
|
|
|
</div>
|
2022-09-30 16:43:04 +00:00
|
|
|
<aside class="toc-drawer no-toc">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
</div>
|
2024-05-05 17:56:33 +00:00
|
|
|
</div><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>
|
|
|
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
|
|
|
<script src="_static/doctools.js"></script>
|
|
|
|
|
<script src="_static/sphinx_highlight.js"></script>
|
|
|
|
|
<script src="_static/scripts/furo.js"></script>
|
|
|
|
|
<script src="_static/clipboard.min.js"></script>
|
|
|
|
|
<script src="_static/copybutton.js"></script>
|
2022-09-30 16:43:04 +00:00
|
|
|
|
|
|
|
|
<script src="_static/searchtools.js"></script>
|
|
|
|
|
<script src="_static/language_data.js"></script>
|
|
|
|
|
<script src="searchindex.js"></script></body>
|
2021-05-16 21:40:49 +00:00
|
|
|
</html>
|
