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 patch-1

Browse source
This commit is contained in:
rcarteraz 2024-03-13 15:32:44 -07:00 committed by GitHub
parent a472d0dccd a4aa3ee7fd
commit 86f07d7a42
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
31 changed files with 114 additions and 78 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/about/overview/radio-settings.mdx
View file

@ -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. 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 ## Europe Frequency Bands

1
docs/configuration/module/ambient-lighting.mdx
View file

@ -2,6 +2,7 @@
id: ambient-lighting id: ambient-lighting
title: Ambient Lighting Module Usage title: Ambient Lighting Module Usage
sidebar_label: Ambient Lighting sidebar_label: Ambient Lighting
description: Configuration details to manage LEDs on your Meshtastic device.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/audio.mdx
View file

@ -2,6 +2,7 @@
id: audio id: audio
title: Audio Module Configuration title: Audio Module Configuration
sidebar_label: Audio sidebar_label: Audio
description: Configuration details for the Audio Module of your Meshtastic device.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/canned-message.mdx
View file

@ -2,6 +2,7 @@
id: canned-message id: canned-message
title: Canned Message Module Configuration title: Canned Message Module Configuration
sidebar_label: Canned Message sidebar_label: Canned Message
description: Configuration details for canned (predefined) messages on your Meshtastic device.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/detection-sensor.mdx
View file

@ -2,6 +2,7 @@
id: detection-sensor id: detection-sensor
title: Detection Sensor Module Usage title: Detection Sensor Module Usage
sidebar_label: Detection Sensor 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/external-notification.mdx
View file

@ -2,6 +2,7 @@
id: external-notification id: external-notification
title: External Notification Module Configuration title: External Notification Module Configuration
sidebar_label: External Notification 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/index.mdx
View file

@ -4,6 +4,7 @@ title: Module Configuration
sidebar_label: Module Config sidebar_label: Module Config
sidebar_position: 2 sidebar_position: 2
slug: /configuration/module 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. Modules are included in the firmware and allow users to extend the functionality of their mesh or device.

1
docs/configuration/module/mqtt.mdx
View file

@ -2,6 +2,7 @@
id: mqtt id: mqtt
title: MQTT Module Configuration title: MQTT Module Configuration
sidebar_label: MQTT sidebar_label: MQTT
description: Learn to manage MQTT servers, encryption, and more for your Meshtastic device.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/neighbor-info.mdx
View file

@ -2,6 +2,7 @@
id: neighbor-info id: neighbor-info
title: Neighbor Info Module Usage title: Neighbor Info Module Usage
sidebar_label: Neighbor Info sidebar_label: Neighbor Info
description: This module allows you to send information about your immediate(0 hop) neighbors.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/paxcounter.mdx
View file

@ -2,6 +2,7 @@
id: paxcounter id: paxcounter
title: Paxcounter Module Usage title: Paxcounter Module Usage
sidebar_label: Paxcounter 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/range-test.mdx
View file

@ -2,6 +2,7 @@
id: range-test id: range-test
title: Range Test Module Configuration title: Range Test Module Configuration
sidebar_label: Range Test sidebar_label: Range Test
description: Learn to configure the range test module to create reports, maps, and more.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/remote-hardware.mdx
View file

@ -2,6 +2,7 @@
id: remote-hardware id: remote-hardware
title: Remote Hardware Module Usage title: Remote Hardware Module Usage
sidebar_label: Remote Hardware 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/serial.mdx
View file

@ -2,6 +2,7 @@
id: serial id: serial
title: Serial Module Configuration title: Serial Module Configuration
sidebar_label: Serial 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/store-and-forward-module.mdx
View file

@ -2,6 +2,7 @@
id: store-and-forward-module id: store-and-forward-module
title: Store & Forward Module Settings title: Store & Forward Module Settings
sidebar_label: Store & Forward 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/telemetry.mdx
View file

@ -2,6 +2,7 @@
id: telemetry id: telemetry
title: Telemetry Module Configuration title: Telemetry Module Configuration
sidebar_label: Telemetry sidebar_label: Telemetry
description: This module allows sharing of Device, Environment, and Air Quality metrics from your Meshtastic device.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/module/traceroute.mdx
View file

@ -2,6 +2,7 @@
id: traceroute id: traceroute
title: Traceroute Module Usage title: Traceroute Module Usage
sidebar_label: Traceroute 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/radio/bluetooth.mdx
View file

@ -2,6 +2,7 @@
id: bluetooth id: bluetooth
title: Bluetooth Settings title: Bluetooth Settings
sidebar_label: Bluetooth sidebar_label: Bluetooth
description: Configure Bluetooth settings on your Meshtastic device for connectivity with smartphones and other devices.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

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

@ -2,6 +2,7 @@
id: channels id: channels
title: Channel Configuration title: Channel Configuration
sidebar_label: Channels 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/radio/device.mdx
View file

@ -2,6 +2,7 @@
id: device id: device
title: Device Configuration title: Device Configuration
sidebar_label: Device 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/radio/display.mdx
View file

@ -2,6 +2,7 @@
id: display id: display
title: Display Configuration title: Display Configuration
sidebar_label: Display sidebar_label: Display
description: Details on the configuration options for the display on your Meshtastic device.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/radio/index.mdx
View file

@ -3,6 +3,7 @@ id: config
title: Radio Configuration title: Radio Configuration
sidebar_label: Radio Config sidebar_label: Radio Config
sidebar_position: 1 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. 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.

1
docs/configuration/radio/lora.mdx
View file

@ -2,6 +2,7 @@
id: lora id: lora
title: LoRa Configuration title: LoRa Configuration
sidebar_label: LoRa 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"; import Tabs from "@theme/Tabs";

1
docs/configuration/radio/network.mdx
View file

@ -2,6 +2,7 @@
id: network id: network
title: Network Configuration title: Network Configuration
sidebar_label: Network sidebar_label: Network
description: Learn about network configuration for your Meshtastic device including NTP, WiFi, and Ethernet.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

1
docs/configuration/radio/position.mdx
View file

@ -2,6 +2,7 @@
id: position id: position
title: Position Configuration title: Position Configuration
sidebar_label: Position sidebar_label: Position
description: GPS position configuration settings for your Meshtastic device including update intervals, broadcast settings, and GPIO.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

133
docs/configuration/radio/power.mdx
View file

@ -2,6 +2,7 @@
id: power id: power
title: Power Configuration title: Power Configuration
sidebar_label: Power sidebar_label: Power
description: Settings for advanced users who want to adjust the power configuration on their Meshtastic device.
--- ---
import Admonition from "@theme/Admonition"; 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. 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. 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> <div class="no-print">
<summary>ADC Calculator</summary> <details>
<div> <summary>ADC Calculator</summary>
<Admonition type="info"> <div>
<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 type="info">
</Admonition> <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>
<table> </Admonition>
<tr> <table>
<td> Battery Charge Percent: </td> <tr>
<td> <td> Battery Charge Percent: </td>
<input type="text" id="batteryChargePercent" defaultValue="65" /> <td>
</td> <input type="text" id="batteryChargePercent" defaultValue="65" />
</tr> </td>
<tr> </tr>
<td>Current Adc Multiplier: </td> <tr>
<td> <td>Current Adc Multiplier: </td>
<input type="text" id="operativeAdcMultiplier" defaultValue="2" /> <td>
</td> <input type="text" id="operativeAdcMultiplier" defaultValue="2" />
</tr> </td>
<tr> </tr>
<td>Calculated New Operative Adc Multiplier: </td> <tr>
<td> <td>Calculated New Operative Adc Multiplier: </td>
<input <td>
type="text" <input
id="newOperativeAdcMultiplier" type="text"
value="2" id="newOperativeAdcMultiplier"
disabled="disabled" value="2"
/> disabled="disabled"
</td> />
</tr> </td>
<tr> </tr>
<td></td> <tr>
<td> <td></td>
<button <td>
className="button button--outline button--lg cta--button" <button
onClick={calculateADC} className="button button--outline button--lg cta--button"
> onClick={calculateADC}
Calculate >
</button> Calculate
</td> </button>
</tr> </td>
</table> </tr>
Default values for ADC Multipliers are: </table>
Default values for ADC Multipliers are:
| Device | Default ADC Multiplier | | Device | Default ADC Multiplier |
| :-------: | :--------------------: | | :-------: | :--------------------: |
| hatter2 | 5.0 | | hatter2 | 5.0 |
| diy | 1.85 | | diy | 1.85 |
| esp32-s3-pico | 3.1 | | esp32-s3-pico | 3.1 |
| heltec_v1 & heltec_v2 | 3.2 | | heltec_v1 & heltec_v2 | 3.2 |
| heltec_v3 & heltec_wsl_v3 | 4.9 | | heltec_v3 & heltec_wsl_v3 | 4.9 |
| heltec_wireless_paper | 2 | | heltec_wireless_paper | 2 |
| heltec_wireless_tracker | 4.9 | | heltec_wireless_tracker | 4.9 |
| lora_isp4520 | 1.436 | | lora_isp4520 | 1.436 |
| m5stack_coreink | 5 | | m5stack_coreink | 5 |
| nano-g1-explorer | 2 | | nano-g1-explorer | 2 |
| picomputer-s3 | 3.1 | | picomputer-s3 | 3.1 |
| station-g1 | 6.45 | | station-g1 | 6.45 |
| station-g2 | 4 | | station-g2 | 4 |
| tlora_v2_1_16 | 2 | | tlora_v2_1_16 | 2 |
| tlora_v2_1_18 | 2.11 | | tlora_v2_1_18 | 2.11 |
| tlora_t3s3_v1 | 2.11 | | tlora_t3s3_v1 | 2.11 |
| t-deck | 2.11 | | t-deck | 2.11 |
| trackerd | 2 | | trackerd | 2 |
</div> </div>
</details> </details>
</div>
### Wait Bluetooth Interval ### Wait Bluetooth Interval

1
docs/configuration/radio/user.mdx
View file

@ -2,6 +2,7 @@
id: user id: user
title: User Configuration title: User Configuration
sidebar_label: User sidebar_label: User
description: Details on Long Name, Short Name, and Licensed operation.
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

3
docs/configuration/remote-admin.mdx
View file

@ -3,6 +3,7 @@ id: remote-admin
title: Remote Node Administration title: Remote Node Administration
sidebar_label: Remote Nodes sidebar_label: Remote Nodes
sidebar_position: 3 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 :::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: 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 [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)

2
docs/configuration/tips.mdx
View file

@ -1,7 +1,7 @@
--- ---
id: tips id: tips
title: Configuration 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_label: Tips
sidebar_position: 4 sidebar_position: 4
--- ---

10
docs/software/integrations/mqtt/python.mdx
View file

@ -7,15 +7,15 @@ sidebar_position: 2
### Sending/receiving messages on mosquitto server using python ### 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 ```python
#!/usr/bin/env python3 #!/usr/bin/env python3
import paho.mqtt.client as mqtt import paho.mqtt.client as mqtt
from random import randrange, uniform from random import uniform
import time import time
client = mqtt.Client("some_client_id") client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
client.connect('localhost') client.connect('localhost')
while True: while True:
@ -36,11 +36,11 @@ def on_message(mosq, obj, msg):
print("%-20s %d %s" % (msg.topic, msg.qos, msg.payload)) print("%-20s %d %s" % (msg.topic, msg.qos, msg.payload))
mosq.publish('pong', 'ack', 0) mosq.publish('pong', 'ack', 0)
def on_publish(mosq, obj, mid): def on_publish(mosq, obj, mid, reason_codes, properties):
pass pass
if __name__ == '__main__': if __name__ == '__main__':
client = paho.Client() client = paho.Client(paho.CallbackAPIVersion.VERSION2)
client.on_message = on_message client.on_message = on_message
client.on_publish = on_publish client.on_publish = on_publish

10
src/css/custom.css
View file

@ -230,12 +230,14 @@ td {
padding-right: 10px !important; padding-right: 10px !important;
} }
/* Need all tab content to show for PDF generation */ /* Print styles for manual printing and PDF generation */
@media print { @media print {
ul.tabs { ul.tabs,
.no-print {
display: none; display: none;
} }
.tabs-container div > div { .tabs-container div > div,
display: block; .accordion__panel {
display: block !important;
} }
} }

4
vercel.json
View file

@ -64,6 +64,10 @@
{ {
"source": "/docs/getting-started/faq", "source": "/docs/getting-started/faq",
"destination": "/docs/faq/" "destination": "/docs/faq/"
},
{
"source": "/docs/",
"destination": "/docs/introduction/"
} }
] ]
} }