meshtastic/docs/software/settings/store-and-forward-plugin.md

57 lines
1.2 KiB
Markdown
Raw Normal View History

2021-04-27 14:08:43 -07:00
---
2021-04-27 14:18:48 -07:00
id: store-and-forward-plugin
2021-04-27 14:08:43 -07:00
title: Store and Forward Settings
sidebar_label: Store and Forward
---
2021-05-05 09:18:44 -07:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2021-04-27 14:08:43 -07:00
## Overview
2021-05-03 13:18:22 -07:00
:::caution
This is a work in progress and is not yet available.
:::
2021-04-27 14:08:43 -07:00
2021-05-03 13:18:22 -07:00
The Store Forward Plugin is an implementation of a Store and Forward system to enable resilient messaging in the event that a client device is disconnected from the main network.
2022-01-02 22:53:45 -08:00
Because of the increased network traffic for this overhead, it's not advised to use this if you are duty cycle limited for your airtime usage nor is it advised to use this for SF12 (Long Range / Slow).
2021-04-27 14:08:43 -07:00
## Settings
2021-05-03 13:18:22 -07:00
| Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: |
| store_forward_plugin_enabled | `true`, `false` | `false` |
| store_forward_plugin_records | integer | `0` |
### store_forward_plugin_enabled
Enables the plugin.
### store_forward_plugin_records
<!--- TODO --->
2021-04-27 14:08:43 -07:00
## Details
2021-05-03 15:25:24 -07:00
2021-05-05 09:18:44 -07:00
## Examples
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
TODO
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>