mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-21 08:37:35 -07:00
429dbac089
* Start of 1.2 EOL cleanup * initial docs updates * Move more 1.2 files * Move remaining 1.2 files * Fix links * Fix links * More links * The rest of the broken links * Missed a couple of links * Really last link * Links to the final 1.2 firmare and android app * add last flasher * fix gps_disabled * update enthusiast page * Delete 1.2 from apple apps * Fix error in module index
316 lines
8.1 KiB
Plaintext
316 lines
8.1 KiB
Plaintext
---
|
||
id: misc
|
||
title: 1.2 Miscellaneous Settings
|
||
sidebar_label: 1.2 Miscellaneous
|
||
---
|
||
|
||
import Tabs from '@theme/Tabs';
|
||
import TabItem from '@theme/TabItem';
|
||
|
||
## Overview
|
||
|
||
## Settings
|
||
|
||
| Setting | Acceptable Values | Default |
|
||
| :-----------------------: | :------------------------------------: | :-----: |
|
||
| auto_screen_carousel_secs | `integer` (seconds) | `0` |
|
||
| debug_log_enabled | `true`, `false` | `false` |
|
||
| factory_reset | `true`, `false` | `false` |
|
||
| ignore_incoming | `string` – list of node nums to ignore | `0` |
|
||
| hop_limit | `0`-`7` | `0` |
|
||
| serial_disabled | `true`, `false` | `false` |
|
||
|
||
### auto_screen_carousel_secs
|
||
|
||
Automatically toggles to the next page on the screen like a carousel, based the specified interval in seconds. Potentially useful for devices without user buttons.
|
||
|
||
#### Configure auto_screen_carousel_secs
|
||
|
||
<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 auto_screen_carousel_secs to default"
|
||
meshtastic --set auto_screen_carousel_secs 0
|
||
```
|
||
|
||
```shell title="Set auto_screen_carousel_secs to 120 seconds"
|
||
meshtastic --set auto_screen_carousel_secs 120
|
||
```
|
||
|
||
</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>
|
||
|
||
### debug_log_enabled
|
||
|
||
By default we turn off logging as soon as an API client connects (to keep shared serial link quiet and save bandwidth). Set this to true to leave the debug log outputting even when API is active.
|
||
|
||
#### Enable/Disable Debug Log
|
||
|
||
<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="Enable debug log"
|
||
meshtastic --set debug_log_enabled true
|
||
```
|
||
|
||
```shell title="Disable debug log"
|
||
meshtastic --set debug_log_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>
|
||
|
||
### factory_reset
|
||
|
||
This setting is never saved to disk, but if set, all device settings will be returned to factory defaults. (Region, serial number etc... will be preserved)
|
||
|
||
#### Factory reset
|
||
|
||
<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="Example - Factory reset"
|
||
meshtastic --set factory_reset true
|
||
```
|
||
|
||
</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>
|
||
|
||
### ignore_incoming
|
||
|
||
If true, radio should not try to be smart about what packets to queue to the phone bool keep_all_packets = 101; If true, we will try to capture all the packets sent on the mesh, not just the ones destined to our node. bool promiscuous_mode = 102; For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send dropped on receive (by router.cpp)
|
||
|
||
#### Enable/Disable ignore_incoming
|
||
|
||
<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="Enable ignore_incoming"
|
||
meshtastic --set ignore_incoming true
|
||
```
|
||
|
||
```shell title="Disable ignore_incoming"
|
||
meshtastic --set ignore_incoming 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>
|
||
|
||
### serial_disabled
|
||
|
||
If set, this will disable the SerialConsole by not initializing the StreamAPI.
|
||
|
||
#### Enable/Disable Serial
|
||
|
||
<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="Enable serial"
|
||
meshtastic --set serial_disabled false
|
||
```
|
||
|
||
```shell title="Disable serial"
|
||
meshtastic --set serial_disabled true
|
||
```
|
||
|
||
</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>
|
||
|
||
### hop_limit
|
||
|
||
Overrides the default number of hops a message will be passed. If not set, will default to 3 hops.
|
||
|
||
:::note
|
||
Meshtastic allows a maximum of 7 hops (this is a limit of the protocol). Setting a hop_limit of greater than 7 will be replaced with 7 on the device.
|
||
:::
|
||
|
||
#### Configure hop_limit
|
||
|
||
<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 hop_limit to default (3 hops)"
|
||
meshtastic --set hop_limit 0
|
||
```
|
||
|
||
```shell title="Set hop_limit to max (7 hops)"
|
||
meshtastic --set hop_limit 7
|
||
```
|
||
|
||
</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>
|