meshtastic/docs/settings/router.mdx

84 lines
2.2 KiB
Plaintext
Raw Normal View History

2021-05-03 13:15:22 -07:00
---
id: router
title: Router Settings
sidebar_label: Router
---
2022-03-08 23:51:46 -08:00
2021-05-05 09:18:44 -07:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2021-05-03 13:15:22 -07:00
## Overview
## Settings
2022-03-08 23:51:46 -08:00
| Setting | Acceptable Values | Default |
| :-------: | :---------------: | :-----: |
| is_router | `true`, `false` | `false` |
2021-05-03 13:15:22 -07:00
### is_router
Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight)
#### Enable/Disable router mode
2022-03-08 23:51:46 -08:00
2021-05-05 09:18:44 -07:00
<Tabs
2022-03-08 23:51:46 -08:00
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="Enable router mode"
2022-03-08 23:51:46 -08:00
meshtastic --set is_router true
```
```shell title="Disable router mode"
2022-03-08 23:51:46 -08:00
meshtastic --set is_router false
```
2021-05-05 09:18:44 -07:00
</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.
:::
2021-05-05 09:18:44 -07:00
</TabItem>
</Tabs>
## Details
Toggling `is_router` changes your device settings in the following ways.
2022-03-08 23:51:46 -08:00
| Setting | `is_router` Default | Normal Default |
| :-----------------------: | :-----------------: | :------------: |
| `position_broadcast_secs` | 12 hours | 15 minutes |
| `wait_bluetooth_secs` | 1 | 60 |
| `mesh_sds_timeout_secs` | NODE_DELAY_FOREVER | 2 hours |
| `phone_sds_timeout_sec` | NODE_DELAY_FOREVER | 2 hours |
| `ls_secs` | 1 day | 5 minutes |
### Altered Behaviors
2022-03-08 23:51:46 -08:00
#### Screen Wake
2022-03-08 23:51:46 -08:00
#### Bluetooth