mirror of
https://github.com/markqvist/unsignedio
synced 2026-08-12 17:40:37 -04:00
143 lines
8.1 KiB
HTML
143 lines
8.1 KiB
HTML
|
|
||
|
|
<!doctype html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<link rel="stylesheet" href="../css/water.css?v=19">
|
||
|
|
<link rel="shortcut icon" type="image/x-icon" href="../gfx/icon.png">
|
||
|
|
<meta charset="utf-8"/>
|
||
|
|
<title>RNode Configuration Utility | unsigned.io</title>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
|
||
|
|
<meta property="og:title" content="RNode Configuration Utility">
|
||
|
|
<meta name="description" content="RNode Configuration Utility page at unsigned.io">
|
||
|
|
<meta property="og:description" content="RNode Configuration Utility page at unsigned.io">
|
||
|
|
<meta property="og:image" content="https://unsigned.io/gfx/unsigned_logo.webp">
|
||
|
|
<meta property="og:url" content="https://unsigned.io/software/RNode_Configuration_Utility.html">
|
||
|
|
<meta property="og:title" content="RNode Configuration Utility">
|
||
|
|
<meta name="twitter:card" content="summary_large_image">
|
||
|
|
<meta property="twitter:domain" content="unsigned.io">
|
||
|
|
<meta property="twitter:url" content="https://unsigned.io/software/RNode_Configuration_Utility.html">
|
||
|
|
<meta name="twitter:title" content="RNode Configuration Utility">
|
||
|
|
<meta name="twitter:description" content="RNode Configuration Utility page at unsigned.io">
|
||
|
|
<meta name="twitter:image" content="https://unsigned.io/gfx/unsigned_logo.webp">
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="load_overlay" style="background-color:#2a2a2f; position:absolute; top:0px; left:0px; width:100%; height:100%; z-index:2000;"></div>
|
||
|
|
<span class="logo">unsigned.io</span>
|
||
|
|
<center>
|
||
|
|
<p><span class="menu"><a href="../index.html">Home</a> | <a href="../log.html">Log</a> | <a href="../guides.html">Guides</a> | <a href="../software/index.html">Software</a> | <a href="../hardware/index.html">Hardware</a> | <a href="https://github.com/markqvist/Reticulum/discussions">Discussions</a> | <a href="../shop.html">Shop</a> | <a href="../contact.html">Contact Me</a> | <a href="../donate.html">Donate</a></span></p>
|
||
|
|
</center><hr><h1>RNode Configuration Utility</h1>
|
||
|
|
<p>Configure, update, flash, backup and install your <a href="../rnode/">RNode</a> with this handy utility.</p>
|
||
|
|
<p>RNode is a flexible digital radio transceiver, and this tool allows you to install and configure RNodes built on a variety of different platforms and boards. With this tool you can configure and update existing RNodes, or make your own RNodes from supported boards and modules.</p>
|
||
|
|
<h2>Supported Devices</h2>
|
||
|
|
<p>Currently the RNode Configuration Utility supports:</p>
|
||
|
|
<ul>
|
||
|
|
<li>The original RNode from <a href="https://unsigned.io/shop/product/rnode">unsigned.io</a></li>
|
||
|
|
<li>Homebrew RNodes based on ATmega1284p boards</li>
|
||
|
|
<li>Homebrew RNodes based on ATmega2560 boards</li>
|
||
|
|
<li>Homebrew RNodes based on Adafruit Feather ESP32 boards</li>
|
||
|
|
<li>Homebrew RNodes based on generic ESP32 boards</li>
|
||
|
|
<li>LilyGO T-Beam v1.1 devices</li>
|
||
|
|
<li>LilyGO LoRa32 v2.0 devices</li>
|
||
|
|
<li>LilyGO LoRa32 v2.1 devices</li>
|
||
|
|
<li>Heltec LoRa32 v2 devices</li>
|
||
|
|
</ul>
|
||
|
|
<p>You can use the included autoinstaller to automatically install and provision the RNode firmware on any supported board.</p>
|
||
|
|
<h2>Installation</h2>
|
||
|
|
<p>The easiest way to install the configuration utility is with pip:</p>
|
||
|
|
<pre><code class="language-sh"># If you don't already have pip installed
|
||
|
|
sudo apt install python-pip
|
||
|
|
|
||
|
|
# Install rnodeconf included in the rns package with pip
|
||
|
|
pip install rns
|
||
|
|
|
||
|
|
# Run rnodeconf
|
||
|
|
rnodeconf --help
|
||
|
|
</code></pre>
|
||
|
|
<h2>Usage Overview</h2>
|
||
|
|
<p>RNode can operate in two modes, host-controlled (default) and TNC mode:</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p>When RNode is in host-controlled mode, it will stay in standby when powered on, until the host specifies frequency, bandwidth, transmit power and other required parameters. This mode can be enabled by using the -N option of this utility.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>When RNode is in TNC mode, it will configure itself on powerup and enable the radio immediately. This mode can be enabled by using the -T option of this utility (the utility will guide you through the settings if you don't specify them directly).</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p>For a complete description of RNodes capabilities, documentation and more, please refer to the <a href="../rnode/">RNode page</a> and the <a href="../rnode_firmware/">RNode Firmware page</a>.</p>
|
||
|
|
<pre><code>usage: rnodeconf [-h] [-i] [-a] [-u] [-U] [--fw-version version] [--nocheck]
|
||
|
|
[-e] [-E] [-C] [-N] [-T] [-b] [-B] [-p]
|
||
|
|
[--freq Hz] [--bw Hz] [--txp dBm] [--sf factor] [--cr rate]
|
||
|
|
[--eeprom-backup] [--eeprom-dump] [--eeprom-wipe] [--version]
|
||
|
|
[port]
|
||
|
|
|
||
|
|
RNode Configuration and firmware utility. This program allows you to change various settings
|
||
|
|
and startup modes of an RNode.
|
||
|
|
|
||
|
|
It can also install, flash and update the firmware on supported devices.
|
||
|
|
|
||
|
|
positional arguments:
|
||
|
|
port serial port where RNode is attached
|
||
|
|
|
||
|
|
options:
|
||
|
|
-h, --help show this help message and exit
|
||
|
|
-i, --info Show device info
|
||
|
|
-a, --autoinstall Automatic installation on various supported devices
|
||
|
|
-u, --update Update firmware to the latest version
|
||
|
|
-U, --force-update Update to specified firmware even if version matches or is older than installed version
|
||
|
|
--fw-version version Use a specific firmware version for update or autoinstall
|
||
|
|
--nocheck Don't check for firmware updates online
|
||
|
|
-e, --extract Extract firmware from connected RNode for later use
|
||
|
|
-E, --use-extracted Use the extracted firmware for autoinstallation or update
|
||
|
|
-C, --clear-cache Clear locally cached firmware files
|
||
|
|
-N, --normal Switch device to normal mode
|
||
|
|
-T, --tnc Switch device to TNC mode
|
||
|
|
-b, --bluetooth-on Turn device bluetooth on
|
||
|
|
-B, --bluetooth-off Turn device bluetooth off
|
||
|
|
-p, --bluetooth-pair Put device into bluetooth pairing mode
|
||
|
|
--freq Hz Frequency in Hz for TNC mode
|
||
|
|
--bw Hz Bandwidth in Hz for TNC mode
|
||
|
|
--txp dBm TX power in dBm for TNC mode
|
||
|
|
--sf factor Spreading factor for TNC mode (7 - 12)
|
||
|
|
--cr rate Coding rate for TNC mode (5 - 8)
|
||
|
|
--eeprom-backup Backup EEPROM to file
|
||
|
|
--eeprom-dump Dump EEPROM to console
|
||
|
|
--eeprom-wipe Unlock and wipe EEPROM
|
||
|
|
--version Print program version and exit
|
||
|
|
</code></pre>
|
||
|
|
<h2>Command Examples</h2>
|
||
|
|
<h3>Show device info</h3>
|
||
|
|
<p>Print info like serial number, hardware revision, model and firmware version.</p>
|
||
|
|
<pre><code class="language-sh">rnodeconf /dev/ttyUSB0 -i
|
||
|
|
</code></pre>
|
||
|
|
<h3>Update the firmware</h3>
|
||
|
|
<p>Grab the latest precompiled firmware from the RNode Firmware repository and flash it to the device.</p>
|
||
|
|
<pre><code class="language-sh">rnodeconf /dev/ttyUSB0 -u
|
||
|
|
</code></pre>
|
||
|
|
<h3>Start the autoinstaller</h3>
|
||
|
|
<p>Start the autoinstallation guide for turning a compatible device into an RNode.</p>
|
||
|
|
<pre><code class="language-sh">rnodeconf --autoinstall
|
||
|
|
</code></pre>
|
||
|
|
<h3>Set RNode to TNC mode</h3>
|
||
|
|
<p>If you just specify the -T option, the utility will ask you for the necessary parameters.</p>
|
||
|
|
<pre><code class="language-sh">rnodeconf /dev/ttyUSB0 -T
|
||
|
|
</code></pre>
|
||
|
|
<p>You can also specify all the options on the command line.</p>
|
||
|
|
<pre><code class="language-sh">rnodeconf /dev/ttyuUSB0 -T --freq 868000000 --bw 125000 --txp 2 --sf 7 --cr 5
|
||
|
|
</code></pre>
|
||
|
|
<h3>Set RNode to host-controlled mode</h3>
|
||
|
|
<p>Use the -N option to set the device to host-controlled mode.</p>
|
||
|
|
<pre><code class="language-sh">rnodeconf /dev/ttyUSB0 -N
|
||
|
|
</code></pre>
|
||
|
|
<br/><hr/><span class="no_print"><center><br/><i>This website is running on a 100% solar powered server</i><br/><br/>☀️<br/><br/><i><small>Unless otherwise noted, everything here is put into the world under a <a href="../LICENSE.txt">CC BY-NC-SA 4.0</a> license.<br/>Feel free to share and remix, just remember the attribution.
|
||
|
|
</small></i></center></span>
|
||
|
|
<div class="print_only donation_block"><br/>
|
||
|
|
Contribute to keeping information on Free & Open Communications systems available for all.<br/>
|
||
|
|
You can donate directly to <b>unsigned.io</b> by using one of the following QR codes:<br/><br/>
|
||
|
|
<span class="donate_qr"><img src="../gfx/donate_xmr.png"/><br/>Monero</span>
|
||
|
|
<span class="donate_qr"><img src="../gfx/donate_btc.png"/><br/>Bitcoin</span>
|
||
|
|
<span class="donate_qr"><img src="../gfx/donate_eth.png"/><br/>Ethereum</span>
|
||
|
|
</div>
|
||
|
|
</body></html>
|