diff --git a/Console/Makefile b/Console/Makefile index 8ce0d55..7f369a0 100644 --- a/Console/Makefile +++ b/Console/Makefile @@ -29,6 +29,7 @@ data: @cp assets/gfx/* build/gfx/ @cp assets/images/* build/images/ @cp assets/stl/* build/3d/ + @cp assets/pkg/* build/pkg/ # @cp assets/scripts/* build/scripts/ # @cp -r ../../Reticulum/docs/manual/* build/reticulum_manual/ # @cp -r ../../Reticulum/docs/Reticulum\ Manual.pdf build/reticulum_manual/ diff --git a/Console/assets/pkg/tncattach.zip b/Console/assets/pkg/tncattach.zip new file mode 100644 index 0000000..56fb7dc Binary files /dev/null and b/Console/assets/pkg/tncattach.zip differ diff --git a/Console/source/contribute.md b/Console/source/contribute.md index 2a45ec4..3fede94 100644 --- a/Console/source/contribute.md +++ b/Console/source/contribute.md @@ -28,7 +28,11 @@ Another great way to contribute, is to spread awareness about the RNode project. - Learn about using Reticulum to set up resilient communications networks, and teach these skills to people in your area that need them ## Contribute Code & Material -If you like to write, build and design, there are plenty of oppertunities to take part in the community around RNode, and the wider Reticulum community as well. There's always plenty of work to do, from writing code, tutorials and guides, to designing parts, devices and integrations, and translating material to other languages. You can find us the following places: +If you like to write, build and design, there are plenty of oppertunities to take part in the community around RNode, and the wider Reticulum community as well. + +There's always plenty of work to do, from writing code, tutorials and guides, to designing parts, devices and integrations, and translating material to other languages. + +You can find us the following places: - The [Reticulum Matrix Channel](element://room/!TRaVWNnQhAbvuiSnEK%3Amatrix.org?via=matrix.org) at `#reticulum:matrix.org` - The [discussion forum](https://github.com/markqvist/Reticulum/discussions) on GitHub diff --git a/Console/source/guides/install_firmware.md b/Console/source/guides/install_firmware.md index 64bb14f..6042a4e 100644 --- a/Console/source/guides/install_firmware.md +++ b/Console/source/guides/install_firmware.md @@ -9,9 +9,9 @@ Do you have one of the devices available that the RNode Firmware supports? In th With the firmware installed, you can use your newly created RNode as: -- A [LoRa interface for Reticulum](https://markqvist.github.io/Reticulum/manual/interfaces.html#rnode-lora-interface) +- A [LoRa interface for Reticulum]({ASSET_PATH}m/interfaces.html#rnode-lora-interface) - A LoRa packet sniffer with [LoRaMon](https://unsigned.io/loramon/) -- A Linux network interface using the [tncattach program](https://unsigned.io/tncattach/) +- A Linux network interface using the [tncattach program]({ASSET_PATH}pkg/tncattach.zip) - A LoRa-based TNC for almost any amateur radio packet application So let's get started! You will need either a **LilyGO T-Beam v1.1**, a **LilyGO LoRa32 v2.0**, a **LilyGO LoRa32 v2.1** or a **Heltec LoRa32 v2** device. More supported devices are added regularly, so it might be useful to check the latest [list of supported devices](https://unsigned.io/rnode_firmware/#supported-hardware) as well. @@ -29,7 +29,7 @@ Some devices come with transceiver chips that are currently unsupported by the R ## Preparations -To get started, you will need to download at least version 2.1.0 of the [RNode Configuration Utility](https://unsigned.io/rnodeconf). The easiest way by far is to simply install it with `pip`, if you already have that installed on your system (if not, go install `python` and `python-pip` now, it will come in handy later). +To get started, you will need to download at least version 2.1.0 of the [RNode Configuration Utility]({ASSET_PATH}m/using.html#the-rnodeconf-utility). The easiest way by far is to simply install it with `pip`, if you already have that installed on your system (if not, go install `python` and `python-pip` now, it will come in handy later). The `rnodeconf` program is part of the `rns` package. To install it, open up a terminal and type: @@ -82,9 +82,9 @@ Remember to replace `/dev/ttyUSB0` with the actual port the installer used in th 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 your device has a display, it should also come alive and show you various information related to the device state. -If you want to use it with [Reticulum](https://reticulum.network), [Nomad Network](https://unsigned.io/nomadnet), [LoRaMon](https://unsigned.io/loramon), or other such applications, leave it in the default `Normal (host-controlled)` mode. +If you want to use it with [Reticulum]({ASSET_PATH}s_rns.html), [Nomad Network]({ASSET_PATH}s_nn.html), [LoRaMon](https://unsigned.io/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](https://unsigned.io/using-an-rnode-with-amateur-radio-software/). +If you want to use it with legacy amateur radio applications that work with KISS TNCs, you should [set it up in TNC mode]({ASSET_PATH}guides/tnc_mode.html). ## External Display & LEDs If you are using a **T-Beam** device, you can connect an external **SSD1306** OLED display using the following setup: diff --git a/Console/source/guides/make_rnodes.md b/Console/source/guides/make_rnodes.md index b9483e4..8f0d0f0 100644 --- a/Console/source/guides/make_rnodes.md +++ b/Console/source/guides/make_rnodes.md @@ -9,7 +9,7 @@ This article will outline the general process, and provide the information you n 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](https://unsigned.io/installing-rnode-firmware-on-supported-devices/). +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]({ASSET_PATH}guides/install_firmware.html). ![A Homemade RNode]({ASSET_PATH}images/g3p.webp)
*A homemade RNode, based on an ESP32 board and a transceiver module, ready for use*
@@ -56,17 +56,12 @@ In the photo above I used an Adafruit Feather ESP32 board and a ModTronix inAir4 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](https://github.com/markqvist/RNode_Firmware/blob/master/Config.h) file of the [RNode Firmware](https://unsigned.io/rnode_firmware). +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]({ASSET_PATH}pkg/rnode_firmware.zip). ## 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](https://markqvist.github.io/Reticulum/manual/using.html#the-rnodeconf-utility). To prepare for loading the firmware, make sure that `python` and `pip` is installed on your system, then install the `rns` package (which includes the `rnodeconf` program) by issuing the command: +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]({ASSET_PATH}m/using.html#the-rnodeconf-utility). - -```txt -pip install rns -``` - -If installation goes well, you can now move on to the next step. +The `rnodeconf` program is included in the `rns` package. Please read [these instructions]({ASSET_PATH}s_rns.html) 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! diff --git a/Console/source/guides/tnc_mode.md b/Console/source/guides/tnc_mode.md index a2a549b..aefb91b 100644 --- a/Console/source/guides/tnc_mode.md +++ b/Console/source/guides/tnc_mode.md @@ -5,17 +5,11 @@
{DATE}
# Using RNodes With Amateur Radio Software -If you want to use an [RNode](https://unsigned.io/rnode/) with amateur radio applications, like [APRS](https://unsigned.io/aprs-over-lora-with-rnode/) or a packet radio BBS, you will need to put the device into *TNC Mode*. In this mode, an RNode will behave exactly like a KISS-compatible TNC, which will make it usable with any amateur radio software that can talk to a KISS TNC over a serial port. +If you want to use an RNode with amateur radio applications, like APRS or a packet radio BBS, you will need to put the device into *TNC Mode*. In this mode, an RNode will behave exactly like a KISS-compatible TNC, which will make it usable with any amateur radio software that can talk to a KISS TNC over a serial port. -Whether you RNode is [bought from my shop](https://unsigned.io/shop/product/rnode/), [made from a compatible LoRa board](https://unsigned.io/installing-rnode-firmware-on-supported-devices/) or [built by yourself](https://unsigned.io/how-to-make-your-own-rnodes/), you can use the [RNode Configuration Utility](https://unsigned.io/rnodeconf) to change settings on your device, including putting it into TNC mode. +You can use the [RNode Configuration Utility]({ASSET_PATH}m/using.html#the-rnodeconf-utility) to change settings on your device, including putting it into TNC mode. -The easiest way to install `rnodeconf` on your system is by installing the `rns` package using `pip`. You probably already have `python` and `pip` installed if you use a relatively recent version of Linux or macOS. If not, go and install Python 3 now. When that is done, you can simply install `rnodeconf` by opening up a terminal and typing: - -``` -pip install rns -``` - -After a few seconds, the program should be installed and ready to use. If this is the very first time you are installing something with `pip`, you might need to close your terminal and open it again, or in some cases restart your computer, before the `rnodeconf` command becomes available. +The `rnodeconf` program is included in the `rns` package. Please read [these instructions]({ASSET_PATH}s_rns.html) for more information on how to install it from this repository, or from the Internet. With the `rnodeconf` program installed, you can put your RNode into TNC mode simply by entering the command: