meshtastic/docs/software/settings/overview.md
2021-12-21 22:44:01 +11:00

3 KiB

id title sidebar_label slug
overview Overview Overview /settings

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Customization 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.

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 and if you're tech savvy or a radio head check out the advanced channel settings.

:::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.

WiFi Settings

Whether you're using the upcoming web interface or you're interested in broadcasting messages to/from the internet using MQTT, the WiFi settings are your first stop towards an IOT radio.

Examples

At the bottom of each setting page, 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'}, ]}>

:::note The CLI examples will require you to utilize the Commandline Interface that is available through Meshtastic-python. Installation instructions can be found here. :::

meshtastic --set region Unset

TODO