Merge branch 'master' into master
53
docs/configuration/tips.mdx
Normal file
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
id: tips
|
||||
title: Configuration Tips
|
||||
sidebar_label: Tips
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
|
||||
## (Not) Sharing Your Location
|
||||
|
||||
Telemetry is shared over your [PRIMARY channel](/docs/settings/config/channels#role). This means that if your node has acquired GPS coordinates from an integrated GPS chip, or from your mobile device, your coordinates will be sent to the mesh over this channel, using it's defined encryption (if any).
|
||||
|
||||
By default the PRIMARY channel's name is LongFast with the encryption key "AQ==" (Base64 equivalent of Hex 0x01). If this is left unchanged, your location will be shared with all nodes in range that are also using the default channel.
|
||||
|
||||
### Creating a Private Primary with Default Secondary
|
||||
|
||||
If you'd like to connect with other Meshtastic users but only share your location with trusted parties, you may create a private PRIMARY channel and use the defaults for a SECONDARY channel.
|
||||
|
||||
1. Ensure you have not changed the LoRa [Modem Preset](/docs/settings/config/lora#modem-preset) from the default `unset` / `LONG_FAST`.
|
||||
2. On your PRIMARY channel, set anything you'd like for the channel's name and choose a random PSK.
|
||||
3. Enable a SECONDARY channel with a blank name (will default to LongFast) with PSK "AQ==".
|
||||
4. Since the radio's frequency is automatically changed based on your PRIMARY channel's name, you will have to manually set it back to Channel 20 (in LoRa settings) in order to interface with users on the default channel.
|
||||
|
||||
To quickly test this configuration, scan your region's QR from [this folder](https://github.com/meshtastic/meshtastic/tree/master/static/img/configuration/qr-private-primary-example/). Remember to generate a new PSK for your private channel before sharing with your trusted nodes.
|
||||
|
||||
## Rebroadcast "Public" Traffic
|
||||
|
||||
Meshtastic nodes will rebroadcast all packets if they share [LoRa modem settings](/docs/settings/config/lora#lora-config-values), regardless of encryption (unless [Rebroadcast mode](/docs/settings/config/device#rebroadcast-mode) is set to `LOCAL_ONLY`).
|
||||
|
||||
:::info
|
||||
If you would like your nodes to include/expand the "public" mesh, you must use the default [modem preset](/docs/settings/config/lora#modem-preset) `LONG_FAST`. If you change your PRIMARY channel name, you must manually set the LoRa channel to 20.
|
||||
:::
|
||||
|
||||
## Chat Channels VS LoRa Modem Channels
|
||||
|
||||
Meshtastic uses the word "channels" to define two different configuration properties: [Messaging Channels](/docs/settings/config/channels) & [LoRa Modem Channels](/docs/settings/config/lora#channel-number)
|
||||
|
||||
### Device Config: Channels
|
||||
|
||||
These configure "message groups" and include your PRIMARY and SECONDARY channels. All SECONDARY channels use the same LoRa modem config as your PRIMARY channel (including LoRa channel number).
|
||||
|
||||
There are 8 total chat channels. Channel 0 is your PRIMARY channel, with channels 1-7 available for private group messaging and/or special channels such as [`admin`](/docs/configuration/remote-admin).
|
||||
|
||||
### Device Config: LoRa: Channel Number
|
||||
|
||||
This configures the frequency the radio is set to. Check out the [frequency calculator](/docs/overview/radio-settings#channel-frequency-calculator) to view the relationship between "channel number" and radio frequency.
|
||||
|
||||
## Best Practices
|
||||
- If you are part of a large mesh and don't know what a setting does, don't change it (unless you're super curious).
|
||||
- Leave your [MAX HOPS](/docs/settings/config/lora#max-hops) set to 3 unless you're sure you need more (or less) to reach your destination node.
|
||||
- Leave your [ROLE](/docs/settings/config/device#role) set to `CLIENT` unless you're sure another role would suit the node's purpose. For example, MQTT nodes do not need to be set to `ROUTER`.
|
||||
- TEST your settings and hardware before you install in hard-to-reach locations.
|
||||
- Connecting a node to the [public MQTT server](http://localhost:3000/docs/settings/moduleconfig/mqtt#connect-to-the-default-public-server) may publish the locations of all nodes in your mesh to the internet. This will also add every globally connected node to your node database and potentially flood your mesh with all types of packets.
|
|
@ -17,7 +17,7 @@ Download and unzip the latest firmware from [Meshtastic Downloads](https://mesht
|
|||
2. Double click the reset button on your device (this will put it into bootloader mode)
|
||||
3. Notice a new drive will be mounted on your computer (Windows, Mac, or Linux)
|
||||
4. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT`
|
||||
5. Drop the appropriate firmware file (`firmware-DEVICE_NAME-vx.x.x-xxxxxxx.uf2`) from the release onto this drive.
|
||||
5. Drop the appropriate firmware file (`firmware-DEVICE_NAME-x.x.x-xxxxxxx.uf2`) from the release onto this drive.
|
||||
|
||||
Once the file has finished copying onto the drive, the device will reboot and install the Meshtastic firmware.
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ values={[
|
|||
|
||||
- [Android App](/docs/category/android-app)
|
||||
- [Web Client](https://client.meshtastic.org)
|
||||
- [iOS App](/docs/category/apple-apps)
|
||||
- [iOS/iPadOS/macOS App](/docs/category/apple-apps)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="network">
|
||||
|
|
|
@ -82,23 +82,11 @@ The app will generate a new QR code on the screen. This encodes the channel det
|
|||
|
||||
2. If the channel is shared from a file or link using the `Share` button, you can click on the file or link and you need to choose "Open with Meshtastic".
|
||||
|
||||
<details>
|
||||
<summary>Troubleshooting shared links: Can't "open with Meshtastic".</summary>
|
||||
<div>
|
||||
<div>
|
||||
If you don't see "Meshtastic" as an option to open the file or link with:
|
||||
<br />
|
||||
1. Go to Android Settings > Apps > Default apps > Meshtastic > Opening
|
||||
links
|
||||
<br />
|
||||
2. Make sure you have in "links/web address": www.meshtastic.org
|
||||
<br />
|
||||
3. If you see the option "Open the supported links", make sure it is
|
||||
enabled.
|
||||
<br />
|
||||
</div>
|
||||
</div>
|
||||
</details>
|
||||
:::info If a QR or URL opens a webpage instead of the APP or "Open with Meshtastic" is not an option:
|
||||
1. Go to Android Settings > Apps > Default apps > Meshtastic > Opening links
|
||||
2. Make sure you have in "links/web address": www.meshtastic.org
|
||||
3. If you see the option "Open the supported links", make sure it is enabled.
|
||||
:::
|
||||
|
||||
[![Accept new channel](/img/android/android-accept-channel-c.png)](/img/android/android-accept-channel.png)
|
||||
|
||||
|
|
|
@ -206,13 +206,13 @@ Always Check Configuration before reloading YAML or restarting Home Assistant to
|
|||
|
||||
Create a new Entities Card and select the entities you have created.
|
||||
|
||||
[<img src="/img/software/mqtt/ha_entities_card.png" style={{zoom: '40%'}} />](/img/software/mqtt/ha_entities_card.png)
|
||||
![HA Entities Card](/img/software/mqtt/ha_entities_card.png)
|
||||
|
||||
### Logbook Card for Messaging
|
||||
|
||||
The logbook card is useful to keep a record of incoming messages from the mesh. Below is an example of how the logbook card would be set up.
|
||||
|
||||
[<img src="/img/software/mqtt/ha_logbook_card.png" style={{zoom: '40%'}} />](/img/software/mqtt/ha_logbook_card.png)
|
||||
![HA Logbook Card](/img/software/mqtt/ha_logbook_card.png)
|
||||
|
||||
|
||||
## Trigger HA Automations
|
||||
|
@ -223,7 +223,7 @@ It is possible to have Home Assistant trigger automations based on messages or e
|
|||
|
||||
This example waits for a message containing @Tropho and then sends a pop-up notification to his flip phone with the message. Optionally you can have ALL messages from the mesh sent as HA notifications to your phone.
|
||||
|
||||
[<img src="/img/software/mqtt/ha_at_tropho.png" style={{zoom: '50%'}} />](/img/software/mqtt/ha_at_tropho.png)
|
||||
![HA At Tropho Message](/img/software/mqtt/ha_at_tropho.png)
|
||||
|
||||
Add the following code to your automations.yaml file. Be sure to modify the `topic`, `regex_search`, and `service` for your configuration.
|
||||
```yaml
|
||||
|
@ -253,4 +253,61 @@ Add the following code to your automations.yaml file. Be sure to modify the `to
|
|||
mode: single
|
||||
```
|
||||
|
||||
This same type of automation is very useful to trigger other actions in Home Assistant. For example, you could turn on a fan when the temperature reaches a certain value, or a play a sound on a speaker when a new message is received.
|
||||
This same type of automation is very useful to trigger other actions in Home Assistant. For example, you could turn on a fan when the temperature reaches a certain value, or a play a sound on a speaker when a new message is received.
|
||||
|
||||
|
||||
## Create a Send Message Entity
|
||||
|
||||
It is possible to create an input text box to send messages to your mesh from within Home Assistant.
|
||||
|
||||
### Input Text Helper Entity
|
||||
|
||||
First, create an input text helper entity. The preferred way to configure an input text is via the HA interface at Settings > Devices & Services > Helpers. Click the add button and then choose the Text option. Make a text input helper with a max length of 190 to be on the safe side. See example below:
|
||||
|
||||
![HA Input Text Helper](/img/software/mqtt/ha_input_text_helper.png)
|
||||
|
||||
### Create a Send Message Automation
|
||||
|
||||
This automation will check the send box for changes. After typing a message, either hit enter or click off the box and the automation will send a text string in JSON to the mqtt broker. Make sure to update the channel name and device ID in the example below.
|
||||
|
||||
```yaml
|
||||
- alias: Meshtastic - Send Automation
|
||||
description: ""
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id:
|
||||
- input_text.meshtastic_send_box
|
||||
condition: []
|
||||
action:
|
||||
- delay:
|
||||
hours: 0
|
||||
minutes: 0
|
||||
seconds: 1
|
||||
milliseconds: 0
|
||||
- service: mqtt.publish
|
||||
data:
|
||||
qos: 0
|
||||
retain: false
|
||||
topic: msh/2/json/LongFast/!67ea9400
|
||||
payload: >-
|
||||
{"channel":"0","sender":"broker","type":"sendtext","payload":"{{
|
||||
states('input_text.meshtastic_send_box') }}"}
|
||||
- delay:
|
||||
hours: 0
|
||||
minutes: 0
|
||||
seconds: 1
|
||||
milliseconds: 0
|
||||
- service: input_text.set_value
|
||||
data:
|
||||
value: " "
|
||||
target:
|
||||
entity_id: input_text.meshtastic_send_box
|
||||
- delay:
|
||||
hours: 0
|
||||
minutes: 0
|
||||
seconds: 2
|
||||
milliseconds: 0
|
||||
mode: single
|
||||
```
|
||||
|
||||
Add this card to your dashboard by going to Edit Dashboard -> + ADD CARD. Then search BY ENTITY for Meshtastic Send Box and check the box next to the entry. Click CONTINUE, then ADD TO DASHBOARD.
|
After Width: | Height: | Size: 948 B |
After Width: | Height: | Size: 938 B |
After Width: | Height: | Size: 938 B |
After Width: | Height: | Size: 951 B |
After Width: | Height: | Size: 941 B |
After Width: | Height: | Size: 940 B |
After Width: | Height: | Size: 949 B |
After Width: | Height: | Size: 947 B |
After Width: | Height: | Size: 943 B |
After Width: | Height: | Size: 934 B |
After Width: | Height: | Size: 944 B |
After Width: | Height: | Size: 935 B |
After Width: | Height: | Size: 948 B |
After Width: | Height: | Size: 940 B |
After Width: | Height: | Size: 940 B |
BIN
static/img/software/mqtt/ha_input_text_helper.png
Normal file
After Width: | Height: | Size: 61 KiB |