diff --git a/docs/about/overview/radio-settings.mdx b/docs/about/overview/radio-settings.mdx index 2ff2c7bd..b7154346 100644 --- a/docs/about/overview/radio-settings.mdx +++ b/docs/about/overview/radio-settings.mdx @@ -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 +
+ ## Frequency Slot Calculator - + +
## Europe Frequency Bands diff --git a/docs/configuration/module/ambient-lighting.mdx b/docs/configuration/module/ambient-lighting.mdx index d90eb8a0..3210c497 100644 --- a/docs/configuration/module/ambient-lighting.mdx +++ b/docs/configuration/module/ambient-lighting.mdx @@ -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"; diff --git a/docs/configuration/module/audio.mdx b/docs/configuration/module/audio.mdx index 546591dc..e5a693a5 100644 --- a/docs/configuration/module/audio.mdx +++ b/docs/configuration/module/audio.mdx @@ -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"; diff --git a/docs/configuration/module/canned-message.mdx b/docs/configuration/module/canned-message.mdx index 9ce28721..44cb0d94 100644 --- a/docs/configuration/module/canned-message.mdx +++ b/docs/configuration/module/canned-message.mdx @@ -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"; diff --git a/docs/configuration/module/detection-sensor.mdx b/docs/configuration/module/detection-sensor.mdx index 320c57b2..132e0df4 100644 --- a/docs/configuration/module/detection-sensor.mdx +++ b/docs/configuration/module/detection-sensor.mdx @@ -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"; diff --git a/docs/configuration/module/external-notification.mdx b/docs/configuration/module/external-notification.mdx index 797af397..a7be9ae0 100644 --- a/docs/configuration/module/external-notification.mdx +++ b/docs/configuration/module/external-notification.mdx @@ -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"; diff --git a/docs/configuration/module/index.mdx b/docs/configuration/module/index.mdx index 3877b2fa..d0b62fd8 100644 --- a/docs/configuration/module/index.mdx +++ b/docs/configuration/module/index.mdx @@ -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. diff --git a/docs/configuration/module/mqtt.mdx b/docs/configuration/module/mqtt.mdx index 6ef35299..cd19d785 100644 --- a/docs/configuration/module/mqtt.mdx +++ b/docs/configuration/module/mqtt.mdx @@ -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"; diff --git a/docs/configuration/module/neighbor-info.mdx b/docs/configuration/module/neighbor-info.mdx index ceb2dbfa..4f97721c 100644 --- a/docs/configuration/module/neighbor-info.mdx +++ b/docs/configuration/module/neighbor-info.mdx @@ -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"; diff --git a/docs/configuration/module/paxcounter.mdx b/docs/configuration/module/paxcounter.mdx index 1c1e17be..eb1e61c1 100644 --- a/docs/configuration/module/paxcounter.mdx +++ b/docs/configuration/module/paxcounter.mdx @@ -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"; diff --git a/docs/configuration/module/range-test.mdx b/docs/configuration/module/range-test.mdx index 98cf4f82..28f9f378 100644 --- a/docs/configuration/module/range-test.mdx +++ b/docs/configuration/module/range-test.mdx @@ -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"; diff --git a/docs/configuration/module/remote-hardware.mdx b/docs/configuration/module/remote-hardware.mdx index cb5b3f02..20eb8245 100644 --- a/docs/configuration/module/remote-hardware.mdx +++ b/docs/configuration/module/remote-hardware.mdx @@ -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"; diff --git a/docs/configuration/module/serial.mdx b/docs/configuration/module/serial.mdx index a5d2af8b..3e45da71 100644 --- a/docs/configuration/module/serial.mdx +++ b/docs/configuration/module/serial.mdx @@ -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"; diff --git a/docs/configuration/module/store-and-forward-module.mdx b/docs/configuration/module/store-and-forward-module.mdx index abe54e24..2053fd3b 100644 --- a/docs/configuration/module/store-and-forward-module.mdx +++ b/docs/configuration/module/store-and-forward-module.mdx @@ -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"; diff --git a/docs/configuration/module/telemetry.mdx b/docs/configuration/module/telemetry.mdx index f56c3c9b..3c3a7d92 100644 --- a/docs/configuration/module/telemetry.mdx +++ b/docs/configuration/module/telemetry.mdx @@ -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"; diff --git a/docs/configuration/module/traceroute.mdx b/docs/configuration/module/traceroute.mdx index 48c135a9..6ccf3967 100644 --- a/docs/configuration/module/traceroute.mdx +++ b/docs/configuration/module/traceroute.mdx @@ -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"; diff --git a/docs/configuration/radio/bluetooth.mdx b/docs/configuration/radio/bluetooth.mdx index 678a91a1..88ba9be3 100644 --- a/docs/configuration/radio/bluetooth.mdx +++ b/docs/configuration/radio/bluetooth.mdx @@ -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"; diff --git a/docs/configuration/radio/channels.mdx b/docs/configuration/radio/channels.mdx index 056b4c52..3daafdd4 100644 --- a/docs/configuration/radio/channels.mdx +++ b/docs/configuration/radio/channels.mdx @@ -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"; diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index 7379e63e..e2dca790 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -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"; diff --git a/docs/configuration/radio/display.mdx b/docs/configuration/radio/display.mdx index b4be9bff..f03d1e49 100644 --- a/docs/configuration/radio/display.mdx +++ b/docs/configuration/radio/display.mdx @@ -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"; diff --git a/docs/configuration/radio/index.mdx b/docs/configuration/radio/index.mdx index 466c0753..e7288697 100644 --- a/docs/configuration/radio/index.mdx +++ b/docs/configuration/radio/index.mdx @@ -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. diff --git a/docs/configuration/radio/lora.mdx b/docs/configuration/radio/lora.mdx index 67b2acca..31b82149 100644 --- a/docs/configuration/radio/lora.mdx +++ b/docs/configuration/radio/lora.mdx @@ -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"; diff --git a/docs/configuration/radio/network.mdx b/docs/configuration/radio/network.mdx index e2a93965..690ce17a 100644 --- a/docs/configuration/radio/network.mdx +++ b/docs/configuration/radio/network.mdx @@ -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"; diff --git a/docs/configuration/radio/position.mdx b/docs/configuration/radio/position.mdx index a93e63b8..15639acd 100644 --- a/docs/configuration/radio/position.mdx +++ b/docs/configuration/radio/position.mdx @@ -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"; diff --git a/docs/configuration/radio/power.mdx b/docs/configuration/radio/power.mdx index 186ace3f..5f1e225f 100644 --- a/docs/configuration/radio/power.mdx +++ b/docs/configuration/radio/power.mdx @@ -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. -
- ADC Calculator -
- -

This calibration method only maps 4.2V to Battery Charge Percent 100%, and does not address the potential non-linearities of the ADC.

- - - - - - - - - - - - - - - - - - -
Battery Charge Percent: - -
Current Adc Multiplier: - -
Calculated New Operative Adc Multiplier: - -
- -
- Default values for ADC Multipliers are: +
+
+ ADC Calculator +
+ +

This calibration method only maps 4.2V to Battery Charge Percent 100%, and does not address the potential non-linearities of the ADC.

+ + + + + + + + + + + + + + + + + + +
Battery Charge Percent: + +
Current Adc Multiplier: + +
Calculated New Operative Adc Multiplier: + +
+ +
+ 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 | -
-
+
+
+ ### Wait Bluetooth Interval diff --git a/docs/configuration/radio/user.mdx b/docs/configuration/radio/user.mdx index 8780868a..711a6f6d 100644 --- a/docs/configuration/radio/user.mdx +++ b/docs/configuration/radio/user.mdx @@ -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"; diff --git a/docs/configuration/remote-admin.mdx b/docs/configuration/remote-admin.mdx index a4960851..4f4546a0 100644 --- a/docs/configuration/remote-admin.mdx +++ b/docs/configuration/remote-admin.mdx @@ -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) \ No newline at end of file +[Complete list of user settings in Protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.User) diff --git a/docs/configuration/tips.mdx b/docs/configuration/tips.mdx index b73fafec..9df2c493 100644 --- a/docs/configuration/tips.mdx +++ b/docs/configuration/tips.mdx @@ -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 --- diff --git a/docs/software/integrations/mqtt/python.mdx b/docs/software/integrations/mqtt/python.mdx index 6f14c1a7..74af6002 100644 --- a/docs/software/integrations/mqtt/python.mdx +++ b/docs/software/integrations/mqtt/python.mdx @@ -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 diff --git a/src/css/custom.css b/src/css/custom.css index 7c784021..d0e7d277 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -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; } } diff --git a/vercel.json b/vercel.json index e8ea1798..51b14d20 100644 --- a/vercel.json +++ b/vercel.json @@ -64,6 +64,10 @@ { "source": "/docs/getting-started/faq", "destination": "/docs/faq/" + }, + { + "source": "/docs/", + "destination": "/docs/introduction/" } ] }