Git-Mirrors/RNode_Firmware
1
0
Fork 0
mirror of https://github.com/markqvist/RNode_Firmware.git synced 2024-10-01 03:15:39 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated build guides

Browse Source
This commit is contained in:
Mark Qvist 2023-01-13 20:30:42 +01:00
parent 0ddf410445
commit b9578010da
6 changed files with 102 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Console/source/builds/ap.md
View File

@ -3,6 +3,6 @@
[image]: <> (gfx/cs.webp)
[excerpt]: <> (An outdoor-mountable RNode suitable for Access Point or network extension operation. Also supports high-capacity batteries and solar charging.)
## Outdoor AP RNode
This RNode comes with a weather-proof case and convenient cable management options, suitable for outdoor mounting and operation. It is possible to mount this RNode directly to mast and antennas, and it supports high-capacity batteries and solar charging.
This RNode comes with a weather-proof case and convenient cable management options, suitable for outdoor mounting and operation. It is possible to mount this RNode directly to masts and antennas, and it supports high-capacity batteries and solar charging.
This build recipe will be released soon. Please [support the project]({ASSET_PATH}contribute.html) to help realise it!

104
Console/source/builds/handheld.md
View File

@ -3,9 +3,15 @@
[image]: <> (gfx/rnode_iso.webp)
[excerpt]: <> (This RNode is suitable for mobile and handheld operation, and offers both wireless and wired connectivity to host devices. A good all-round unit. It is also suitable for permanent installation indoors.)
## Handheld RNode Recipe
*Version 2.1*
This build recipe will help you create an RNode that is suitable for mobile and handheld operation, and offers both wireless and wired connectivity to host devices. It is also useful for permanent installation indoors, or even outdoors, as long as it is protected from water ingress and direct sunlight.
**Table of Contents**
When you have completed this guide, you will end up with an RNode like this:
![Completed Handheld RNode]({ASSET_PATH}images/bg_h_1.webp)
### Table of Contents
1. [Preparation](#prep)
2. [Supported Board](#devboard)
@ -30,25 +36,107 @@ To complete this build recipe, you will need access to the following items:
### <a name="devboard"></a>Step 2: Supported Development Boards
Lorem
This RNode design is using a **LilyGO LoRa32 v2.1** board, in either the 433 MHz, 868 MHz, 915 MHz or 923 MHz variants. It is easiest to obtain the version of the board with an *u.FL* (sometimes also labeled *IPEX*) antenna connector, instead of the *SMA* connector. This version comes with an SMA to u.FL pigtail, which is installed into the 3D-printed case.
### <a name="materials"></a>Step 3: Materials
If you have the version with an *SMA* connector, you will have to desolder it, and activate the *u.FL* connector instead, by moving a resistor on the board.
Lorem
You will also need to demount the OLED display from the small acrylic riser on the board, and unscrew and discard the riser, since the OLED display will be mounted directly into a matching slot in the 3D-printed case.
![Compatible board]({ASSET_PATH}images/bg_h_2.webp)
*The correct board version for this RNode build recipe*
### <a name="materials"></a>Step 3: Obtain Materials
In addition to the board, you will need a few other components to build this RNode.
- A suitable antenna. Most boards purchased online include a passable antenna, but you may want to upgrade it to a better one.
- 6 pieces of M2x6mm screws for assembling the case. Can be bought in most hardware stores or from online vendors.
- An optional NeoPixel RGB LED for displaying status, and TX/RX activity. If you do not want to add this, it can simply be omitted.
- The easiest way is to use the PCB-mounted NeoPixel "mini-buttons" manufactured by [adafruit.com](https://www.adafruit.com/product/1612). These fit exactly into the slot in the mounting position in the 3D-printed case, and are easy to connect cables to.
- An optional lithium-polymer battery.
- This RNode supports 3.7v, single-cell LiPo batteries
- 1.25mm JST connector
- The standard case can fit up to a 700mAh LP602248 battery
- Maximum battery dimensions for this case is 50mm x 25mm x 6mm
- There is a larger bottom casing available that fits 1100mAh batteries
- Maximum battery dimensions for this case is 50mm x 25mm x 12mm
### <a name="parts"></a>Step 4: 3D Print Parts
Lorem
To complete the build of this RNode, you will need to 3D-print the parts for the casing. Download, extract and slice the STL files from the [parts package](#p) in your preffered software.
- Two of the parts should are LED light-guides, and should be printed in a semi-translucent material:
- The `LED_Window.stl` file is a light-guide for the NeoPixel LED, mounted in the circular cutout at the top of the device.
- The `LED_Guide.stl` file is a light-guide for the power and charging LEDs, mounted in the rectangular grove at the bottom of the device.
- The rest of the parts can be printed in any material, but for durability and heat-resistance, PETG is recommended.
- The `Power_Switch.stl` file is a small power-switch slider, mounted in the matching grove on the bottom-left of the device.
- The `Case_Top.stl` file is the top shell of the case. It holds the OLED display and NeoPixel RGB LED, and mounts to the bottom shell of the case with 6 M2 screws. The screw holes in both the top and bottom shells of the case are dimensioned to be self-threading when screws are inserted for the first time. Do not over-tighten.
- The `Case_Bottom_Small_Battery.stl` file is the default bottom shell of the case. It holds batteries up to approximately 700mAh.
- The `Case_Bottom_Large_Battery.stl` file is an alternative bottom shell for the case. It holds batteries up to approximately 1100mAh.
- The `Case_Bottom_No_Battery.stl` file is an alternative bottom shell for the case. It does not have space for a battery, but results in a very compact device.
- The `Case_Battery_Door.stl` file is the door for the battery compartment of the device. It snap-fits tightly into place in the bottom shell, and features a small slot for opening with a flathead screwdriver or similar.
All files are dimensioned to fit together perfectly without any scaling on a well-tuned 3D-printer. The recommended layer height for all files is 0.15mm.
### <a name="tools"></a>Step 5: Install Tools
Lorem
To install and configure the RNode Firmware on the device, you will need to install the `rnodeconf` program on your computer. This is included in the `rns` package, that can be [installed directly from this RNode]({ASSET_PATH}s_rns.html). Please carry out the installation instructions on [this page]({ASSET_PATH}s_rns.html), and continue to the next step when the `rnodeconf` program is installed.
### <a name="firmware"></a>Step 6: Firmware Setup
Lorem
Once the `rnodeconf` program is installed, we will use it to install the RNode Firmware on your device, and do the initial provisioning of configuration parameters. This process can be completed automatically, by using the auto-installer. Run the `rnodeconf` auto-installer with the following command:
```
rnodeconf --autoinstall
```
1. The program will ask you to connect your device to an USB-port on your computer. Do so, and hit enter.
2. Select the serial port the device is connected as.
3. You will now be asked what device this is, select the option **A Specific Kind of RNode**.
4. The installer will ask you what model your device is. Select the **Handheld RNode v2.x** option that matches the frequency band of your device.
5. The installer will display a summary of your choices. If you are satisfied, confirm your selection.
6. The installer will now automaticall install and configure the firmware and prepare the device for use.
> **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-firmware /dev/ttyUSB0
```
Remember to replace `/dev/ttyUSB0` with the port the RNode is actually connected to. If `rnodeconf` finds a working RNode on the specified port, it will extract and save the firmware from the device for later use. You can then run the auto-installer with the `--no-check` and `--fw-version`options to use the locally extracted file:
```
rnodeconf --autoinstall --no-check --fw-version 1.55
```
Make sure to replace the version number with the one that actually matches the extracted firmware.
### <a name="assembly"></a>Step 7: Assembly
Lorem
With the firmware installed and configured, and the case parts printed, it's time to put it all together.
1. Insert the **SMA to u.FL** pigtail adatper into the matching **slot** in the top part of the bottom shell. Make sure it lines up with the internal hex-nut cut-out in the bottom shell, as the hex nut of the adapter will get pulled into this cut-out, and thereby self-lock, when an antenna is connected. You can optionally mount a locking nut on the exterior thread of the SMA connector when the case has been completely assembled.
2. Thread the cable of the **SMA to u.FL** pigtail adapter into the matching grove, and run it out of the bottom opening.
3. Mount the **power-switch slider** into the matching slot, in the bottom-left part of the bottom shell.
4. With the SMA connector and power switch mounted, slide the **board** into the bottom shell, such that the **power switch** of the **board** mates with the slot in the already installed power-switch slider. Click the **board** into place in the bottom shell.
5. Optionally mount the **NeoPixel LED**:
- Measure out cables that matches lenghts between the NeoPixel mounting slot, and the corresponding pins on the board.
- Solder the **V+**, **GND** and **DATA** cables to the NeoPixel.
- Solder the **V+** cable to the **3.3v** pin on the board.
- Solder the **GND** cable to the **GND** pin on the board.
- Solder the **DATA** cable to **IO Pin 12** on the board.
- Mount the **NeoPixel** in the circular slot in the top part of the top shell.
6. Carefully mount the OLED display in the rectangular slot in the middle part of the top shell.
7. While ensuring that all internal cables stay within their routing groves, place the **top shell** on top of the **bottom shell**, making sure that the screw-mounting holes line up.
8. Mount the 6 **M2x6mm screws** into the mounting holes, until the two shells of the case are tightly and securely connected.
9. Flip over the device.
10. Connect the male **u.FL** connector to the female **u.FL** socket on the **board**.
11. Optionally, connect the male JST connector of the **battery** to the female JST connector on the **board**.
12. Fit the **battery door** into place.
Congratulations, Your Handheld RNode is now complete! Flip the power switch, and start using it!

2
Console/source/builds/micropylon.md
View File

@ -1,7 +1,7 @@
[date]: <> (2023-01-09)
[title]: <> (Reticulum MicroPylon)
[image]: <> (gfx/cs.webp)
[excerpt]: <> (A powerful multi-transceiver RNode-based radio system for autonomous and self-configuring Reticulum network deployments.)
[excerpt]: <> (A powerful, solar-powered multi-transceiver RNode-based radio system for autonomous and self-configuring Reticulum network deployments.)
## Reticulum MicroPylon
This radio system is a powerful and flexible multi-transceiver radio system, designed for rapidly deploying autonomous and self-configuring Reticulum networks over wide areas.

3
Console/source/help.md
View File

@ -2,6 +2,7 @@
## Get Help
If you are having trouble, or if something is not working, this RNode contains a number of useful resources.
- The [unsigned.io](https://unsigned.io/) website
- Read [Questions & Answers](qa.html) section
- Read the [Reticulum Manual](m/index.html) stored on this RNode
- Browse a copy of the [Reticulum Website](r/index.html) stored on this RNode
@ -11,4 +12,4 @@ If things still aren't working as expected here are some great places to ask for
- The [discussion forum](https://github.com/markqvist/Reticulum/discussions) on GitHub
- The [Reticulum Matrix Channel](element://room/!TRaVWNnQhAbvuiSnEK%3Amatrix.org?via=matrix.org) at `#reticulum:matrix.org`
- The [Reticulum subreddit](https://reddit.com/r/reticulum)
- The [Reticulum subreddit](https://reddit.com/r/reticulum)

1
Console/source/learn.md
View File

@ -2,6 +2,7 @@
## Learn More
This RNode contains a selection of tutorials and guides on setting up communications, creating RNodes, building networks and using Reticulum. You can find additional information in the following sections:
- The [unsigned.io](https://unsigned.io/) website
- The [Questions & Answers](qa.html) section
- The [Reticulum Manual](m/index.html) stored on this RNode
- A copy of the [Reticulum Website](r/index.html) stored on this RNode

2
Console/source/recipes.md
View File

@ -1,5 +1,5 @@
[title]: <> (RNode Recipes)
## RNode Build Recipes
This section contains a library of build recipes for various types of RNodes, along with accessories and useful extras. All the recipes contain necessary plans, instructions and 3D-printable files for completing the build.
This section contains a library of build recipes for various types of RNodes. All the recipes contain necessary plans, instructions and 3D-printable files for completing the build.
{TOPIC:builds}