jacob.eva/Reticulum
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Mark Qvist 2022-06-22 16:34:43 +02:00
parent 8f8da080f5
commit 2fe9dec459
5 changed files with 42 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/Reticulum Manual.pdf
View File

Binary file not shown.

27
docs/manual/_sources/hardware.rst.txt
View File

@ -24,10 +24,11 @@ starting from scratch.
This chapter will outline a few different sensible starting paths to get This chapter will outline a few different sensible starting paths to get
real-world functional wireless communications up and running with minimal cost real-world functional wireless communications up and running with minimal cost
and effort. Two fundamental devices categories will be covered, *RNodes* and and effort. Two fundamental devices categories will be covered, *RNodes* and
*WiFi-based radios*. While there are many other device categories that are *WiFi-based radios*.
useful in building Reticulum networks, knowing how to just employ these two
will make it possible to build a wide range of useful networks with little While there are many other device categories that are useful in building Reticulum
effort. networks, knowing how to employ just these two will make it possible to build
a wide range of useful networks with little effort.
.. _rnode-main: .. _rnode-main:
@ -39,8 +40,8 @@ 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 power-hungry, or all of the above at the same time. In an attempt to alleviate
this situation, the transceiver system *RNode* was designed. It is important to this situation, the transceiver system *RNode* was designed. It is important to
note that RNode is not one specific device, from one particular vendor, but note that RNode is not one specific device, from one particular vendor, but
*an open plaform* that anyone can use to build digital transceivers suited to *an open plaform* that anyone can use to build interoperable digital transceivers
their needs and particular situations. suited to their needs and particular situations.
An RNode is a general purpose, interoperable, low-power and long-range, reliable, 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 open and flexible radio communications device. Depending on its components, it can
@ -48,11 +49,11 @@ 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 schemes, but most commonly, and for the purposes of this chapter, we will limit
the discussion to RNodes using *LoRa* modulation in common ISM bands. the discussion to RNodes using *LoRa* modulation in common ISM bands.
**Avoid Confusion!** An RNode can use LoRa as a *physical-layer modulation*, but it **Avoid Confusion!** RNodes can use LoRa as a *physical-layer modulation*, but it
does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly
used for IoT devices. RNodes use *raw LoRa modulation*, without any additional used for centrally controlled IoT devices. RNodes use *raw LoRa modulation*, without
protocol overhead. All high-level protocol funcionality is handled directly by any additional protocol overhead. All high-level protocol funcionality is handled
Reticulum. directly by Reticulum.
.. _rnode-creating: .. _rnode-creating:
@ -60,9 +61,9 @@ Creating RNodes
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
RNode has been designed as a system that is easy to replicate across time and 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 space. You can put together a functioning transceiver using commonly available
components, and a few software tools. While you can design and build RNodes components, and a few open source software tools. While you can design and build RNodes
completely from scratch, to your exact desired specifications, this chapter completely from scratch, to your exact desired specifications, this chapter
will explain the easiest possible approach to creating RNodes, which is using common will explain the easiest possible approach to creating RNodes: Using common
LoRa development boards. This approach can be boiled down to two simple steps: LoRa development boards. This approach can be boiled down to two simple steps:
1. Obtain one or more supported development boards 1. Obtain one or more supported development boards
@ -237,7 +238,7 @@ networks running concurrently on such devices.
Combining Hardware Types Combining Hardware Types
======================== ========================
It is a useful tool to combine different link and hardware types when designing and 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 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) 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 for the network backbone, and using LoRa-based RNodes for covering large areas with

26
docs/manual/hardware.html
View File

@ -60,10 +60,10 @@ starting from scratch.</p>
<p>This chapter will outline a few different sensible starting paths to get <p>This chapter will outline a few different sensible starting paths to get
real-world functional wireless communications up and running with minimal cost real-world functional wireless communications up and running with minimal cost
and effort. Two fundamental devices categories will be covered, <em>RNodes</em> and and effort. Two fundamental devices categories will be covered, <em>RNodes</em> and
<em>WiFi-based radios</em>. While there are many other device categories that are <em>WiFi-based radios</em>.</p>
useful in building Reticulum networks, knowing how to just employ these two <p>While there are many other device categories that are useful in building Reticulum
will make it possible to build a wide range of useful networks with little networks, knowing how to employ just these two will make it possible to build
effort.</p> a wide range of useful networks with little effort.</p>
<div class="section" id="rnode"> <div class="section" id="rnode">
<span id="rnode-main"></span><h2>RNode<a class="headerlink" href="#rnode" title="Permalink to this headline"></a></h2> <span id="rnode-main"></span><h2>RNode<a class="headerlink" href="#rnode" title="Permalink to this headline"></a></h2>
<p>Reliable and general-purpose long-range digital radio transceiver systems are <p>Reliable and general-purpose long-range digital radio transceiver systems are
@ -71,25 +71,25 @@ 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 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 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 note that RNode is not one specific device, from one particular vendor, but
<em>an open plaform</em> that anyone can use to build digital transceivers suited to <em>an open plaform</em> that anyone can use to build interoperable digital transceivers
their needs and particular situations.</p> suited to their needs and particular situations.</p>
<p>An RNode is a general purpose, interoperable, low-power and long-range, reliable, <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 open and flexible radio communications device. Depending on its components, it can
operate on many different frequency bands, and use many different modulation 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 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> the discussion to RNodes using <em>LoRa</em> modulation in common ISM bands.</p>
<p><strong>Avoid Confusion!</strong> An RNode can use LoRa as a <em>physical-layer modulation</em>, but it <p><strong>Avoid Confusion!</strong> RNodes can use LoRa as a <em>physical-layer modulation</em>, but it
does not use, and has nothing to do with the <em>LoRaWAN</em> protocol and standard, commonly does not use, and has nothing to do with the <em>LoRaWAN</em> protocol and standard, commonly
used for IoT devices. RNodes use <em>raw LoRa modulation</em>, without any additional used for centrally controlled IoT devices. RNodes use <em>raw LoRa modulation</em>, without
protocol overhead. All high-level protocol funcionality is handled directly by any additional protocol overhead. All high-level protocol funcionality is handled
Reticulum.</p> directly by Reticulum.</p>
<div class="section" id="creating-rnodes"> <div class="section" id="creating-rnodes">
<span id="rnode-creating"></span><h3>Creating RNodes<a class="headerlink" href="#creating-rnodes" title="Permalink to this headline"></a></h3> <span id="rnode-creating"></span><h3>Creating RNodes<a class="headerlink" href="#creating-rnodes" title="Permalink to this headline"></a></h3>
<p>RNode has been designed as a system that is easy to replicate across time and <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 space. You can put together a functioning transceiver using commonly available
components, and a few software tools. While you can design and build RNodes components, and a few open source software tools. While you can design and build RNodes
completely from scratch, to your exact desired specifications, this chapter completely from scratch, to your exact desired specifications, this chapter
will explain the easiest possible approach to creating RNodes, which is using common will explain the easiest possible approach to creating RNodes: Using common
LoRa development boards. This approach can be boiled down to two simple steps:</p> LoRa development boards. This approach can be boiled down to two simple steps:</p>
<ol class="arabic simple"> <ol class="arabic simple">
<li><p>Obtain one or more supported development boards</p></li> <li><p>Obtain one or more supported development boards</p></li>
@ -228,7 +228,7 @@ networks running concurrently on such devices.</p>
</div> </div>
<div class="section" id="combining-hardware-types"> <div class="section" id="combining-hardware-types">
<h2>Combining Hardware Types<a class="headerlink" href="#combining-hardware-types" title="Permalink to this headline"></a></h2> <h2>Combining Hardware Types<a class="headerlink" href="#combining-hardware-types" title="Permalink to this headline"></a></h2>
<p>It is a useful tool to combine different link and hardware types when designing and <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 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) 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 for the network backbone, and using LoRa-based RNodes for covering large areas with

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

27
docs/source/hardware.rst
View File

@ -24,10 +24,11 @@ starting from scratch.
This chapter will outline a few different sensible starting paths to get This chapter will outline a few different sensible starting paths to get
real-world functional wireless communications up and running with minimal cost real-world functional wireless communications up and running with minimal cost
and effort. Two fundamental devices categories will be covered, *RNodes* and and effort. Two fundamental devices categories will be covered, *RNodes* and
*WiFi-based radios*. While there are many other device categories that are *WiFi-based radios*.
useful in building Reticulum networks, knowing how to just employ these two
will make it possible to build a wide range of useful networks with little While there are many other device categories that are useful in building Reticulum
effort. networks, knowing how to employ just these two will make it possible to build
a wide range of useful networks with little effort.
.. _rnode-main: .. _rnode-main:
@ -39,8 +40,8 @@ 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 power-hungry, or all of the above at the same time. In an attempt to alleviate
this situation, the transceiver system *RNode* was designed. It is important to this situation, the transceiver system *RNode* was designed. It is important to
note that RNode is not one specific device, from one particular vendor, but note that RNode is not one specific device, from one particular vendor, but
*an open plaform* that anyone can use to build digital transceivers suited to *an open plaform* that anyone can use to build interoperable digital transceivers
their needs and particular situations. suited to their needs and particular situations.
An RNode is a general purpose, interoperable, low-power and long-range, reliable, 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 open and flexible radio communications device. Depending on its components, it can
@ -48,11 +49,11 @@ 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 schemes, but most commonly, and for the purposes of this chapter, we will limit
the discussion to RNodes using *LoRa* modulation in common ISM bands. the discussion to RNodes using *LoRa* modulation in common ISM bands.
**Avoid Confusion!** An RNode can use LoRa as a *physical-layer modulation*, but it **Avoid Confusion!** RNodes can use LoRa as a *physical-layer modulation*, but it
does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly
used for IoT devices. RNodes use *raw LoRa modulation*, without any additional used for centrally controlled IoT devices. RNodes use *raw LoRa modulation*, without
protocol overhead. All high-level protocol funcionality is handled directly by any additional protocol overhead. All high-level protocol funcionality is handled
Reticulum. directly by Reticulum.
.. _rnode-creating: .. _rnode-creating:
@ -60,9 +61,9 @@ Creating RNodes
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
RNode has been designed as a system that is easy to replicate across time and 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 space. You can put together a functioning transceiver using commonly available
components, and a few software tools. While you can design and build RNodes components, and a few open source software tools. While you can design and build RNodes
completely from scratch, to your exact desired specifications, this chapter completely from scratch, to your exact desired specifications, this chapter
will explain the easiest possible approach to creating RNodes, which is using common will explain the easiest possible approach to creating RNodes: Using common
LoRa development boards. This approach can be boiled down to two simple steps: LoRa development boards. This approach can be boiled down to two simple steps:
1. Obtain one or more supported development boards 1. Obtain one or more supported development boards
@ -237,7 +238,7 @@ networks running concurrently on such devices.
Combining Hardware Types Combining Hardware Types
======================== ========================
It is a useful tool to combine different link and hardware types when designing and 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 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) 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 for the network backbone, and using LoRa-based RNodes for covering large areas with