2022-09-30 18:43:04 +02:00
<!doctype html>
< html class = "no-js" lang = "en" >
< head > < meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width,initial-scale=1" / >
2023-06-29 16:52:06 +02:00
< meta name = "color-scheme" content = "light dark" > < meta name = "generator" content = "Docutils 0.19: https://docutils.sourceforge.io/" / >
2023-10-01 01:59:22 +02:00
< link rel = "index" title = "Index" href = "genindex.html" / > < link rel = "search" title = "Search" href = "search.html" / > < link rel = "next" title = "Configuring Interfaces" href = "interfaces.html" / > < link rel = "prev" title = "Understanding Reticulum" href = "understanding.html" / >
2022-06-22 15:19:18 +02:00
2024-05-05 19:56:33 +02:00
< meta name = "generator" content = "sphinx-5.3.0, furo 2022.09.29.dev1" / >
< title > Communications Hardware - Reticulum Network Stack 0.7.4 beta documentation< / title >
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css" / >
2023-06-29 16:52:06 +02:00
< link rel = "stylesheet" type = "text/css" href = "_static/styles/furo.css?digest=189ec851f9bb375a2509b67be1f64f0cf212b702" / >
2024-05-05 19:56:33 +02:00
< link rel = "stylesheet" type = "text/css" href = "_static/copybutton.css" / >
2022-09-30 18:43:04 +02:00
< link rel = "stylesheet" type = "text/css" href = "_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" / >
2024-05-05 19:56:33 +02:00
< link rel = "stylesheet" type = "text/css" href = "_static/custom.css" / >
2022-09-30 18:43:04 +02:00
2022-06-22 15:19:18 +02:00
2022-09-30 00:02:15 +02:00
2022-09-30 18:43:04 +02:00
< style >
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@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;
}
@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;
}
}
}
< / style > < / head >
< body >
2022-06-22 15:19:18 +02:00
2022-09-30 18:43:04 +02:00
< script >
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
< / script >
2022-06-22 15:19:18 +02:00
2022-09-30 18:43:04 +02:00
< 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-05-05 19:56:33 +02:00
< a href = "index.html" > < div class = "brand" > Reticulum Network Stack 0.7.4 beta documentation< / div > < / a >
2022-09-30 18:43:04 +02: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" 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 19:56:33 +02:00
< div class = "sidebar-sticky" > < a class = "sidebar-brand centered" href = "index.html" >
2022-09-30 18:43:04 +02:00
< div class = "sidebar-logo-container" >
< img class = "sidebar-logo" src = "_static/rns_logo_512.png" alt = "Logo" / >
< / div >
2024-05-05 19:56:33 +02:00
< span class = "sidebar-brand-text" > Reticulum Network Stack 0.7.4 beta documentation< / span >
2022-09-30 18:43:04 +02:00
< / a > < form class = "sidebar-search-container" method = "get" action = "search.html" role = "search" >
2023-06-29 16:52:06 +02:00
< input class = "sidebar-search" placeholder = "Search" name = "q" aria-label = "Search" >
2022-09-30 18:43:04 +02: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 class = "current" >
< 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 current current-page" > < a class = "current reference internal" href = "#" > Communications Hardware< / a > < / li >
2023-10-01 01:59:22 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "interfaces.html" > Configuring Interfaces< / a > < / li >
2022-09-30 18:43:04 +02: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 >
< / 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 >
< / div >
< label class = "toc-overlay-icon toc-content-icon" 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 >
< article role = "main" >
< section id = "communications-hardware" >
< span id = "hardware-main" > < / span > < h1 > Communications Hardware< a class = "headerlink" href = "#communications-hardware" title = "Permalink to this heading" > #< / a > < / h1 >
2022-06-22 15:19:18 +02:00
< p > One of the truly valuable aspects of Reticulum is the ability to use it over
almost any conceivable kind of communications medium. The < a class = "reference internal" href = "interfaces.html#interfaces-main" > < span class = "std std-ref" > interface types< / span > < / a >
available for configuration in Reticulum are flexible enough to cover the use
of most wired and wireless communications hardware available, from decades-old
packet radio modems to modern millimeter-wave backhaul systems.< / p >
< p > If you already have or operate some kind of communications hardware, there is a
very good chance that it will work with Reticulum out of the box. In case it does
not, it is possible to provide the necessary glue with very little effort using
for example the < a class = "reference internal" href = "interfaces.html#interfaces-pipe" > < span class = "std std-ref" > PipeInterface< / span > < / a > or the < a class = "reference internal" href = "interfaces.html#interfaces-tcpc" > < span class = "std std-ref" > TCPClientInterface< / span > < / a >
in combination with code like < a class = "reference external" href = "https://github.com/simplyequipped/tcpkissserver" > TCP KISS Server< / a >
by < a class = "reference external" href = "https://github.com/simplyequipped" > simplyequipped< / a > .< / p >
< p > While this broad support and flexibility is very useful, an abundance of options
can sometimes make it difficult to know where to begin, especially when you are
starting from scratch.< / p >
2022-06-22 16:20:01 +02:00
< p > This chapter will outline a few different sensible starting paths to get
2022-06-22 15:19:18 +02:00
real-world functional wireless communications up and running with minimal cost
2022-06-22 16:20:01 +02:00
and effort. Two fundamental devices categories will be covered, < em > RNodes< / em > and
2023-09-18 12:36:08 +02:00
< em > WiFi-based radios< / em > . Additionally, other common options will be briefly described.< / p >
< p > Knowing how to employ just a few different types of hardware will make it possible
to build a wide range of useful networks with little effort.< / p >
< section id = "combining-hardware-types" >
< h2 > Combining Hardware Types< a class = "headerlink" href = "#combining-hardware-types" title = "Permalink to this heading" > #< / a > < / h2 >
< p > It is useful to combine different link and hardware types when designing and
building a network. One useful design pattern is to employ high-capacity point-to-point
links based on WiFi or millimeter-wave radios (with high-gain directional antennas)
for the network backbone, and using LoRa-based RNodes for covering large areas with
connectivity for client devices.< / p >
< / section >
2022-09-30 00:02:15 +02:00
< section id = "rnode" >
2022-09-30 18:43:04 +02:00
< span id = "rnode-main" > < / span > < h2 > RNode< a class = "headerlink" href = "#rnode" title = "Permalink to this heading" > #< / a > < / h2 >
2022-06-22 15:19:18 +02:00
< p > Reliable and general-purpose long-range digital radio transceiver systems are
commonly either very expensive, difficult to set up and operate, hard to source,
power-hungry, or all of the above at the same time. In an attempt to alleviate
this situation, the transceiver system < em > RNode< / em > was designed. It is important to
note that RNode is not one specific device, from one particular vendor, but
2022-06-22 16:34:43 +02:00
< em > an open plaform< / em > that anyone can use to build interoperable digital transceivers
suited to their needs and particular situations.< / p >
2022-06-22 15:19:18 +02:00
< p > An RNode is a general purpose, interoperable, low-power and long-range, reliable,
open and flexible radio communications device. Depending on its components, it can
operate on many different frequency bands, and use many different modulation
schemes, but most commonly, and for the purposes of this chapter, we will limit
the discussion to RNodes using < em > LoRa< / em > modulation in common ISM bands.< / p >
2022-06-22 16:34:43 +02:00
< p > < strong > Avoid Confusion!< / strong > RNodes can use LoRa as a < em > physical-layer modulation< / em > , but it
2022-06-22 15:19:18 +02:00
does not use, and has nothing to do with the < em > LoRaWAN< / em > protocol and standard, commonly
2022-06-22 16:34:43 +02:00
used for centrally controlled IoT devices. RNodes use < em > raw LoRa modulation< / em > , without
2022-08-25 11:00:30 +02:00
any additional protocol overhead. All high-level protocol functionality is handled
2022-06-22 16:34:43 +02:00
directly by Reticulum.< / p >
2022-09-30 00:02:15 +02:00
< section id = "creating-rnodes" >
2022-09-30 18:43:04 +02:00
< span id = "rnode-creating" > < / span > < h3 > Creating RNodes< a class = "headerlink" href = "#creating-rnodes" title = "Permalink to this heading" > #< / a > < / h3 >
2022-06-22 15:19:18 +02:00
< p > RNode has been designed as a system that is easy to replicate across time and
space. You can put together a functioning transceiver using commonly available
2022-06-22 16:34:43 +02:00
components, and a few open source software tools. While you can design and build RNodes
2022-06-22 15:19:18 +02:00
completely from scratch, to your exact desired specifications, this chapter
2022-06-22 16:34:43 +02:00
will explain the easiest possible approach to creating RNodes: Using common
2022-06-22 15:19:18 +02:00
LoRa development boards. This approach can be boiled down to two simple steps:< / p >
< ol class = "arabic simple" >
< li > < p > Obtain one or more supported development boards< / p > < / li >
< li > < p > Install the RNode firmware with the automated installer< / p > < / li >
< / ol >
< p > Once the firmware has been installed and provisioned by the install script, it
is ready to use with any software that supports RNodes, including Reticulum.
The device can be used with Reticulum by adding an < a class = "reference internal" href = "interfaces.html#interfaces-rnode" > < span class = "std std-ref" > RNodeInterface< / span > < / a >
to the configuration.< / p >
2022-09-30 00:02:15 +02:00
< / section >
< section id = "supported-boards" >
2022-09-30 18:43:04 +02:00
< span id = "rnode-supported" > < / span > < h3 > Supported Boards< a class = "headerlink" href = "#supported-boards" title = "Permalink to this heading" > #< / a > < / h3 >
2022-06-22 15:19:18 +02:00
< p > To create one or more RNodes, you will need to obtain supported development
boards. The following boards are supported by the auto-installer.< / p >
2022-09-30 00:02:15 +02:00
< section id = "lilygo-lora32-v2-1" >
2022-09-30 18:43:04 +02:00
< h4 > LilyGO LoRa32 v2.1< a class = "headerlink" href = "#lilygo-lora32-v2-1" title = "Permalink to this heading" > #< / a > < / h4 >
2022-06-22 15:48:45 +02:00
< a class = "reference internal image-reference" href = "_images/board_t3v21.png" > < img alt = "_images/board_t3v21.png" class = "align-center" src = "_images/board_t3v21.png" style = "width: 46%;" / > < / a >
2022-06-22 15:19:18 +02:00
< ul class = "simple" >
< li > < p > < strong > Supported Firmware Lines< / strong > v1.x & v2.x< / p > < / li >
< li > < p > < strong > Transceiver IC< / strong > Semtech SX1276< / p > < / li >
< li > < p > < strong > Device Platform< / strong > ESP32< / p > < / li >
< li > < p > < strong > Manufacturer< / strong > < a class = "reference external" href = "https://lilygo.cn" > LilyGO< / a > < / p > < / li >
< / ul >
2022-09-30 00:02:15 +02:00
< / section >
< section id = "lilygo-lora32-v2-0" >
2022-09-30 18:43:04 +02:00
< h4 > LilyGO LoRa32 v2.0< a class = "headerlink" href = "#lilygo-lora32-v2-0" title = "Permalink to this heading" > #< / a > < / h4 >
2022-06-22 15:48:45 +02:00
< a class = "reference internal image-reference" href = "_images/board_t3v20.png" > < img alt = "_images/board_t3v20.png" class = "align-center" src = "_images/board_t3v20.png" style = "width: 46%;" / > < / a >
2022-06-22 15:19:18 +02:00
< ul class = "simple" >
< li > < p > < strong > Supported Firmware Lines< / strong > v1.x & v2.x< / p > < / li >
< li > < p > < strong > Transceiver IC< / strong > Semtech SX1276< / p > < / li >
< li > < p > < strong > Device Platform< / strong > ESP32< / p > < / li >
< li > < p > < strong > Manufacturer< / strong > < a class = "reference external" href = "https://lilygo.cn" > LilyGO< / a > < / p > < / li >
< / ul >
2022-09-30 00:02:15 +02:00
< / section >
< section id = "lilygo-t-beam" >
2022-09-30 18:43:04 +02:00
< h4 > LilyGO T-Beam< a class = "headerlink" href = "#lilygo-t-beam" title = "Permalink to this heading" > #< / a > < / h4 >
2022-06-22 15:48:45 +02:00
< a class = "reference internal image-reference" href = "_images/board_tbeam.png" > < img alt = "_images/board_tbeam.png" class = "align-center" src = "_images/board_tbeam.png" style = "width: 75%;" / > < / a >
2022-06-22 15:19:18 +02:00
< ul class = "simple" >
< li > < p > < strong > Supported Firmware Lines< / strong > v1.x & v2.x< / p > < / li >
< li > < p > < strong > Transceiver IC< / strong > Semtech SX1276< / p > < / li >
< li > < p > < strong > Device Platform< / strong > ESP32< / p > < / li >
< li > < p > < strong > Manufacturer< / strong > < a class = "reference external" href = "https://lilygo.cn" > LilyGO< / a > < / p > < / li >
< / ul >
2022-09-30 00:02:15 +02:00
< / section >
< section id = "heltec-lora32-v2-0" >
2022-09-30 18:43:04 +02:00
< h4 > Heltec LoRa32 v2.0< a class = "headerlink" href = "#heltec-lora32-v2-0" title = "Permalink to this heading" > #< / a > < / h4 >
2022-06-22 15:48:45 +02:00
< a class = "reference internal image-reference" href = "_images/board_heltec32.png" > < img alt = "_images/board_heltec32.png" class = "align-center" src = "_images/board_heltec32.png" style = "width: 58%;" / > < / a >
2022-06-22 15:19:18 +02:00
< ul class = "simple" >
< li > < p > < strong > Supported Firmware Lines< / strong > v1.x & v2.x< / p > < / li >
< li > < p > < strong > Transceiver IC< / strong > Semtech SX1276< / p > < / li >
< li > < p > < strong > Device Platform< / strong > ESP32< / p > < / li >
< li > < p > < strong > Manufacturer< / strong > < a class = "reference external" href = "https://heltec.org" > Heltec Automation< / a > < / p > < / li >
< / ul >
2022-09-30 00:02:15 +02:00
< / section >
< section id = "unsigned-rnode-v2-x" >
2022-09-30 18:43:04 +02:00
< h4 > Unsigned RNode v2.x< a class = "headerlink" href = "#unsigned-rnode-v2-x" title = "Permalink to this heading" > #< / a > < / h4 >
2022-06-22 15:48:45 +02:00
< a class = "reference internal image-reference" href = "_images/board_rnodev2.png" > < img alt = "_images/board_rnodev2.png" class = "align-center" src = "_images/board_rnodev2.png" style = "width: 58%;" / > < / a >
< ul class = "simple" >
< li > < p > < strong > Supported Firmware Lines< / strong > v1.x & v2.x< / p > < / li >
< li > < p > < strong > Transceiver IC< / strong > Semtech SX1276< / p > < / li >
< li > < p > < strong > Device Platform< / strong > ESP32< / p > < / li >
< li > < p > < strong > Manufacturer< / strong > < a class = "reference external" href = "https://unsigned.io" > unsigned.io< / a > < / p > < / li >
< / ul >
2022-09-30 00:02:15 +02:00
< / section >
< section id = "unsigned-rnode-v1-x" >
2022-09-30 18:43:04 +02:00
< h4 > Unsigned RNode v1.x< a class = "headerlink" href = "#unsigned-rnode-v1-x" title = "Permalink to this heading" > #< / a > < / h4 >
2022-06-22 15:19:18 +02:00
< a class = "reference internal image-reference" href = "_images/board_rnode.png" > < img alt = "_images/board_rnode.png" class = "align-center" src = "_images/board_rnode.png" style = "width: 50%;" / > < / a >
< ul class = "simple" >
< li > < p > < strong > Supported Firmware Lines< / strong > v1.x< / p > < / li >
< li > < p > < strong > Transceiver IC< / strong > Semtech SX1276< / p > < / li >
< li > < p > < strong > Device Platform< / strong > AVR ATmega1284p< / p > < / li >
< li > < p > < strong > Manufacturer< / strong > < a class = "reference external" href = "https://unsigned.io" > unsigned.io< / a > < / p > < / li >
< / ul >
2022-09-30 00:02:15 +02:00
< / section >
< / section >
< section id = "installation" >
2022-09-30 18:43:04 +02:00
< span id = "rnode-installation" > < / span > < h3 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this heading" > #< / a > < / h3 >
2022-06-22 15:19:18 +02:00
< p > Once you have obtained compatible boards, you can install the < a class = "reference external" href = "https://github.com/markqvist/RNode_Firmware" > RNode Firmware< / a >
using the < a class = "reference external" href = "https://github.com/markqvist/rnodeconfigutil" > RNode Configuration Utility< / a > .
2022-12-20 20:57:49 +01:00
If you have installed Reticulum on your system, the < code class = "docutils literal notranslate" > < span class = "pre" > rnodeconf< / span > < / code > program will already be
available. If not, make sure that < code class = "docutils literal notranslate" > < span class = "pre" > Python3< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > pip< / span > < / code > is installed on your system, and
then install Reticulum with with < code class = "docutils literal notranslate" > < span class = "pre" > pip< / span > < / code > :< / p >
2023-01-01 18:49:13 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > pip< / span > < span class = "n" > install< / span > < span class = "n" > rns< / span >
2022-06-22 15:19:18 +02:00
< / pre > < / div >
< / div >
< p > Once installation has completed, it is time to start installing the firmware on your
devices. Run < code class = "docutils literal notranslate" > < span class = "pre" > rnodeconf< / span > < / code > in auto-install mode like so:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > rnodeconf< / span > < span class = "o" > --< / span > < span class = "n" > autoinstall< / span >
< / pre > < / div >
< / div >
< p > The utility will guide you through the installation process by asking a series of
questions about your hardware. Simply follow the guide, and the utility will
2022-12-20 20:57:49 +01:00
auto-install and configure your devices.< / p >
2022-09-30 00:02:15 +02:00
< / section >
< section id = "usage-with-reticulum" >
2022-09-30 18:43:04 +02:00
< span id = "rnode-usage" > < / span > < h3 > Usage with Reticulum< a class = "headerlink" href = "#usage-with-reticulum" title = "Permalink to this heading" > #< / a > < / h3 >
2022-06-22 15:19:18 +02:00
< p > When the devices have been installed and provisioned, you can use them with Reticulum
by adding the < a class = "reference internal" href = "interfaces.html#interfaces-rnode" > < span class = "std std-ref" > relevant interface section< / span > < / a > to the configuration
file of Reticulum. For v1.x firmwares, you will have to specify all interface parameters,
such as serial port and on-air parameters. For v2.x firmwares, you just need to specify
the Connection ID of the RNode, and Reticulum will automatically locate and connect to the
RNode, using the parameters stored in the RNode itself.< / p >
2022-09-30 00:02:15 +02:00
< / section >
< / section >
< section id = "wifi-based-hardware" >
2022-09-30 18:43:04 +02:00
< h2 > WiFi-based Hardware< a class = "headerlink" href = "#wifi-based-hardware" title = "Permalink to this heading" > #< / a > < / h2 >
2022-08-25 11:00:30 +02:00
< p > It is possible to use all kinds of both short- and long-range WiFi-based hardware
with Reticulum. Any kind of hardware that fully supports bridged Ethernet over the
2022-06-22 15:19:18 +02:00
WiFi interface will work with the < a class = "reference internal" href = "interfaces.html#interfaces-auto" > < span class = "std std-ref" > AutoInterface< / span > < / a > in Reticulum.
Most devices will behave like this by default, or allow it via configuration options.< / p >
< p > This means that you can simply configure the physical links of the WiFi based devices,
and start communicating over them using Reticulum. It is not necessary to enable any IP
infrastructure such as DHCP servers, DNS or similar, as long as at least Ethernet is
available, and packets are passed transparently over the physical WiFi-based devices.< / p >
2022-06-22 16:04:44 +02:00
< a class = "reference internal image-reference" href = "_images/radio_rblhg5.png" > < img alt = "_images/radio_rblhg5.png" src = "_images/radio_rblhg5.png" style = "width: 49%;" / > < / a >
< a class = "reference internal image-reference" href = "_images/radio_is5ac.png" > < img alt = "_images/radio_is5ac.png" src = "_images/radio_is5ac.png" style = "width: 49%;" / > < / a >
2022-06-22 15:19:18 +02:00
< p > Below is a list of example WiFi (and similar) radios that work well for high capacity
Reticulum links over long distances:< / p >
< ul class = "simple" >
< li > < p > < a class = "reference external" href = "https://store.ui.com/collections/operator-airmax-devices" > Ubiquiti airMAX radios< / a > < / p > < / li >
< li > < p > < a class = "reference external" href = "https://store.ui.com/collections/operator-ltu" > Ubiquiti LTU radios< / a > < / p > < / li >
< li > < p > < a class = "reference external" href = "https://mikrotik.com/products/group/wireless-systems" > MikroTik radios< / a > < / p > < / li >
< / ul >
< p > This list is by no means exhaustive, and only serves as a few examples of radio hardware
that is relatively cheap while providing long range and high capacity for Reticulum
networks. As in all other cases, it is also possible for Reticulum to co-exist with IP
networks running concurrently on such devices.< / p >
2022-09-30 00:02:15 +02:00
< / section >
2023-09-18 12:36:08 +02:00
< section id = "ethernet-based-hardware" >
< h2 > Ethernet-based Hardware< a class = "headerlink" href = "#ethernet-based-hardware" title = "Permalink to this heading" > #< / a > < / h2 >
< p > Reticulum can run over any kind of hardware that can provide a switched Ethernet-based
medium. This means that anything from a plain Ethernet switch, to fiber-optic systems,
to data radios with Ethernet interfaces can be used by Reticulum.< / p >
< p > The Ethernet medium does not need to have any IP infrastructure such as DHCP servers
or routing set up, but in case such infrastructure does exist, Reticulum will simply
co-exist with.< / p >
< p > To use Reticulum over Ethernet-based mediums, it is generally enough to use the included
< a class = "reference internal" href = "interfaces.html#interfaces-auto" > < span class = "std std-ref" > AutoInterface< / span > < / a > . This interface also works over any kind of
virtual networking adapter, such as < code class = "docutils literal notranslate" > < span class = "pre" > tun< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > tap< / span > < / code > devices in Linux.< / p >
< / section >
< section id = "serial-lines-devices" >
< h2 > Serial Lines & Devices< a class = "headerlink" href = "#serial-lines-devices" title = "Permalink to this heading" > #< / a > < / h2 >
< p > Using Reticulum over any kind of raw serial line is also possible with the
< a class = "reference internal" href = "interfaces.html#interfaces-serial" > < span class = "std std-ref" > SerialInterface< / span > < / a > . This interface type is also useful for
using Reticulum over communications hardware that provides a serial port interface.< / p >
< / section >
< section id = "packet-radio-modems" >
< h2 > Packet Radio Modems< a class = "headerlink" href = "#packet-radio-modems" title = "Permalink to this heading" > #< / a > < / h2 >
< p > Any packet radio modem that provides a standard KISS interface over USB, serial or TCP
can be used with Reticulum. This includes virtual software modems such as
< a class = "reference external" href = "https://github.com/xssfox/freedv-tnc" > FreeDV TNC< / a > and < a class = "reference external" href = "https://github.com/wb2osz/direwolf" > Dire Wolf< / a > .< / p >
2022-09-30 00:02:15 +02:00
< / section >
< / section >
2022-06-22 15:19:18 +02:00
2022-09-30 18:43:04 +02:00
< / article >
< / div >
< footer >
< div class = "related-pages" >
< a class = "next-page" href = "interfaces.html" >
< div class = "page-info" >
< div class = "context" >
< span > Next< / span >
< / div >
2023-10-01 01:59:22 +02:00
< div class = "title" > Configuring Interfaces< / div >
2022-09-30 18:43:04 +02:00
< / div >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< / a >
< a class = "prev-page" href = "understanding.html" >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< div class = "page-info" >
< div class = "context" >
< span > Previous< / span >
< / div >
< div class = "title" > Understanding Reticulum< / div >
< / div >
< / a >
< / div >
< div class = "bottom-of-page" >
< div class = "left-details" >
< div class = "copyright" >
2023-02-23 17:25:38 +01:00
Copyright © 2023, Mark Qvist
2022-09-30 18:43:04 +02: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 >
2022-06-22 15:19:18 +02:00
< / div >
< / div >
2022-09-30 18:43:04 +02:00
< / footer >
< / div >
< aside class = "toc-drawer" >
< div class = "toc-sticky toc-scroll" >
< div class = "toc-title-container" >
< span class = "toc-title" >
On this page
< / span >
< / div >
< div class = "toc-tree-container" >
< div class = "toc-tree" >
< ul >
2022-06-22 15:19:18 +02:00
< li > < a class = "reference internal" href = "#" > Communications Hardware< / a > < ul >
2023-09-18 12:36:08 +02:00
< li > < a class = "reference internal" href = "#combining-hardware-types" > Combining Hardware Types< / a > < / li >
2022-06-22 15:19:18 +02:00
< li > < a class = "reference internal" href = "#rnode" > RNode< / a > < ul >
< li > < a class = "reference internal" href = "#creating-rnodes" > Creating RNodes< / a > < / li >
< li > < a class = "reference internal" href = "#supported-boards" > Supported Boards< / a > < ul >
< li > < a class = "reference internal" href = "#lilygo-lora32-v2-1" > LilyGO LoRa32 v2.1< / a > < / li >
< li > < a class = "reference internal" href = "#lilygo-lora32-v2-0" > LilyGO LoRa32 v2.0< / a > < / li >
< li > < a class = "reference internal" href = "#lilygo-t-beam" > LilyGO T-Beam< / a > < / li >
< li > < a class = "reference internal" href = "#heltec-lora32-v2-0" > Heltec LoRa32 v2.0< / a > < / li >
2022-06-22 15:48:45 +02:00
< li > < a class = "reference internal" href = "#unsigned-rnode-v2-x" > Unsigned RNode v2.x< / a > < / li >
< li > < a class = "reference internal" href = "#unsigned-rnode-v1-x" > Unsigned RNode v1.x< / a > < / li >
2022-06-22 15:19:18 +02:00
< / ul >
< / li >
< li > < a class = "reference internal" href = "#installation" > Installation< / a > < / li >
< li > < a class = "reference internal" href = "#usage-with-reticulum" > Usage with Reticulum< / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#wifi-based-hardware" > WiFi-based Hardware< / a > < / li >
2023-09-18 12:36:08 +02:00
< li > < a class = "reference internal" href = "#ethernet-based-hardware" > Ethernet-based Hardware< / a > < / li >
< li > < a class = "reference internal" href = "#serial-lines-devices" > Serial Lines & Devices< / a > < / li >
< li > < a class = "reference internal" href = "#packet-radio-modems" > Packet Radio Modems< / a > < / li >
2022-06-22 15:19:18 +02:00
< / ul >
< / li >
< / ul >
2022-09-30 18:43:04 +02:00
< / div >
2022-06-22 15:19:18 +02:00
< / div >
< / div >
2022-09-30 18:43:04 +02:00
< / aside >
< / div >
2024-05-05 19:56:33 +02: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 18:43:04 +02:00
< / body >
2022-06-22 15:19:18 +02:00
< / html >
