From fa757e1f2ce009c9d2aff8249610ed1d97d39191 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 11 May 2021 12:23:15 -0600 Subject: [PATCH 01/20] Rephrase overview based on meshtastic device wifi page. --- website/docs/software/settings/wifi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/software/settings/wifi.md b/website/docs/software/settings/wifi.md index d434ca02..747deefe 100644 --- a/website/docs/software/settings/wifi.md +++ b/website/docs/software/settings/wifi.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; ## Overview -WiFi support can be configured as either a WiFi Client or a Software Access Point (SoftAP). The WiFi client will connect to your existing WiFi network, as opposed to the SoftAP which will broadcast a new SSID and Password. See below for more details. +The ESP32 based devices have the ability to connect to WiFi as a client and also are able to create a software based access point (SoftAP). See below for more details. :::note The device can be either a WiFi client or a software access point. It **cannot** operate as both at the same time. From 3893f59f600290fea1fbbfb682f76c8dd666b1d2 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 11 May 2021 12:23:39 -0600 Subject: [PATCH 02/20] add SSL key note from meshtastic device wifi page --- website/docs/software/settings/wifi.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/docs/software/settings/wifi.md b/website/docs/software/settings/wifi.md index 747deefe..3e1d7210 100644 --- a/website/docs/software/settings/wifi.md +++ b/website/docs/software/settings/wifi.md @@ -14,6 +14,10 @@ The ESP32 based devices have the ability to connect to WiFi as a client and also The device can be either a WiFi client or a software access point. It **cannot** operate as both at the same time. ::: +:::note +The first time your device restarts after enabling the WiFi access point, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse. +::: + ## Settings | Setting | Acceptable Values | Default | From 4b8e9b91a75329fa6e0f1b7541d8f9b2cfbf8aa0 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:27:21 -0600 Subject: [PATCH 03/20] created advanced settings page --- .../software/settings/channel-advanced.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 website/docs/software/settings/channel-advanced.md diff --git a/website/docs/software/settings/channel-advanced.md b/website/docs/software/settings/channel-advanced.md new file mode 100644 index 00000000..14a110ee --- /dev/null +++ b/website/docs/software/settings/channel-advanced.md @@ -0,0 +1,35 @@ +--- +id: channel-advanced +title: Channel Settings - Advanced +sidebar_label: Channel - Advanced +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::caution +These settings are for advanced users only. If you don't know what you are doing you could damage your radio or break local radio laws. Proceed with caution. +::: + +## Overview +## Settings +## Examples + +### Example TODO + + + + TODO + + + + + TODO + + + From be3353672106e15fbec8d017bcce73cb0600cf76 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:28:32 -0600 Subject: [PATCH 04/20] improved settings overview page --- website/docs/software/settings/overview.md | 29 +++++++++++++++++----- 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/website/docs/software/settings/overview.md b/website/docs/software/settings/overview.md index 22fb1d2c..680e5ee0 100644 --- a/website/docs/software/settings/overview.md +++ b/website/docs/software/settings/overview.md @@ -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 :::note - -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 ``` From 66127328e6f1da58fa8b3dc9568c8492839e5b27 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:36:05 -0600 Subject: [PATCH 05/20] create advanced section --- website/docs/software/settings/channel-advanced.md | 2 +- website/sidebars.js | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/website/docs/software/settings/channel-advanced.md b/website/docs/software/settings/channel-advanced.md index 14a110ee..0dfd8632 100644 --- a/website/docs/software/settings/channel-advanced.md +++ b/website/docs/software/settings/channel-advanced.md @@ -1,7 +1,7 @@ --- id: channel-advanced title: Channel Settings - Advanced -sidebar_label: Channel - Advanced +sidebar_label: Channel --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/sidebars.js b/website/sidebars.js index bbdedc4e..6c86d55c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -119,8 +119,11 @@ module.exports = { "software/settings/serial-plugin", "software/settings/store-and-forward-plugin", ], + "Advanced": [ + "software/settings/channel-advanced", + "software/settings/misc", + ], }, - "software/settings/misc", ] }, ], From bdd37d484852e4663832dd0f4b371298b2c205eb Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:37:23 -0600 Subject: [PATCH 06/20] remove details section from setting pages with no details --- website/docs/software/settings/channel.md | 1 - website/docs/software/settings/gps.md | 2 -- website/docs/software/settings/misc.md | 4 ---- website/docs/software/settings/power.md | 2 -- 4 files changed, 9 deletions(-) diff --git a/website/docs/software/settings/channel.md b/website/docs/software/settings/channel.md index 76d04857..59a023e3 100644 --- a/website/docs/software/settings/channel.md +++ b/website/docs/software/settings/channel.md @@ -38,7 +38,6 @@ 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) ::: -## Details ## Examples diff --git a/website/docs/software/settings/gps.md b/website/docs/software/settings/gps.md index c2ce6709..638915b0 100644 --- a/website/docs/software/settings/gps.md +++ b/website/docs/software/settings/gps.md @@ -77,8 +77,6 @@ How often our position is sent to the mesh (but only if it has changed significa The gps updates will be sent out every `position_broadcast_secs`, with either the actual gps location, or an empty location if no gps fix was achieved. This defaults to broadcast every 15 minutes. -## Details - ## Examples ### Disable Location Sharing diff --git a/website/docs/software/settings/misc.md b/website/docs/software/settings/misc.md index 85b4c9ab..b0b2a4f6 100644 --- a/website/docs/software/settings/misc.md +++ b/website/docs/software/settings/misc.md @@ -41,10 +41,6 @@ If true, radio should not try to be smart about what packets to queue to the pho If set, this will disable the SerialConsole by not initilizing the StreamAPI. -## Details - - - ## Examples Date: Tue, 18 May 2021 20:48:10 -0600 Subject: [PATCH 07/20] fixed links --- website/docs/software/settings/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/software/settings/overview.md b/website/docs/software/settings/overview.md index 680e5ee0..e79592d6 100644 --- a/website/docs/software/settings/overview.md +++ b/website/docs/software/settings/overview.md @@ -17,7 +17,7 @@ Below are some of the most common settings that a new user will want to become a ### 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). +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). :::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. From 5e111df7107b0b3ed3e2c2aedf3565a2a2d17cc1 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:52:55 -0600 Subject: [PATCH 08/20] too much overview --- website/docs/software/settings/overview.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/website/docs/software/settings/overview.md b/website/docs/software/settings/overview.md index e79592d6..538dd4cf 100644 --- a/website/docs/software/settings/overview.md +++ b/website/docs/software/settings/overview.md @@ -7,8 +7,6 @@ slug: /settings import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Overview - 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. ## Settings From 5a98e0c82d4bba1022c291228a1124ab249e8670 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:54:51 -0600 Subject: [PATCH 09/20] typo --- website/docs/software/settings/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/software/settings/overview.md b/website/docs/software/settings/overview.md index 538dd4cf..94749390 100644 --- a/website/docs/software/settings/overview.md +++ b/website/docs/software/settings/overview.md @@ -7,7 +7,7 @@ slug: /settings import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -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. +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 From 8bc5f2985b4fe43d0823bf31321200bb82bc1fa4 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 18 May 2021 20:56:09 -0600 Subject: [PATCH 10/20] 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 From b13850d4685414a842f3d8343822cf0b4b28c1c4 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 21 May 2021 06:55:52 -0600 Subject: [PATCH 11/20] added channel details and protobuf comments to scaffold new descriptions --- website/docs/software/settings/channel.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/website/docs/software/settings/channel.md b/website/docs/software/settings/channel.md index a5da8626..e5e830d6 100644 --- a/website/docs/software/settings/channel.md +++ b/website/docs/software/settings/channel.md @@ -17,9 +17,9 @@ Channel settings are an integral part of the way your devices communicate across | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | downlink_enabled | `true`, `false` | `false` | -| id | | | +| id | `integer` | `0` | | modem_config | `Bw125Cr45Sf128`, `Bw500Cr45Sf128`, `Bw31_25Cr48Sf512`, `Bw125Cr48Sf4096` | TODO | -| name | | | +| name | `string` | `""` | | 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` | @@ -34,7 +34,7 @@ This is in active development and not ready for casual users. Testing only. ### id -TODO + ### modem_config @@ -47,7 +47,7 @@ TODO ### name -TODO + ### psk @@ -55,6 +55,8 @@ TODO + + | Setting | Behavior | | :-----: | :------: | | `0` | Disable Encryption | @@ -63,6 +65,8 @@ TODO + + | Setting | Behavior | | :-----: | :------: | | `none` | Disable Encryption | From 7eb749515b0eaa1cda3deb2fe7bfdb1242b94bfb Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 21 May 2021 06:59:18 -0600 Subject: [PATCH 12/20] added additional GPS examples --- website/docs/software/settings/gps.md | 85 +++++++++++++++++++++++++-- 1 file changed, 79 insertions(+), 6 deletions(-) diff --git a/website/docs/software/settings/gps.md b/website/docs/software/settings/gps.md index 638915b0..45617e0b 100644 --- a/website/docs/software/settings/gps.md +++ b/website/docs/software/settings/gps.md @@ -35,7 +35,7 @@ If you wish to disable any GPS features, see below for more information. ### fixed_position -If set, this node is at a fixed position. The device will generate GPS position updates at the regular `gps_update_interval`, but use whatever the last lat/lon/alt it saved for the node. The lat/lon/alt can be set by an internal GPS or with the help of the mobile device's GPS. +If set, this node is at a fixed position. The device will generate GPS updates at the regular `gps_update_interval`, but use whatever the last lat/lon/alt it saved for the node. The lat/lon/alt can be set by an internal GPS or with the help of the mobile device's GPS. ### gps_attempt_time @@ -79,6 +79,32 @@ The gps updates will be sent out every `position_broadcast_secs`, with either th ## Examples +### Disable GPS Completely + + + + ```bash title="Disable GPS Completely" + meshtastic --set gps_operation GpsOpDisabled + ``` + + + + + TODO + + + + +:::note +`gps_operation GpsOpTimeOnly` is prefered to `gps_operation GpsOPDisabled` because it allows the device to get a highres time. +::: + ### Disable Location Sharing - ```bash title="Disable GPS Completely" - meshtastic --set gps_operation GpsOpDisabled + ```bash title="Set Fixed Position" + meshtastic --set fixed_position true ``` @@ -129,5 +154,53 @@ Disabling location sharing does not disable the GPS functionality, only the loca :::note -`gps_operation GpsOpTimeOnly` is prefered to `gps_operation GpsOPDisabled` because it allows the device to get a highres time. +The device will continue to aquire GPS coordinates according to the `gps_update_interval`, but will use the last saved coordinates as its fixed point. +::: + +### Set Fixed Position – Specify Lat/Lon + + + + ```bash title="Set Fixed Position" + meshtastic --setlat 37.8651 --setlon -119.5383 + ``` + + + + + TODO + + + + +### Unset Fixed Position + + + + ```bash title="Unset Fixed Position" + meshtastic --set fixed_position false + ``` + + + + + TODO + + + + +:::note +It may take some time to see that the change has taken effect. The GPS location is updated according to the value specified on `gps_update_interval` and the mesh will be notified of the new position in relation to the `position_broadcast_secs` value. ::: From 2643d09c67276944520c55032f95b3a1a8decd28 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 21 May 2021 10:57:52 -0600 Subject: [PATCH 13/20] added channel examples --- website/docs/software/settings/channel.md | 107 +++++++++++++++++++++- 1 file changed, 106 insertions(+), 1 deletion(-) diff --git a/website/docs/software/settings/channel.md b/website/docs/software/settings/channel.md index e5e830d6..f11c649d 100644 --- a/website/docs/software/settings/channel.md +++ b/website/docs/software/settings/channel.md @@ -93,12 +93,115 @@ 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 +### 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 +### Set Channel ID + + + + ```bash title="Set channel ID" + meshtastic --ch-set id 1234 + ``` + + + + + TODO + + + + +:::note +The channel `id` must be an integer. +::: + +### Set Channel Name + + + + ```bash title="Set channel name" + meshtastic --ch-set name MyChannel + ``` + + ```bash title="Set channel name with spaces" + meshtastic --ch-set name "My Channel" + ``` + + + + TODO + + + + +:::note +A channel `id` must be set in order to name a channel. +::: + +### Set Encryption + + + + ```bash title="Set psk" + meshtastic --ch-set psk default + ``` + + + + + + TODO + + + + +### Set Modem + + + + ```bash title="Set Modem - LongSlow" + meshtastic --ch-set modem_config Bw125Cr48Sf4096 + ``` + + + + TODO + + + + +:::note +See [`modem_config`](#modem_config) for details. For advanced modem configuration, see [Channel Settings - Advanced](software/settings/channel-advanced). +::: + ### Set Region + + From d0ffb2f3fbee0e46c359b3f9d3eb95f46599c999 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 21 May 2021 11:07:46 -0600 Subject: [PATCH 14/20] link --- website/docs/software/settings/channel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/software/settings/channel.md b/website/docs/software/settings/channel.md index f11c649d..4ec9b606 100644 --- a/website/docs/software/settings/channel.md +++ b/website/docs/software/settings/channel.md @@ -199,7 +199,7 @@ A channel `id` must be set in order to name a channel. :::note -See [`modem_config`](#modem_config) for details. For advanced modem configuration, see [Channel Settings - Advanced](software/settings/channel-advanced). +See [`modem_config`](#modem_config) for details. For advanced modem configuration, see [Channel Settings - Advanced](channel-advanced). ::: ### Set Region From 1cd2d33fa0a5d3d48df18a52a243b2a3ce31f5c5 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 21 May 2021 12:11:55 -0600 Subject: [PATCH 15/20] added note to encryption example --- website/docs/software/settings/channel.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/docs/software/settings/channel.md b/website/docs/software/settings/channel.md index 4ec9b606..c24e51a3 100644 --- a/website/docs/software/settings/channel.md +++ b/website/docs/software/settings/channel.md @@ -177,6 +177,10 @@ A channel `id` must be set in order to name a channel. +:::note +See [`psk`](#psk) for details. +::: + ### Set Modem Date: Thu, 27 May 2021 10:19:13 -0600 Subject: [PATCH 16/20] added debug log example seen on forum --- website/docs/software/settings/misc.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/website/docs/software/settings/misc.md b/website/docs/software/settings/misc.md index b0b2a4f6..e23c2cfd 100644 --- a/website/docs/software/settings/misc.md +++ b/website/docs/software/settings/misc.md @@ -23,7 +23,7 @@ import TabItem from '@theme/TabItem'; ### debug_log_enabled -By default we turn off logging as soon as an API client connects (to keep shared serial link quiet). Set this to true to leave the debug log outputting even when API is active. +By default we turn off logging as soon as an API client connects (to keep shared serial link quiet and save bandwidth). Set this to true to leave the debug log outputting even when API is active. ### factory_reset @@ -43,6 +43,8 @@ If set, this will disable the SerialConsole by not initilizing the StreamAPI. ## Examples +### Enable debug log + - TODO + ``` + meshtastic --set debug_log_enabled true + ``` From 427a58f8c225fddcfcb3a930557b269b662e7c2a Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 27 May 2021 10:55:09 -0600 Subject: [PATCH 17/20] cli examples work in progress --- website/docs/software/settings/misc.md | 104 ++++++++++++++++++++++++- 1 file changed, 103 insertions(+), 1 deletion(-) diff --git a/website/docs/software/settings/misc.md b/website/docs/software/settings/misc.md index e23c2cfd..de1375dd 100644 --- a/website/docs/software/settings/misc.md +++ b/website/docs/software/settings/misc.md @@ -43,7 +43,7 @@ If set, this will disable the SerialConsole by not initilizing the StreamAPI. ## Examples -### Enable debug log +### debug_log_enabled + ```bash title="Example - Disable debug log" + meshtastic --set debug_log_enabled false ``` +:::note +`debug_log_enabled` set to `false` is the default behavior. +::: + ```bash title="Example - Enable debug log" meshtastic --set debug_log_enabled true ``` @@ -65,3 +71,99 @@ If set, this will disable the SerialConsole by not initilizing the StreamAPI. + +### factory_reset + + + + + ```bash title="Example - Factory reset" + meshtastic --set factory_reset true + ``` + + + + + TODO + + + + +### frequency_offset + + + + + TODO + + + + + TODO + + + + + +### ignore_incoming + + + + + TODO + + + + + TODO + + + + + +### serial_disabled + + + + + ```bash title="Example - Disable serial" + meshtastic --set disable_serial true + ``` + ```bash title="Example - Enable serial" + meshtastic --set disable_serial false + ``` +:::note +`disable_serial` set to `false` is the default behavior. +::: + + + + + TODO + + + From b3e16d720178956be8115f07d4196e99678deee3 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 27 May 2021 12:29:28 -0600 Subject: [PATCH 18/20] reconfigured examples --- website/docs/software/settings/misc.md | 69 ++++++++++++++++++++------ 1 file changed, 55 insertions(+), 14 deletions(-) diff --git a/website/docs/software/settings/misc.md b/website/docs/software/settings/misc.md index de1375dd..4e4063be 100644 --- a/website/docs/software/settings/misc.md +++ b/website/docs/software/settings/misc.md @@ -43,7 +43,11 @@ If set, this will disable the SerialConsole by not initilizing the StreamAPI. ## Examples -### debug_log_enabled +### Debug Log - Disable + +:::note +`debug_log_enabled` set to `false` is the default behavior. +::: + + + TODO + + + + +### Debug Log - Enable + + + + ```bash title="Example - Enable debug log" meshtastic --set debug_log_enabled true ``` @@ -72,7 +92,7 @@ If set, this will disable the SerialConsole by not initilizing the StreamAPI. -### factory_reset +### Factory reset -### frequency_offset +### Frequency Offset -### ignore_incoming +### Ignore Incoming -### serial_disabled +### Serial - Disable + + + TODO + + + + +### Serial - Enable + +:::note +`disable_serial` set to `false` is the default behavior. +::: + + + + + ```bash title="Example - Enable serial" + meshtastic --set disable_serial false + ``` From 820d9ea7f3a875db9d511a2b1674ed40a9ce4cf9 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 4 Jun 2021 09:59:11 -0600 Subject: [PATCH 19/20] added placeholders. need to add admonitions, these are advanced settings --- .../software/settings/channel-advanced.md | 87 ++++++++++++++++++- 1 file changed, 86 insertions(+), 1 deletion(-) diff --git a/website/docs/software/settings/channel-advanced.md b/website/docs/software/settings/channel-advanced.md index 1176b537..69a02a67 100644 --- a/website/docs/software/settings/channel-advanced.md +++ b/website/docs/software/settings/channel-advanced.md @@ -46,7 +46,92 @@ TODO ## Examples -### Example TODO +### Set Bandwidth + + + + + TODO + + + + + TODO + + + + +### Set Channel Number + + + + + TODO + + + + + TODO + + + + +### Set Coding Rate + + + + + TODO + + + + + TODO + + + + +### Set Spread Factor + + + + + TODO + + + + + TODO + + + + +### Set TX Power + Date: Fri, 4 Jun 2021 09:59:23 -0600 Subject: [PATCH 20/20] added example to router --- website/docs/software/settings/router.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/website/docs/software/settings/router.md b/website/docs/software/settings/router.md index e73da6ee..d072e8e9 100644 --- a/website/docs/software/settings/router.md +++ b/website/docs/software/settings/router.md @@ -40,6 +40,7 @@ Toggling `is_router` changes your device settings in the following ways. ## Examples +### Set Router - TODO + ```bash title="Set Router" + meshtastic --set is_router true + ```