From b8e2d8448781f0d057c0e5a72c2d04df45377655 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Wed, 3 Jul 2024 09:00:55 -0700 Subject: [PATCH 1/4] scrubbed --- docs/configuration/module/store-and-forward-module.mdx | 8 ++++---- docs/configuration/radio/device.mdx | 6 ++---- docs/configuration/tips.mdx | 4 ++-- 3 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/configuration/module/store-and-forward-module.mdx b/docs/configuration/module/store-and-forward-module.mdx index 1179e2d9..deebeccb 100644 --- a/docs/configuration/module/store-and-forward-module.mdx +++ b/docs/configuration/module/store-and-forward-module.mdx @@ -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 diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index b88d9c1b..580a1202 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -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` | diff --git a/docs/configuration/tips.mdx b/docs/configuration/tips.mdx index 76960872..0c16f941 100644 --- a/docs/configuration/tips.mdx +++ b/docs/configuration/tips.mdx @@ -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. From 350c00e2eb98cecd2c56c5cf3833600ad7a4ebd5 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Wed, 3 Jul 2024 09:01:43 -0700 Subject: [PATCH 2/4] update submodule --- static/design | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/design b/static/design index eeddd10c..77fafb2b 160000 --- a/static/design +++ b/static/design @@ -1 +1 @@ -Subproject commit eeddd10c108f1516e6e0c878fbaa8ed40a4d279d +Subproject commit 77fafb2b027787f1206fe3774a2f456f1ffc721d From db17b1709ecf173ad9a1254be0e302f18f642a9a Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Wed, 3 Jul 2024 12:15:52 -0700 Subject: [PATCH 3/4] add missing 1 --- docs/configuration/module/store-and-forward-module.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/module/store-and-forward-module.mdx b/docs/configuration/module/store-and-forward-module.mdx index deebeccb..dfd42aa2 100644 --- a/docs/configuration/module/store-and-forward-module.mdx +++ b/docs/configuration/module/store-and-forward-module.mdx @@ -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. +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. From 557180d0442f6e9bc1c0d55ec4bfaceb8fcce8d5 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Wed, 3 Jul 2024 12:20:08 -0700 Subject: [PATCH 4/4] minor changes --- docs/configuration/radio/device.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index 580a1202..794637a1 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -46,7 +46,7 @@ This table shows the **default** values after selecting a preset. As always, ind [^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 maxing out `power.min_wake_secs`, `power.wait_bluetooth_secs` and `display.screen_on_secs` if BLE/WiFi/Serial are still needed. +[^2]: The `ROUTER` role enables [Power Saving](/docs/configuration/radio/power/#power-saving) by default (ESP32 only). When needing to update a `ROUTER` via BLE, it's recommended you utilize an admin channel to temporarily change the role in order to update and then revert when done. ## Notes about Power Saving + Role behavior