From 23551a6248800184678fac91a3b9e4a67b7b1f06 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 4 Feb 2022 16:13:41 -0700 Subject: [PATCH 01/26] add downlink_enabled example --- docs/software/settings/mqtt.md | 49 ++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 94bc0ec7..b2fc7d5d 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -37,6 +37,55 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages from the MQTT server specified [here](#mqtt_server) to the mesh from this device. +#### Enable/Disable downlink_enabled + + + + ```bash title="Enable downlink_enabled on PRIMARY channel" + meshtastic --ch-set downlink_enabled true --ch-index 0 + ``` + ```bash title="Disable downlink_enabled on PRIMARY channel" + meshtastic --ch-set downlink_enabled false --ch-index 0 + ``` + ```bash title="Enable downlink_enabled on OTHER channel" + meshtastic --ch-set downlink_enabled true --ch-index 1 + ``` + ```bash title="Disable downlink_enabled on OTHER channel" + meshtastic --ch-set downlink_enabled false --ch-index 1 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### mqtt_disabled If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as `uplink_enabled` or `downlink_enabled`. But if this flag is set, all MQTT features will be disabled and no servers will be contacted. From f220d78af4ba212de15c4f43021f9a7f95e65256 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 4 Feb 2022 16:20:10 -0700 Subject: [PATCH 02/26] Add example for uplink_enabled --- docs/software/settings/mqtt.md | 49 ++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index b2fc7d5d..31285705 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -250,6 +250,55 @@ MQTT username to use (most useful for a custom MQTT server). If using a custom s This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages to whatever MQTT server is specified in [mqtt_server](#mqtt_server). +#### Enable/Disable uplink_enabled + + + + ```bash title="Enable uplink_enabled on PRIMARY channel" + meshtastic --ch-set uplink_enabled true --ch-index 0 + ``` + ```bash title="Disable uplink_enabled on PRIMARY channel" + meshtastic --ch-set uplink_enabled false --ch-index 0 + ``` + ```bash title="Enable uplink_enabled on OTHER channel" + meshtastic --ch-set uplink_enabled true --ch-index 1 + ``` + ```bash title="Disable uplink_enabled on OTHER channel" + meshtastic --ch-set uplink_enabled false --ch-index 1 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ## Details From 85498267cc16e13f812e463b9f4fe9eec759653e Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 4 Feb 2022 16:28:07 -0700 Subject: [PATCH 03/26] Add example for mqtt_password --- docs/software/settings/mqtt.md | 46 ++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 31285705..b451cfae 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -188,6 +188,52 @@ Configuring this setting is not yet available for the selected platform. If this MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password (TODO - find default password). +#### Configure mqtt_password + + + + ```bash title="Set mqtt_password" + meshtastic --set mqtt_password mypassword + ``` + ```bash title="Set mqtt_password (with spaces)" + meshtastic --set mqtt_password "my password" + ``` + ```bash title="Unset mqtt_password (Default)" + meshtastic --set mqtt_password "" + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### mqtt_server The server to use for our MQTT global message gateway feature. If not set, the default server will be used From 4be47af7ef85dc718c68624a826fbb497a2a97d2 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 4 Feb 2022 16:29:56 -0700 Subject: [PATCH 04/26] Add example for mqtt_username --- docs/software/settings/mqtt.md | 46 ++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index b451cfae..a1ff2b5b 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -292,6 +292,52 @@ Configuring this setting is not yet available for the selected platform. If this MQTT username to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default username (TODO - find default username). +#### Configure mqtt_username + + + + ```bash title="Set mqtt_username" + meshtastic --set mqtt_username myusername + ``` + ```bash title="Set mqtt_username (with spaces)" + meshtastic --set mqtt_username "my username" + ``` + ```bash title="Unset mqtt_username (Default)" + meshtastic --set mqtt_username "" + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### uplink_enabled This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages to whatever MQTT server is specified in [mqtt_server](#mqtt_server). From 81bb19e8cef85787007edeca28c2e40711a1a72e Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Mon, 7 Feb 2022 11:13:37 -0700 Subject: [PATCH 05/26] Change self-signed ssl key admonition on WiFi to info --- docs/software/settings/wifi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/software/settings/wifi.md b/docs/software/settings/wifi.md index 4cb6d44a..69355b53 100644 --- a/docs/software/settings/wifi.md +++ b/docs/software/settings/wifi.md @@ -14,7 +14,7 @@ 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 +:::info 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. ::: From be2b08c7b590c451e404e453cfe866397ff40b59 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Mon, 7 Feb 2022 11:19:21 -0700 Subject: [PATCH 06/26] Add example environmental_measurement_plugin_read_error_count_threshold --- .../environmental-measurment-plugin.md | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/docs/software/settings/environmental-measurment-plugin.md b/docs/software/settings/environmental-measurment-plugin.md index 14cb2dad..b9d805e6 100644 --- a/docs/software/settings/environmental-measurment-plugin.md +++ b/docs/software/settings/environmental-measurment-plugin.md @@ -129,10 +129,88 @@ Configuring this setting is not yet available for the selected platform. If this Sometimes sensor reads can fail. If this happens, we will retry a configurable number of attempts. Each attempt will be delayed by the minimum required refresh rate for that sensor +#### Configure environmental_measurement_plugin_read_error_count_threshold + + + +```bash title="Configure environmental_measurement_plugin_read_error_count_threshold to 3 tries" +meshtastic --set environmental_measurement_plugin_read_error_count_threshold 3 +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### environmental_measurement_plugin_recovery_interval Sometimes we can end up with more than read_error_count_threshold failures. In this case, we will stop trying to read from the sensor for a while. Wait this long until trying to read from the sensor again. +#### Configure environmental_measurement_plugin_recovery_interval + + + +```bash title="Configure environmental_measurement_plugin_recovery_interval to 120 seconds" +meshtastic --set environmental_measurement_plugin_recovery_interval 120 +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### environmental_measurement_plugin_screen_enabled Enable/Disable the environmental measurement plugin on-device display. From c93aab460f2a15e17711eb41560f1285701a7ee9 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Mon, 7 Feb 2022 11:19:56 -0700 Subject: [PATCH 07/26] remove unused details section --- docs/software/settings/external-notification-plugin.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/software/settings/external-notification-plugin.md b/docs/software/settings/external-notification-plugin.md index aa9b619c..2cd69c45 100644 --- a/docs/software/settings/external-notification-plugin.md +++ b/docs/software/settings/external-notification-plugin.md @@ -306,8 +306,3 @@ Configuring this setting is not yet available for the selected platform. If this - - -## Details - - From 879d983cf8328db2e355e58b786e60c5a53d3a58 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Mon, 7 Feb 2022 11:21:00 -0700 Subject: [PATCH 08/26] remove unused details section --- docs/software/settings/serial-plugin.md | 41 ------------------------- 1 file changed, 41 deletions(-) diff --git a/docs/software/settings/serial-plugin.md b/docs/software/settings/serial-plugin.md index 199386f4..2318d2b9 100644 --- a/docs/software/settings/serial-plugin.md +++ b/docs/software/settings/serial-plugin.md @@ -283,44 +283,3 @@ Configuring this setting is not yet available for the selected platform. If this - -## Details - -## Examples - - - - - TODO - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - From 18564d72a4c848a7be1683766bfd7aa519cfc5b7 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Mon, 7 Feb 2022 14:52:01 -0700 Subject: [PATCH 09/26] changed label to remove ambiguity --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index bea49df2..101ce936 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -38,7 +38,7 @@ const config = { label: "Documentation", items: [ { - label: "About Meshtastic", + label: "Meshtastic Software", to: "docs/software", }, { From 2514a5d353f5fde5f4b58a4c69d9043ade70f234 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Mon, 7 Feb 2022 15:34:52 -0700 Subject: [PATCH 10/26] added about section and renamed docs/software --- docs/about-documentation/overview.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/about-documentation/overview.md b/docs/about-documentation/overview.md index 72f271d0..813f5d5f 100644 --- a/docs/about-documentation/overview.md +++ b/docs/about-documentation/overview.md @@ -14,7 +14,8 @@ Another component that we use is [Vercel](https://vercel.com) — a platform for ## Documentation Organization | Section | File Path | Description | | :-----: | :-------: | :---------: | -| About Meshtastic | `docs/software` | High level explanation of each part of Meshtastic. | +| About Meshtastic | `docs/about` | High level explanation of of Meshtastic. | +| Meshtastic Software | `docs/software` | Current bulk of documentation running through each Meshtastic project. | | Getting Started | `docs/getting-started` | Instructions on how to get the Meshtastic firmware onto a users device. | | Device Settings | `docs/software/settings` | Details each user setting and provides explanations for what the setting does and how to configure the device using the various clients available (Android, CLI, iOS, Web) | | Hardware Details | `docs/hardware` | Any hardware related content. Any time a user is attaching a peripheral accessory to their device. That includes 3d printed cases, antennas, buttons, chimes, rotary encoders, and screens. | From dc4af88013b8b9e378e6c9ec0115485081cf913b Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 09:53:49 -0700 Subject: [PATCH 11/26] added hop_limit example --- docs/software/settings/misc.md | 48 +++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index b5048e35..68c919bd 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -20,7 +20,7 @@ import TabItem from '@theme/TabItem'; | factory_reset | `true`, `false` | `false` | | frequency_offset | real numbers | `0` | | ignore_incoming | `string` – list of node nums to ignore | `0` | -| hop_limit | real numbers | 0| +| hop_limit | `0`-`7` | `0` | | serial_disabled | `true`, `false` | `false` | @@ -304,7 +304,53 @@ Configuring this setting is not yet available for the selected platform. If this Overrides the default number of hops a message will be passed. If not set, will default to 3 hops. +:::note Meshtastic allows a maximum of 7 hops (this is a limit of the protocol). Setting a hop_limit of greater than 7 will be replaced with 7 on the device. +::: + +#### Configure hop_limit + + + + + ```bash title="Set hop_limit to default (3 hops)" + meshtastic --set hop_limit 0 + ``` + ```bash title="Set hop_limit to max (7 hops)" + meshtastic --set hop_limit 7 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + #### Ignore Incoming From 14c2dfd2b50ca28ae53b9af9df0067c168bb385c Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 10:11:04 -0700 Subject: [PATCH 12/26] corrected titles --- docs/software/settings/misc.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index 68c919bd..8213d61b 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -28,7 +28,7 @@ import TabItem from '@theme/TabItem'; Automatically toggles to the next page on the screen like a carousel, based the specified interval in seconds. Potentially useful for devices without user buttons. -#### Ignore Incoming +#### Configure auto_screen_carousel_secs Date: Tue, 8 Feb 2022 10:11:22 -0700 Subject: [PATCH 13/26] added ignore_incoming example --- docs/software/settings/misc.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index 8213d61b..78aef6a2 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -224,9 +224,12 @@ If true, radio should not try to be smart about what packets to queue to the pho ]}> -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Enable ignore_incoming" + meshtastic --set ignore_incoming true + ``` + ```bash title="Disable ignore_incoming" + meshtastic --set ignore_incoming false + ``` From 649a53dd1891aba8d39067e541cbec3be25d2c7b Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 10:11:35 -0700 Subject: [PATCH 14/26] removed extra tabs --- docs/software/settings/misc.md | 41 ---------------------------------- 1 file changed, 41 deletions(-) diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index 78aef6a2..1767b403 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -354,44 +354,3 @@ Configuring this setting is not yet available for the selected platform. If this - -#### Ignore Incoming - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - From 08d7593050e4101d7c81771ed752ebb4141d0413 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 10:14:41 -0700 Subject: [PATCH 15/26] added auto_screen_carousel_secs example --- docs/software/settings/misc.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index 1767b403..6b4739eb 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -41,9 +41,12 @@ Automatically toggles to the next page on the screen like a carousel, based the ]}> -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set auto_screen_carousel_secs to default" + meshtastic --set auto_screen_carousel_secs 0 + ``` + ```bash title="Set auto_screen_carousel_secs to 120 seconds" + meshtastic --set auto_screen_carousel_secs 120 + ``` From 12b18447b7f525b587dc570146cc253c25e0ad8b Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 10:24:57 -0700 Subject: [PATCH 16/26] removed example from overview --- docs/software/settings/power.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 9b99c6bb..23b28aa3 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -11,16 +11,6 @@ import TabItem from '@theme/TabItem'; Power settings on a Meshtastic device can be set like other user-define settings with the `--set` command see ([see Meshtastic-python](/docs/software/python/python-cli)). Some of these options are implicit in other commands. For example, when you set the device to router mode using `is_router true`, it is implied that deep sleep is disabled and we want to constantly listen for messages. Below is a list of all user-definable settings and the acceptable values that these settings can use. -For example, if we wanted to disable sleep mode, like when we put the device into router mode, we could use the command: - -```bash -meshtastic --set mesh_sds_timeout_secs 4294967295 -``` - -:::note -See MAXUINT from `mesh_sds_timeout_secs` below: -::: - For a description and more information on what exactly all of these mean, please refer to [Power Management State Machine](/docs/software/other/power) ## Settings From a604e516bf0e8969b149d830252117a5583416fe Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 10 Feb 2022 17:03:35 -0700 Subject: [PATCH 17/26] added spread factor --- docs/software/settings/channel-advanced.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/software/settings/channel-advanced.md b/docs/software/settings/channel-advanced.md index e1094705..4f7ae8d5 100644 --- a/docs/software/settings/channel-advanced.md +++ b/docs/software/settings/channel-advanced.md @@ -21,7 +21,7 @@ Most users should not need to change these settings. The default [modem_config]( | bandwidth | | | | channel_num | | | | coding_rate | | | -| spread_factor | `7`, `8`, `9`, `10`, `11`, `12` | TODO | +| spread_factor | `7`, `8`, `9`, `10`, `11`, `12` | `7` | | tx_power | `integer` (in dBm) | `0` | ### bandwidth @@ -161,7 +161,7 @@ Configuring this setting is not yet available for the selected platform. If this ### spread_factor -TODO +LoRa is a spread spectrum technology. spread_factor is how much the signal is spread over the spectrum. SF8 = 2^8 or spread 256 times. SF12 = 2^12 or spread 4096 times. #### Set Spread Factor From 230e5114514d0924ceab98199c32219c4b862fd6 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 10 Feb 2022 17:08:46 -0700 Subject: [PATCH 18/26] added descriptions --- docs/software/settings/channel-advanced.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/software/settings/channel-advanced.md b/docs/software/settings/channel-advanced.md index 4f7ae8d5..235c7e5e 100644 --- a/docs/software/settings/channel-advanced.md +++ b/docs/software/settings/channel-advanced.md @@ -26,7 +26,7 @@ Most users should not need to change these settings. The default [modem_config]( ### bandwidth -TODO +Total amount of spectrum used for the transmission. #### Set Bandwidth @@ -71,7 +71,7 @@ Configuring this setting is not yet available for the selected platform. If this ### channel_num -TODO +An abstraction that maps to a specific center frequency used for transmission. #### Set Channel Number @@ -116,7 +116,7 @@ Configuring this setting is not yet available for the selected platform. If this ### coding_rate -TODO +The amount of forward error correction applied to allow for us to automatically repair errors in the data transmission. #### Set Coding Rate @@ -206,7 +206,13 @@ Configuring this setting is not yet available for the selected platform. If this ### tx_power -TODO +Configured transmit power out of the LoRa radio, measured in dBM. + +:::caution +Ensure that you are not exceeding your country's regulations. + +`Country regulation - antenna gain = tx_power max setting` +::: #### Set TX Power From bc438211c15661022d01b9715b7926b75f1b3507 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 10 Feb 2022 19:22:44 -0700 Subject: [PATCH 19/26] added bandwidth values and coding rate values Placeholder for channelnum --- docs/software/settings/channel-advanced.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/software/settings/channel-advanced.md b/docs/software/settings/channel-advanced.md index 235c7e5e..fafe70bf 100644 --- a/docs/software/settings/channel-advanced.md +++ b/docs/software/settings/channel-advanced.md @@ -18,9 +18,9 @@ Most users should not need to change these settings. The default [modem_config]( | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | -| bandwidth | | | -| channel_num | | | -| coding_rate | | | +| bandwidth | `10.4`, `15.6`, `20.8`, `31.25`, `41.7`, `62.5`, `125`, `250`, `500` | `125` | +| channel_num | FIXME | FIXME | +| coding_rate | `5`, `6`, `7`, `8` | `5` | | spread_factor | `7`, `8`, `9`, `10`, `11`, `12` | `7` | | tx_power | `integer` (in dBm) | `0` | From a4e0d0de990619cc380d7902639694b40b775613 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 10 Feb 2022 19:41:51 -0700 Subject: [PATCH 20/26] added txpower details --- docs/software/settings/channel-advanced.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/software/settings/channel-advanced.md b/docs/software/settings/channel-advanced.md index fafe70bf..cc9ea3e1 100644 --- a/docs/software/settings/channel-advanced.md +++ b/docs/software/settings/channel-advanced.md @@ -22,7 +22,7 @@ Most users should not need to change these settings. The default [modem_config]( | channel_num | FIXME | FIXME | | coding_rate | `5`, `6`, `7`, `8` | `5` | | spread_factor | `7`, `8`, `9`, `10`, `11`, `12` | `7` | -| tx_power | `integer` (in dBm) | `0` | +| tx_power | `0`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, (dBm) | `0` | ### bandwidth @@ -206,7 +206,7 @@ Configuring this setting is not yet available for the selected platform. If this ### tx_power -Configured transmit power out of the LoRa radio, measured in dBM. +Configured transmit power out of the LoRa radio, measured in dBM. Setting this to `0` will use the device default which is the max legal continuous power for your region. :::caution Ensure that you are not exceeding your country's regulations. @@ -227,7 +227,12 @@ Ensure that you are not exceeding your country's regulations. ]}> - TODO + ```bash title="Set Default" + meshtastic --ch-set tx_power 0 --ch-index 0 + ``` + ```bash title="Set to 2dBM" + meshtastic --ch-set tx_power 2 --ch-index 0 + ``` From 2b72a3c020f2c91d42004e75bf037e3959046ee8 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 11 Feb 2022 13:23:54 -0700 Subject: [PATCH 21/26] updated store and forward --- .../settings/store-and-forward-plugin.md | 89 ++++++++++++------- 1 file changed, 56 insertions(+), 33 deletions(-) diff --git a/docs/software/settings/store-and-forward-plugin.md b/docs/software/settings/store-and-forward-plugin.md index c8563320..60b4c223 100644 --- a/docs/software/settings/store-and-forward-plugin.md +++ b/docs/software/settings/store-and-forward-plugin.md @@ -6,6 +6,11 @@ sidebar_label: Store and Forward import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +:::info +Currently only available for ESP32 based devices with external PSRAM. Requires the device to be set as a router. + +**Don't enable Store and Forward Plugin on multiple [routers](router).** +::: ## Overview @@ -26,10 +31,10 @@ Once plugin settings are changed, a **reset** is required for them to take effec | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | store_forward_plugin_enabled | `true`, `false` | `false` | -| store_forward_plugin_heartbeat | `true`, `false` | TODO - look up default setting | +| store_forward_plugin_heartbeat | `true`, `false` | `false` | | store_forward_plugin_history_return_max | `integer` | `0` | | store_forward_plugin_history_return_window | `integer` | `0` | -| store_forward_plugin_records | integer | `0` | +| store_forward_plugin_records | `integer` | `0` | ### store_forward_plugin_enabled @@ -46,9 +51,12 @@ Enables the plugin. ]}> -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Enable the plugin" + meshtastic --set store_forward_plugin_enabled true + ``` + ```bash title="Disable the plugin" + meshtastic --set store_forward_plugin_enabled false + ``` @@ -76,7 +84,7 @@ Configuring this setting is not yet available for the selected platform. If this ### store_forward_plugin_heartbeat - +The Store & Forward Router sends a periodic message onto the network. This allows connected devices to know that a router is in range and listening to received messages. A client like Android, iOS, or Web can (if supported) indicate to the user whether a store and forward router is available. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set store_forward_plugin_heartbeat to default" + meshtastic --set store_forward_plugin_heartbeat 0 + ``` @@ -120,7 +128,7 @@ Configuring this setting is not yet available for the selected platform. If this ### store_forward_plugin_history_return_max - +Sets the maximum number of messages to return to a client device. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set store_forward_plugin_history_return_max to default" + meshtastic --set store_forward_plugin_history_return_max 0 + ``` + ```bash title="Set store_forward_plugin_history_return_max to 100 messages" + meshtastic --set store_forward_plugin_history_return_max 100 + ``` @@ -164,7 +175,7 @@ Configuring this setting is not yet available for the selected platform. If this ### store_forward_plugin_history_return_window - +Limits the time period (in minutes) a client device can request. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set store_forward_plugin_history_return_window to default" + meshtastic --set store_forward_plugin_history_return_window 0 + ``` + ```bash title="Set store_forward_plugin_history_return_window to 1 day (1440 minutes)" + meshtastic --set store_forward_plugin_history_return_window 1440 + ``` @@ -208,7 +222,7 @@ Configuring this setting is not yet available for the selected platform. If this ### store_forward_plugin_records - +Set this to the maximum number of records to save. Best to leave this at the default (`0`) where the plugin will use 2/3 of your device's available PSRAM. This is about 11,000 records. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set store_forward_plugin_records to default (≈11,000 records)" + meshtastic --set store_forward_plugin_records 0 + ``` + ```bash title="Set store_forward_plugin_records to 100 records" + meshtastic --set store_forward_plugin_records 100 + ``` @@ -261,15 +278,15 @@ Configuring this setting is not yet available for the selected platform. If this Initial Requirements: * Must be installed on a router node. -* * This is an artificial limitation, but is in place to enforce best practices. -* * Router nodes are intended to be always online. If this plugin misses any messages, the reliability of the stored messages will be reduced. + * This is an artificial limitation, but is in place to enforce best practices. + * Router nodes are intended to be always online. If this plugin misses any messages, the reliability of the stored messages will be reduced. * Esp32 Processor based device with external PSRAM. (tbeam v1.0 and tbeamv1.1, and maybe others) ### Usage Overview * To use / test this you will want at least 3 devices -* * One device will (currently) need be a tbeam v1.0 and tbeamv1.1 configured as a Meshtastic router. Other devices with built in PSRAM will be supported at some point. -* * Two others will be regular clients. Nothing special required. + * One device will (currently) need be a tbeam v1.0 and tbeamv1.1 configured as a Meshtastic router. Other devices with built in PSRAM will be supported at some point. + * Two others will be regular clients. Nothing special required. ### Meshtastic channel configuration @@ -279,7 +296,7 @@ Either use a custom channel configuration with at an at least 1kbit data rate or Recommended channel setting is for 1.343kbps: -```bash +```bash title="Recommended channel setting for S&F plugin" meshtastic --setchan spread_factor 11 --setchan coding_rate 4 --setchan bandwidth 500 ``` @@ -287,16 +304,22 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly ### Router setup -* Configure your device as a meshtastic router. -* * https://meshtastic.org/docs/software/settings/router -* Configure the Store and Forward plugin -* * Required configuration -* * * store_forward_plugin_enabled - Set this to true to enable the plugin. False to disable the plugin. -* * Optional configuration -* * * store_forward_plugin_records - Set this to the maximum number of records to save. Best to leave this at the default (0) where the plugin will use 2/3 of your device's available PSRAM. This is about 11,000 records. +* Configure your device as a [meshtastic router](router). * Name your router node something that makes it easily identifiable, aka "Router". +* Configure the Store and Forward plugin + ```bash title="Required - Enable the plugin" + meshtastic --set store_forward_plugin_enabled true + ``` + ```bash title="Optional - Set maximum number of records to save to device" + meshtastic --set store_forward_plugin_records 100 + ``` +:::tip +Best to leave `store_forward_plugin_records` at the default (`0`) where the plugin will use 2/3 of your device's available PSRAM. This is about 11,000 records. +::: +:::warning Don't enable the Store and Forward plugin on multiple routers! +::: ### Client Usage From ee0a41bcc617aa2ecbfd04538160587dc09110d2 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 11 Feb 2022 13:28:14 -0700 Subject: [PATCH 22/26] added username and password from source code --- docs/software/settings/mqtt.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index a1ff2b5b..17ad2721 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -186,7 +186,7 @@ Configuring this setting is not yet available for the selected platform. If this ### mqtt_password -MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password (TODO - find default password). +MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password `large4cats`. #### Configure mqtt_password Date: Fri, 11 Feb 2022 13:30:43 -0700 Subject: [PATCH 23/26] added region note --- docs/software/settings/channel-advanced.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/software/settings/channel-advanced.md b/docs/software/settings/channel-advanced.md index cc9ea3e1..b9f17712 100644 --- a/docs/software/settings/channel-advanced.md +++ b/docs/software/settings/channel-advanced.md @@ -19,7 +19,7 @@ Most users should not need to change these settings. The default [modem_config]( | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | bandwidth | `10.4`, `15.6`, `20.8`, `31.25`, `41.7`, `62.5`, `125`, `250`, `500` | `125` | -| channel_num | FIXME | FIXME | +| channel_num | Depends on Region | Region Channel Number Default | | coding_rate | `5`, `6`, `7`, `8` | `5` | | spread_factor | `7`, `8`, `9`, `10`, `11`, `12` | `7` | | tx_power | `0`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, (dBm) | `0` | From e1cb90b22af1449a5351ffc60c723786f6ac4e27 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 11 Feb 2022 13:36:22 -0700 Subject: [PATCH 24/26] moved frequency_offset to advanced channel settings --- docs/software/settings/channel-advanced.md | 46 ++++++++++++++++++++++ docs/software/settings/misc.md | 46 ---------------------- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/software/settings/channel-advanced.md b/docs/software/settings/channel-advanced.md index b9f17712..af2e676e 100644 --- a/docs/software/settings/channel-advanced.md +++ b/docs/software/settings/channel-advanced.md @@ -21,6 +21,7 @@ Most users should not need to change these settings. The default [modem_config]( | bandwidth | `10.4`, `15.6`, `20.8`, `31.25`, `41.7`, `62.5`, `125`, `250`, `500` | `125` | | channel_num | Depends on Region | Region Channel Number Default | | coding_rate | `5`, `6`, `7`, `8` | `5` | +| frequency_offset | real numbers | `0` | | spread_factor | `7`, `8`, `9`, `10`, `11`, `12` | `7` | | tx_power | `0`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, (dBm) | `0` | @@ -159,6 +160,51 @@ Configuring this setting is not yet available for the selected platform. If this +### frequency_offset + +This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors. + +#### Configure frequency_offset + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### spread_factor LoRa is a spread spectrum technology. spread_factor is how much the signal is spread over the spectrum. SF8 = 2^8 or spread 256 times. SF12 = 2^12 or spread 4096 times. diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index 6b4739eb..18bc74de 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -18,7 +18,6 @@ import TabItem from '@theme/TabItem'; | auto_screen_carousel_secs | `integer` (seconds) | `0` | | debug_log_enabled | `true`, `false` | `false` | | factory_reset | `true`, `false` | `false` | -| frequency_offset | real numbers | `0` | | ignore_incoming | `string` – list of node nums to ignore | `0` | | hop_limit | `0`-`7` | `0` | | serial_disabled | `true`, `false` | `false` | @@ -165,51 +164,6 @@ Configuring this setting is not yet available for the selected platform. If this -### frequency_offset - -This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors. - -#### Configure frequency_offset - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### ignore_incoming If true, radio should not try to be smart about what packets to queue to the phone bool keep_all_packets = 101; If true, we will try to capture all the packets sent on the mesh, not just the ones destined to our node. bool promiscuous_mode = 102; For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send dropped on receive (by router.cpp) From 498ca2475704cea31b032e99eb0f2a4f3a1ce236 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 11 Feb 2022 13:38:12 -0700 Subject: [PATCH 25/26] moved router warning --- docs/software/settings/store-and-forward-plugin.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/software/settings/store-and-forward-plugin.md b/docs/software/settings/store-and-forward-plugin.md index 60b4c223..d537353e 100644 --- a/docs/software/settings/store-and-forward-plugin.md +++ b/docs/software/settings/store-and-forward-plugin.md @@ -304,6 +304,10 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly ### Router setup +:::warning +Don't enable the Store and Forward plugin on multiple routers! +::: + * Configure your device as a [meshtastic router](router). * Name your router node something that makes it easily identifiable, aka "Router". * Configure the Store and Forward plugin @@ -317,10 +321,6 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly Best to leave `store_forward_plugin_records` at the default (`0`) where the plugin will use 2/3 of your device's available PSRAM. This is about 11,000 records. ::: -:::warning -Don't enable the Store and Forward plugin on multiple routers! -::: - ### Client Usage Currently, no special configuration is required. To request your history sent to you, send the command into the message field "SF". That's it. This will eventually change to make it easier. At the moment, that message will be sent to everyone on the mesh but we'll (eventually) make it easier to use where there'll be a button (or maybe it'll be transparent) and the command isn't sent as a text message to the mesh. From 845c9a2f44b3dd0eda02aa4b7f29f187ea3aac5b Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 11 Feb 2022 13:54:01 -0700 Subject: [PATCH 26/26] added serial plugin details --- docs/software/settings/serial-plugin.md | 52 ++++++++++++++++--------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/docs/software/settings/serial-plugin.md b/docs/software/settings/serial-plugin.md index 2318d2b9..a559023d 100644 --- a/docs/software/settings/serial-plugin.md +++ b/docs/software/settings/serial-plugin.md @@ -22,9 +22,9 @@ Once plugin settings are changed, a **reset** is required for them to take effec | serialplugin_enabled | `true`, `false` | `false` | | serialplugin_echo | `true`, `false` | `false` | | serialplugin_mode | `integer` | `0` | -| serialplugin_rxd | `integer` | `0` | +| serialplugin_rxd | `integer` (GPIO) | `0` | | serialplugin_timeout | `integer` (seconds) | `0` | -| serialplugin_txd | `integer` | `0` | +| serialplugin_txd | `integer` (GPIO) | `0` | ### serialplugin_enabled @@ -41,9 +41,12 @@ Enables the plugin. ]}> -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Enable plugin" + meshtastic --set serialplugin_enabled true + ``` + ```bash title="Disable plugin" + meshtastic --set serialplugin_enabled false + ``` @@ -71,7 +74,7 @@ Configuring this setting is not yet available for the selected platform. If this ### serialplugin_echo - +If set, any packets you send will be echoed back to your device. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Enable serialplugin_echo" + meshtastic --set serialplugin_echo true + ``` + ```bash title="Disable serialplugin_echo" + meshtastic --set serialplugin_echo false + ``` @@ -157,7 +163,7 @@ Configuring this setting is not yet available for the selected platform. If this ### serialplugin_rxd - +Set the GPIO pin to the RXD pin you have set up. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +:::note +Replace `GPIO` in the below command with the GPIO number your circuit is attached to. ::: + ```bash title="Set RXD to GPIO pin number" + meshtastic --set serialplugin_rxd GPIO + ``` + @@ -200,7 +210,7 @@ Configuring this setting is not yet available for the selected platform. If this ### serialplugin_timeout - +The amount of time to wait before we consider your packet as "done". -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set serialplugin_timeout to 15 seconds" + meshtastic --set serialplugin_timeout 15 + ``` @@ -243,7 +253,7 @@ Configuring this setting is not yet available for the selected platform. If this ### serialplugin_txd - +Set the GPIO pin to the TXD pin you have set up. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +:::note +Replace `GPIO` in the below command with the GPIO number your circuit is attached to. ::: + ```bash title="Set TXD to GPIO pin number" + meshtastic --set serialplugin_txd GPIO + ``` +