Configuration Utility for RNode hardware
Project description
RNode Configuration Utility
Introduction
Configure, update, flash, backup and install your RNode (homebrew or official) with this handy utility.
RNode is a flexible LoRa-based 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.
Currently the RNode Configuration Utility supports:
- The original RNode from unsigned.io
- Homebrew RNodes based on ATmega1284p boards
- Homebrew RNodes based on ATmega2560 boards
- Homebrew RNodes based on Adafruit Feather ESP32 boards
- Homebrew RNodes based on generic ESP32 boards
- LilyGO T-Beam v1.1 devices
- LilyGO LoRa32 v2.0 devices
- LilyGO LoRa32 v2.1 devices
You can use the included autoinstaller to automatically install and provision the RNode firmware on any supported board.
RNode can operate in two modes, host-controlled (default) and TNC mode:
-
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.
-
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).
For a complete description of RNodes capabilities, documentation and more, please refer to the RNode repository.
usage: rnodeconf [-h] [-i] [-a] [-u] [--nocheck] [-N] [-T] [--freq Hz] [--bw Hz] [--txp dBm] [--sf factor] [--cr rate] [-b] [-d] [--eepromwipe] [--version]
[port]
RNode Configuration and firmware utility. This program allows you to change various settings and startup modes of 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
--nocheck Don't check for firmware updates online, use existing local files if possible
-N, --normal Switch device to normal mode
-T, --tnc Switch device to TNC 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)
-b, --backup Backup EEPROM to file
-d, --dump Dump EEPROM to console
--eepromwipe Unlock and wipe EEPROM
--version Print program version and exit
Installation
The easiest way to install the configuration utility is with pip:
# If you don't already have pip installed
sudo apt install python3-pip
# Install rnodeconf with pip
pip3 install rnodeconf
# Run rnodeconf
rnodeconf --help
On some operating systems, programs installed by pip cannot be run simply by typing their name. If you get a command not found error, you will have to add the pip install directory to your PATH variable. The best way to do this is to edit the ".profile" file in your home directory and add the following lines at the bottom of the file:
# Include locally installed programs in path
if [ -d "$HOME/.local/bin" ] ; then
PATH="$HOME/.local/bin:$PATH"
fi
If you want to use the utility for firmware updating or flashing, you will also need avrdude:
sudo apt install avrdude
You can also clone or download this repository, place it wherever you'd like and run rnodeconf from there:
# Clone repository
git clone https://github.com/markqvist/rnodeconfigutil.git
# Move into folder
cd rnodeconfigutil
# Set executable permission on rnodeconf
chmod a+x rnodeconf/rnodeconf.py
# Symlink executable to main directory
ln -s rnodeconf/rnodeconf.py rnodeconfig
# Run rnodeconf
./rnodeconfig --help
Dependencies
The config utility requires Python 3, pyserial and cryptography.io. To install:
# Install dependencies for rnodeconf
sudo pip3 install pyserial cryptography
Examples
Show device info
Print info like serial number, hardware revision, model and firmware version.
rnodeconf /dev/ttyUSB0 -i
Update the firmware
Grab the latest precompiled firmware from the RNode Firmware repository and flash it to the device.
rnodeconf /dev/ttyUSB0 -u
Set RNode to TNC mode
If you just specify the -T option, the utility will ask you for the necessary parameters.
rnodeconf /dev/ttyUSB0 -T
You can also specify all the options on the command line.
rnodeconf /dev/ttyuUSB0 -T --freq 868000000 --bw 125000 --txp 2 --sf 7 --cr 5
Set RNode to host-controlled mode
Use the -N option to set the device to host-controlled mode.
rnodeconf /dev/ttyUSB0 -N
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for rnodeconf-1.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1323140611ded7a4ace6d9968af58faa54aef5246ba96c5802412c3404fb2ca |
|
MD5 | 442dd046db5caeeca38726388554d49a |
|
BLAKE2b-256 | 9db775cef6f00405e6c9f7a36295d2c3bc4481ed96b757fbee8be88a47eca0df |
Hashes for rnodeconf-1.1.9-1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4aaee44e4f04a9f9dd868f4f0dd14e445db2fa8b85bbb7bad5212045b845c6f3 |
|
MD5 | 39b03303b19681dddb3882ca1c3b5a9c |
|
BLAKE2b-256 | eaa038a4b75d387dd1e81d90eb8ca2ab67df19ba587c06b89300d26c9a0b4167 |