mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-28 23:19:47 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add android availability

Browse source
This commit is contained in:
pdxlocations 2023-06-17 21:13:24 -07:00
parent 916c70c0fd
commit b141d0f04b
1 changed files with 41 additions and 158 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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.history_return_window | `integer` | `0` |
| store_forward.records | `integer` | `0` | | store_forward.records | `integer` | `0` |
### Enabled
Enables the module.
<Tabs <Tabs
groupId="settings" groupId="settings"
@ -49,6 +46,10 @@ values={[
]}> ]}>
<TabItem value="cli"> <TabItem value="cli">
### Enabled
Enables the module.
```shell title="Enable the module" ```shell title="Enable the module"
meshtastic --set store_forward.enabled true meshtastic --set store_forward.enabled true
``` ```
@ -57,214 +58,96 @@ meshtastic --set store_forward.enabled true
meshtastic --set store_forward.enabled false meshtastic --set store_forward.enabled false
``` ```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
### Heartbeat ### 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. 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.
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Set store_forward.heartbeat to default" ```shell title="Set store_forward.heartbeat to default"
meshtastic --set store_forward.heartbeat 0 meshtastic --set store_forward.heartbeat 0
``` ```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
### History Return Max ### History Return Max
Sets the maximum number of messages to return to a client device. Sets the maximum number of messages to return to a client device.
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Set store_forward.history_return_max to default" ```shell title="Set store_forward.history_return_max to default"
meshtastic --set store_forward.history_return_max 0 meshtastic --set store_forward.history_return_max 0
``` ```
```shell title="Set store_forward.history_return_max to 100 messages" ```shell title="Set store_forward.history_return_max to 100 messages"
meshtastic --set store_forward.history_return_max 100 meshtastic --set store_forward.history_return_max 100
``` ```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
### History Return Window ### History Return Window
Limits the time period (in minutes) a client device can request. Limits the time period (in minutes) a client device can request.
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Set store_forward.history_return_window to default" ```shell title="Set store_forward.history_return_window to default"
meshtastic --set store_forward.history_return_window 0 meshtastic --set store_forward.history_return_window 0
``` ```
```shell title="Set store_forward.history_return_window to 1 day (1440 minutes)" ```shell title="Set store_forward.history_return_window to 1 day (1440 minutes)"
meshtastic --set store_forward.history_return_window 1440 meshtastic --set store_forward.history_return_window 1440
``` ```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
### Records ### 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. 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.
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Set store_forward.records to default (≈11,000 records)" ```shell title="Set store_forward.records to default (≈11,000 records)"
meshtastic --set store_forward.records 0 meshtastic --set store_forward.records 0
``` ```
```shell title="Set store_forward.records to 100 records" ```shell title="Set store_forward.records to 100 records"
meshtastic --set store_forward.records 100 meshtastic --set store_forward.records 100
``` ```
</TabItem>
</TabItem> <TabItem value="android">
<TabItem value="android">
:::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.
</TabItem>
<TabItem value="iOS">
:::info :::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
::: :::
</TabItem> </TabItem>
<TabItem value="iOS">
<TabItem value="web">
:::info :::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
::: :::
</TabItem> </TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs> </Tabs>
## Details ## Details
### How it works ### How it works