From b141d0f04b35fcc5555ec37198046188beda3a15 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Sat, 17 Jun 2023 21:13:24 -0700 Subject: [PATCH] Add android availability --- .../store-and-forward-module.mdx | 199 ++++-------------- 1 file changed, 41 insertions(+), 158 deletions(-) diff --git a/docs/configuration/module-config/store-and-forward-module.mdx b/docs/configuration/module-config/store-and-forward-module.mdx index 9666a42d..48218c66 100644 --- a/docs/configuration/module-config/store-and-forward-module.mdx +++ b/docs/configuration/module-config/store-and-forward-module.mdx @@ -34,9 +34,6 @@ Because of the increased network traffic for this overhead, it's not advised to | store_forward.history_return_window | `integer` | `0` | | store_forward.records | `integer` | `0` | -### Enabled - -Enables the module. +### Enabled + +Enables the module. + ```shell title="Enable the module" meshtastic --set store_forward.enabled true ``` @@ -57,214 +58,96 @@ meshtastic --set store_forward.enabled true meshtastic --set store_forward.enabled false ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### Heartbeat The Store & Forward Router sends a periodic message onto the network. This allows connected devices to know that a router is in range and listening to received messages. A client like Android, iOS, or Web can (if supported) indicate to the user whether a store and forward router is available. - - - ```shell title="Set store_forward.heartbeat to default" meshtastic --set store_forward.heartbeat 0 ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### History Return Max Sets the maximum number of messages to return to a client device. - - - ```shell title="Set store_forward.history_return_max to default" meshtastic --set store_forward.history_return_max 0 ``` - ```shell title="Set store_forward.history_return_max to 100 messages" meshtastic --set store_forward.history_return_max 100 ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### History Return Window Limits the time period (in minutes) a client device can request. - - - ```shell title="Set store_forward.history_return_window to default" meshtastic --set store_forward.history_return_window 0 ``` - ```shell title="Set store_forward.history_return_window to 1 day (1440 minutes)" meshtastic --set store_forward.history_return_window 1440 ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### Records Set this to the maximum number of records to save. Best to leave this at the default (`0`) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records. - - - ```shell title="Set store_forward.records to default (≈11,000 records)" meshtastic --set store_forward.records 0 ``` - ```shell title="Set store_forward.records to 100 records" meshtastic --set store_forward.records 100 ``` + - - + + +:::info +Store and Forward Config options are available for Android. + +1. Open the Meshtastic App +2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio configuration > Module configuration > Store & Forward** +::: + +### Enabled + +Enables the module. + +### Heartbeat + +The Store & Forward Router sends a periodic message onto the network. This allows connected devices to know that a router is in range and listening to received messages. A client like Android, iOS, or Web can (if supported) indicate to the user whether a store and forward router is available. + +### History Return Max + +Sets the maximum number of messages to return to a client device. + +### History Return Window + +Limits the time period (in minutes) a client device can request. +### Records + +Set this to the maximum number of records to save. Best to leave this at the default (`0`) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records. + + + + :::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. ::: - - + + + :::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. ::: - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - + + ## Details ### How it works