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

Updated manual

Browse Source
This commit is contained in:
Mark Qvist 2024-10-06 10:28:26 +02:00
parent a41bce012b
commit ac09bc3567
11 changed files with 15 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/Reticulum Manual.epub
View File

Binary file not shown.

BIN
docs/Reticulum Manual.pdf
View File

Binary file not shown.

BIN
docs/manual/_images/board_heltec32.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 191 KiB

BIN
docs/manual/_images/board_rak4631.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 214 KiB

BIN
docs/manual/_images/board_rnodev2.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 562 KiB

After

Width:  |  Height:  |  Size: 124 KiB

BIN
docs/manual/_images/board_t3s3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 140 KiB

BIN
docs/manual/_images/board_tbeam_supreme.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 345 KiB

BIN
docs/manual/_images/board_tdeck.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 229 KiB

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

@ -92,7 +92,7 @@ boards. The following boards are supported by the auto-installer.
------------ ------------
.. image:: graphics/board_tbeam_supreme.webp .. image:: graphics/board_tbeam_supreme.png
:width: 75% :width: 75%
:align: center :align: center
@ -116,7 +116,7 @@ LilyGO T-Beam
------------ ------------
.. image:: graphics/board_t3s3.webp .. image:: graphics/board_t3s3.png
:width: 50% :width: 50%
:align: center :align: center
@ -128,7 +128,7 @@ LilyGO T3S3
------------ ------------
.. image:: graphics/board_rak4631.webp .. image:: graphics/board_rak4631.png
:width: 45% :width: 45%
:align: center :align: center
@ -140,7 +140,7 @@ RAK4631-based Boards
------------ ------------
.. image:: graphics/board_rnodev2.webp .. image:: graphics/board_rnodev2.png
:width: 68% :width: 68%
:align: center :align: center
@ -188,7 +188,7 @@ LilyGO LoRa32 v1.0
------------ ------------
.. image:: graphics/board_tdeck.webp .. image:: graphics/board_tdeck.png
:width: 45% :width: 45%
:align: center :align: center
@ -268,10 +268,8 @@ Usage with Reticulum
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
When the devices have been installed and provisioned, you can use them with Reticulum When the devices have been installed and provisioned, you can use them with Reticulum
by adding the :ref:`relevant interface section<interfaces-rnode>` to the configuration by adding the :ref:`relevant interface section<interfaces-rnode>` to the configuration
file of Reticulum. For v1.x firmwares, you will have to specify all interface parameters, file of Reticulum. In the configuraion you can specify all interface parameters,
such as serial port and on-air parameters. For v2.x firmwares, you just need to specify such as serial port and on-air parameters.
the Connection ID of the RNode, and Reticulum will automatically locate and connect to the
RNode, using the parameters stored in the RNode itself.
WiFi-based Hardware WiFi-based Hardware

16
docs/manual/hardware.html
View File

@ -292,7 +292,7 @@ to the configuration.</p>
<p>To create one or more RNodes, you will need to obtain supported development <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> boards. The following boards are supported by the auto-installer.</p>
<hr class="docutils" /> <hr class="docutils" />
<a class="reference internal image-reference" href="_images/board_tbeam_supreme.webp"><img alt="_images/board_tbeam_supreme.webp" class="align-center" src="_images/board_tbeam_supreme.webp" style="width: 75%;" /></a> <a class="reference internal image-reference" href="_images/board_tbeam_supreme.png"><img alt="_images/board_tbeam_supreme.png" class="align-center" src="_images/board_tbeam_supreme.png" style="width: 75%;" /></a>
<section id="lilygo-t-beam-supreme"> <section id="lilygo-t-beam-supreme">
<h4>LilyGO T-Beam Supreme<a class="headerlink" href="#lilygo-t-beam-supreme" title="Permalink to this heading">#</a></h4> <h4>LilyGO T-Beam Supreme<a class="headerlink" href="#lilygo-t-beam-supreme" title="Permalink to this heading">#</a></h4>
<ul class="simple"> <ul class="simple">
@ -311,7 +311,7 @@ boards. The following boards are supported by the auto-installer.</p>
<li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
<hr class="docutils" /> <hr class="docutils" />
<a class="reference internal image-reference" href="_images/board_t3s3.webp"><img alt="_images/board_t3s3.webp" class="align-center" src="_images/board_t3s3.webp" style="width: 50%;" /></a> <a class="reference internal image-reference" href="_images/board_t3s3.png"><img alt="_images/board_t3s3.png" class="align-center" src="_images/board_t3s3.png" style="width: 50%;" /></a>
</section> </section>
<section id="lilygo-t3s3"> <section id="lilygo-t3s3">
<h4>LilyGO T3S3<a class="headerlink" href="#lilygo-t3s3" title="Permalink to this heading">#</a></h4> <h4>LilyGO T3S3<a class="headerlink" href="#lilygo-t3s3" title="Permalink to this heading">#</a></h4>
@ -321,7 +321,7 @@ boards. The following boards are supported by the auto-installer.</p>
<li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
<hr class="docutils" /> <hr class="docutils" />
<a class="reference internal image-reference" href="_images/board_rak4631.webp"><img alt="_images/board_rak4631.webp" class="align-center" src="_images/board_rak4631.webp" style="width: 45%;" /></a> <a class="reference internal image-reference" href="_images/board_rak4631.png"><img alt="_images/board_rak4631.png" class="align-center" src="_images/board_rak4631.png" style="width: 45%;" /></a>
</section> </section>
<section id="rak4631-based-boards"> <section id="rak4631-based-boards">
<h4>RAK4631-based Boards<a class="headerlink" href="#rak4631-based-boards" title="Permalink to this heading">#</a></h4> <h4>RAK4631-based Boards<a class="headerlink" href="#rak4631-based-boards" title="Permalink to this heading">#</a></h4>
@ -331,7 +331,7 @@ boards. The following boards are supported by the auto-installer.</p>
<li><p><strong>Manufacturer</strong> <a class="reference external" href="https://www.rakwireless.com">RAK Wireless</a></p></li> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://www.rakwireless.com">RAK Wireless</a></p></li>
</ul> </ul>
<hr class="docutils" /> <hr class="docutils" />
<a class="reference internal image-reference" href="_images/board_rnodev2.webp"><img alt="_images/board_rnodev2.webp" class="align-center" src="_images/board_rnodev2.webp" style="width: 68%;" /></a> <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: 68%;" /></a>
</section> </section>
<section id="unsigned-rnode-v2-x"> <section id="unsigned-rnode-v2-x">
<h4>Unsigned RNode v2.x<a class="headerlink" href="#unsigned-rnode-v2-x" title="Permalink to this heading">#</a></h4> <h4>Unsigned RNode v2.x<a class="headerlink" href="#unsigned-rnode-v2-x" title="Permalink to this heading">#</a></h4>
@ -371,7 +371,7 @@ boards. The following boards are supported by the auto-installer.</p>
<li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
<hr class="docutils" /> <hr class="docutils" />
<a class="reference internal image-reference" href="_images/board_tdeck.webp"><img alt="_images/board_tdeck.webp" class="align-center" src="_images/board_tdeck.webp" style="width: 45%;" /></a> <a class="reference internal image-reference" href="_images/board_tdeck.png"><img alt="_images/board_tdeck.png" class="align-center" src="_images/board_tdeck.png" style="width: 45%;" /></a>
</section> </section>
<section id="lilygo-t-deck"> <section id="lilygo-t-deck">
<h4>LilyGO T-Deck<a class="headerlink" href="#lilygo-t-deck" title="Permalink to this heading">#</a></h4> <h4>LilyGO T-Deck<a class="headerlink" href="#lilygo-t-deck" title="Permalink to this heading">#</a></h4>
@ -436,10 +436,8 @@ auto-install and configure your devices.</p>
<span id="rnode-usage"></span><h3>Usage with Reticulum<a class="headerlink" href="#usage-with-reticulum" title="Permalink to this heading">#</a></h3> <span id="rnode-usage"></span><h3>Usage with Reticulum<a class="headerlink" href="#usage-with-reticulum" title="Permalink to this heading">#</a></h3>
<p>When the devices have been installed and provisioned, you can use them with Reticulum <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 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, file of Reticulum. In the configuraion you can specify all interface parameters,
such as serial port and on-air parameters. For v2.x firmwares, you just need to specify such as serial port and on-air parameters.</p>
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>
</section> </section>
</section> </section>
<section id="wifi-based-hardware"> <section id="wifi-based-hardware">

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long