mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-21 03:25:51 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

improved settings overview page

Browse source
This commit is contained in:
Foster Irwin 2021-05-18 20:28:32 -06:00
parent 4b8e9b91a7
commit be33536721
1 changed files with 23 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
website/docs/software/settings/overview.md
View file

@ -7,11 +7,29 @@ slug: /settings
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
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.
## Overview
## First Steps
Cusomization of your settings is vital to configuring your own mesh. 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.
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.
## Settings
Below are some of the most common settings that a new user will want to become aquainted with, but it isn't an exhaustive list. Make sure to take a look at the sidebar for additional settings. If you find something missing or incorrect, please help us improve our docs by filing an issue, creating a pull request, or mentioning it in our forum.
### Channel Settings
Channel settings are very important, if channels are misconfigured between devices they won't be able to communicate! A freshly flashed device will use the default channel settings. Depending on your use case you may want to change your encryption using `psk`, your range of communication by setting one of the four pre-set bands using `modem_config`, or even just the name of your channel! Before you begin, don't forget to set your `region` correctly! Take a look at the [basic channel configuration](software/settings/channels) and if you're tech savvy or a radio head check out the [advanced channel settings](software/settings/channels-advanced).
:::note
It is very important that you set your device's `region` setting. This will ensure that you are operating within the legal limits for your area.
:::
### GPS Settings
For most, GPS is a really cool, desirable feature. Knowing where everyone on your local mesh is has some major advantages. However, it's possible you want to hide the location of a particular device (like a router mounted on your home). All of the settings related to GPS are located [here](software/settings/gps).
### WiFi Settings
Whether you're using the upcoming [web interface](software/web/web-app-software) or you're interested in broadcasting messages to/from the internet using [MQTT](software/settings/mqtt), the [WiFi settings](software/settings/wifi) are your first stop towards an IOT radio.
## Examples
@ -27,11 +45,10 @@ At the bottom of each setting page, examples will be available displaying how to
<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.
The CLI examples will require you to utilize the Commandline Interface that is available through Meshtastic-python. Installation instructions can be found [here](software/python/python-installation).
:::
```bash title="Example"
```bash title="Example - Set Region (an important first step!)"
meshtastic --set region Unset
```