From c507181a205433420df94b6829dbe1181b17e4af Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Sun, 10 Mar 2024 21:25:09 -0700 Subject: [PATCH 01/20] add --ble documentation --- docs/software/python-cli/usage.mdx | 75 ++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/docs/software/python-cli/usage.mdx b/docs/software/python-cli/usage.mdx index cd61b8f4..d9778789 100644 --- a/docs/software/python-cli/usage.mdx +++ b/docs/software/python-cli/usage.mdx @@ -133,6 +133,79 @@ Use "--ch-set psk default" to restore the standard 'default' (minimally secure, All "ch-set" commands will default to the primary channel at index 0, but can be applied to other channels with the "ch-index" parameter. +## Utilizing BLE via the Python CLI + +The Python CLI supports communicating with Meshtastic devices via Bluetooth Low Energy (BLE), in addition to the standard serial and TCP/IP connections. To use BLE, you will need a Bluetooth adapter on your computer. + +### Scan for BLE Devices + +First, you can scan for available Meshtastic devices using: + +```shell +meshtastic --ble-scan +``` + +This will list all Meshtastic devices discoverable over BLE along with their addresses and names in the following format: + +```shell +Found: name='Meshtastic_1234' address='AA11BB22-CC33-DD44-EE55-FF6677889900' +BLE scan finished +``` + +### Available Commands + +Once you have the device address or name, you can utilize it alongside your normal Python CLI commands like `--info`, `--nodes`, `--export-config`, etc. but with the `--ble` option to communicate via BLE rather than serial. + +You can use **either** the name or address to issue your commands. + +```shell +meshtastic --ble --info +meshtastic --ble
--nodes +``` + +The initial time you use the `--ble` option for a specific device, you will be prompted to enter the BLE PIN code (as is normal with a client). Once paired, this step won't be required unless you forget the device. + +:::note +On Linux, you may need to pair the BLE device using `bluetoothctl` before connecting. This allows entering the required PIN for pairing. +::: + +### Additional BLE Examples + +#### Scan for devices and get info from the first one: + +```bash +meshtastic --ble-scan +# Sample output: +# Found: name='Meshtastic_1234' address='AA11BB22-CC33-DD44-EE55-FF6677889900' +# Found: name='Meshtastic_5678' address='FF00DD00-AA11-BB22-CC33-DD44EE5566FF' +BLE scan finished + +meshtastic --ble AA11BB22-CC33-DD44-EE55-FF6677889900 --info +``` + +#### Connect to a named device and read the node list: + +```shell +meshtastic --ble Meshtastic_1234 --nodes +``` +#### Export device config with --export-config + +```shell +meshtastic --ble Meshtastic_1234 --export-config > config.yaml +``` + +#### Send a command to a remote device using the --dest option: + +```shell +meshtastic --dest '!fe1932db4' --set device.is_managed false --ble Meshtastic_9abc +``` + +#### For debugging, you can enable verbose BLE logging by adding the `--debug` flag: + +```shell +meshtastic --ble AA11BB22-CC33-DD44-EE55-FF6677889900 --debug --info +``` + ## FAQ/common problems This is a collection of common questions and answers from our friendly forum. @@ -162,3 +235,5 @@ There is a problem with Big Sur and pyserial. The workaround is to install a new ```shell pip3 install -U --pre pyserial ``` +import { DeviceState } from "@buf/meshtastic_protobufs.bufbuild_es/meshtastic/deviceonly_pb" + From 9f85ee6628b2427f9c7241da32cbfb38c713fcc8 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Sun, 10 Mar 2024 21:27:33 -0700 Subject: [PATCH 02/20] oops don't know why that was added --- docs/software/python-cli/usage.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/software/python-cli/usage.mdx b/docs/software/python-cli/usage.mdx index d9778789..483bc13e 100644 --- a/docs/software/python-cli/usage.mdx +++ b/docs/software/python-cli/usage.mdx @@ -234,6 +234,4 @@ There is a problem with Big Sur and pyserial. The workaround is to install a new ```shell pip3 install -U --pre pyserial -``` -import { DeviceState } from "@buf/meshtastic_protobufs.bufbuild_es/meshtastic/deviceonly_pb" - +``` \ No newline at end of file From fc5b68e347bc54ffa15cb45692877a5aaf359b2d Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Sun, 10 Mar 2024 21:47:45 -0700 Subject: [PATCH 03/20] update --ble on index --- docs/software/python-cli/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/software/python-cli/index.mdx b/docs/software/python-cli/index.mdx index 5577fdee..691f81cf 100644 --- a/docs/software/python-cli/index.mdx +++ b/docs/software/python-cli/index.mdx @@ -440,10 +440,10 @@ meshtastic --test ### --ble BLE -BLE mac address to connect to (BLE is not yet supported for this tool). +Connect to a Meshtastic device using its BLE address or name. This option allows for wireless communication with the device, similar to how the `--host` option is used for TCP connections. ```shell title="Usage" -meshtastic --ble "83:38:92:32:37:48" +meshtastic --ble "device_name_or_address" --info ``` ### --noproto From 0204ff2a71de12b33b15b6ca8d089713e6edaef2 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Sun, 10 Mar 2024 21:48:00 -0700 Subject: [PATCH 04/20] add --ble-scan to index --- docs/software/python-cli/index.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/software/python-cli/index.mdx b/docs/software/python-cli/index.mdx index 691f81cf..747cc5ae 100644 --- a/docs/software/python-cli/index.mdx +++ b/docs/software/python-cli/index.mdx @@ -446,6 +446,14 @@ Connect to a Meshtastic device using its BLE address or name. This option allows meshtastic --ble "device_name_or_address" --info ``` +### --ble-scan + +Scan for available Meshtastic devices using BLE. This command lists discoverable devices, providing a convenient method to identify devices for connection via BLE. + +```shell title="Usage" +meshtastic --ble-scan +``` + ### --noproto Don't start the API, just function as a dumb serial terminal. Probably not very helpful from the command line. Used more for testing/internal needs. From 352431264dda066e02d91de22c684430764af983 Mon Sep 17 00:00:00 2001 From: Wouter Klijnsmit <30867746+wowtah@users.noreply.github.com> Date: Mon, 11 Mar 2024 16:16:16 +0100 Subject: [PATCH 05/20] Update local-groups.mdx Added Europe Added the Telegram group for The Netherlands Ordered the list A-Z --- docs/community/local-groups.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/community/local-groups.mdx b/docs/community/local-groups.mdx index f3626b55..0a3cda7f 100644 --- a/docs/community/local-groups.mdx +++ b/docs/community/local-groups.mdx @@ -20,6 +20,13 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group. ### Alberta - [YYC Mesh](https://yycmesh.com/) +## Europe +### The Netherlands +- [Meshtastic Netherlands](https://t.me/meshtastic_nl) + +### United Kingdon +- [UK Meshtastic Kent / South East](https://www.facebook.com/groups/ukmeshtastickent/) + ## United States ### Arkansas @@ -45,8 +52,7 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group. ### Texas - [Austin Mesh](https://austinmesh.org/) -## United Kingdon -- [UK Meshtastic Kent / South East](https://www.facebook.com/groups/ukmeshtastickent/) + From 14794f7640df31232c687113cac91203a4952f90 Mon Sep 17 00:00:00 2001 From: Wouter Klijnsmit <30867746+wowtah@users.noreply.github.com> Date: Mon, 11 Mar 2024 16:30:44 +0100 Subject: [PATCH 06/20] Update local-groups.mdx Removed Europe as a group. --- docs/community/local-groups.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/community/local-groups.mdx b/docs/community/local-groups.mdx index 0a3cda7f..80f9d682 100644 --- a/docs/community/local-groups.mdx +++ b/docs/community/local-groups.mdx @@ -20,11 +20,10 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group. ### Alberta - [YYC Mesh](https://yycmesh.com/) -## Europe -### The Netherlands +## The Netherlands - [Meshtastic Netherlands](https://t.me/meshtastic_nl) -### United Kingdon +## United Kingdon - [UK Meshtastic Kent / South East](https://www.facebook.com/groups/ukmeshtastickent/) ## United States From 5cc78e03bd3b7771e4374ea6eb615a1b58a6897c Mon Sep 17 00:00:00 2001 From: Alice <84906+wheresalice@users.noreply.github.com> Date: Mon, 11 Mar 2024 19:17:23 +0100 Subject: [PATCH 07/20] Correct Python MQTT code paho-mqtt version 2.0 is quite different to the old version 1, so the code needs updating to support the new version --- docs/software/integrations/mqtt/python.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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 From c0ab4304920862b222672ed9fe9ad3d6c89d5f75 Mon Sep 17 00:00:00 2001 From: "thomas.ekstrand" Date: Wed, 13 Mar 2024 13:46:16 -0500 Subject: [PATCH 08/20] allow for hidden elements in print and PDF generation --- docs/about/overview/radio-settings.mdx | 6 +- docs/configuration/radio/power.mdx | 132 +++++++++++++------------ src/css/custom.css | 10 +- 3 files changed, 77 insertions(+), 71 deletions(-) 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/radio/power.mdx b/docs/configuration/radio/power.mdx index 186ace3f..2207accd 100644 --- a/docs/configuration/radio/power.mdx +++ b/docs/configuration/radio/power.mdx @@ -49,73 +49,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/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; } } From 68b0ddbb91a7b4de19ce36d00dbf6db48d1f5825 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Wed, 13 Mar 2024 12:18:18 -0700 Subject: [PATCH 09/20] redirect --- vercel.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/vercel.json b/vercel.json index e8ea1798..199c4bff 100644 --- a/vercel.json +++ b/vercel.json @@ -64,6 +64,10 @@ { "source": "/docs/getting-started/faq", "destination": "/docs/faq/" - } + }, + { + "source": "/docs/", + "destination": "/docs/introduction/" + }, ] } From 7cacbccce4902fb9628c4abae08a719d6091b6be Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Wed, 13 Mar 2024 12:20:00 -0700 Subject: [PATCH 10/20] comma --- vercel.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vercel.json b/vercel.json index 199c4bff..51b14d20 100644 --- a/vercel.json +++ b/vercel.json @@ -68,6 +68,6 @@ { "source": "/docs/", "destination": "/docs/introduction/" - }, + } ] } From 6e36bdd5cc8d6d4cb5c44232234adf0a30a779a4 Mon Sep 17 00:00:00 2001 From: "thomas.ekstrand" Date: Wed, 13 Mar 2024 17:02:55 -0500 Subject: [PATCH 11/20] Add descriptions to all configuration documents --- docs/configuration/module/ambient-lighting.mdx | 1 + docs/configuration/module/audio.mdx | 1 + docs/configuration/module/canned-message.mdx | 1 + docs/configuration/module/detection-sensor.mdx | 1 + docs/configuration/module/external-notification.mdx | 1 + docs/configuration/module/index.mdx | 1 + docs/configuration/module/mqtt.mdx | 1 + docs/configuration/module/neighbor-info.mdx | 1 + docs/configuration/module/paxcounter.mdx | 1 + docs/configuration/module/range-test.mdx | 1 + docs/configuration/module/remote-hardware.mdx | 1 + docs/configuration/module/serial.mdx | 1 + docs/configuration/module/store-and-forward-module.mdx | 1 + docs/configuration/module/telemetry.mdx | 1 + docs/configuration/module/traceroute.mdx | 1 + docs/configuration/radio/bluetooth.mdx | 1 + docs/configuration/radio/channels.mdx | 1 + docs/configuration/radio/device.mdx | 1 + docs/configuration/radio/display.mdx | 1 + docs/configuration/radio/index.mdx | 1 + docs/configuration/radio/lora.mdx | 1 + docs/configuration/radio/network.mdx | 1 + docs/configuration/radio/position.mdx | 1 + docs/configuration/radio/power.mdx | 1 + docs/configuration/radio/user.mdx | 1 + docs/configuration/remote-admin.mdx | 3 ++- docs/configuration/tips.mdx | 2 +- 27 files changed, 28 insertions(+), 2 deletions(-) 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 2207accd..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"; 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 --- From 2f2ac5bcbb3cabb0fee032d92946999085a11ac7 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Wed, 13 Mar 2024 15:35:34 -0700 Subject: [PATCH 12/20] moved --- docs/community/local-groups.mdx | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/community/local-groups.mdx b/docs/community/local-groups.mdx index 80f9d682..ff99bd28 100644 --- a/docs/community/local-groups.mdx +++ b/docs/community/local-groups.mdx @@ -20,12 +20,6 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group. ### Alberta - [YYC Mesh](https://yycmesh.com/) -## The Netherlands -- [Meshtastic Netherlands](https://t.me/meshtastic_nl) - -## United Kingdon -- [UK Meshtastic Kent / South East](https://www.facebook.com/groups/ukmeshtastickent/) - ## United States ### Arkansas @@ -51,7 +45,11 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group. ### Texas - [Austin Mesh](https://austinmesh.org/) - +## United Kingdon +- [UK Meshtastic Kent / South East](https://www.facebook.com/groups/ukmeshtastickent/) + +## The Netherlands +- [Meshtastic Netherlands](https://t.me/meshtastic_nl) From 94a753c8970eea85b3395ac64cac07c8ac65ec2b Mon Sep 17 00:00:00 2001 From: Ian McEwen Date: Wed, 13 Mar 2024 17:52:46 -0700 Subject: [PATCH 13/20] Update MQTT docs for the topic containing 'e' --- docs/software/integrations/mqtt/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/software/integrations/mqtt/index.mdx b/docs/software/integrations/mqtt/index.mdx index 8bded5fe..0e6d398a 100644 --- a/docs/software/integrations/mqtt/index.mdx +++ b/docs/software/integrations/mqtt/index.mdx @@ -40,9 +40,9 @@ For each channel where uplink and/or downlink is enabled, two other topics might #### Protobufs topic A gateway node will uplink and/or downlink raw ([protobuf](https://developers.google.com/protocol-buffers)) MeshPackets to the topic: -`msh/2/c/CHANNELNAME/USERID`, where `CHANNELNAME` is the name of the channel. +`msh/2/e/CHANNELNAME/USERID`, where `CHANNELNAME` is the name of the channel (firmware versions prior to 2.3.0 will publish to a topic with `/c/` in the place of `/e/`). -For example: `msh/2/c/LongFast/!abcd1234` +For example: `msh/2/e/LongFast/!abcd1234` The payload is a raw protobuf, whose definitions for Meshtastic can be found [here](https://github.com/meshtastic/protobufs/blob/master/meshtastic). Reference guides for working with protobufs in several popular programming languages can be found [here](https://protobuf.dev/reference/). Looking at the MQTT traffic with a program like `mosquitto_sub` will tell you it's working, but you won't get much useful information out of it. For example: From 99e5cb87f09da45547766be705b89dae4433bce9 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 14 Mar 2024 13:26:38 -0700 Subject: [PATCH 14/20] frequency slot --- docs/configuration/radio/channels.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/radio/channels.mdx b/docs/configuration/radio/channels.mdx index 3daafdd4..5bd81071 100644 --- a/docs/configuration/radio/channels.mdx +++ b/docs/configuration/radio/channels.mdx @@ -56,8 +56,8 @@ Each channel is assigned one of 3 roles: - The channel settings are set to default. :::note -While you can have a different PRIMARY channel and communicate over SECONDARY channels with the same Name & PSK, a hash of the PRIMARY channel's name sets the LoRa channel number, which determines the actual frequency you are transmitting on in the band. -To ensure devices with different PRIMARY channel name transmit on the same frequency, you must explicitly set the LoRa channel number. +While you can have a different PRIMARY channel and communicate over SECONDARY channels with the same Name & PSK, a hash of the PRIMARY channel's name sets the LoRa frequency slot, which determines the actual frequency you are transmitting on in the band. +To ensure devices with different PRIMARY channel name transmit on the same frequency, you must explicitly set the LoRa frequency slot. ::: ## Channel Settings Values From fb2ab02969533928257dce2449b1c1c80885b66b Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 14 Mar 2024 13:47:04 -0700 Subject: [PATCH 15/20] update references on Tips page --- docs/configuration/tips.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/configuration/tips.mdx b/docs/configuration/tips.mdx index 9df2c493..2b8b49ab 100644 --- a/docs/configuration/tips.mdx +++ b/docs/configuration/tips.mdx @@ -29,9 +29,9 @@ If you'd like to connect with other Meshtastic users but only share your locatio 1. Ensure you have not changed the LoRa [Modem Preset](/docs/configuration/radio/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 named "LongFast" with PSK "AQ==". -4. If your LoRa channel is set to the default (`0`), the radio's frequency will be automatically changed based on your PRIMARY channel's name. In this case, you will have to manually set it back to your region's default (in LoRa settings) in order to interface with users on the default channel: +4. If your LoRa frequency slot is set to the default (`0`), the radio's trasnit frequency will be automatically changed based on your PRIMARY channel's name. In this case, you will have to manually set it back to your region's default (in LoRa settings) in order to interface with users on the default slot: -### Default Primary Channels by Region +### Default Primary Frequency Slots by Region | US | EU_433 | EU_868 | CN | JP | ANZ | KR | TW | RU | IN | NZ_865 | TH | UA_433 | UA_868 | MY_433 | MY_919 | SG_923 | LORA_24 | |:--:|:------:|:------:|:--:|:--:|:---:|:--:|:--:|:--:|:--:|:------:|:--:|:------:|:------:|:------:|:------:|:------:|:-------:| @@ -47,19 +47,19 @@ Meshtastic nodes will rebroadcast all packets if they share [LoRa modem settings If you would like your nodes to include/expand the "public" mesh, you must use the default [modem preset](/docs/configuration/radio/lora#modem-preset) `LONG_FAST`. If you change your PRIMARY channel name, you must manually set the LoRa channel to the default for your region (see above). ::: -## Chat Channels VS LoRa Modem Channels +## Chat Channels and LoRa Frequency Slots -Meshtastic uses the word "channels" to define two different configuration properties: [Messaging Channels](/docs/configuration/radio/channels) & [LoRa Modem Channels](/docs/configuration/radio/lora#channel-number) +Previously, Meshtastic used the word "channels" to define two different configuration properties: Messaging Channels & LoRa Channel Numbers. However, this could lead to confusion since "channels" was being used to refer to two distinct concepts. To clarify the distinction, the decision was made to change "LoRa Channel Number" to "LoRa Frequency Slot". ### Radio 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). +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 frequency slot). -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). +There are 8 total messaging 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). -### Radio Config: LoRa: Channel Number +### Radio Config: LoRa Frequency Slot -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. +This property, formerly known as "LoRa Channel Number", 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 "frequency slot" 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). From d00873924abf62e26cbcfa123f37c0ccc027ddd9 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 14 Mar 2024 13:49:22 -0700 Subject: [PATCH 16/20] spelling --- docs/configuration/tips.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/tips.mdx b/docs/configuration/tips.mdx index 2b8b49ab..d445e63b 100644 --- a/docs/configuration/tips.mdx +++ b/docs/configuration/tips.mdx @@ -29,7 +29,7 @@ If you'd like to connect with other Meshtastic users but only share your locatio 1. Ensure you have not changed the LoRa [Modem Preset](/docs/configuration/radio/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 named "LongFast" with PSK "AQ==". -4. If your LoRa frequency slot is set to the default (`0`), the radio's trasnit frequency will be automatically changed based on your PRIMARY channel's name. In this case, you will have to manually set it back to your region's default (in LoRa settings) in order to interface with users on the default slot: +4. If your LoRa frequency slot is set to the default (`0`), the radio's transmit frequency will be automatically changed based on your PRIMARY channel's name. In this case, you will have to manually set it back to your region's default (in LoRa settings) in order to interface with users on the default slot: ### Default Primary Frequency Slots by Region From d55b7ebe948dea74244a9d691e4072cfc4faf64b Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 14 Mar 2024 14:23:18 -0700 Subject: [PATCH 17/20] =?UTF-8?q?missed=20one=20=F0=9F=A4=A6=F0=9F=8F=BB?= =?UTF-8?q?=E2=80=8D=E2=99=82=EF=B8=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/configuration/radio/lora.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/radio/lora.mdx b/docs/configuration/radio/lora.mdx index 31b82149..d857432d 100644 --- a/docs/configuration/radio/lora.mdx +++ b/docs/configuration/radio/lora.mdx @@ -9,7 +9,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import LoRaRegions from "../../blocks/_lora-regions.mdx"; -The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled, Channel Number, Ignore Incoming Array, Ignore MQTT, Override Duty Cycle Limit, SX126x RX Boosted Gain, and Override Frequency. LoRa config uses an admin message sending a `Config.LoRa` protobuf. +The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled, Frequency Slot, Ignore Incoming Array, Ignore MQTT, Override Duty Cycle Limit, SX126x RX Boosted Gain, and Override Frequency. LoRa config uses an admin message sending a `Config.LoRa` protobuf. :::note In order to communicate fully, devices within a mesh must have identical settings for Region and Modem Preset, or identical custom Modem settings. From b9ca14f17402308345614b5cf6d9c86fde39bd5c Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 14 Mar 2024 14:38:51 -0700 Subject: [PATCH 18/20] add repobeats link back --- docs/development/reference/github.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/development/reference/github.mdx b/docs/development/reference/github.mdx index 7ba0080a..b7a126aa 100644 --- a/docs/development/reference/github.mdx +++ b/docs/development/reference/github.mdx @@ -75,6 +75,8 @@ A description about the project +Repobeats images can be generated at [repobeats.axiom.co](https://repobeats.axiom.co/) + ## Installation & Usage From b46de055dababe80d56a78df7362e1f6c90aa654 Mon Sep 17 00:00:00 2001 From: tekstrand Date: Thu, 14 Mar 2024 22:13:50 -0500 Subject: [PATCH 19/20] Add descriptions for getting-started documents --- docs/getting-started/flashing-firmware/esp32/cli-script.mdx | 1 + .../flashing-firmware/esp32/external-serial-adapter.mdx | 1 + docs/getting-started/flashing-firmware/esp32/index.mdx | 1 + docs/getting-started/flashing-firmware/esp32/web-flasher.mdx | 1 + .../getting-started/flashing-firmware/nrf52/convert-rak4631r.mdx | 1 + docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx | 1 + docs/getting-started/flashing-firmware/nrf52/index.mdx | 1 + docs/getting-started/flashing-firmware/nrf52/nrf52-erase.mdx | 1 + docs/getting-started/flashing-firmware/nrf52/ota.mdx | 1 + .../flashing-firmware/nrf52/update-techo-booloader.mdx | 1 + docs/getting-started/index.mdx | 1 + docs/getting-started/initial-config.mdx | 1 + docs/getting-started/serial-drivers/serial-drivers-esp32.mdx | 1 + docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx | 1 + .../serial-drivers/test-serial-driver-installation.mdx | 1 + 15 files changed, 15 insertions(+) diff --git a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx index 35eabc45..c8e0e4e2 100644 --- a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx +++ b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx @@ -3,6 +3,7 @@ id: cli-script title: Flashing with the CLI sidebar_label: CLI Script (Advanced Users) sidebar_position: 3 +description: Instructions for using the CLI to flash Meshtastic firmware to an ESP32 chipset device. --- import Tabs from "@theme/Tabs"; diff --git a/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx b/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx index 2f59a96c..6e2ccd8d 100644 --- a/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx +++ b/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx @@ -3,6 +3,7 @@ id: external-serial-adapter title: Flashing with an External Serial Adapter sidebar_label: External Serial Adapter (Advanced Users) sidebar_position: 4 +description: Instructions for using an external serial adapter to flash Meshtastic firmware to an ESP32 chipset device. --- import Tabs from "@theme/Tabs"; diff --git a/docs/getting-started/flashing-firmware/esp32/index.mdx b/docs/getting-started/flashing-firmware/esp32/index.mdx index 67479c36..5b85753a 100644 --- a/docs/getting-started/flashing-firmware/esp32/index.mdx +++ b/docs/getting-started/flashing-firmware/esp32/index.mdx @@ -3,6 +3,7 @@ id: flashing-esp32-devices title: Flash ESP32 Devices sidebar_label: ESP32 Device sidebar_position: 2 +description: Instructions to flash Meshtastic firmware to an ESP32 chipset device. --- :::info diff --git a/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx b/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx index 65d0de1c..a1df311e 100644 --- a/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx +++ b/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx @@ -3,6 +3,7 @@ id: web-flasher title: Meshtastic Web Flasher sidebar_label: Web Flasher (recommended) sidebar_position: 1 +description: Instructions for using the Web Flasher(recommended) to flash Meshtastic firmware to an ESP32 chipset device. --- import Link from "@docusaurus/Link"; diff --git a/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r.mdx b/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r.mdx index 99f86f5c..e94cc2eb 100644 --- a/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r.mdx @@ -3,6 +3,7 @@ id: convert-rak4631r title: Convert RAK4631-R to RAK4631 sidebar_label: Convert RAK4631-R sidebar_position: 4 +description: Instructions for converting the RAK4631-R to RAK-4631 using Python and adafruit-nrfutil. --- The only difference between the _RAK4631-R_ (RUI3) and the _RAK4631_ (Arduino) is the bootloader it is shipped with - the hardware is the same. diff --git a/docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx b/docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx index 27bff140..222ace1e 100644 --- a/docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx @@ -3,6 +3,7 @@ id: drag-n-drop title: Drag & Drop nRF52 & RP2040 Firmware Updates sidebar_label: Drag & Drop (recommended) sidebar_position: 1 +description: Instructions for using the Drag & Drop(recommended) file method to flash Meshtastic firmware to nRF52 or RP2040 chipset devices. --- import Tabs from "@theme/Tabs"; diff --git a/docs/getting-started/flashing-firmware/nrf52/index.mdx b/docs/getting-started/flashing-firmware/nrf52/index.mdx index dd244abd..0ca34309 100644 --- a/docs/getting-started/flashing-firmware/nrf52/index.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/index.mdx @@ -3,6 +3,7 @@ id: flashing-nrf52-devices title: Flash nRF52 & RP2040 Devices sidebar_label: nRF52/RP2040 Device sidebar_position: 2 +description: Instructions to flash Meshtastic firmware to nRF52 or RP2040 chipset devices. --- ## Flashing Methods for nRF52 and RP2040 Devices diff --git a/docs/getting-started/flashing-firmware/nrf52/nrf52-erase.mdx b/docs/getting-started/flashing-firmware/nrf52/nrf52-erase.mdx index 2b19073a..90a2cc9e 100644 --- a/docs/getting-started/flashing-firmware/nrf52/nrf52-erase.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/nrf52-erase.mdx @@ -3,6 +3,7 @@ id: nrf52-erase title: Flash nRF52/RP2040 Factory Erase sidebar_label: Factory Erase sidebar_position: 3 +description: Instructions for factory erasing an nRF52 or RP2040 device. --- import Link from "@docusaurus/Link"; diff --git a/docs/getting-started/flashing-firmware/nrf52/ota.mdx b/docs/getting-started/flashing-firmware/nrf52/ota.mdx index 36632eef..65211882 100644 --- a/docs/getting-started/flashing-firmware/nrf52/ota.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/ota.mdx @@ -3,6 +3,7 @@ id: ota title: nRF52 OTA Firmware Updates sidebar_label: Over-The-Air sidebar_position: 2 +description: Instructions for using the Over-The-Air(OTA) method to flash Meshtastic firmware to nRF52 chipset devices. --- import Tabs from "@theme/Tabs"; diff --git a/docs/getting-started/flashing-firmware/nrf52/update-techo-booloader.mdx b/docs/getting-started/flashing-firmware/nrf52/update-techo-booloader.mdx index 86c8d3b3..45c5fd4a 100644 --- a/docs/getting-started/flashing-firmware/nrf52/update-techo-booloader.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/update-techo-booloader.mdx @@ -3,6 +3,7 @@ id: update-techo-bootloader title: How to Update the LilyGo T-Echo Bootloader to the Latest Version sidebar_label: Update T-Echo Bootloader sidebar_position: 5 +description: Instructions for updating the T-Echo bootloader to the latest version for use with Meshtastic. --- If you're experiencing issues with updating or flashing newer versions of the Meshtastic firmware, and your LilyGo T-Echo is not running the latest bootloader version (0.6.1), updating the bootloader may resolve these problems. diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 6290e63c..3c53aa57 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -4,6 +4,7 @@ title: Getting Started sidebar_label: Getting Started slug: /getting-started sidebar_position: 2 +description: The official Meshtastic guide to get you started. Covers all devices and configurations. --- import Link from "@docusaurus/Link"; diff --git a/docs/getting-started/initial-config.mdx b/docs/getting-started/initial-config.mdx index df6985f4..13fe5740 100644 --- a/docs/getting-started/initial-config.mdx +++ b/docs/getting-started/initial-config.mdx @@ -4,6 +4,7 @@ title: Initial Configuration sidebar_label: Initial Configuration slug: /getting-started/initial-config sidebar_position: 4 +description: Getting started with the initial configuration of your Meshtastic device including serial, bluetooth, LoRa, and more. --- import Tabs from "@theme/Tabs"; diff --git a/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx b/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx index 0de4cfcf..710f9044 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx @@ -3,6 +3,7 @@ id: esp32 title: ESP32 Serial Drivers sidebar_label: ESP32 Drivers sidebar_position: 1 +description: Instructions for installing ESP32 USB serial drivers to interact with a Meshtastic device. --- import Tabs from "@theme/Tabs"; diff --git a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx index 9fd64735..7c8d1ac7 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx @@ -3,6 +3,7 @@ id: nrf52 title: nRF52/RP2040 Serial Drivers sidebar_label: nRF52/RP2040 Drivers sidebar_position: 2 +description: Instructions for installing nRF52 and RP2040 USB serial drivers to interact with a Meshtastic device. --- import Tabs from "@theme/Tabs"; diff --git a/docs/getting-started/serial-drivers/test-serial-driver-installation.mdx b/docs/getting-started/serial-drivers/test-serial-driver-installation.mdx index a5e5539f..460cf2f3 100644 --- a/docs/getting-started/serial-drivers/test-serial-driver-installation.mdx +++ b/docs/getting-started/serial-drivers/test-serial-driver-installation.mdx @@ -3,6 +3,7 @@ id: test-serial-driver-installation title: Test Serial Driver Installation sidebar_label: Test Serial Driver Installation sidebar_position: 3 +description: Instructions for testing serial driver installation on Linux, macOS, or Windows. --- import Link from "@docusaurus/Link"; From 810a485946b391ddf427efc20c19dd76c8a9e687 Mon Sep 17 00:00:00 2001 From: tekstrand Date: Thu, 14 Mar 2024 22:16:18 -0500 Subject: [PATCH 20/20] Add descriptions for getting-started documents, fix links --- docs/configuration/tips.mdx | 4 ++-- docs/terms/index.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration/tips.mdx b/docs/configuration/tips.mdx index d445e63b..ce38ee88 100644 --- a/docs/configuration/tips.mdx +++ b/docs/configuration/tips.mdx @@ -8,7 +8,7 @@ sidebar_position: 4 ## Roles -Leave your [ROLE](/docs/configuration/radio/device#role) set to `CLIENT` unless you're sure another role would suit the node's purpose. All `CLIENT` nodes will "repeat" and "route" packets. Roles are for very specific applications so please [read the documentation](/docs/configuration/radio/device#role) before changing your node's role. +Leave your [ROLE](/docs/configuration/radio/device#roles) set to `CLIENT` unless you're sure another role would suit the node's purpose. All `CLIENT` nodes will "repeat" and "route" packets. Roles are for very specific applications so please [read the documentation](/docs/configuration/radio/device#roles) before changing your node's role. :::info @@ -59,7 +59,7 @@ There are 8 total messaging channels. Channel 0 is your PRIMARY channel, with ch ### Radio Config: LoRa Frequency Slot -This property, formerly known as "LoRa Channel Number", 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 "frequency slot" and radio frequency. +This property, formerly known as "LoRa Channel Number", configures the frequency the radio is set to. Check out the [frequency calculator](/docs/overview/radio-settings#frequency-slot-calculator) to view the relationship between "frequency slot" 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). diff --git a/docs/terms/index.mdx b/docs/terms/index.mdx index ba6da8da..b430b323 100644 --- a/docs/terms/index.mdx +++ b/docs/terms/index.mdx @@ -13,7 +13,7 @@ Band Broadcast : Sending a message or data from one device to all other devices within range in the Meshtastic network, rather than to a specific recipient. -Channel | [Configuration](/docs/configuration/radio/channels/) | [Frequency Calculator](/docs/overview/radio-settings/#channel-frequency-calculator) +Channel | [Configuration](/docs/configuration/radio/channels/) | [Frequency Calculator](/docs/overview/radio-settings/#frequency-slot-calculator) : At least two definitions in Meshtastic usage: 1) One of 8 configurable channels in the firmware, each supporting a separate name and encryption, with one set as primary and the rest secondary. 2) A specific frequency within a LoRa band that a device can be configured to use. CLI | [Guide](/docs/software/python/cli/)