Merge branch 'master' into add-meshtasticd

This commit is contained in:
rcarteraz 2025-02-17 09:00:02 -07:00 committed by GitHub
commit af0c4eea9e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 7 deletions

View file

@ -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` |

View file

@ -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*