From 8bc5f2985b4fe43d0823bf31321200bb82bc1fa4 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:56:09 -0600 Subject: [PATCH] draft channel settings pages, work in progress --- .../software/settings/channel-advanced.md | 32 +++++++++++ website/docs/software/settings/channel.md | 54 +++++++++++++++++++ 2 files changed, 86 insertions(+) diff --git a/website/docs/software/settings/channel-advanced.md b/website/docs/software/settings/channel-advanced.md index 0dfd8632..1176b537 100644 --- a/website/docs/software/settings/channel-advanced.md +++ b/website/docs/software/settings/channel-advanced.md @@ -11,7 +11,39 @@ These settings are for advanced users only. If you don't know what you are doing ::: ## Overview + +Most + ## Settings + +| Setting | Acceptable Values | Default | +| :-----: | :---------------: | :-----: | +| bandwidth | | | +| channel_num | | | +| coding_rate | | | +| spread_factor | `7`, `8`, `9`, `10`, `11`, `12` | TODO | +| tx_power | `integer` (in dBm) | `0` | + +### bandwidth + +TODO + +### channel_num + +TODO + +### coding_rate + +TODO + +### spread_factor + +TODO + +### tx_power + +TODO + ## Examples ### Example TODO diff --git a/website/docs/software/settings/channel.md b/website/docs/software/settings/channel.md index 59a023e3..a5da8626 100644 --- a/website/docs/software/settings/channel.md +++ b/website/docs/software/settings/channel.md @@ -16,7 +16,58 @@ Channel settings are an integral part of the way your devices communicate across | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | +| downlink_enabled | `true`, `false` | `false` | +| id | | | +| modem_config | `Bw125Cr45Sf128`, `Bw500Cr45Sf128`, `Bw31_25Cr48Sf512`, `Bw125Cr48Sf4096` | TODO | +| name | | | +| psk | `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9` | `1` | | region | `Unset`, `US`, `EU433`, `EU865`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` | `Unset` | +| uplink_enabled | `true`, `false` | `false` | + +### downlink_enabled + +If `true`, messages seen on the internet will be forwarded to the local mesh through a gateway node. See [MQTT settings](mqtt) for more details. + +:::caution +This is in active development and not ready for casual users. Testing only. +::: + +### id + +TODO + +### modem_config + +| Setting | Name | Bandwidth | Coding Rate | Spread Factor | Speed | +| :-----: | :--: | :-------: | :---------: | :-----------: | :-----: | +| `Bw125Cr45Sf128` | Medium | 125 kHz | 4/5 | 7 = 128chips/symbol | 5.469 kbps | +| `Bw500Cr45Sf128` | ShortFast | 500 kHz | 4/5 | 7 = 128chips/symbol | 21.875 kbps | +| `Bw31_25Cr48Sf512` | LongAlt | 31.25 kHz | 4/8 | 9 = 512chips/symbol | 275 bps | +| `Bw125Cr48Sf4096` | LongSlow | 125 kHz | 4/8 | 12 = 4096chips/symbol | 183 bps | + +### name + +TODO + +### psk + + + + + +| Setting | Behavior | +| :-----: | :------: | +| `0` | Disable Encryption | +| `1` | Default Encryption | +| `2`-`10` | Default Encryption, except with 1-9 added to the last byte | + + + +| Setting | Behavior | +| :-----: | :------: | +| `none` | Disable Encryption | +| `default` | Default Encryption | +| `random` | TODO | ### region @@ -38,6 +89,9 @@ The `region` variable sets which region your radio is configured to work in. It For more details about `region` settings, you can see the source code [here](https://github.com/meshtastic/Meshtastic-device/blob/master/src/mesh/RadioInterface.cpp) ::: +### Uplink Enabled + +If `true`, messages on the mesh will be sent to the public internet by any gateway node. See [MQTT settings](mqtt) for more details. ## Examples