Updated manual

Changelog.md

@@ -1,6 +1,34 @@
+### 2024-10-06: RNS β 0.8.2
+
+This release adds several new boards to `rnodeconf`, fixes a range of bugs and improves transport reliability.
+
+Thanks to @jacobeva, @prusnak and @deavmi who contributed to this release!
+
+**Changes**
+- Added support for T-Beam Supreme devices to `rnodeconf`
+- Added support for T3S3 devices to `rnodeconf`
+- Added support for T-Deck devices to `rnodeconf`
+- Added support for new hardware error codes from connected RNodes
+- Added the ability to control the display on nRF52-based RNodes
+- Improved resource transfers over very slow links, by adding more suitable `MAX_WINDOW` cap if link speed is continously below threshold.
+- Improved `rnodeconf` flashing so manual resets for some devices are no longer required
+- Added edge case handling for receiving a link proof after the link had timed out and been closed, but before it having been purged from active links table
+- Updated supported hardware section of the manual with new boards
+- Tuned path request timing for roaming instances
+- Fixed a bug that caused RNS to fail to initialise in Termux on Android
+- Fixed a bug in RNodeInterface firmware version comparison
+- Fixed a bug in the serial framing of RNodeMultiInterface
+- Fixed a bug in sub-interface spawning of RNodeMultiInterface
+
+**Release Hashes**
+```
+db720a727a09c0c9d76288dec5a995a30146e65d6a4c5c034f47fb60a78f4962 rns-0.8.2-py3-none-any.whl
+ee412535edba48817551658247fb0c843d17e1c97cad9d2a819a7fc627c5ba28 rnspure-0.8.2-py3-none-any.whl
+```
+
 ### 2024-10-02: RNS β 0.8.1
 
-This release add BLE support to RNodeInterface, and support for configuring additional options to `rnodeconf`.
+This release adds BLE support to RNodeInterface, and support for configuring additional options to `rnodeconf`.
 
 **Changes**
 - Added Bluetooth Low Energy support to RNodeInterface

RNS/Interfaces/TCPInterface.py

@@ -200,7 +200,7 @@ class TCPClientInterface(Interface):
             if initial:
                 RNS.log("Establishing TCP connection for "+str(self)+"...", RNS.LOG_DEBUG)
 
-            self.socket = socket.socket(socket.AF_INET|socket.AF_INET6, socket.SOCK_STREAM)
+            self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             self.socket.settimeout(TCPClientInterface.INITIAL_CONNECT_TIMEOUT)
             self.socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
             self.socket.connect((self.target_ip, self.target_port))

docs/manual/_sources/hardware.rst.txt

@@ -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%
     :align: center
 
@@ -116,7 +116,7 @@ LilyGO T-Beam
 
 ------------
 
-.. image:: graphics/board_t3s3.webp
+.. image:: graphics/board_t3s3.png
     :width: 50%
     :align: center
 
@@ -128,7 +128,7 @@ LilyGO T3S3
 
 ------------
 
-.. image:: graphics/board_rak4631.webp
+.. image:: graphics/board_rak4631.png
     :width: 45%
     :align: center
 
@@ -140,7 +140,7 @@ RAK4631-based Boards
 
 ------------
 
-.. image:: graphics/board_rnodev2.webp
+.. image:: graphics/board_rnodev2.png
     :width: 68%
     :align: center
 
@@ -188,7 +188,7 @@ LilyGO LoRa32 v1.0
 
 ------------
 
-.. image:: graphics/board_tdeck.webp
+.. image:: graphics/board_tdeck.png
     :width: 45%
     :align: center
 
@@ -268,10 +268,8 @@ Usage 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
-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

docs/manual/hardware.html

@@ -292,7 +292,7 @@ to the configuration.</p>
 <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>
 <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">
 <h4>LilyGO T-Beam Supreme<a class="headerlink" href="#lilygo-t-beam-supreme" title="Permalink to this heading">#</a></h4>
 <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>
 </ul>
 <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 id="lilygo-t3s3">
 <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>
 </ul>
 <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 id="rak4631-based-boards">
 <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>
 </ul>
 <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 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>
@@ -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>
 </ul>
 <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 id="lilygo-t-deck">
 <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>
 <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,
+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 id="wifi-based-hardware">

docs/source/hardware.rst

@@ -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%
     :align: center
 
@@ -116,7 +116,7 @@ LilyGO T-Beam
 
 ------------
 
-.. image:: graphics/board_t3s3.webp
+.. image:: graphics/board_t3s3.png
     :width: 50%
     :align: center
 
@@ -128,7 +128,7 @@ LilyGO T3S3
 
 ------------
 
-.. image:: graphics/board_rak4631.webp
+.. image:: graphics/board_rak4631.png
     :width: 45%
     :align: center
 
@@ -140,7 +140,7 @@ RAK4631-based Boards
 
 ------------
 
-.. image:: graphics/board_rnodev2.webp
+.. image:: graphics/board_rnodev2.png
     :width: 68%
     :align: center
 
@@ -188,7 +188,7 @@ LilyGO LoRa32 v1.0
 
 ------------
 
-.. image:: graphics/board_tdeck.webp
+.. image:: graphics/board_tdeck.png
     :width: 45%
     :align: center
 
@@ -268,10 +268,8 @@ Usage 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
-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