mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-01-12 14:27:45 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

scrubbed

Browse source
This commit is contained in:
rcarteraz 2024-07-03 09:00:55 -07:00
parent bd115a77b7
commit b8e2d84487
3 changed files with 8 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/configuration/module/store-and-forward-module.mdx
View file

@ -13,7 +13,7 @@ import TabItem from "@theme/TabItem";
Using this module, a client device can ask a special Store & Forward Router to resend text messages after the client has been temporarily not in LoRa range of the mesh.
:::info
Only ESP32 based devices with onboard PSRAM like the T-Beam and T3S3 can be a Store & Forward Router. Requires the device to use at least firmware version 2.2.23 and to be set as a `ROUTER` or `ROUTER_CLIENT`.
Only ESP32 based devices with onboard PSRAM like the T-Beam and T3S3 can be a Store & Forward Router. Requires the device to use at least firmware version 2.2.23 and to be set as a `ROUTER.
:::
When a client device requests the history from the Store & Forward Router, the router will resend the text messages over LoRa that it has received. The router will only return messages that are within the time window the client has requested up to the maximum number of messages configured for the router.
@ -33,7 +33,7 @@ Be mindful when requesting the history, as the router might send a lot of messag
Initial requirements for the Store and Forward Router:
- Must be installed on a `ROUTER` or `ROUTER_CLIENT` node.
- Must be installed on a `ROUTER` node.
- This is an artificial limitation, but is in place to enforce best practices.
- Router nodes are intended to be always online. If this module misses any messages, the reliability of the stored messages will be reduced.
- ESP32 Processor based device with onboard PSRAM (T-Beam > v1.0, T3S3, and maybe others).
@ -41,12 +41,12 @@ Initial requirements for the Store and Forward Router:
### Usage Overview
- To use / test this you will want at least 3 devices
- One ESP32 device with PSRAM configured as `ROUTER` or `ROUTER_CLIENT`.
- One ESP32 device with PSRAM configured as `ROUTER`.
- Two others will be regular clients. If one client sends a text message when the other is not in range, the other can request the history from the router to receive the missed message when it is back in range.
### Router setup
- Configure your device as a `ROUTER` or `ROUTER_CLIENT`.
- Configure your device as a `ROUTER`.
- Name your router node something that makes it easily identifiable, aka "Router".
- Configure the Store and Forward module

6
docs/configuration/radio/device.mdx
View file

@ -26,7 +26,6 @@ The device config options are: Role, Serial Output, and Debug Log. Device config
| TAK_TRACKER | Enables automatic TAK PLI broadcasts and reduces routine broadcasts. | Standalone PLI integration with ATAK systems for communication in tactical or coordinated operations. |
| REPEATER | Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is not shown in topology. |
| ROUTER | Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is shown in topology. |
| ROUTER_CLIENT | Combination of both ROUTER and CLIENT. Not for mobile devices. | Devices in a strategic position for priority routing that need to also serve as a standard CLIENT. |
### Role Comparison
@ -43,12 +42,11 @@ This table shows the **default** values after selecting a preset. As always, ind
| TAK | Yes | Optional | Regular | Yes | No | Yes |
| TAK_TRACKER | Yes | Optional | Regular | Yes | No | Yes |
| ROUTER | No[^2] | No | High | Yes | Yes | Yes |
| ROUTER_CLIENT | Yes | Yes | Highest | Yes | Yes | Yes |
| REPEATER | Yes | No | High | Yes | Yes | No |
[^1]: **Awake Only** indicates retransmissions will occur normally but not while asleep between transmission intervals.
[^2]: The Router role enables [Power Saving](/docs/configuration/radio/power/#power-saving) by default. Consider ROUTER_CLIENT if BLE/WiFi/Serial are still needed.
[^2]: The Router role enables [Power Saving](/docs/configuration/radio/power/#power-saving) by default. Consider maxing out `power.min_wake_secs`, `power.wait_bluetooth_secs` and `display.screen_on_secs` if BLE/WiFi/Serial are still needed.
## Notes about Power Saving + Role behavior
@ -160,7 +158,7 @@ All device config options are available in the python CLI. Example commands are
| Setting | Acceptable Values | Default |
| --------------------------------- | ----------------------------------------------------------------------------------- | ----------------- |
| device.debug_log_enabled | `true`, `false` | `false` |
| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT`, `REPEATER`, `TRACKER`, `SENSOR` | `CLIENT` |
| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `REPEATER`, `TRACKER`, `SENSOR` | `CLIENT` |
| device.rebroadcast_mode | `ALL`, `ALL_SKIP_DECODING`, `LOCAL_ONLY` | `ALL` |
| device.serial_enabled | `true`, `false` | `true` |
| device.button_gpio | `0` - `34` | `0` |

4
docs/configuration/tips.mdx
View file

@ -15,9 +15,9 @@ It is strongly recommended to keep your [ROLE](/docs/configuration/radio/device#
- `CLIENT` nodes efficiently repeat and route packets as needed.
- They use smart delays for rebroadcasting, improving network stability.
### Avoid `ROUTER`, `ROUTER_CLIENT`, and `REPEATER`
### Avoid `ROUTER`and `REPEATER`
Using `ROUTER`, `ROUTER_CLIENT, or `REPEATER` roles unnecessarily can cause serious network issues:
Using `ROUTER` or `REPEATER` roles unnecessarily can cause serious network issues:
- Increased risk of packet collision.
- Reduced message delivery rates.