mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-02-02 08:42:11 -08:00
Merge branch 'master' into ota-update
This commit is contained in:
charminULTRA
GitHub
commit
8bf7b283a0
|
|
@ -8,9 +8,9 @@ sidebar_label: MQTT
|
|||
import Tabs from "@theme/Tabs";
|
||||
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 be enabled as uplink and/or downlink for protobufs to be transmitted from and/or to the mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings the node will still connect to MQTT server and send status messages.
|
||||
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/settings/config/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 and JSON Enabled. 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, and Root Topic. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf.
|
||||
|
||||
## Settings
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ Enables the MQTT module.
|
|||
|
||||
### Server Address
|
||||
|
||||
The server to use for MQTT. If not set, the default server public will be used.
|
||||
The server to use for MQTT. If not set, the default public server will be used.
|
||||
|
||||
### Username
|
||||
|
||||
|
|
@ -30,16 +30,24 @@ MQTT Server username to use (most useful for a custom MQTT server). If using a c
|
|||
|
||||
### Password
|
||||
|
||||
MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password
|
||||
MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password.
|
||||
|
||||
### Encryption Enabled
|
||||
|
||||
Whether to send encrypted or decrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets) Decrypted packets may be useful for external systems that want to consume meshtastic packets.
|
||||
Whether to send encrypted or unencrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets). Unencrypted packets may be useful for external systems that want to consume meshtastic packets.
|
||||
|
||||
### JSON Enabled
|
||||
|
||||
Enable the sending / consumption of JSON packets on MQTT. These packets are not encrypted, but offer an easy way to integrate with systems that can read JSON.
|
||||
|
||||
### TLS Enabled
|
||||
|
||||
If true, we attempt to establish a secure connection using TLS.
|
||||
|
||||
### Root Topic
|
||||
|
||||
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.
|
||||
|
||||
## MQTT Module Config Client Availability
|
||||
|
||||
<Tabs
|
||||
|
|
@ -66,7 +74,9 @@ MQTT Config options are available for Android.
|
|||
<TabItem value="apple">
|
||||
|
||||
:::info
|
||||
MQTT module config is not available for Apple.
|
||||
|
||||
MQTT Config options are available on iOS, iPadOS and macOS at Settings > Modules > MQTT.
|
||||
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -78,14 +88,16 @@ All MQTT module config options are available in the python CLI. Example commands
|
|||
|
||||
:::
|
||||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :---------------------: | :---------------: | :-----: |
|
||||
| mqtt.enabled | `true`, `false` | `false` |
|
||||
| mqtt.address | `string` | |
|
||||
| mqtt.username | `string` | |
|
||||
| mqtt.password | `string` | |
|
||||
| mqtt.encryption_enabled | `string` | |
|
||||
| mqtt.json_enabled | `true`, `false` | `false` |
|
||||
| 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` | |
|
||||
|
||||
:::tip
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,16 @@ sidebar_label: Range Test
|
|||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh.
|
||||
This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh.
|
||||
|
||||
While a minimum of two radios is required, more can be used. You can have any number of receivers and senders that your mesh is able to handle. You can test having a single sender with multiple receivers or a single receiver with multiple senders. Let us know on the [forum thread](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591) the results of your configuration.
|
||||
|
||||
:::info
|
||||
|
||||
Be sure to turn off the module or disable sending when not in use. This will use a lot of time on air, slow down your mesh, and spam your channel.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
The range test module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.RangeTest` protobuf.
|
||||
|
||||
|
|
@ -18,13 +27,33 @@ The range test module config options are: Enabled, Save, and Sender. Range Test
|
|||
|
||||
Enables the range test module.
|
||||
|
||||
### Save CSV File `ESP32 Only Setting`
|
||||
### Save CSV File
|
||||
|
||||
If enabled, we will save a log of all received messages to a file named rangetest.csv which you can access from the web server Extensions > File Browser > rangetest.csv. The file will be created after receiving messages. The device will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage.
|
||||
:::info
|
||||
|
||||
Saving files is only available on ESP32-based devises
|
||||
|
||||
:::
|
||||
|
||||
If enabled, a log of all received messages will be saved to a file named rangetest.csv.
|
||||
|
||||
To access this file, first turn on the WiFi on your device and connect to your network. Once you can connect to your device, navigate to `meshtastic.local/rangetest.csv` (or your_device_ip/rangetest.csv) and the file will be downloaded automatically. This file will only be created after receiving initial messages.
|
||||
|
||||
To prevent filling up the storage, the device will abort writing if there is less than 50kb of space on the filesystem.
|
||||
|
||||
### Sender Interval
|
||||
|
||||
How long to wait between sending test packets. 0 is default which disables sending messages.
|
||||
How long to wait between sending sequential test packets. 0 is default which disables sending messages.
|
||||
|
||||
### Recommended Sender Settings
|
||||
|
||||
| Radio Setting | `range_test.sender` |
|
||||
| :-----------: | :-----------------: |
|
||||
| Long Slow | 60 |
|
||||
| Long Alt | 30 |
|
||||
| Medium | 15 |
|
||||
| Short Fast | 15 |
|
||||
|
||||
|
||||
## Range Test Module Config Client Availability
|
||||
|
||||
|
|
@ -48,6 +77,8 @@ Range Test Config options are available for Android.
|
|||
|
||||
:::
|
||||
|
||||
Android also had the option to download a rangetest.csv file which is stored on your phone. This file does not require the Range Test module to be active and will log all incoming Nodeinfo, Position, Telemetry and Messages.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="apple">
|
||||
|
||||
|
|
@ -55,6 +86,8 @@ Range Test Config options are available for Android.
|
|||
All range test module config options are available on iOS, iPadOS and macOS at Settings > Modules > Range Test.
|
||||
:::
|
||||
|
||||
Apple apps also have the option to download logged position data which is stored on your iPhone/iPad/Mac. Access this by clicking on the Nodes tab, selecting a node, then select Position Log and click Save. This data file does not require the Range Test module to be active.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli">
|
||||
|
||||
|
|
@ -103,42 +136,13 @@ meshtastic --set range_test.sender 0
|
|||
|
||||
:::info
|
||||
|
||||
No range test module config options are available in the Web UI.
|
||||
All range test module config options are available in the Web UI.
|
||||
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Examples
|
||||
|
||||
While a minimum of two radios is required, more can be used. You can have any number of receivers and senders that your mesh is able to handle. You can test having a single sender with multiple receivers or a single receiver with multiple senders. Let us know on the [forum thread](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591) the results of your configuration.
|
||||
|
||||
Be sure to turn off either the module configured as a sender or the device where the module setup as sender when not in use. This will use a lot of time on air and will spam your channel.
|
||||
|
||||
Also be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results.
|
||||
|
||||
:::note
|
||||
Leaving this module on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.PortNum) are sent on.
|
||||
:::
|
||||
|
||||
### Accessing your CSV
|
||||
|
||||
Connect to your device over WiFi, either using the [software access point](/docs/settings/config/network#software-access-point) or [WiFi Client](/docs/settings/config/network#wifi-client). Then navigate to `meshtastic.local` (or your IP address). Your file will be available for download under `Extensions > File Browser > rangetest.csv` once it has been created by receiving messages.
|
||||
|
||||
```plaintext title="Example URLs"
|
||||
http://meshtastic.local
|
||||
http://198.168.0.15
|
||||
```
|
||||
|
||||
### Recommended Sender Settings
|
||||
|
||||
| Radio Setting | `range_test.sender` |
|
||||
| :-----------: | :-----------------: |
|
||||
| Long Slow | 60 |
|
||||
| Long Alt | 30 |
|
||||
| Medium | 15 |
|
||||
| Short Fast | 15 |
|
||||
|
||||
## Application Examples
|
||||
|
||||
|
|
@ -169,10 +173,6 @@ You can style the ranges differently based on the values, so you can have the pi
|
|||
|
||||
## FAQ
|
||||
|
||||
Q: Where is rangetest.csv saved?
|
||||
|
||||
- Turn on the WiFi on your device as either a WiFi client or a WiFi AP. Once you can connect to your device, navigate to `Extensions > File Browser` and you will see `rangetest.csv` once messages have been saved and the file has been created.
|
||||
|
||||
Q: Do I need to have WiFi turned on for the file to be saved?
|
||||
|
||||
- Nope, it'll just work.
|
||||
|
|
@ -191,7 +191,7 @@ Q: What will happen if I run out of space on my device?
|
|||
|
||||
Q: What do I do with the rangetest.csv file when I'm done?
|
||||
|
||||
- Go to /static and delete the file.
|
||||
- Currently the only way to erase the file is to perform a factory reset.
|
||||
|
||||
Q: Can I use this as a sender while on battery power?
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ sidebar_label: Serial
|
|||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO and Sender. Serial Module config uses an admin message sending a `ConfigModule.Serial` protobuf.
|
||||
The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO, Baud Rate, Timeout, and Override Console Serial Port. Serial Module config uses an admin message sending a `ConfigModule.Serial` protobuf.
|
||||
|
||||
This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.
|
||||
|
||||
|
|
|
|||
|
|
@ -18,3 +18,7 @@ sidebar_label: Trademark Grants
|
|||
- Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
|
||||
- Grant: Mark Birss
|
||||
- Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
|
||||
- Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe)
|
||||
- Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
|
||||
- Grant: [Keith Monaghan](http://voltaicenclosures.com/)
|
||||
- Details: Keith is a contributer of computer aided design (CAD)/3D designs primarily for device enclosures and accessories, and runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Keith is sponsored or endorsed by Meshtastic. Keith also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
|
||||
|
|
|
|||
Loading…
Reference in a new issue