This commit is contained in:
Foster Irwin 2021-05-05 10:18:44 -06:00
parent f736a36718
commit 73d1d8a55a
13 changed files with 418 additions and 52 deletions

View file

@ -3,6 +3,8 @@ id: channel
title: Channel Settings title: Channel Settings
sidebar_label: Channel sidebar_label: Channel
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -38,7 +40,26 @@ For more details about `region` settings, you can see the source code [here](htt
## Details ## Details
### CLI Examples ## Examples
```bash title="Set Region"
meshtastic --set region Unset ### Set Region
``` <Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Set Region"
meshtastic --set region Unset
```
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>

View file

@ -3,6 +3,9 @@ id: environmental-measurement-plugin
title: Environmental Measurement Plugin Settings title: Environmental Measurement Plugin Settings
sidebar_label: Environmental Measurement Plugin sidebar_label: Environmental Measurement Plugin
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -61,6 +64,23 @@ Interval in seconds of how often we should try to send our measurements to the m
<!--- TODO ---> <!--- TODO --->
### CLI Examples ## Examples
<!--- TODO ---> <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>

View file

@ -3,6 +3,9 @@ id: external-notification-plugin
title: External Notification Plugin Settings title: External Notification Plugin Settings
sidebar_label: External Notification Plugin sidebar_label: External Notification Plugin
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -47,6 +50,23 @@ Enables the plugin
<!--- TODO ---> <!--- TODO --->
### CLI Examples ## Examples
<!--- TODO ---> <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>

View file

@ -3,6 +3,9 @@ id: gps
title: GPS Settings title: GPS Settings
sidebar_label: GPS sidebar_label: GPS
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::caution :::caution
Altering/disabling the GPS functionality does not mean that you will be unable to be found. Via triangulation of your radio, location may be given up to someone if they are determined enough. Altering/disabling the GPS functionality does not mean that you will be unable to be found. Via triangulation of your radio, location may be given up to someone if they are determined enough.
::: :::
@ -76,18 +79,57 @@ The gps updates will be sent out every `position_broadcast_secs`, with either th
## Details ## Details
### CLI Examples ## Examples
### Disable Location Sharing
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Disable Location Sharing"
meshtastic --set location_share LocDisabled
```
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>
```bash title="Disable Location Sharing"
meshtastic --set location_share LocDisabled
```
:::note :::note
Disabling location sharing does not disable the GPS functionality, only the location sharing via the mesh. Disabling location sharing does not disable the GPS functionality, only the location sharing via the mesh.
::: :::
```bash title="Disable GPS Completely"
meshtastic --set gps_operation GpsOpDisabled ### Disable GPS Completely
``` <Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Disable GPS Completely"
meshtastic --set gps_operation GpsOpDisabled
```
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>
:::note :::note
`gps_operation GpsOpTimeOnly` is prefered to `gps_operation GpsOPDisabled` because it allows the device to get a highres time. `gps_operation GpsOpTimeOnly` is prefered to `gps_operation GpsOPDisabled` because it allows the device to get a highres time.
::: :::

View file

@ -3,6 +3,9 @@ id: misc
title: Miscellaneous Settings title: Miscellaneous Settings
sidebar_label: Miscellaneous sidebar_label: Miscellaneous
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -42,6 +45,23 @@ If set, this will disable the SerialConsole by not initilizing the StreamAPI.
<!--- TODO ---> <!--- TODO --->
### CLI Examples ## Examples
<!--- TODO ---> <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>

View file

@ -3,6 +3,9 @@ id: mqtt
title: MQTT Settings title: MQTT Settings
sidebar_label: MQTT sidebar_label: MQTT
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::note :::note
This is still under development, use at your own risk. Report any bugs you see by creating an issue on the [meshtastic/Meshtastic-device](https://github.com/meshtastic/Meshtastic-device) repository or comment on our forum. This is still under development, use at your own risk. Report any bugs you see by creating an issue on the [meshtastic/Meshtastic-device](https://github.com/meshtastic/Meshtastic-device) repository or comment on our forum.
::: :::
@ -44,6 +47,23 @@ This is a channel specific setting. If your channel has this set to `true` and y
<!--- TODO ---> <!--- TODO --->
### CLI Examples ## Examples
<!--- TODO ---> <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>

View file

@ -4,13 +4,42 @@ title: Overview
sidebar_label: Overview sidebar_label: Overview
slug: /settings slug: /settings
--- ---
<!--- TODO Add link once CLI page is completed ---> import Tabs from '@theme/Tabs';
:::note import TabItem from '@theme/TabItem';
Each page will include examples using the Command Line Interface (CLI), for more information on how to install and use the CLI, view the CLI documentation.
:::
Changing settings is currently most reliably done using the Commandline Interface available within `Meshtastic-python`. Setting support is being added to all other methods of interfacing with your device. Changing settings is currently most reliably done using the Commandline Interface available within `Meshtastic-python`. Setting support is being added to all other methods of interfacing with your device.
## First Steps ## First Steps
If you've just flashed your device, you'll want to make sure to set your region first. Every freshly flashed device will have the same default channel settings. If you ever want to return your device to all defaults If you've just flashed your device, you'll want to make sure to set your region first. Every freshly flashed device will have the same default channel settings. If you ever want to return your device to all defaults.
## Examples
At the bottom of each setting page, various examples will be available displaying how to adjust settings using the various platforms available to interface with your device. The examples will look like this:
### Introducing Examples
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
:::note
<!--- TODO add link --->
The CLI examples will require you to utilize the Commandline Interface that is available through Meshtastic-python. Installation instructions can be found here.
:::
Examples will look like this:
```bash title="Example"
meshtastic --set region Unset
```
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>

View file

@ -3,6 +3,9 @@ id: power
title: Power Settings title: Power Settings
sidebar_label: Power sidebar_label: Power
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -87,4 +90,23 @@ Power management state machine option. See the [power page](../software/other/po
## Details ## Details
### CLI Examples ## 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>

View file

@ -3,6 +3,9 @@ id: range-test-plugin
title: Range Test Plugin Settings title: Range Test Plugin Settings
sidebar_label: Range Test Plugin sidebar_label: Range Test Plugin
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -62,14 +65,51 @@ http://198.168.0.X/static/rangetest.csv
| Medium | 15 | | Medium | 15 |
| Short Fast | 15 | | Short Fast | 15 |
### CLI Examples ## Examples
```bash title="Example - Sender Node" ### Sender Node
meshtastic --set range_test_plugin_enabled true <Tabs
meshtastic --set range_test_plugin_sender 60 groupId="settings"
``` defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Example - Receiver Node" ```bash title="Example - Sender Node"
meshtastic --set range_test_plugin_enabled true meshtastic --set range_test_plugin_enabled true
meshtastic --set range_test_plugin_save true meshtastic --set range_test_plugin_sender 60
``` ```
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>
### Receiver Node
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Example - Receiver Node"
meshtastic --set range_test_plugin_enabled true
meshtastic --set range_test_plugin_save true
```
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>

View file

@ -3,6 +3,9 @@ id: router
title: Router Settings title: Router Settings
sidebar_label: Router sidebar_label: Router
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -35,4 +38,23 @@ Toggling `is_router` changes your device settings in the following ways.
#### Screen Wake #### Screen Wake
#### Bluetooth #### Bluetooth
### CLI Examples ## 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>

View file

@ -3,6 +3,9 @@ id: serial-plugin
title: Serial Plugin Settings title: Serial Plugin Settings
sidebar_label: Serial Plugin sidebar_label: Serial Plugin
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -45,4 +48,23 @@ Enables the plugin.
## Details ## Details
### CLI Examples ## 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>

View file

@ -3,6 +3,9 @@ id: store-and-forward-plugin
title: Store and Forward Settings title: Store and Forward Settings
sidebar_label: Store and Forward sidebar_label: Store and Forward
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -31,4 +34,23 @@ Enables the plugin.
## Details ## Details
### CLI Examples ## 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>

View file

@ -3,6 +3,8 @@ id: wifi
title: WiFi Settings title: WiFi Settings
sidebar_label: WiFi sidebar_label: WiFi
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview ## Overview
@ -20,12 +22,6 @@ The device can be either a WiFi client or a software access point. It **cannot**
| wifi_password | string | `""` | | wifi_password | string | `""` |
| wifi_ssid | string | `""` | | wifi_ssid | string | `""` |
:::note
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
```bash title="Example with spaces"
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
```
:::
:::note :::note
`wifi_ssid` & `wifi_password` are both **case sensitive** values. `wifi_ssid` & `wifi_password` are both **case sensitive** values.
::: :::
@ -65,20 +61,90 @@ With `wifi_ssid` & `wifi_password` populated, the device will now to connect to
To disable WiFi completely, set `wifi_ap_mode` to `false`, and both `wifi_ssid` & `wifi_password` to an empty string `""`. To disable WiFi completely, set `wifi_ap_mode` to `false`, and both `wifi_ssid` & `wifi_password` to an empty string `""`.
### CLI Examples ## Examples
```bash title="Example - Enabling WiFi"
meshtastic --set wifi_ap_mode false --set wifi_ssid mywifissid --set wifi_password mywifipassword ### Enable WiFi (as client)
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Enabling WiFi Client"
meshtastic --set wifi_ap_mode false --set wifi_ssid mywifissid --set wifi_password mywifipassword
```
:::note
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
```bash title="Example with spaces"
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
``` ```
:::
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>
In the above example, the device will join a network with the SSID `mywifissid` and the password `mywifipassword`. In the above example, the device will join a network with the SSID `mywifissid` and the password `mywifipassword`.
```bash title="Example - Disabling WiFi" ### Enable WiFi (as SoftAP)
meshtastic --set wifi_ap_mode false --set wifi_ssid "" --set wifi_password "" <Tabs
``` groupId="settings"
In the above example, the device will disable WiFi. defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Software Access Point Example" ```bash title="Software Access Point Example"
meshtastic --set wifi_ap_mode true --set wifi_ssid mywifissid --set wifi_password mywifipassword meshtastic --set wifi_ap_mode true --set wifi_ssid mywifissid --set wifi_password mywifipassword
```
:::note
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
```bash title="Example with spaces"
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
``` ```
:::
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>
In the above example, the device will broadcast a network with the SSID `mywifissid` and the password `mywifipassword`. In the above example, the device will broadcast a network with the SSID `mywifissid` and the password `mywifipassword`.
### Disable WiFi Completely
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Example - Disabling WiFi"
meshtastic --set wifi_ap_mode false --set wifi_ssid "" --set wifi_password ""
```
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>