Merge pull request #253 from jfirwin/move-settings

move settings folder
This commit is contained in:
Foster Irwin 2022-02-21 17:26:13 -07:00 committed by GitHub
commit 35e2bebdf9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 25 additions and 25 deletions

View file

@ -94,7 +94,7 @@ Given our use-case for the initial release, most of our protocol is built around
If any mesh nodes see a packet with a HopLimit other than zero, it will decrement that HopLimit and attempt retransmission on behalf of the original sending node. If any mesh nodes see a packet with a HopLimit other than zero, it will decrement that HopLimit and attempt retransmission on behalf of the original sending node.
:::note :::note
A node being in router mode does **not** currently change this behavior, but is intended to be used for future versions of the meshing algorithm. For an explanation of what router mode currently does, see [settings](/docs/software/settings/router#enabledisable-router-mode). A node being in router mode does **not** currently change this behavior, but is intended to be used for future versions of the meshing algorithm. For an explanation of what router mode currently does, see [settings](/docs/settings/router#enabledisable-router-mode).
::: :::
### Layer 4: DSR for Multi-Hop Unicast Messaging ### Layer 4: DSR for Multi-Hop Unicast Messaging

View file

@ -15,7 +15,7 @@ Below are some of the most common settings that a new user will want to become a
### Channel Settings ### 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/channel) and if you're tech savvy or a radio head check out the [advanced channel settings](software/settings/channel-advanced). 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](settings/channel) and if you're tech savvy or a radio head check out the [advanced channel settings](settings/channel-advanced).
:::note :::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. 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.
@ -23,11 +23,11 @@ It is very important that you set your device's `region` setting. This will ensu
### GPS Settings ### 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). 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](settings/gps).
### WiFi Settings ### 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. 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](settings/mqtt), the [WiFi settings](settings/wifi) are your first stop towards an IoT radio.
## Examples ## Examples

View file

@ -97,7 +97,7 @@ module.exports = {
], ],
"Additional Documentation": [ "Additional Documentation": [
{type: "ref", id: "getting-started/overview"}, {type: "ref", id: "getting-started/overview"},
{type: "ref", id: "software/settings/overview"}, {type: "ref", id: "settings/overview"},
{type: "ref", id: "hardware/overview"}, {type: "ref", id: "hardware/overview"},
{type: "ref", id: "developers/overview"}, {type: "ref", id: "developers/overview"},
{type: "ref", id: "about-documentation/overview"}, {type: "ref", id: "about-documentation/overview"},
@ -128,27 +128,27 @@ module.exports = {
], ],
"Device Settings": [ "Device Settings": [
"software/settings/overview", "settings/overview",
"software/settings/channel", "settings/channel",
"software/settings/gps", "settings/gps",
"software/settings/ham", "settings/ham",
"software/settings/mqtt", "settings/mqtt",
"software/settings/power", "settings/power",
"software/settings/router", "settings/router",
"software/settings/wifi", "settings/wifi",
{ {
Plugins: [ Plugins: [
"software/settings/canned-message-plugin", "settings/canned-message-plugin",
"software/settings/environmental-measurement-plugin", "settings/environmental-measurement-plugin",
"software/settings/external-notification-plugin", "settings/external-notification-plugin",
"software/settings/range-test-plugin", "settings/range-test-plugin",
"software/settings/rotary-encoder-plugin", "settings/rotary-encoder-plugin",
"software/settings/serial-plugin", "settings/serial-plugin",
"software/settings/store-and-forward-plugin", "settings/store-and-forward-plugin",
], ],
Advanced: [ Advanced: [
"software/settings/channel-advanced", "settings/channel-advanced",
"software/settings/misc", "settings/misc",
], ],
}, },
], ],
@ -187,7 +187,7 @@ module.exports = {
], ],
"Additional Documentation": [ "Additional Documentation": [
{type: "ref", id: "getting-started/overview"}, {type: "ref", id: "getting-started/overview"},
{type: "ref", id: "software/settings/overview"}, {type: "ref", id: "settings/overview"},
{type: "ref", id: "software/overview"}, {type: "ref", id: "software/overview"},
{type: "ref", id: "developers/overview"}, {type: "ref", id: "developers/overview"},
{type: "ref", id: "about-documentation/overview"}, {type: "ref", id: "about-documentation/overview"},
@ -244,7 +244,7 @@ module.exports = {
], ],
"Additional Documentation": [ "Additional Documentation": [
{type: "ref", id: "getting-started/overview"}, {type: "ref", id: "getting-started/overview"},
{type: "ref", id: "software/settings/overview"}, {type: "ref", id: "settings/overview"},
{type: "ref", id: "hardware/overview"}, {type: "ref", id: "hardware/overview"},
{type: "ref", id: "software/overview"}, {type: "ref", id: "software/overview"},
{type: "ref", id: "legal/overview"}, {type: "ref", id: "legal/overview"},
@ -259,7 +259,7 @@ module.exports = {
], ],
"Additional Documentation": [ "Additional Documentation": [
{type: "ref", id: "getting-started/overview"}, {type: "ref", id: "getting-started/overview"},
{type: "ref", id: "software/settings/overview"}, {type: "ref", id: "settings/overview"},
{type: "ref", id: "hardware/overview"}, {type: "ref", id: "hardware/overview"},
{type: "ref", id: "software/overview"}, {type: "ref", id: "software/overview"},
{type: "ref", id: "developers/overview"}, {type: "ref", id: "developers/overview"},