From b5ce80462534cf5be3776f696e42b9fe05edf858 Mon Sep 17 00:00:00 2001 From: Andrew Yong Date: Thu, 13 Feb 2025 14:22:06 +0800 Subject: [PATCH 1/2] Update position.mdx: position.gps_mode capitalization Meshtastic Python CLI only accepts case-sensitive arguments for position.gps_mode and they must be in all caps, or it will refuse the setting with "position.gps_mode does not have an enum called not_present, so you can not set it." Update documentation to match. --- docs/configuration/radio/position.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration/radio/position.mdx b/docs/configuration/radio/position.mdx index 9128d53a..8ef3446d 100644 --- a/docs/configuration/radio/position.mdx +++ b/docs/configuration/radio/position.mdx @@ -19,9 +19,9 @@ The position config uses an admin message to send a `Config.Position` protobuf. Configures whether the GPS functionality is enabled, disabled, or not present on the node. -Acceptable values: `Disabled`, `Enabled`, and `Not_Present`. +Acceptable values: `DISABLED`, `ENABLED`, and `NOT_PRESENT`. -Generally, depending on the device and its configuration, this value will default to either `Enabled` or `Not Present`. +Generally, depending on the device and its configuration, this value will default to either `ENABLED` or `NOT_PRESENT`. ### GPS Update Interval @@ -163,7 +163,7 @@ All Position config commands are available in the python CLI. Example commands a | Setting | Acceptable Values | Default | | :--------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------: | -| position.gps_mode | `enabled`, `disabled`, `not_present` | `Enabled` or `Not Present` | +| position.gps_mode | `ENABLED`, `DISABLED`, `NOT_PRESENT` | `ENABLED` or `NOT_PRESENT` | | position.gps_update_interval | `integer` (seconds) | Default `0` is 2 Minutes | | position.fixed_position | `true`, `false` | `false` | | position.position_broadcast_smart_enabled | `true`, `false` | `true` | From 2e324b040b7ec0f26e1b95bd334dc4d0942259af Mon Sep 17 00:00:00 2001 From: David Andrzejewski Date: Sun, 16 Feb 2025 18:14:29 -0500 Subject: [PATCH 2/2] Updated "tips" page with CLIENT_MUTE advice. (#1720) * Updated "tips" page with client_mute advice. * Update docs/configuration/tips.mdx Co-authored-by: Tommy Ekstrand * Update docs/configuration/tips.mdx Co-authored-by: Tommy Ekstrand * Update docs/configuration/tips.mdx Co-authored-by: Tommy Ekstrand * Update docs/configuration/tips.mdx Co-authored-by: Tommy Ekstrand * Update docs/configuration/tips.mdx Co-authored-by: Tommy Ekstrand * Fixes based on suggestions in the PR. * Fixed per https://github.com/meshtastic/meshtastic/pull/1720#discussion_r1957434228 * Fixed typo. * Make heading more concise. * Update docs/configuration/tips.mdx --------- Co-authored-by: Tommy Ekstrand --- docs/configuration/tips.mdx | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/configuration/tips.mdx b/docs/configuration/tips.mdx index 13dac4dc..66ce7276 100644 --- a/docs/configuration/tips.mdx +++ b/docs/configuration/tips.mdx @@ -8,12 +8,18 @@ sidebar_position: 4 ## Roles -It is strongly recommended to keep your [ROLE](/docs/configuration/radio/device#roles) set to `CLIENT`. Only change this if you have a specific, well-understood reason to do so. +It is strongly recommended to keep your [ROLE](/docs/configuration/radio/device#roles) set to `CLIENT` or `CLIENT_MUTE`. Only use other roles if you have a specific, well-understood reason to do so. Read our [blog post about choosing the best role](/blog/choosing-the-right-device-role/). -### Why `CLIENT` is Recommended +### Recommended Roles -- `CLIENT` nodes efficiently repeat and route packets as needed. -- They use smart delays for rebroadcasting, improving network stability. +- `CLIENT` nodes efficiently repeat and route packets as needed. + - **Almost always the correct mode.** + - Uses smart delays for rebroadcasting, improving network stability. + - Use for "rooftop" or other nodes that enhance your mesh. + - Use during isolated activities such as hiking, skiing, or MTB where you're in an area with few nodes. +- `CLIENT_MUTE` nodes behave as above but do not repeat packets. + - Use for personal nodes that are in range of a higher-profile node in a dense or congested mesh. + - Use when you have multiple nodes in close proximity (set your "best-placed" node to `CLIENT`). ![Client Node Example](/img/configuration/client.webp) *One example of a 'Client' node. Photo credit: Cully@KBOXLABS*