Merge branch 'master' into patch-3

This commit is contained in:
HarukiToreda 2024-05-14 19:45:10 -04:00 committed by GitHub
commit 6105b72086
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 13 additions and 24 deletions

View file

@ -8,26 +8,24 @@ description: GPS position configuration settings for your Meshtastic device incl
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Smart Broadcast Minimum Distance, Smart Broadcast Minimum Interval, Broadcast Interval, Position Packet Flags, and GPS RX/TX Pins. Position config uses an admin message sending a `Config.Position` protobuf.
Position data from GPS is provided by either the radio or your paired phone. It is not required to use Meshtastic, but time calculations require at least one device on the mesh to have either a GPS, RTC, or internet connection for NTP.
Position data from GPS is provided by either the radio or your paired phone. Position data is not required to use Meshtastic but time calculations require at least one device on the mesh have either a GPS or internet connection for time.
The position config uses an admin message to send a `Config.Position` protobuf. The position config options are: GPS Mode, GPS Update Interval, Fixed Position, Smart Broadcast, Smart Broadcast Minimum Distance, Smart Broadcast Minimum Interval, Broadcast Interval, Position Packet Flags, and GPS RX/TX Pins.
## Position Config Values
### GPS Enabled
### GPS Mode
Acceptable values: `true` or `false`
Configures whether the GPS functionality is enabled, disabled, or not present on the node.
Defaults to true. Enables GPS on the node.
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`.
### GPS Update Interval
How often we should try to get GPS position (in seconds), or zero for the default of once every 2 minutes, or a very large value (maxint) to update only once at boot.
### GPS Attempt Time
How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 15 minutes.
### Fixed Position
Acceptable values: `true` or `false`
@ -64,9 +62,9 @@ The minimum number of seconds (since the last send) before we can send a positio
Default of `0` is 15 minutes
If smart broadcast is off we should send our position this often (but only if it has changed significantly)
If smart broadcast is off we should send our position this often.
The GPS updates will be sent out every Broadcast Interval, with either the actual GPS location, or an empty location if no GPS fix was achieved.
The GPS updates will be sent out every broadcast interval, either with the actual GPS location or an empty location if no GPS fix was achieved.
### Position Flags
@ -136,9 +134,8 @@ All Position config commands are available in the python CLI. Example commands a
| Setting | Acceptable Values | Default |
| :------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------: |
| position.gps_enabled | `true`, `false` | `true` |
| position.gps_mode | `enabled`, `disabled`, `not_present` | `Enabled` or `Not Present` |
| position.gps_update_interval | `integer` (seconds) | Default `0` is 2 Minutes |
| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 15 Minutes |
| position.fixed_position | `true`, `false` | `false` |
| position.position_broadcast_smart_enabled | `true`, `false` | `true` |
| position.broadcast_smart_minimum_distance | `integer` (meters) | Default of `0` is 100 Meters |
@ -163,11 +160,6 @@ meshtastic --set position.gps_update_interval 0
meshtastic --set position.gps_update_interval 45
```
```shell title="Set GPS attempt time (Default of 0 is 30 seconds)"
meshtastic --set position.gps_attempt_time 0
meshtastic --set position.gps_attempt_time 45
```
```shell title="Set Fixed Position - Current Location"
meshtastic --set position.fixed_position true
```
@ -214,7 +206,3 @@ All position config options are available in the Web UI.
</TabItem>
</Tabs>
:::caution
Altering/disabling the GPS functionality does not mean that you will be unable to be found. Via triangulation of your radio, location may be given up to someone if they are determined enough.
:::

View file

@ -120,6 +120,8 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS
<LoRaRegions />
Refer to [LoRa Region by Country](/docs/configuration/region-by-country) for a more comprehensive list.
## Continue Configuration
Now that you have set the LoRa region on your device, you can continue with configuring any additional configs to suit your needs.

View file

@ -8,7 +8,6 @@ sidebar_position: 1
## Functionality
- **Capacitive Touch Button (Top):**<br />
*If "Wake on Tap or Motion" setting enabled:*
- **Touch:**
- Update the display
- *(at screensaver)* Wake the display.

View file

@ -16,7 +16,7 @@ Please ensure the inclusion of the following statement in your support documenta
> Meshtastic® is a registered trademark of Meshtastic LLC. Meshtastic software components are released under various licenses, see GitHub for details. No warranty is provided - use at your own risk.
Alternatively, if you prefer, you can use our community project logos, "M-Powered" and "M-PWRD", which are specifically designed for projects that utilize Meshtastic technology. These logos offer a straightforward way to show compatibility with our platform without needing a trademark grant. For more information on these logos, including usage guidelines and design files, please refer to [Community Project Logos: M-Powered & M-PWRD](/docs/legal/licensing-and-trademark#community-project-logos-m-powered--m-pwrd).
Alternatively, if you prefer, you can use our community project logos, nicknamed "M-Powered" and "M-PWRD", which are specifically designed for projects that utilize Meshtastic technology. These logos offer a straightforward way to show compatibility with our platform without needing a trademark grant. For more information on these logos, including usage guidelines and design files, please refer to [Community Project Logos: M-Powered & M-PWRD](/docs/legal/licensing-and-trademark#community-project-logos-m-powered--m-pwrd).
## Meshtastic Trademark Policy & Brand Guidelines