Configuration Utility for RNode hardware
Project description
RNode Configuration Utility
Introduction
Configure, flash, backup and upgrade your RNode with this handy utility. The only required option is the serial port the device is attached to. To show basic device info, use the -i option.
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.py [-h] [-i] [-T] [-N] [-b] [-d] [-f] [-r] [-u] [-k] [-p]
[--model model] [--hwrev revision] [--freq Hz] [--bw Hz]
[--txp dBm] [--sf factor] [--cr rate]
[port]
RNode Configuration and firmware utility. This program allows you to change
various settings and startup modes of RNode. It can also flash and update the
firmware, and manage device EEPROM.
positional arguments:
port serial port where RNode is attached
optional arguments:
-h, --help show this help message and exit
-i, --info Show device info
-T, --tnc Switch device to TNC mode
-N, --normal Switch device to normal mode
-b, --backup Backup EEPROM to file
-d, --dump Dump EEPROM to console
-f, --flash Flash firmware and bootstrap EEPROM
-r, --rom Bootstrap EEPROM without flashing firmware
-u, --update Update firmware
-k, --key Generate a new signing key and exit
-p, --public Display public part of signing key
--model model Model code for EEPROM bootstrap
--hwrev revision Hardware revision EEPROM bootstrap
--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
--cr rate Coding rate for TNC mode
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
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 rnodeconf
# Run rnodeconf
./rnodeconf --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 Distribution
Hashes for rnodeconf-0.9.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dae0d58117c80b4b49a844de88d20595229050c68b9893e8faf5fd7eae554d62 |
|
MD5 | ec44236ece9174b5265aed7bc0a23e30 |
|
BLAKE2b-256 | 4a90f221b2b5876cbb6731d33933fe474cc5d918ffa00ce7ca79e99cd6a973b4 |