mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-03-05 21:00:08 -08:00
Merge branch 'master' into patch-1
This commit is contained in:
rcarteraz
GitHub
commit
86f07d7a42
|
|
@ -17,9 +17,11 @@ Meshtastic is **not** LoRaWAN, Helium or TTN (TheThingsNetwork). Meshtastic uses
|
|||
Power limits will generally be lifted in the software if `is_licensed` is set to `true`. See [HAM Mode](/docs/faq#amateur-radio-ham) for more information.
|
||||
:::
|
||||
|
||||
## Frequency Slot Calculator
|
||||
<div class="no-print">
|
||||
## Frequency Slot Calculator
|
||||
|
||||
<FrequencyCalculator />
|
||||
<FrequencyCalculator />
|
||||
</div>
|
||||
|
||||
## Europe Frequency Bands
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: ambient-lighting
|
||||
title: Ambient Lighting Module Usage
|
||||
sidebar_label: Ambient Lighting
|
||||
description: Configuration details to manage LEDs on your Meshtastic device.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: audio
|
||||
title: Audio Module Configuration
|
||||
sidebar_label: Audio
|
||||
description: Configuration details for the Audio Module of your Meshtastic device.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: canned-message
|
||||
title: Canned Message Module Configuration
|
||||
sidebar_label: Canned Message
|
||||
description: Configuration details for canned (predefined) messages on your Meshtastic device.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: detection-sensor
|
||||
title: Detection Sensor Module Usage
|
||||
sidebar_label: Detection Sensor
|
||||
description: Configuration details for the Detection Sensor Module of your Meshtastic device. Used for motion, reed, and other open/closed gate systems.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: external-notification
|
||||
title: External Notification Module Configuration
|
||||
sidebar_label: External Notification
|
||||
description: This module will allow you to connect a buzzer, speaker, LED, or other similar accessory to your Meshtastic device.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ title: Module Configuration
|
|||
sidebar_label: Module Config
|
||||
sidebar_position: 2
|
||||
slug: /configuration/module
|
||||
description: Learn how to configure all of the different modules on your Meshtastic device.
|
||||
---
|
||||
|
||||
Modules are included in the firmware and allow users to extend the functionality of their mesh or device.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: mqtt
|
||||
title: MQTT Module Configuration
|
||||
sidebar_label: MQTT
|
||||
description: Learn to manage MQTT servers, encryption, and more for your Meshtastic device.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: neighbor-info
|
||||
title: Neighbor Info Module Usage
|
||||
sidebar_label: Neighbor Info
|
||||
description: This module allows you to send information about your immediate(0 hop) neighbors.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: paxcounter
|
||||
title: Paxcounter Module Usage
|
||||
sidebar_label: Paxcounter
|
||||
description: This module uses WiFi and BLE to count people or devices passing by your Meshtastic device. Used in retail, museums, etc.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: range-test
|
||||
title: Range Test Module Configuration
|
||||
sidebar_label: Range Test
|
||||
description: Learn to configure the range test module to create reports, maps, and more.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: remote-hardware
|
||||
title: Remote Hardware Module Usage
|
||||
sidebar_label: Remote Hardware
|
||||
description: The Remote Hardware Module allows to read, write and watch GPIO pins on a remote node.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: serial
|
||||
title: Serial Module Configuration
|
||||
sidebar_label: Serial
|
||||
description: This module is an interface to talk to and control your Meshtastic device over a serial port.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: store-and-forward-module
|
||||
title: Store & Forward Module Settings
|
||||
sidebar_label: Store & Forward
|
||||
description: This module allows you to resend text messages after a device has been temporarily not in LoRa range of the mesh.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: telemetry
|
||||
title: Telemetry Module Configuration
|
||||
sidebar_label: Telemetry
|
||||
description: This module allows sharing of Device, Environment, and Air Quality metrics from your Meshtastic device.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: traceroute
|
||||
title: Traceroute Module Usage
|
||||
sidebar_label: Traceroute
|
||||
description: The traceroute module allows you to understand the path a message took to reach the final destination over the mesh.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: bluetooth
|
||||
title: Bluetooth Settings
|
||||
sidebar_label: Bluetooth
|
||||
description: Configure Bluetooth settings on your Meshtastic device for connectivity with smartphones and other devices.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: channels
|
||||
title: Channel Configuration
|
||||
sidebar_label: Channels
|
||||
description: Understand how to configure channels on your Meshtastic device, including private channels, encryption, MQTT, and location precision.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: device
|
||||
title: Device Configuration
|
||||
sidebar_label: Device
|
||||
description: Learn about and compare device roles such as Client, Repeater, and Router as well as other Device settings.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: display
|
||||
title: Display Configuration
|
||||
sidebar_label: Display
|
||||
description: Details on the configuration options for the display on your Meshtastic device.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ id: config
|
|||
title: Radio Configuration
|
||||
sidebar_label: Radio Config
|
||||
sidebar_position: 1
|
||||
description: Dive into the technical specifics of configuring your Meshtastic radio settings, including frequency ranges, power limits, and channels for optimal communication.
|
||||
---
|
||||
|
||||
There are several config sections in the Meshtastic firmware, these are broken out so they can be sent as small admin messages over the mesh.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: lora
|
||||
title: LoRa Configuration
|
||||
sidebar_label: LoRa
|
||||
description: Understanding the LoRa configuration settings on your Meshtastic device including region, modem, hop limit, and more.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: network
|
||||
title: Network Configuration
|
||||
sidebar_label: Network
|
||||
description: Learn about network configuration for your Meshtastic device including NTP, WiFi, and Ethernet.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: position
|
||||
title: Position Configuration
|
||||
sidebar_label: Position
|
||||
description: GPS position configuration settings for your Meshtastic device including update intervals, broadcast settings, and GPIO.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: power
|
||||
title: Power Configuration
|
||||
sidebar_label: Power
|
||||
description: Settings for advanced users who want to adjust the power configuration on their Meshtastic device.
|
||||
---
|
||||
|
||||
import Admonition from "@theme/Admonition";
|
||||
|
|
@ -49,73 +50,75 @@ Should be set to floating point value between 2 and 6
|
|||
4. If "Battery Charge Percent" (e.g., B 3.82V 60%) is not displayed on the screen, it means that the default value of "Operative Adc Multiplier" is too high. Lower the "Operative Adc Multiplier" to a smaller number (it is recommended to decrease by 0.1) until the screen displays "Battery Charge Percent". Enter the current "Operative Adc Multiplier" in use into the "Operative Adc Multiplier" field in the calculator. Also, input the "Battery Charge Percent" displayed on the screen into the calculator.
|
||||
5. Click the "Calculate" button to compute the "Calculated New Operative Adc Multiplier", and set it as the new "Operative Adc Multiplier" for the device.
|
||||
|
||||
<details>
|
||||
<summary>ADC Calculator</summary>
|
||||
<div>
|
||||
<Admonition type="info">
|
||||
<p>This calibration method only maps 4.2V to Battery Charge Percent 100%, and does not address the potential non-linearities of the ADC.</p>
|
||||
</Admonition>
|
||||
<table>
|
||||
<tr>
|
||||
<td> Battery Charge Percent: </td>
|
||||
<td>
|
||||
<input type="text" id="batteryChargePercent" defaultValue="65" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Current Adc Multiplier: </td>
|
||||
<td>
|
||||
<input type="text" id="operativeAdcMultiplier" defaultValue="2" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Calculated New Operative Adc Multiplier: </td>
|
||||
<td>
|
||||
<input
|
||||
type="text"
|
||||
id="newOperativeAdcMultiplier"
|
||||
value="2"
|
||||
disabled="disabled"
|
||||
/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<button
|
||||
className="button button--outline button--lg cta--button"
|
||||
onClick={calculateADC}
|
||||
>
|
||||
Calculate
|
||||
</button>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
Default values for ADC Multipliers are:
|
||||
<div class="no-print">
|
||||
<details>
|
||||
<summary>ADC Calculator</summary>
|
||||
<div>
|
||||
<Admonition type="info">
|
||||
<p>This calibration method only maps 4.2V to Battery Charge Percent 100%, and does not address the potential non-linearities of the ADC.</p>
|
||||
</Admonition>
|
||||
<table>
|
||||
<tr>
|
||||
<td> Battery Charge Percent: </td>
|
||||
<td>
|
||||
<input type="text" id="batteryChargePercent" defaultValue="65" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Current Adc Multiplier: </td>
|
||||
<td>
|
||||
<input type="text" id="operativeAdcMultiplier" defaultValue="2" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Calculated New Operative Adc Multiplier: </td>
|
||||
<td>
|
||||
<input
|
||||
type="text"
|
||||
id="newOperativeAdcMultiplier"
|
||||
value="2"
|
||||
disabled="disabled"
|
||||
/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<button
|
||||
className="button button--outline button--lg cta--button"
|
||||
onClick={calculateADC}
|
||||
>
|
||||
Calculate
|
||||
</button>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
Default values for ADC Multipliers are:
|
||||
|
||||
| Device | Default ADC Multiplier |
|
||||
| :-------: | :--------------------: |
|
||||
| hatter2 | 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 |
|
||||
| lora_isp4520 | 1.436 |
|
||||
| m5stack_coreink | 5 |
|
||||
| nano-g1-explorer | 2 |
|
||||
| picomputer-s3 | 3.1 |
|
||||
| station-g1 | 6.45 |
|
||||
| station-g2 | 4 |
|
||||
| tlora_v2_1_16 | 2 |
|
||||
| tlora_v2_1_18 | 2.11 |
|
||||
| tlora_t3s3_v1 | 2.11 |
|
||||
| t-deck | 2.11 |
|
||||
| trackerd | 2 |
|
||||
| Device | Default ADC Multiplier |
|
||||
| :-------: | :--------------------: |
|
||||
| hatter2 | 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 |
|
||||
| lora_isp4520 | 1.436 |
|
||||
| m5stack_coreink | 5 |
|
||||
| nano-g1-explorer | 2 |
|
||||
| picomputer-s3 | 3.1 |
|
||||
| station-g1 | 6.45 |
|
||||
| station-g2 | 4 |
|
||||
| tlora_v2_1_16 | 2 |
|
||||
| tlora_v2_1_18 | 2.11 |
|
||||
| tlora_t3s3_v1 | 2.11 |
|
||||
| t-deck | 2.11 |
|
||||
| trackerd | 2 |
|
||||
|
||||
</div>
|
||||
</details>
|
||||
</div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
### Wait Bluetooth Interval
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: user
|
||||
title: User Configuration
|
||||
sidebar_label: User
|
||||
description: Details on Long Name, Short Name, and Licensed operation.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ id: remote-admin
|
|||
title: Remote Node Administration
|
||||
sidebar_label: Remote Nodes
|
||||
sidebar_position: 3
|
||||
description: An advanced feature which allows remote administration of a device through a secure channel on the Mesh instead of via Bluetooth, Serial, or IPv4.
|
||||
---
|
||||
|
||||
:::caution Disclaimer
|
||||
|
|
@ -199,4 +200,4 @@ You've finished setting up and adding two devices to the admin channel. Remember
|
|||
For further reading, I recommend starting out with the [Meshtastic Python CLI Guide](/docs/software/python/cli/) if you haven't already gone through this (hopefully you have since you are reading this). But for a full reference to the settings you can change, please see:
|
||||
|
||||
[Settings Overview](/docs/configuration) and
|
||||
[Complete list of user settings in Protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.User)
|
||||
[Complete list of user settings in Protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.User)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: tips
|
||||
title: Configuration Tips
|
||||
description: Common Settings & Solutions
|
||||
description: Tips and Solutions to help you get the most out of your Meshtastic device and network.
|
||||
sidebar_label: Tips
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
|
|
|||
|
|
@ -7,15 +7,15 @@ sidebar_position: 2
|
|||
|
||||
### Sending/receiving messages on mosquitto server using python
|
||||
|
||||
Here is an example publish message in python:
|
||||
Here is an example publish message in python (run `pip install paho-mqtt` first):
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
import paho.mqtt.client as mqtt
|
||||
from random import randrange, uniform
|
||||
from random import uniform
|
||||
import time
|
||||
|
||||
client = mqtt.Client("some_client_id")
|
||||
client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
|
||||
client.connect('localhost')
|
||||
|
||||
while True:
|
||||
|
|
@ -36,11 +36,11 @@ def on_message(mosq, obj, msg):
|
|||
print("%-20s %d %s" % (msg.topic, msg.qos, msg.payload))
|
||||
mosq.publish('pong', 'ack', 0)
|
||||
|
||||
def on_publish(mosq, obj, mid):
|
||||
def on_publish(mosq, obj, mid, reason_codes, properties):
|
||||
pass
|
||||
|
||||
if __name__ == '__main__':
|
||||
client = paho.Client()
|
||||
client = paho.Client(paho.CallbackAPIVersion.VERSION2)
|
||||
client.on_message = on_message
|
||||
client.on_publish = on_publish
|
||||
|
||||
|
|
|
|||
|
|
@ -230,12 +230,14 @@ td {
|
|||
padding-right: 10px !important;
|
||||
}
|
||||
|
||||
/* Need all tab content to show for PDF generation */
|
||||
/* Print styles for manual printing and PDF generation */
|
||||
@media print {
|
||||
ul.tabs {
|
||||
ul.tabs,
|
||||
.no-print {
|
||||
display: none;
|
||||
}
|
||||
.tabs-container div > div {
|
||||
display: block;
|
||||
.tabs-container div > div,
|
||||
.accordion__panel {
|
||||
display: block !important;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -64,6 +64,10 @@
|
|||
{
|
||||
"source": "/docs/getting-started/faq",
|
||||
"destination": "/docs/faq/"
|
||||
},
|
||||
{
|
||||
"source": "/docs/",
|
||||
"destination": "/docs/introduction/"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue