mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into master

Browse source
This commit is contained in:
pdxlocations 2024-10-22 15:33:43 -07:00 committed by GitHub
parent 617a804114 dfeaa04673
commit d084058b7d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 64 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/blocks/_position-precision-bits.mdx Normal file
View file

@ -0,0 +1,12 @@
| Precision bits | Metric | Imperial |
| :------------: | :-----: | :--------: |
| 10 | 23.3 km | 14.5 miles |
| 11 | 11.7 km | 7.3 miles |
| 12 | 5.8 km | 3.6 miles |
| 13 | 2.9 km | 1.8 miles |
| 14 | 1.5 km | 4787 feet |
| 15 | 729 m | 2392 feet |
| 16 | 364 m | 1194 feet |
| 17 | 182 m | 597 feet |
| 18 | 91 m | 299 feet |
| 19 | 45 m | 148 feet |

12
docs/blocks/_position-precision.mdx Normal file
View file

@ -0,0 +1,12 @@
| Metric | Imperial |
| :-----: | :--------: |
| 23.3 km | 14.5 miles |
| 11.7 km | 7.3 miles |
| 5.8 km | 3.6 miles |
| 2.9 km | 1.8 miles |
| 1.5 km | 4787 feet |
| 729 m | 2392 feet |
| 364 m | 1194 feet |
| 182 m | 597 feet |
| 91 m | 299 feet |
| 45 m | 148 feet |

16
docs/configuration/radio/channels.mdx
View file

@ -7,6 +7,7 @@ description: Understand how to configure channels on your Meshtastic device, inc
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import PositionPrecisionBits from "@site/docs/blocks/_position-precision-bits.mdx";
The Channels config options are: Index, Roles, and Settings. Channel config uses an admin message sending a `Channel` protobuf which also consists of a `ChannelSettings` or `ModuleSettings` protobuf.
@ -117,13 +118,9 @@ The `position_precision` value is an integer between 0 and 32:
- A value of 0 means that location data is never sent over the given channel.
- A value of 32 means that location data is sent with full precision.
- Values in between indicate the number of bits of precision to be sent.
- Values in between indicate the number of bits of precision to be sent, which correspond to a position precision from the table below.
Some useful values and their approximate precisions:
- 11: Large region, around ±11 kilometers
- 13: City-sized region, around ±3 kilometers
- 16: Neighborhood-level precision, around ±350 meters
<PositionPrecisionBits />
The client applications have implemented different levels of precision giving the user a practical range to choose from. Setting across the full range of integers can be done via the Python CLI. See [Setting Position Precision](/docs/configuration/radio/channels/#setting-position-precision) for examples on setting different levels of precision using CLI.
@ -158,13 +155,14 @@ See [Android App Usage](/docs/software/android/usage#setup-a-channel) for more f
[![Channel Editor](/img/android/android-channel-edit-sm.webp)](/img/android/android-channel-edit.webp)
Tap the Channel Name (or the pen icon) to access the Channel Menu:
Tap "Edit" to access the Channel Menu:
1. Add, remove, or modify secondary channels
2. Create or modify encryption keys
3. Enable uplink and downlink for individual channels
4. Set the position precision value
4. Position enabled
5. Precise location (if position is enabled)
6. Position precision (if precise location is disabled)
</TabItem>

23
docs/getting-started/flashing-firmware/esp32/cli-script.mdx
View file

@ -189,20 +189,33 @@ MAC: 24:6f:28:b5:36:71
Hard resetting via RTS pin...
```
### Navigate to Firmware
### Download Firmware
`cd` into the directory where you unzipped the latest release. For example:
1. Head to the [Meshtastic Downloads Page](/downloads) to download the latest firmware.
2. Scroll down to the **Firmware** section and select one of the following, depending on your preferences:
- **Download Stable**: For stable, well-tested releases.
- **Download Alpha**: For newer, experimental releases with the latest features.
3. Once redirected to the GitHub release page, scroll down to the "Assets" section and expand it. Identify the correct firmware for your device by its architecture (e.g., `firmware-esp32s3` for ESP32-S3-based devices like the Heltec V3).
4. Download the file and take note of the download location on your system (usually in your `~/Downloads` folder).
### Navigate to Firmware Directory
1. Open a terminal and navigate (`cd`) to the directory where your firmware was downloaded. The folder name typically matches the architecture and firmware version from the zip file. For example:
```shell title="Example"
cd ~/Downloads/firmware/
cd ~/Downloads/firmware-esp32s3-X.X.X.xxxxxxx/
```
:::note
Make sure to replace `esp32s3` and the version number with those corresponding to the file you downloaded.
:::
### Install/Update Firmware
Install or Update the device that you have by using the following commands according to your operating system:
Now, proceed with the instructions below for your operating system to install or update the firmware for your specific board:
:::caution
Be very careful to install the correct firmware file for your board. In particular, the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly. If you flash the incorrect device firmware, it may appear to successfully complete, yet the device will usually become unresponsive, displaying a blank screen (if equipped). Attempt to flash the correct version. Please note, while these devices are quite resilient and damage is not always likely, there is a possibility of onboard radio and peripheral damage due to incorrect GPIO pin direction.
Be very careful to install the correct firmware file for your board. In particular, the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly. If you flash the incorrect device firmware, it may appear to successfully complete, yet the device will usually become unresponsive, displaying a blank screen (if equipped). Attempt to flash the correct version. Please note, while these devices are quite resilient and damage is not always likely, there is a possibility of onboard radio and peripheral damage due to incorrect GPIO pin direction
:::
<Tabs

2
docs/getting-started/flashing-firmware/nrf52/update-booloader.mdx
View file

@ -63,7 +63,7 @@ pip install adafruit-nrfutil
4. In the terminal or command prompt, navigate to the directory where you downloaded the bootloader zip package and execute the following command, replacing /dev/ttyACM0 with the correct port for your device (Windows users might use COMx):
```bash
adafruit-nrfutil --verbose dfu serial --package <downloaded file>.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200
adafruit-nrfutil --singlebank --touch 1200 --verbose dfu serial --package <downloaded file>.zip -p /dev/ttyACM0 -b 115200
```
5. Once the process finishes, the update is complete. Your device is now running the latest bootloader version and you can proceed with [flashing the firmware](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop/).

15
docs/software/android/usage.mdx
View file

@ -4,10 +4,13 @@ title: Android Application Usage
sidebar_label: Usage
sidebar_position: 2
---
import PositionPrecision from "@site/docs/blocks/_position-precision.mdx";
import Link from "@docusaurus/Link"
import ThemedImage from '@theme/ThemedImage';
import useBaseUrl from '@docusaurus/useBaseUrl';
## Introduction
The Meshtastic Android app handles the communication and can show the location of everyone in your private group. Each member of your private mesh can see the location and distance of members and text messages sent to your group chat.
@ -133,14 +136,14 @@ You can test changing channels with the QR code shown below.
You can change the following settings by tapping on the name of an existing channel:
1. MQTT Uplink
2. MQTT Downlink
3. Position precision value
3. Position enabled
4. Precise location (if position is enabled)
5. Position precision (if precise location is disabled)
#### Position Precision
The precision levels currently used in the app correspond to the following values:
- HIGH_PRECISION (32), full precision
- MED_PRECISION (16), around ±350 meters
- LOW_PRECISION (11), around ±11 kilometers
- DISABLED (0), location data is never sent over the given channel
The precision levels currently used in the app correspond the values in the table below. These can be thought of as the radius of a circle around a point (not your current location) which you are within.
<PositionPrecision />
### Send a message

10
pnpm-lock.yaml
View file

@ -889,7 +889,7 @@ packages:
resolution: {integrity: sha512-s3jaWicZd0pkP0jf5ysyHUI/RE7MHos6qlToFcGWXVp+ykHOy77OUMrfbgJ9it2C5bow7OIQwYYaHjk9XlBQ2A==}
'@buf/meshtastic_protobufs.bufbuild_es@2.0.0-20240906232734-3da561588c55.2':
resolution: {registry: https://buf.build/gen/npm/v1, tarball: https://buf.build/gen/npm/v1/@buf/meshtastic_protobufs.bufbuild_es/-/meshtastic_protobufs.bufbuild_es-2.0.0-20240906232734-3da561588c55.2.tgz}
resolution: {tarball: https://buf.build/gen/npm/v1/@buf/meshtastic_protobufs.bufbuild_es/-/meshtastic_protobufs.bufbuild_es-2.0.0-20240906232734-3da561588c55.2.tgz}
peerDependencies:
'@bufbuild/protobuf': ^2.0.0
@ -3538,8 +3538,8 @@ packages:
resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==}
engines: {node: '>= 8'}
mermaid@10.9.1:
resolution: {integrity: sha512-Mx45Obds5W1UkW1nv/7dHRsbfMM1aOKA2+Pxs/IGHNonygDHwmng8xTHyS9z4KWVi0rbko8gjiBmuwwXQ7tiNA==}
mermaid@10.9.3:
resolution: {integrity: sha512-V80X1isSEvAewIL3xhmz/rVmc27CVljcsbWxkxlWJWY/1kQa4XOABqpDl2qQLGKzpKm6WbTfUEKImBlUfFYArw==}
methods@1.1.2:
resolution: {integrity: sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==}
@ -7009,7 +7009,7 @@ snapshots:
'@docusaurus/theme-common': 3.1.1(@docusaurus/types@3.1.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(typescript@5.6.2)
'@docusaurus/types': 3.1.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1)
'@docusaurus/utils-validation': 3.1.1(@docusaurus/types@3.1.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1))
mermaid: 10.9.1
mermaid: 10.9.3
react: 18.3.1
react-dom: 18.3.1(react@18.3.1)
tslib: 2.7.0
@ -10020,7 +10020,7 @@ snapshots:
merge2@1.4.1: {}
mermaid@10.9.1:
mermaid@10.9.3:
dependencies:
'@braintree/sanitize-url': 6.0.4
'@types/d3-scale': 4.0.8