William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-22 21:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Mark Qvist 2022-04-07 20:21:15 +02:00
parent fc83c5b082
commit 4e1cdc638f
7 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/manual/_sources/understanding.rst.txt
View File

@ -42,9 +42,9 @@ Since Reticulum is completely medium agnostic, this could be whatever is best su
In some cases, this might be 1200 baud packet radio links over VHF frequencies, in other cases it might In some cases, this might be 1200 baud packet radio links over VHF frequencies, in other cases it might
be a microwave network using off-the-shelf radios. At the time of release of this document, the be a microwave network using off-the-shelf radios. At the time of release of this document, the
recommended setup for development and testing is using LoRa radio modules with an open source firmware recommended setup for development and testing is using LoRa radio modules with an open source firmware
(see the section :ref:`Reference System Setup<understanding-referencesystem>`), connected to a small (see the section :ref:`Reference Setup<understanding-referencesystem>`), connected to a small
computer like a Raspberry Pi. As an example, the default reference setup provides a channel capacity computer like a Raspberry Pi. As an example, the default reference setup provides a channel capacity
of 5.4 Kbps, and a usable direct node-to-node range of around 15 kilometers (extendable by using multiple hops). of 3.1 Kbps, and a usable direct node-to-node range of around 15 kilometers (extendable by using multiple hops).
.. _understanding-goals: .. _understanding-goals:
@ -334,7 +334,7 @@ If it is a *Transport Node*, it should be given the configuration directive ``en
The Announce Mechanism in Detail The Announce Mechanism in Detail
-------------------------------- --------------------------------
When an *announce* is transmitted by a node, it will be forwarded by any node receiving it, but When an *announce* is transmitted by from a Reticulum instance, it will be forwarded by any transport node receiving it, but
according to some specific rules: according to some specific rules:

6
docs/manual/_sources/using.rst.txt
View File

@ -177,8 +177,8 @@ These changes will be detailed here.
Fixed Serial Port Names Fixed Serial Port Names
======================= =======================
On a Reticulum node with several serial port based interfaces, it can be On a Reticulum instance with several serial port based interfaces, it can be
beneficial to use the fixed name device nodes for the serial ports, instead beneficial to use the fixed device names for the serial ports, instead
of the dynamically allocated shorthands such as ``/dev/ttyUSB0``. Under most of the dynamically allocated shorthands such as ``/dev/ttyUSB0``. Under most
Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes
can be found under ``/dev/serial/by-id``. can be found under ``/dev/serial/by-id``.
@ -203,7 +203,7 @@ Here is an example of a packet radio TNC configured as such:
slottime = 20 slottime = 20
Using this methodology avoids potential naming mix-ups where physical devices Using this methodology avoids potential naming mix-ups where physical devices
might be plugged and unplugged in different orders, or when node name might be plugged and unplugged in different orders, or when device name
assignment varies from one boot to another. assignment varies from one boot to another.
.. _using-systemd: .. _using-systemd:

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

6
docs/manual/understanding.html
View File

@ -73,9 +73,9 @@ traffic, and censor or persecute unwanted actors.</p>
In some cases, this might be 1200 baud packet radio links over VHF frequencies, in other cases it might In some cases, this might be 1200 baud packet radio links over VHF frequencies, in other cases it might
be a microwave network using off-the-shelf radios. At the time of release of this document, the be a microwave network using off-the-shelf radios. At the time of release of this document, the
recommended setup for development and testing is using LoRa radio modules with an open source firmware recommended setup for development and testing is using LoRa radio modules with an open source firmware
(see the section <a class="reference internal" href="#understanding-referencesystem"><span class="std std-ref">Reference System Setup</span></a>), connected to a small (see the section <a class="reference internal" href="#understanding-referencesystem"><span class="std std-ref">Reference Setup</span></a>), connected to a small
computer like a Raspberry Pi. As an example, the default reference setup provides a channel capacity computer like a Raspberry Pi. As an example, the default reference setup provides a channel capacity
of 5.4 Kbps, and a usable direct node-to-node range of around 15 kilometers (extendable by using multiple hops).</p> of 3.1 Kbps, and a usable direct node-to-node range of around 15 kilometers (extendable by using multiple hops).</p>
</div> </div>
<div class="section" id="goals"> <div class="section" id="goals">
<span id="understanding-goals"></span><h2>Goals<a class="headerlink" href="#goals" title="Permalink to this headline"></a></h2> <span id="understanding-goals"></span><h2>Goals<a class="headerlink" href="#goals" title="Permalink to this headline"></a></h2>
@ -355,7 +355,7 @@ is the default setting.</p>
</div> </div>
<div class="section" id="the-announce-mechanism-in-detail"> <div class="section" id="the-announce-mechanism-in-detail">
<span id="understanding-announce"></span><h3>The Announce Mechanism in Detail<a class="headerlink" href="#the-announce-mechanism-in-detail" title="Permalink to this headline"></a></h3> <span id="understanding-announce"></span><h3>The Announce Mechanism in Detail<a class="headerlink" href="#the-announce-mechanism-in-detail" title="Permalink to this headline"></a></h3>
<p>When an <em>announce</em> is transmitted by a node, it will be forwarded by any node receiving it, but <p>When an <em>announce</em> is transmitted by from a Reticulum instance, it will be forwarded by any transport node receiving it, but
according to some specific rules:</p> according to some specific rules:</p>
<ul> <ul>
<li><div class="line-block"> <li><div class="line-block">

6
docs/manual/using.html
View File

@ -192,8 +192,8 @@ few system configuration changes that can make this easier to administrate.
These changes will be detailed here.</p> These changes will be detailed here.</p>
<div class="section" id="fixed-serial-port-names"> <div class="section" id="fixed-serial-port-names">
<h3>Fixed Serial Port Names<a class="headerlink" href="#fixed-serial-port-names" title="Permalink to this headline"></a></h3> <h3>Fixed Serial Port Names<a class="headerlink" href="#fixed-serial-port-names" title="Permalink to this headline"></a></h3>
<p>On a Reticulum node with several serial port based interfaces, it can be <p>On a Reticulum instance with several serial port based interfaces, it can be
beneficial to use the fixed name device nodes for the serial ports, instead beneficial to use the fixed device names for the serial ports, instead
of the dynamically allocated shorthands such as <code class="docutils literal notranslate"><span class="pre">/dev/ttyUSB0</span></code>. Under most of the dynamically allocated shorthands such as <code class="docutils literal notranslate"><span class="pre">/dev/ttyUSB0</span></code>. Under most
Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes
can be found under <code class="docutils literal notranslate"><span class="pre">/dev/serial/by-id</span></code>.</p> can be found under <code class="docutils literal notranslate"><span class="pre">/dev/serial/by-id</span></code>.</p>
@ -215,7 +215,7 @@ Here is an example of a packet radio TNC configured as such:</p>
</pre></div> </pre></div>
</div> </div>
<p>Using this methodology avoids potential naming mix-ups where physical devices <p>Using this methodology avoids potential naming mix-ups where physical devices
might be plugged and unplugged in different orders, or when node name might be plugged and unplugged in different orders, or when device name
assignment varies from one boot to another.</p> assignment varies from one boot to another.</p>
</div> </div>
<div class="section" id="reticulum-as-a-system-service"> <div class="section" id="reticulum-as-a-system-service">

6
docs/source/understanding.rst
View File

@ -42,9 +42,9 @@ Since Reticulum is completely medium agnostic, this could be whatever is best su
In some cases, this might be 1200 baud packet radio links over VHF frequencies, in other cases it might In some cases, this might be 1200 baud packet radio links over VHF frequencies, in other cases it might
be a microwave network using off-the-shelf radios. At the time of release of this document, the be a microwave network using off-the-shelf radios. At the time of release of this document, the
recommended setup for development and testing is using LoRa radio modules with an open source firmware recommended setup for development and testing is using LoRa radio modules with an open source firmware
(see the section :ref:`Reference System Setup<understanding-referencesystem>`), connected to a small (see the section :ref:`Reference Setup<understanding-referencesystem>`), connected to a small
computer like a Raspberry Pi. As an example, the default reference setup provides a channel capacity computer like a Raspberry Pi. As an example, the default reference setup provides a channel capacity
of 5.4 Kbps, and a usable direct node-to-node range of around 15 kilometers (extendable by using multiple hops). of 3.1 Kbps, and a usable direct node-to-node range of around 15 kilometers (extendable by using multiple hops).
.. _understanding-goals: .. _understanding-goals:
@ -334,7 +334,7 @@ If it is a *Transport Node*, it should be given the configuration directive ``en
The Announce Mechanism in Detail The Announce Mechanism in Detail
-------------------------------- --------------------------------
When an *announce* is transmitted by a node, it will be forwarded by any node receiving it, but When an *announce* is transmitted by from a Reticulum instance, it will be forwarded by any transport node receiving it, but
according to some specific rules: according to some specific rules:

6
docs/source/using.rst
View File

@ -177,8 +177,8 @@ These changes will be detailed here.
Fixed Serial Port Names Fixed Serial Port Names
======================= =======================
On a Reticulum node with several serial port based interfaces, it can be On a Reticulum instance with several serial port based interfaces, it can be
beneficial to use the fixed name device nodes for the serial ports, instead beneficial to use the fixed device names for the serial ports, instead
of the dynamically allocated shorthands such as ``/dev/ttyUSB0``. Under most of the dynamically allocated shorthands such as ``/dev/ttyUSB0``. Under most
Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes
can be found under ``/dev/serial/by-id``. can be found under ``/dev/serial/by-id``.
@ -203,7 +203,7 @@ Here is an example of a packet radio TNC configured as such:
slottime = 20 slottime = 20
Using this methodology avoids potential naming mix-ups where physical devices Using this methodology avoids potential naming mix-ups where physical devices
might be plugged and unplugged in different orders, or when node name might be plugged and unplugged in different orders, or when device name
assignment varies from one boot to another. assignment varies from one boot to another.
.. _using-systemd: .. _using-systemd: