mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-01-29 14:51:50 -08:00
Merge branch 'master' into linux-native-support
This commit is contained in:
rcarteraz
GitHub
commit
ec6c055e90
|
|
@ -41,7 +41,7 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
|
|||
- [Hawaii Meshnet](https://www.hawaiimesh.net/)
|
||||
|
||||
### Illinois
|
||||
- [Chicagoland Meshtastic](https://discord.com/invite/DUejYDPupT)
|
||||
- [Chicagoland Meshtastic](https://chicagolandmesh.org/)
|
||||
|
||||
### Massachusetts
|
||||
- [Boston Meshnet](https://github.com/Darachnid/Boston-Meshnet)
|
||||
|
|
@ -52,6 +52,9 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
|
|||
### Texas
|
||||
- [Austin Mesh](https://austinmesh.org/)
|
||||
|
||||
## Poland
|
||||
- [Meshtastic Poland Matrix Space](https://matrix.to/#/#meshtasticpl:matrix.org)
|
||||
|
||||
## United Kingdon
|
||||
- [UK Meshtastic Kent / South East](https://www.facebook.com/groups/ukmeshtastickent/)
|
||||
- [UK Meshtastic Brighton](https://www.facebook.com/groups/3696312513946679/)
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem";
|
|||
|
||||
If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must also be enabled as uplink and/or downlink for packets to be transmitted from and/or to your mesh (See [channels](/docs/configuration/radio/channels#downlink-enabled)). Without these settings enabled, the node will still connect to the MQTT server but only send status messages.
|
||||
|
||||
The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled, JSON Enabled, TLS Enabled, and Root Topic. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf.
|
||||
The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled, JSON Enabled, TLS Enabled, Root Topic, Client Proxy Enabled, Map Reporting Enabled (with Position Precision and Publish Interval). MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf.
|
||||
|
||||
## Settings
|
||||
|
||||
|
|
@ -53,6 +53,26 @@ If true, we attempt to establish a secure connection using TLS.
|
|||
|
||||
The root topic to use for MQTT messages. This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs.
|
||||
|
||||
### Client Proxy Enabled
|
||||
If true, let the device use the client's (e.g. your phone's) network connection to connect to the MQTT server. If false, it uses the device's network connection which you have to enable via the [network settings](/docs/configuration/radio/network).
|
||||
|
||||
### Map Reporting Enabled
|
||||
|
||||
Available from firmware version 2.3.2 on.
|
||||
If true, your node will periodically send an unencrypted map report to the MQTT server to be displayed by online maps that support this packet. This report includes the following information:
|
||||
- The node's long and short name and ID;
|
||||
- The node's position (with configurable precision) and altitude;
|
||||
- The node's hardware model and [role](/docs/configuration/radio/device/#roles);
|
||||
- The node's firmware version;
|
||||
- The node's LoRa region, modem preset and primary channel name;
|
||||
- Whether the node can be reached on the default channel with known key;
|
||||
- Number of local online nodes (heard in the last 2 hours, excluding those heard via MQTT).
|
||||
|
||||
#### Map Report Position Precision
|
||||
The precision to use for the position in the map report. Defaults to a maximum deviation of around 1459m.
|
||||
|
||||
#### Map Report Publish Interval
|
||||
How often we should publish the map report to the MQTT server in seconds. Defaults to 900 seconds (15 minutes).
|
||||
|
||||
## MQTT Module Config Client Availability
|
||||
<Tabs
|
||||
|
|
@ -95,20 +115,22 @@ All MQTT config options are available on iOS, iPadOS and macOS at Settings > Mod
|
|||
|
||||
:::info
|
||||
|
||||
All MQTT module config options are available in the python CLI. Example commands are below:
|
||||
The following configuration options are available in the Python CLI:
|
||||
|
||||
:::
|
||||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :---------------------: | :---------------: | :-----------------: |
|
||||
| mqtt.enabled | `true`, `false` | `false` |
|
||||
| mqtt.address | `string` |`mqtt.meshtastic.org`|
|
||||
| mqtt.username | `string` | `meshdev` |
|
||||
| mqtt.password | `string` | `large4cats` |
|
||||
| mqtt.encryption_enabled | `true`, `false` | `false` |
|
||||
| mqtt.json_enabled | `true`, `false` | `false` |
|
||||
| mqtt.tls_enabled | `true`, `false` | `false` |
|
||||
| mqtt.root | `string` | |
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :--------------------------: | :---------------: | :-----------------: |
|
||||
| mqtt.enabled | `true`, `false` | `false` |
|
||||
| mqtt.address | `string` |`mqtt.meshtastic.org`|
|
||||
| mqtt.username | `string` | `meshdev` |
|
||||
| mqtt.password | `string` | `large4cats` |
|
||||
| mqtt.encryption_enabled | `true`, `false` | `false` |
|
||||
| mqtt.json_enabled | `true`, `false` | `false` |
|
||||
| mqtt.tls_enabled | `true`, `false` | `false` |
|
||||
| mqtt.root | `string` | |
|
||||
| mqtt.proxy_to_client_enabled | `true`, `false` | `false` |
|
||||
| mqtt.map_reporting_enabled | `true`, `false` | `false` |
|
||||
|
||||
:::tip
|
||||
|
||||
|
|
|
|||
|
|
@ -93,17 +93,19 @@ Should be set to floating point value between 2 and 6
|
|||
|
||||
| Device | Default ADC Multiplier |
|
||||
| :-------: | :--------------------: |
|
||||
| hatter2 | 5.0 |
|
||||
| chatter2 | 5.0 |
|
||||
| diy | 1.85 |
|
||||
| esp32-s3-pico | 3.1 |
|
||||
| heltec_v1 & heltec_v2 | 3.2 |
|
||||
| heltec_v3 & heltec_wsl_v3 | 4.9 |
|
||||
| heltec_wireless_paper | 2 |
|
||||
| heltec_wireless_tracker | 4.9 |
|
||||
| heltec_wireless_tracker 1.0/1.1 | 4.9 |
|
||||
| lora_isp4520 | 1.436 |
|
||||
| m5stack_coreink | 5 |
|
||||
| nano-g1-explorer | 2 |
|
||||
| nano-g2-ultra | 2 |
|
||||
| picomputer-s3 | 3.1 |
|
||||
| rak4631 | 1.73 |
|
||||
| rpipico | 3.1 |
|
||||
| rpipicow | 3.1 |
|
||||
| station-g1 | 6.45 |
|
||||
|
|
@ -112,7 +114,7 @@ Should be set to floating point value between 2 and 6
|
|||
| tlora_v2_1_18 | 2.11 |
|
||||
| tlora_t3s3_v1 | 2.11 |
|
||||
| t-deck | 2.11 |
|
||||
| trackerd | 2 |
|
||||
| t-echo | 2 |
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
|
|
|||
|
|
@ -5,8 +5,10 @@ sidebar_label: Testing Reports
|
|||
sidebar_position: 2
|
||||
---
|
||||
|
||||
## RicInNewMexico
|
||||
## Community Evaluations
|
||||
|
||||
[_RicInNewMexico_](https://github.com/RicInNewMexico) and others have gone through the trouble of testing a number of commonly purchased antennas in the Meshtastic community and given an opinion on whether or not a given antenna is performing optimally.
|
||||
The Meshtastic Antenna Reports repository started as a project by [RicInNewMexico](https://github.com/RicInNewMexico) before being officially transferred to the Meshtastic organization. It contains testing reports and evaluations of various antennas commonly used with Meshtastic devices, contributed by members of the community.
|
||||
|
||||
Please check out the project on Github: [Meshtastic-Antenna-Reports](https://github.com/RicInNewMexico/Meshtastic-Antenna-Reports)
|
||||
These users have gone through the effort of testing and providing their opinions on whether specific antennas perform optimally with Meshtastic devices.
|
||||
|
||||
If you wish to contribute a testing report or evaluation, please review the contribution guidelines in the [Meshtastic Antenna Reports](https://github.com/meshtastic/antenna-reports) Github repository.
|
||||
|
|
@ -145,7 +145,7 @@ This board is still in production but for various reasons not recommended for ne
|
|||
## Lora v2.1-1.6
|
||||
|
||||
:::caution
|
||||
Early versions of some of these boards contained the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. Boards purchased after 2021 should be ok.
|
||||
Early versions of these boards contained the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. Boards purchased after 2021, unless the version is T3_v1.6 20180606, should not have this issue.
|
||||
:::
|
||||
|
||||
- **MCU**
|
||||
|
|
|
|||
|
|
@ -54,6 +54,7 @@ values={[
|
|||
- You should see something like:
|
||||
- `ID 10c4:ea60 Silicon Labs CP210x UART Bridge` for CP210X
|
||||
- `ID 1a86:55d4 QinHeng Electronics USB Single Serial` for CH9102
|
||||
- If there is no seral device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
|
||||
|
||||
- Check that your computer has Python 3 installed.
|
||||
|
||||
|
|
@ -107,7 +108,7 @@ values={[
|
|||
- Connect your Meshtastic device to your USB port
|
||||
- Navigate to `Apple Menu > About This Mac > System Report... > Hardware > USB`
|
||||
- You should see something like `CP210X USB to UART Bridge Controller`
|
||||
- If not download the drivers from [Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
|
||||
- If there is no serial device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
|
||||
- Check that your computer has Python 3 installed.
|
||||
- Use the command
|
||||
```shell
|
||||
|
|
@ -150,16 +151,18 @@ values={[
|
|||
- Connect your Meshtastic device to your USB port
|
||||
- Open Device Manager
|
||||
- Under `Ports (COM & LPT)` you should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`
|
||||
- If not download the drivers from [Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers) or use the direct link below.
|
||||
:::warning
|
||||
You must install the [CP210x Universal Windows Driver](https://www.silabs.com/documents/public/software/CP210x_Universal_Windows_Driver.zip). If you do not install this driver, your device may not work and the driver may need to be uninstalled from device manager before installing the correct driver.
|
||||
:::
|
||||
- If there is no serial device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
|
||||
- Check that your computer has Python 3 installed.
|
||||
- Use the command
|
||||
```powershell
|
||||
py -V
|
||||
```
|
||||
- If this does not return a version, install [python](https://www.python.org)
|
||||
|
||||
:::info
|
||||
When installing Python, make sure to select the option to "Add Python to PATH" or check the box that says "Add Python to environment variables". If you missed this during installation, you can add Python to your system's PATH manually after installation. Failing to do so may result in errors when trying to use Python or pip commands.
|
||||
:::
|
||||
|
||||
- Pip is typically installed if you are using python 3 version >= 3.4
|
||||
- Check that pip is installed using this command
|
||||
```powershell
|
||||
|
|
@ -180,11 +183,7 @@ values={[
|
|||
|
||||
#### Termux
|
||||
|
||||
:::note
|
||||
Wifi connection is currently under development and may not be working properly just yet. If you would like to provide feedback or test this feature, please visit our [forum](https://meshtastic.discourse.group) or join our [Discord server](https://discord.gg/ktMAKGBnBs) for more information.
|
||||
:::
|
||||
|
||||
- Install [Termux](https://f-droid.org/en/packages/com.termux) from the F-Droid app store (Google play does not currently support the latest builds)
|
||||
- Install [Termux from F-Droid](https://f-droid.org/en/packages/com.termux) or [Github Releases](https://github.com/termux/termux-app/releases). The Google Play store version has been deprecated.
|
||||
- Load Termux and update the package list
|
||||
```shell
|
||||
pkg update
|
||||
|
|
@ -203,15 +202,14 @@ Wifi connection is currently under development and may not be working properly j
|
|||
```
|
||||
|
||||
:::note
|
||||
Be aware that the Meshtastic CLI is not able to control the nodes over USB through termux, but you can control devices over Wifi using the `--host x.x.x.x` option with the device IP address. However, only ESP32 devices can use Wifi currently.
|
||||
Be aware that the Meshtastic CLI is not able to control the nodes over USB through termux, but you can control devices over Wifi using the `--host x.x.x.x` option with the device IP address (ESP32 or Pico W only). Wifi connection is currently under development and may not be working properly just yet. If you would like to provide feedback or test this feature, please visit our [forum](https://meshtastic.discourse.group) or join our [Discord server](https://discord.gg/ktMAKGBnBs) for more information.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::info
|
||||
You may need to close and re-open the CLI. The path variables may or may not update for the current session when installing.
|
||||
:::
|
||||
**You may need to close and re-open the CLI. The path variables may or may not update for the current session when installing.**
|
||||
|
||||
|
||||
### Standalone Installation (Ubuntu only)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue