Mirrors
/
RNode_Firmware
mirror of https://github.com/markqvist/RNode_Firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
RNode_Firmware/Console/source/guides/make_rnodes.md

11 KiB
Raw Blame History

{DATE}
# How To Make Your Own RNodes

This article will outline the general process, and provide the information you need, for building your own RNode from a few basic modules. The RNode will be functionally identical to a purchased device.

Once you have learned the put together a custom RNode with your own choice of components, you can use these skills to create your own RNode designs from scratch, using either a custom-designed PCB, or simply by mounting your choice of modules in a enclosure or case.

If you haven't already, you migh also want to check out how to install the RNode firmware directly on pre-made LoRa development boards.

A Homemade RNode

*A homemade RNode, based on an ESP32 board and a transceiver module, ready for use*

Since there is not one right way to cut this pie, this article will probably not give the exact steps for the combination of components you choose, but will instead attempt to provide you with the information you need to build RNodes from a wide variety of microcontroller boards and LoRa modules. Generally speaking, you will need three things to construct a working RNode:

  • A supported microcontroller board
  • A supported transceiver module
  • A way to mount and connect the two

Preparing the Hardware

Currently, the RNode firmware supports a variety of different microcontrollers, and more are being added regurlarly. That means that there is a lot of boards to choose from. You can probably use most boards that are based on either the ATmega1284P, ATmega2560 or ESP32 microcontrollers. Regarding microcontroller boards there is a few key points to take note of:

  • You will need to connect the transceiver module over the SPI bus. This means that the board should have SPI pins for exposed for you to connect to. UART-only modules will not work.
  • Logic voltage levels must match the transceiver module you are using, or you will have to add a voltage level converter in between the two devices, that is fast enough for the clock of the SPI bus (usually 8 or 10MHz). I recommend using a microcontroller and transceiver module with matching logic levels. Most will be 3.3 volts.
  • Apart from the SPI pins for clock, chip select, MOSI and MISO, you will also need an output pin for a reset line to the transceiver module, and one interrupt-capable input pin for the interrupt signal from the transceiver module. Almost all boards should have plenty of IO available for this, but you might as well make sure before ordering anything.
  • You need to choose a board that can provide enough power on it's internal regulators to power the transceiver module while it is transmitting. This can draw quite a bit of power, and some boards only have very small 3.3v regulators, which will not cut it while driving the transmitter at full tilt.

Regarding the LoRa transceiver module, there is going to be an almost overwhelming amount of options to choose from. To narrow it down, here are the essential characteristics to look for:

  • The RNode firmware needs a module based on the Semtech SX1276 or Semtech SX1278 LoRa transceiver IC. These come in several different variants, for all frequency bands from about 150 MHz to about 1100 MHz.
  • Support for SX1262, SX1268 and SX1280-based modules is coming soon, but until that is released, only SX1276 and SX1278 modules will work.
  • The module must expose the direct SPI bus to the transceiver chip. UART based modules that add their own communications layer will not work.
  • The module must also expose the reset line of the chip, and provide the DIO0 interrupt signal from the chip.
  • As mentioned above, the module must be logic-level compatible with the microcontroller you are using, unless you want to add a level-shifter. Resistor divider arrays will most likely not work here, due to the bus speeds required.

Keeping those things in mind, you should be able to select a suitable combination of microcontroller board and transceiver module.

Assembling the RNode

Ok, having gone through the endless combinations and selected a board and a module, you are actually almost done. Connecting the devices together is pretty simple, and should only take a few minutes. I recommend that you place both devices in a solderless breadboard initially, to make sure everything is working as expected. Once you have a working setup, you can make it more durable and permanent by soldering it to a prototyping board, and connecting permanent lines between the devices.

In the photo above I used an Adafruit Feather ESP32 board and a ModTronix inAir4 module. That will result in an RNode suitable for the 420 MHz to 520 MHz range. To complete the device I did the following:

  1. Connect the GND pin of the microcontroller board to the GND rail of the breadboard.
  2. Connect the GND pin of the transceiver module to the GND rail of the breadboard.
  3. Connect the 3.3 volt output line of the microcontroller board to the V_IN pin of the transceiver module.
  4. Connect the chip select pin of the microcontroller board to the chip select pin of the transceiver module.
  5. Connect the SPI clock pin of the microcontroller board to the SPI clock pin of the transceiver module.
  6. Connect the MOSI pin of microcontroller board to the MOSI pin of the transceiver module.
  7. Connect the MISO pin of the microcontroller board to the MISO pin of the transceiver module.
  8. Connect the transceiver reset pin of the microcontroller board to the reset pin of the transceiver module.
  9. Connect the DIO0 pin of the transceiver module to the DIO0 interrupt pin of the microcontroller board.
  10. You can optionally connect transmit and receiver LEDs to the corresponding pins of the microcontroller board.

The pin layouts of your transceiver module and microcontroller board will vary, but you can look up the correct pin assignments for your processor type and board layout in the Config.h file of the RNode Firmware.

Loading the Firmware

Once the hardware is assembled, you are ready to load the firmware onto the board and configure the configuration parameters in the boards EEPROM. Luckily, this process is completely automated by the RNode Configuration Utility.

The rnodeconf program is included in the rns package. Please read these instructions for more information on how to install it from this repository, or from the Internet. If installation goes well, you can now move on to the next step.

Take Care: A LoRa transceiver module must be connected to the board for the firmware to start and accept commands. If the firmware does not verify that the correct transceiver is available on the SPI bus, execution is stopped, and the board will not accept commands. If you find the board unresponsive after installing the firmware, or EEPROM configuration fails, double-check your transceiver module wiring!

Having double-checked that everything is connected correctly, it is time to power up the board and install the firmware. Run the rnodeconf autoinstaller by executing the command:

rnodeconf --autoinstall

The installer will now ask you to insert the device you want to set up, scan for connected serial ports, and ask you a number of questions regarding the device. When it has the information it needs, it will install the correct firmware and configure the necessary parameters in the device EEPROM for it to function properly.

Please Note! If you are connected to the Internet while installing, the autoinstaller will automatically download any needed firmware files to a local cache before installing.

If you do not have an active Internet connection while installing, you can extract and use the firmware from this device instead. This will only work if you are building the same type of RNode as the device you are extracting from, as the firmware has to match the targeted board and hardware configuration.

If you need to extract the firmware from an existing RNode, run the following command:

rnodeconf --extract

If rnodeconf finds a working RNode, it will extract and save the firmware from the device for later use. You can then run the auto-installer with the --use-extracted option to use the locally extracted file:

rnodeconf --autoinstall --use-extracted

This also works for updating the firmware on existing RNodes, so you can extract a newer firmware from one RNode, and deploy it onto other RNodes using the same method. Just use the --update option instead of --autoinstall.

If the install goes well, you will be greated with a success message telling you that your device is now ready. To confirm everything is OK, you can query the device info with:

rnodeconf --info /dev/ttyUSB0

Remember to replace /dev/ttyUSB0 with the actual port the installer used in the previous step. You should now see rnodeconf connect to your device and show something like this:

[2022-01-27 20:11:22] Opening serial port /dev/ttyUSB0...
[2022-01-27 20:11:25] Device connected
[2022-01-27 20:11:25] Current firmware version: 1.26
[2022-01-27 20:11:25] Reading EEPROM...
[2022-01-27 20:11:25] EEPROM checksum correct
[2022-01-27 20:11:25] Device signature validated
[2022-01-27 20:11:25]
[2022-01-27 20:11:25] Device info:
[2022-01-27 20:11:25]   Product            : LilyGO LoRa32 v2.0 850 - 950 MHz (b0:b8:36)
[2022-01-27 20:11:25]   Device signature   : Validated - Local signature
[2022-01-27 20:11:25]   Firmware version   : 1.26
[2022-01-27 20:11:25]   Hardware revision  : 1
[2022-01-27 20:11:25]   Serial number      : 00:00:00:02
[2022-01-27 20:11:25]   Frequency range    : 850.0 MHz - 950.0 MHz
[2022-01-27 20:11:25]   Max TX power       : 17 dBm
[2022-01-27 20:11:25]   Manufactured       : 2022-01-27 20:10:32
[2022-01-27 20:11:25]   Device mode        : Normal (host-controlled)

On the hardware side, you should see the status LED flashing briefly approximately every 2 seconds. If all of the above checks out, congratulations! Your RNode is now ready to use.

If you want to use it with Reticulum, Nomad Network, LoRaMon, or other such applications, leave it in the default Normal (host-controlled) mode.

If you want to use it with legacy amateur radio applications that work with KISS TNCs, you should set it up in TNC mode.