Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2025-05-03 07:05:06 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated hardware section of docs

Browse source
This commit is contained in:
Mark Qvist 2025-04-10 00:16:01 +02:00
parent f4d13986af
commit cb69085280
16 changed files with 160 additions and 85 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/manual/_images/board_opencomxl.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/manual/_images/board_t114.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 87 KiB

BIN
docs/manual/_images/board_techo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 68 KiB

73
docs/manual/_sources/hardware.rst.txt
View file

@ -88,7 +88,8 @@ to the configuration.
Supported Boards and Devices Supported Boards and Devices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To create one or more RNodes, you will need to obtain supported development To create one or more RNodes, you will need to obtain supported development
boards. The following boards are supported by the auto-installer. boards or completed devices. The following boards and devices are supported
by the auto-installer.
------------ ------------
@ -98,7 +99,7 @@ boards. The following boards are supported by the auto-installer.
LilyGO T-Beam Supreme LilyGO T-Beam Supreme
""""""""""""" """""""""""""
- **Transceiver IC** Semtech SX1262, SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -110,7 +111,7 @@ LilyGO T-Beam Supreme
LilyGO T-Beam LilyGO T-Beam
""""""""""""" """""""""""""
- **Transceiver IC** Semtech SX1262, SX1268, SX1276 and SX1278 - **Transceiver IC** Semtech SX1262, SX1268, SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -122,7 +123,7 @@ LilyGO T-Beam
LilyGO T3S3 LilyGO T3S3
""""""""""" """""""""""
- **Transceiver IC** Semtech SX1262, SX1268, SX1276 and SX1278 - **Transceiver IC** Semtech SX1262, SX1268, SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -134,19 +135,31 @@ LilyGO T3S3
RAK4631-based Boards RAK4631-based Boards
"""""""""""""""""""" """"""""""""""""""""
- **Transceiver IC** Semtech SX1262, SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** nRF52 - **Device Platform** nRF52
- **Manufacturer** `RAK Wireless <https://www.rakwireless.com>`_ - **Manufacturer** `RAK Wireless <https://www.rakwireless.com>`_
------------ ------------
.. image:: graphics/board_opencomxl.png
:width: 45%
:align: center
OpenCom XL
""""""""""""""""""""
- **Transceiver ICs** Semtech SX1262 and SX1280 (dual transceiver)
- **Device Platform** nRF52
- **Manufacturer** `RAK Wireless <https://liberatedsystems.co.uk/>`_
------------
.. image:: graphics/board_rnodev2.png .. image:: graphics/board_rnodev2.png
:width: 68% :width: 68%
:align: center :align: center
Unsigned RNode v2.x Unsigned RNode v2.x
""""""""""""""""""" """""""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `unsigned.io <https://unsigned.io>`_ - **Manufacturer** `unsigned.io <https://unsigned.io>`_
@ -158,7 +171,7 @@ Unsigned RNode v2.x
LilyGO LoRa32 v2.1 LilyGO LoRa32 v2.1
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -170,7 +183,7 @@ LilyGO LoRa32 v2.1
LilyGO LoRa32 v2.0 LilyGO LoRa32 v2.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -182,7 +195,7 @@ LilyGO LoRa32 v2.0
LilyGO LoRa32 v1.0 LilyGO LoRa32 v1.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -194,19 +207,43 @@ LilyGO LoRa32 v1.0
LilyGO T-Deck LilyGO T-Deck
""""""""""""" """""""""""""
- **Transceiver IC** Semtech SX1262, SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
------------ ------------
.. image:: graphics/board_techo.png
:width: 45%
:align: center
LilyGO T-Echo
"""""""""""""
- **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** nRF52
- **Manufacturer** `LilyGO <https://lilygo.cn>`_
------------
.. image:: graphics/board_t114.png
:width: 58%
:align: center
Heltec T114
"""""""""""
- **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32
- **Manufacturer** `Heltec Automation <https://heltec.org>`_
------------
.. image:: graphics/board_heltec32v30.png .. image:: graphics/board_heltec32v30.png
:width: 58% :width: 58%
:align: center :align: center
Heltec LoRa32 v3.0 Heltec LoRa32 v3.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1262 and SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `Heltec Automation <https://heltec.org>`_ - **Manufacturer** `Heltec Automation <https://heltec.org>`_
@ -218,24 +255,12 @@ Heltec LoRa32 v3.0
Heltec LoRa32 v2.0 Heltec LoRa32 v2.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `Heltec Automation <https://heltec.org>`_ - **Manufacturer** `Heltec Automation <https://heltec.org>`_
------------ ------------
.. image:: graphics/board_rnode.png
:width: 50%
:align: center
Unsigned RNode v1.x
"""""""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278
- **Device Platform** AVR ATmega1284p
- **Manufacturer** `unsigned.io <https://unsigned.io>`_
------------
.. _rnode-installation: .. _rnode-installation:
Installation Installation

8
docs/manual/_sources/interfaces.rst.txt
View file

@ -34,14 +34,14 @@ example for basic interface code to build upon.
Auto Interface Auto Interface
============== ==============
The Auto Interface enables communication with other discoverable Reticulum The ``AutoInterface`` enables communication with other discoverable Reticulum
nodes over autoconfigured IPv6 and UDP. Even though it uses IPv6 for peer nodes over any kind of local Ethernet or WiFi-based medium. Even though it uses IPv6 for peer
discovery, and UDP for packet transport, it **does not** need any functional IP discovery, and UDP for packet transport, it **does not** need any functional IP
infrastructure like routers or DHCP servers, on your physical network. infrastructure like routers or DHCP servers, on your physical network.
As long as there is at least some sort of switching medium present between peers (a As long as there is at least some sort of switching medium present between peers (a
wired switch, a hub, a WiFi access point or similar), it will work without wired switch, a hub, a WiFi access point or similar, or simply two devices connected
any configuration, setup or intermediary devices. directly by Ethernet cable), it will work without any configuration, setup or intermediary devices.
For ``AutoInterface`` peer discovery to work, it's also required that link-local For ``AutoInterface`` peer discovery to work, it's also required that link-local
IPv6 support is available on your system, which it should be by default in all IPv6 support is available on your system, which it should be by default in all

73
docs/manual/hardware.html
View file

@ -290,14 +290,15 @@ to the configuration.</p>
<section id="supported-boards-and-devices"> <section id="supported-boards-and-devices">
<span id="rnode-supported"></span><h3>Supported Boards and Devices<a class="headerlink" href="#supported-boards-and-devices" title="Permalink to this heading">#</a></h3> <span id="rnode-supported"></span><h3>Supported Boards and Devices<a class="headerlink" href="#supported-boards-and-devices" title="Permalink to this heading">#</a></h3>
<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 or completed devices. The following boards and devices are supported
by the auto-installer.</p>
<hr class="docutils" /> <hr class="docutils" />
<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 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> </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">
<li><p><strong>Transceiver IC</strong> Semtech SX1262, SX1268</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1262 or SX1268</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
@ -308,7 +309,7 @@ boards. The following boards are supported by the auto-installer.</p>
<section id="lilygo-t-beam"> <section id="lilygo-t-beam">
<h4>LilyGO T-Beam<a class="headerlink" href="#lilygo-t-beam" title="Permalink to this heading">#</a></h4> <h4>LilyGO T-Beam<a class="headerlink" href="#lilygo-t-beam" title="Permalink to this heading">#</a></h4>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1262, SX1268, SX1276 and SX1278</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1262, SX1268, SX1276 or SX1278</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
@ -319,7 +320,7 @@ boards. The following boards are supported by the auto-installer.</p>
<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>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1262, SX1268, SX1276 and SX1278</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1262, SX1268, SX1276 or SX1278</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
@ -330,18 +331,29 @@ boards. The following boards are supported by the auto-installer.</p>
<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>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1262, SX1268</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1262 or SX1268</p></li>
<li><p><strong>Device Platform</strong> nRF52</p></li> <li><p><strong>Device Platform</strong> nRF52</p></li>
<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_opencomxl.png"><img alt="_images/board_opencomxl.png" class="align-center" src="_images/board_opencomxl.png" style="width: 45%;" />
</a>
</section>
<section id="opencom-xl">
<h4>OpenCom XL<a class="headerlink" href="#opencom-xl" title="Permalink to this heading">#</a></h4>
<ul class="simple">
<li><p><strong>Transceiver ICs</strong> Semtech SX1262 and SX1280 (dual transceiver)</p></li>
<li><p><strong>Device Platform</strong> nRF52</p></li>
<li><p><strong>Manufacturer</strong> <a class="reference external" href="https://liberatedsystems.co.uk/">RAK Wireless</a></p></li>
</ul>
<hr class="docutils" />
<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 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> </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>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1276 and SX1278</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1276 or SX1278</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://unsigned.io">unsigned.io</a></p></li>
</ul> </ul>
@ -352,7 +364,7 @@ boards. The following boards are supported by the auto-installer.</p>
<section id="lilygo-lora32-v2-1"> <section id="lilygo-lora32-v2-1">
<h4>LilyGO LoRa32 v2.1<a class="headerlink" href="#lilygo-lora32-v2-1" title="Permalink to this heading">#</a></h4> <h4>LilyGO LoRa32 v2.1<a class="headerlink" href="#lilygo-lora32-v2-1" title="Permalink to this heading">#</a></h4>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1276 and SX1278</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1276 or SX1278</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
@ -363,7 +375,7 @@ boards. The following boards are supported by the auto-installer.</p>
<section id="lilygo-lora32-v2-0"> <section id="lilygo-lora32-v2-0">
<h4>LilyGO LoRa32 v2.0<a class="headerlink" href="#lilygo-lora32-v2-0" title="Permalink to this heading">#</a></h4> <h4>LilyGO LoRa32 v2.0<a class="headerlink" href="#lilygo-lora32-v2-0" title="Permalink to this heading">#</a></h4>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1276 and SX1278</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1276 or SX1278</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
@ -374,7 +386,7 @@ boards. The following boards are supported by the auto-installer.</p>
<section id="lilygo-lora32-v1-0"> <section id="lilygo-lora32-v1-0">
<h4>LilyGO LoRa32 v1.0<a class="headerlink" href="#lilygo-lora32-v1-0" title="Permalink to this heading">#</a></h4> <h4>LilyGO LoRa32 v1.0<a class="headerlink" href="#lilygo-lora32-v1-0" title="Permalink to this heading">#</a></h4>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1276 and SX1278</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1276 or SX1278</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul> </ul>
@ -385,18 +397,40 @@ boards. The following boards are supported by the auto-installer.</p>
<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>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1262, SX1268</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1262 or SX1268</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <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_techo.png"><img alt="_images/board_techo.png" class="align-center" src="_images/board_techo.png" style="width: 45%;" />
</a>
</section>
<section id="lilygo-t-echo">
<h4>LilyGO T-Echo<a class="headerlink" href="#lilygo-t-echo" title="Permalink to this heading">#</a></h4>
<ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1262 or SX1268</p></li>
<li><p><strong>Device Platform</strong> nRF52</p></li>
<li><p><strong>Manufacturer</strong> <a class="reference external" href="https://lilygo.cn">LilyGO</a></p></li>
</ul>
<hr class="docutils" />
<a class="reference internal image-reference" href="_images/board_t114.png"><img alt="_images/board_t114.png" class="align-center" src="_images/board_t114.png" style="width: 58%;" />
</a>
</section>
<section id="heltec-t114">
<h4>Heltec T114<a class="headerlink" href="#heltec-t114" title="Permalink to this heading">#</a></h4>
<ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1262 or SX1268</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>
<hr class="docutils" />
<a class="reference internal image-reference" href="_images/board_heltec32v30.png"><img alt="_images/board_heltec32v30.png" class="align-center" src="_images/board_heltec32v30.png" style="width: 58%;" /> <a class="reference internal image-reference" href="_images/board_heltec32v30.png"><img alt="_images/board_heltec32v30.png" class="align-center" src="_images/board_heltec32v30.png" style="width: 58%;" />
</a> </a>
</section> </section>
<section id="heltec-lora32-v3-0"> <section id="heltec-lora32-v3-0">
<h4>Heltec LoRa32 v3.0<a class="headerlink" href="#heltec-lora32-v3-0" title="Permalink to this heading">#</a></h4> <h4>Heltec LoRa32 v3.0<a class="headerlink" href="#heltec-lora32-v3-0" title="Permalink to this heading">#</a></h4>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1262 and SX1268</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1262 or SX1268</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://heltec.org">Heltec Automation</a></p></li>
</ul> </ul>
@ -407,22 +441,11 @@ boards. The following boards are supported by the auto-installer.</p>
<section id="heltec-lora32-v2-0"> <section id="heltec-lora32-v2-0">
<h4>Heltec LoRa32 v2.0<a class="headerlink" href="#heltec-lora32-v2-0" title="Permalink to this heading">#</a></h4> <h4>Heltec LoRa32 v2.0<a class="headerlink" href="#heltec-lora32-v2-0" title="Permalink to this heading">#</a></h4>
<ul class="simple"> <ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1276 and SX1278</p></li> <li><p><strong>Transceiver IC</strong> Semtech SX1276 or SX1278</p></li>
<li><p><strong>Device Platform</strong> ESP32</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> <li><p><strong>Manufacturer</strong> <a class="reference external" href="https://heltec.org">Heltec Automation</a></p></li>
</ul> </ul>
<hr class="docutils" /> <hr class="docutils" />
<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>
</section>
<section id="unsigned-rnode-v1-x">
<h4>Unsigned RNode v1.x<a class="headerlink" href="#unsigned-rnode-v1-x" title="Permalink to this heading">#</a></h4>
<ul class="simple">
<li><p><strong>Transceiver IC</strong> Semtech SX1276 and SX1278</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>
<hr class="docutils" />
</section> </section>
</section> </section>
<section id="installation"> <section id="installation">
@ -569,14 +592,16 @@ can be used with Reticulum. This includes virtual software modems such as
<li><a class="reference internal" href="#lilygo-t-beam">LilyGO T-Beam</a></li> <li><a class="reference internal" href="#lilygo-t-beam">LilyGO T-Beam</a></li>
<li><a class="reference internal" href="#lilygo-t3s3">LilyGO T3S3</a></li> <li><a class="reference internal" href="#lilygo-t3s3">LilyGO T3S3</a></li>
<li><a class="reference internal" href="#rak4631-based-boards">RAK4631-based Boards</a></li> <li><a class="reference internal" href="#rak4631-based-boards">RAK4631-based Boards</a></li>
<li><a class="reference internal" href="#opencom-xl">OpenCom XL</a></li>
<li><a class="reference internal" href="#unsigned-rnode-v2-x">Unsigned RNode v2.x</a></li> <li><a class="reference internal" href="#unsigned-rnode-v2-x">Unsigned RNode v2.x</a></li>
<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-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-lora32-v2-0">LilyGO LoRa32 v2.0</a></li>
<li><a class="reference internal" href="#lilygo-lora32-v1-0">LilyGO LoRa32 v1.0</a></li> <li><a class="reference internal" href="#lilygo-lora32-v1-0">LilyGO LoRa32 v1.0</a></li>
<li><a class="reference internal" href="#lilygo-t-deck">LilyGO T-Deck</a></li> <li><a class="reference internal" href="#lilygo-t-deck">LilyGO T-Deck</a></li>
<li><a class="reference internal" href="#lilygo-t-echo">LilyGO T-Echo</a></li>
<li><a class="reference internal" href="#heltec-t114">Heltec T114</a></li>
<li><a class="reference internal" href="#heltec-lora32-v3-0">Heltec LoRa32 v3.0</a></li> <li><a class="reference internal" href="#heltec-lora32-v3-0">Heltec LoRa32 v3.0</a></li>
<li><a class="reference internal" href="#heltec-lora32-v2-0">Heltec LoRa32 v2.0</a></li> <li><a class="reference internal" href="#heltec-lora32-v2-0">Heltec LoRa32 v2.0</a></li>
<li><a class="reference internal" href="#unsigned-rnode-v1-x">Unsigned RNode v1.x</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#installation">Installation</a></li> <li><a class="reference internal" href="#installation">Installation</a></li>

8
docs/manual/interfaces.html
View file

@ -242,13 +242,13 @@ example for basic interface code to build upon.</p>
</section> </section>
<section id="auto-interface"> <section id="auto-interface">
<span id="interfaces-auto"></span><h2>Auto Interface<a class="headerlink" href="#auto-interface" title="Permalink to this heading">#</a></h2> <span id="interfaces-auto"></span><h2>Auto Interface<a class="headerlink" href="#auto-interface" title="Permalink to this heading">#</a></h2>
<p>The Auto Interface enables communication with other discoverable Reticulum <p>The <code class="docutils literal notranslate"><span class="pre">AutoInterface</span></code> enables communication with other discoverable Reticulum
nodes over autoconfigured IPv6 and UDP. Even though it uses IPv6 for peer nodes over any kind of local Ethernet or WiFi-based medium. Even though it uses IPv6 for peer
discovery, and UDP for packet transport, it <strong>does not</strong> need any functional IP discovery, and UDP for packet transport, it <strong>does not</strong> need any functional IP
infrastructure like routers or DHCP servers, on your physical network.</p> infrastructure like routers or DHCP servers, on your physical network.</p>
<p>As long as there is at least some sort of switching medium present between peers (a <p>As long as there is at least some sort of switching medium present between peers (a
wired switch, a hub, a WiFi access point or similar), it will work without wired switch, a hub, a WiFi access point or similar, or simply two devices connected
any configuration, setup or intermediary devices.</p> directly by Ethernet cable), it will work without any configuration, setup or intermediary devices.</p>
<p>For <code class="docutils literal notranslate"><span class="pre">AutoInterface</span></code> peer discovery to work, it’s also required that link-local <p>For <code class="docutils literal notranslate"><span class="pre">AutoInterface</span></code> peer discovery to work, it’s also required that link-local
IPv6 support is available on your system, which it should be by default in all IPv6 support is available on your system, which it should be by default in all
current operating systems, both desktop and mobile.</p> current operating systems, both desktop and mobile.</p>

2
docs/manual/searchindex.js
View file

File diff suppressed because one or more lines are too long

BIN
docs/source/graphics/board_opencomxl.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/source/graphics/board_opencomxl.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
docs/source/graphics/board_t114.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 87 KiB

BIN
docs/source/graphics/board_t114.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
docs/source/graphics/board_techo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 68 KiB

BIN
docs/source/graphics/board_techo.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8 KiB

73
docs/source/hardware.rst
View file

@ -88,7 +88,8 @@ to the configuration.
Supported Boards and Devices Supported Boards and Devices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To create one or more RNodes, you will need to obtain supported development To create one or more RNodes, you will need to obtain supported development
boards. The following boards are supported by the auto-installer. boards or completed devices. The following boards and devices are supported
by the auto-installer.
------------ ------------
@ -98,7 +99,7 @@ boards. The following boards are supported by the auto-installer.
LilyGO T-Beam Supreme LilyGO T-Beam Supreme
""""""""""""" """""""""""""
- **Transceiver IC** Semtech SX1262, SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -110,7 +111,7 @@ LilyGO T-Beam Supreme
LilyGO T-Beam LilyGO T-Beam
""""""""""""" """""""""""""
- **Transceiver IC** Semtech SX1262, SX1268, SX1276 and SX1278 - **Transceiver IC** Semtech SX1262, SX1268, SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -122,7 +123,7 @@ LilyGO T-Beam
LilyGO T3S3 LilyGO T3S3
""""""""""" """""""""""
- **Transceiver IC** Semtech SX1262, SX1268, SX1276 and SX1278 - **Transceiver IC** Semtech SX1262, SX1268, SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -134,19 +135,31 @@ LilyGO T3S3
RAK4631-based Boards RAK4631-based Boards
"""""""""""""""""""" """"""""""""""""""""
- **Transceiver IC** Semtech SX1262, SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** nRF52 - **Device Platform** nRF52
- **Manufacturer** `RAK Wireless <https://www.rakwireless.com>`_ - **Manufacturer** `RAK Wireless <https://www.rakwireless.com>`_
------------ ------------
.. image:: graphics/board_opencomxl.png
:width: 45%
:align: center
OpenCom XL
""""""""""""""""""""
- **Transceiver ICs** Semtech SX1262 and SX1280 (dual transceiver)
- **Device Platform** nRF52
- **Manufacturer** `RAK Wireless <https://liberatedsystems.co.uk/>`_
------------
.. image:: graphics/board_rnodev2.png .. image:: graphics/board_rnodev2.png
:width: 68% :width: 68%
:align: center :align: center
Unsigned RNode v2.x Unsigned RNode v2.x
""""""""""""""""""" """""""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `unsigned.io <https://unsigned.io>`_ - **Manufacturer** `unsigned.io <https://unsigned.io>`_
@ -158,7 +171,7 @@ Unsigned RNode v2.x
LilyGO LoRa32 v2.1 LilyGO LoRa32 v2.1
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -170,7 +183,7 @@ LilyGO LoRa32 v2.1
LilyGO LoRa32 v2.0 LilyGO LoRa32 v2.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -182,7 +195,7 @@ LilyGO LoRa32 v2.0
LilyGO LoRa32 v1.0 LilyGO LoRa32 v1.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
@ -194,19 +207,43 @@ LilyGO LoRa32 v1.0
LilyGO T-Deck LilyGO T-Deck
""""""""""""" """""""""""""
- **Transceiver IC** Semtech SX1262, SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `LilyGO <https://lilygo.cn>`_ - **Manufacturer** `LilyGO <https://lilygo.cn>`_
------------ ------------
.. image:: graphics/board_techo.png
:width: 45%
:align: center
LilyGO T-Echo
"""""""""""""
- **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** nRF52
- **Manufacturer** `LilyGO <https://lilygo.cn>`_
------------
.. image:: graphics/board_t114.png
:width: 58%
:align: center
Heltec T114
"""""""""""
- **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32
- **Manufacturer** `Heltec Automation <https://heltec.org>`_
------------
.. image:: graphics/board_heltec32v30.png .. image:: graphics/board_heltec32v30.png
:width: 58% :width: 58%
:align: center :align: center
Heltec LoRa32 v3.0 Heltec LoRa32 v3.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1262 and SX1268 - **Transceiver IC** Semtech SX1262 or SX1268
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `Heltec Automation <https://heltec.org>`_ - **Manufacturer** `Heltec Automation <https://heltec.org>`_
@ -218,24 +255,12 @@ Heltec LoRa32 v3.0
Heltec LoRa32 v2.0 Heltec LoRa32 v2.0
"""""""""""""""""" """"""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278 - **Transceiver IC** Semtech SX1276 or SX1278
- **Device Platform** ESP32 - **Device Platform** ESP32
- **Manufacturer** `Heltec Automation <https://heltec.org>`_ - **Manufacturer** `Heltec Automation <https://heltec.org>`_
------------ ------------
.. image:: graphics/board_rnode.png
:width: 50%
:align: center
Unsigned RNode v1.x
"""""""""""""""""""
- **Transceiver IC** Semtech SX1276 and SX1278
- **Device Platform** AVR ATmega1284p
- **Manufacturer** `unsigned.io <https://unsigned.io>`_
------------
.. _rnode-installation: .. _rnode-installation:
Installation Installation

8
docs/source/interfaces.rst
View file

@ -34,14 +34,14 @@ example for basic interface code to build upon.
Auto Interface Auto Interface
============== ==============
The Auto Interface enables communication with other discoverable Reticulum The ``AutoInterface`` enables communication with other discoverable Reticulum
nodes over autoconfigured IPv6 and UDP. Even though it uses IPv6 for peer nodes over any kind of local Ethernet or WiFi-based medium. Even though it uses IPv6 for peer
discovery, and UDP for packet transport, it **does not** need any functional IP discovery, and UDP for packet transport, it **does not** need any functional IP
infrastructure like routers or DHCP servers, on your physical network. infrastructure like routers or DHCP servers, on your physical network.
As long as there is at least some sort of switching medium present between peers (a As long as there is at least some sort of switching medium present between peers (a
wired switch, a hub, a WiFi access point or similar), it will work without wired switch, a hub, a WiFi access point or similar, or simply two devices connected
any configuration, setup or intermediary devices. directly by Ethernet cable), it will work without any configuration, setup or intermediary devices.
For ``AutoInterface`` peer discovery to work, it's also required that link-local For ``AutoInterface`` peer discovery to work, it's also required that link-local
IPv6 support is available on your system, which it should be by default in all IPv6 support is available on your system, which it should be by default in all