From 68ceb5240713a24781ec09c580f5d6d42a7b0023 Mon Sep 17 00:00:00 2001 From: Tommy Ekstrand Date: Thu, 22 Feb 2024 15:09:26 -0600 Subject: [PATCH] Add headings to all TabItems (#1021) --- docs/about/overview/range-test.mdx | 30 ++++++------ .../configuration/module/ambient-lighting.mdx | 9 +++- docs/configuration/module/audio.mdx | 10 +++- docs/configuration/module/canned-message.mdx | 10 +++- .../configuration/module/detection-sensor.mdx | 8 ++++ .../module/external-notification.mdx | 8 ++++ docs/configuration/module/mqtt.mdx | 46 +++++++++++++------ docs/configuration/module/neighbor-info.mdx | 3 ++ docs/configuration/module/paxcounter.mdx | 10 +++- docs/configuration/module/range-test.mdx | 8 ++++ docs/configuration/module/remote-hardware.mdx | 7 +++ docs/configuration/module/serial.mdx | 8 ++++ .../module/store-and-forward-module.mdx | 10 +++- docs/configuration/module/telemetry.mdx | 8 ++++ docs/configuration/module/traceroute.mdx | 8 ++++ docs/configuration/radio/bluetooth.mdx | 14 ++++-- docs/configuration/radio/channels.mdx | 14 ++++-- docs/configuration/radio/device.mdx | 10 +++- docs/configuration/radio/display.mdx | 10 +++- docs/configuration/radio/lora.mdx | 10 +++- docs/configuration/radio/network.mdx | 8 ++++ docs/configuration/radio/position.mdx | 8 ++++ docs/configuration/radio/power.mdx | 10 +++- docs/configuration/radio/user.mdx | 8 ++++ .../documentation/style-guides/settings.mdx | 4 ++ .../flashing-firmware/esp32/cli-script.mdx | 30 +++++++++--- .../flashing-firmware/nrf52/ota.mdx | 4 ++ docs/getting-started/initial-config.mdx | 14 ++++++ .../serial-drivers/serial-drivers-esp32.mdx | 6 +++ .../serial-drivers/serial-drivers-nrf52.mdx | 9 +++- .../test-serial-driver-installation.mdx | 6 +++ docs/hardware/devices/nano/buttons.mdx | 12 +++-- docs/software/python-cli/installation.mdx | 12 +++++ 33 files changed, 317 insertions(+), 55 deletions(-) diff --git a/docs/about/overview/range-test.mdx b/docs/about/overview/range-test.mdx index d9846321..438060cb 100644 --- a/docs/about/overview/range-test.mdx +++ b/docs/about/overview/range-test.mdx @@ -19,13 +19,15 @@ values={[ -## Current Ground Record: 254km +#### Ground + +##### Current Ground Record: 254km - **Range:** 254km (158 miles) - **Record Holders:** _kboxlabs_ - **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/137) -

Modem Settings

+
Modem Settings
Default Long_Fast - **Frequency:** 915MHz @@ -33,13 +35,13 @@ Default Long_Fast - **Spread Factor:** 11 - **Coding Rate:** 4/8 -

Node A

+
Node A
- **Device:** [RAK4631 Core](https://meshtastic.org/docs/hardware/devices/rak/core-module) with [RAK 5005-O Base Board](https://meshtastic.org/docs/hardware/devices/rak/base-board) - **Firmware Version:** 2.1.17 - **Antenna:** 902-928MHz 5.8 dBi Slinkdsco Outdoor -

Node B

+
Node B
- **Device:** [RAK4631 Core](https://meshtastic.org/docs/hardware/devices/rak/core-module) with [RAK 19003 Mini Base Board](https://meshtastic.org/docs/hardware/devices/rak/base-board) - **Firmware Version:** 2.1.18 @@ -52,26 +54,26 @@ Default Long_Fast Geographic Locations -## Previous Record 166km +##### Previous Record 166km - **Range:** 166km (103 miles) - **Record Holder:** _PuzzledPancake_ - **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/44) -

Modem Settings

+
Modem Settings
- **Frequency:** 868MHz - **Bandwidth:** 125 - **Spread Factor:** 12 - **Coding Rate:** 4/8 -

Node A

+
Node A
- **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam) - **Firmware Version:** 1.2 - **Antenna:** [868MHz 5dBi Antenna](https://ivent.co.nz/product/category/1000/868mhz%205dbi%20antenna%20193mm%20black%20sma%20%28m%29/38646) -

Node B

+
Node B
- **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam) - **Firmware Version:** 1.2 @@ -83,20 +85,22 @@ Default Long_Fast ![Node B](https://canada1.discourse-cdn.com/free1/uploads/meshtastic/optimized/2X/1/1c8bd5fc41f7bab925404b657a9c481882de9313_2_1332x1000.jpeg) -

Resources Used

+
Resources Used
- http://www.heywhatsthat.com -## Current Air Record: 206km +#### Air + +##### Current Air Record: 206km - **Range:** 206km (128 miles) - **Record Holders:** _StarWatcher, CVR, rook, kboxlabs_ - **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/130) -

Modem Settings

+
Modem Settings
Default Long_Fast - **Frequency:** 915MHz @@ -104,13 +108,13 @@ Default Long_Fast - **Spread Factor:** 11 - **Coding Rate:** 4/8 -

Node A

+
Node A
- **Device:** [LILYGO TTGO T-Beam](/docs/hardware/devices/tbeam) - **Firmware Version:** 2.1.10 - **Antenna:** Stock Antenna -

Node B

+
Node B
- **Device:** [LILYGO TTGO T-Beam](/docs/hardware/devices/tbeam) - **Firmware Version:** 2.1.10 (modified to place GPS in flight mode) diff --git a/docs/configuration/module/ambient-lighting.mdx b/docs/configuration/module/ambient-lighting.mdx index 4bb48d43..5a278eb5 100644 --- a/docs/configuration/module/ambient-lighting.mdx +++ b/docs/configuration/module/ambient-lighting.mdx @@ -46,6 +46,7 @@ values={[ ]}> +#### Android :::info All Ambient Lighting Module config options are available for Android in app version 2.2.3 and higher. @@ -57,6 +58,8 @@ All Ambient Lighting Module config options are available for Android in app vers +#### Apple + :::info All Ambient Lighting Module config options are available on iOS, iPadOS and macOS app versions 2.2.3 and higher at Settings > Modules > Ambient Lighting ::: @@ -64,6 +67,8 @@ All Ambient Lighting Module config options are available on iOS, iPadOS and macO +#### CLI + :::info All Ambient Lighting Module config options are available in the python CLI version 2.2.3 and higher. @@ -99,10 +104,12 @@ meshtastic --get ambient_lighting +#### Web + :::info All Ambient Lighting module config options are available in the Web UI. ::: - \ No newline at end of file + diff --git a/docs/configuration/module/audio.mdx b/docs/configuration/module/audio.mdx index 093ed620..546591dc 100644 --- a/docs/configuration/module/audio.mdx +++ b/docs/configuration/module/audio.mdx @@ -68,6 +68,8 @@ values={[ ]}> +#### Android + :::info Audio Config options are available for Android. @@ -81,6 +83,8 @@ Audio Config options are available for Android. +#### Apple + :::info Audio module config is not available on iOS, iPadOS and macOS. ::: @@ -88,6 +92,8 @@ Audio module config is not available on iOS, iPadOS and macOS. +#### CLI + :::info All audio module config options are available in the python CLI. Example commands are below: @@ -139,11 +145,13 @@ meshtastic --set audio.bitrate CODEC2_1400 +#### Web + :::info All audio module config options are available in the Web UI. ::: - + :::warning diff --git a/docs/configuration/module/canned-message.mdx b/docs/configuration/module/canned-message.mdx index b6fca729..4e46bc5f 100644 --- a/docs/configuration/module/canned-message.mdx +++ b/docs/configuration/module/canned-message.mdx @@ -86,6 +86,8 @@ values={[ ]}> +#### Android + :::info Canned Message Config options are available for Android. @@ -98,6 +100,8 @@ Canned Message Config options are available for Android. +#### Apple + :::info All canned message module config options are available on iOS, iPadOS and macOS at Settings > Modules > Canned Messages. ::: @@ -105,6 +109,8 @@ All canned message module config options are available on iOS, iPadOS and macOS +#### CLI + :::info All canned message module config options are available in the python CLI. @@ -192,11 +198,13 @@ meshtastic --set canned_message.inputbroker_event_press "" +#### Web + :::info All canned message module config options are available in the Web UI. ::: - + :::warning diff --git a/docs/configuration/module/detection-sensor.mdx b/docs/configuration/module/detection-sensor.mdx index a6594423..6c49a580 100644 --- a/docs/configuration/module/detection-sensor.mdx +++ b/docs/configuration/module/detection-sensor.mdx @@ -59,6 +59,8 @@ values={[ ]}> +#### Android + :::info All Detection Sensor Module config options are available for Android in app version 2.2.2 and higher. @@ -70,6 +72,8 @@ All Detection Sensor Module config options are available for Android in app vers +#### Apple + :::info All Detection Sensor Module config options are available on iOS, iPadOS and macOS app versions 2.2.2 and higher at Settings > Modules > Detection Sensor ::: @@ -77,6 +81,8 @@ All Detection Sensor Module config options are available on iOS, iPadOS and macO +#### CLI + :::info All Detection Sensor Module config options are available in the python CLI version 2.2.2 and higher. @@ -129,6 +135,8 @@ meshtastic --get detection_sensor +#### Web + :::info All Detection Sensor module config options are available in the Web UI. diff --git a/docs/configuration/module/external-notification.mdx b/docs/configuration/module/external-notification.mdx index 648c1a66..673043cb 100644 --- a/docs/configuration/module/external-notification.mdx +++ b/docs/configuration/module/external-notification.mdx @@ -63,6 +63,8 @@ values={[ ]}> +#### Android + :::info External Notification Config options are available for Android. @@ -75,6 +77,8 @@ External Notification Config options are available for Android. +#### Apple + :::info All external notification module config options are available on iOS, iPadOS and macOS at Settings > Modules > External Notification. ::: @@ -82,6 +86,8 @@ All external notification module config options are available on iOS, iPadOS and +#### CLI + :::info All external notification module config options are available in the python CLI. Example commands are below: @@ -147,6 +153,8 @@ meshtastic --set external_notification.output_ms 1500 +#### Web + :::info All External Notification module config is available for the Web UI. ::: diff --git a/docs/configuration/module/mqtt.mdx b/docs/configuration/module/mqtt.mdx index 2682833b..69b3dab3 100644 --- a/docs/configuration/module/mqtt.mdx +++ b/docs/configuration/module/mqtt.mdx @@ -61,6 +61,8 @@ values={[ ]}> +#### Android + :::info MQTT Config options are available for Android. @@ -73,6 +75,8 @@ MQTT Config options are available for Android. +#### Apple + :::info MQTT Config options are available on iOS, iPadOS and macOS at Settings > Modules > MQTT. @@ -82,6 +86,8 @@ MQTT Config options are available on iOS, iPadOS and macOS at Settings > Modules +#### CLI + :::info All MQTT module config options are available in the python CLI. Example commands are below: @@ -119,14 +125,16 @@ meshtastic --set mqtt.json_enabled true meshtastic --set mqtt.json_enabled false ``` - - + + + +#### Web :::info All MQTT module config options are available for the Web UI. ::: - + ## Connect to the Default Public Server @@ -146,7 +154,9 @@ values={[ -

1. Enable the MQTT Module

+#### Android + +##### 1. Enable the MQTT Module Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > MQTT: Turn on the slider for **MQTT enabled** and tap **Send**. @@ -156,13 +166,13 @@ Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > MQTT: [![Client Proxy](/img/modules/mqtt/android_mqtt_proxy_sm.webp)](/img/modules/mqtt/android_mqtt_proxy_encryption.webp) -

2. Enable Channel Uplink & Downlink

+##### 2. Enable Channel Uplink & Downlink Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > Channels > LongFast: Turn on the sliders for **Uplink enabled** and **Downlink enabled**, then tap **Save** and tap **Send**. [![Channel Settings](/img/modules/mqtt/android_channel_sm.webp)](/img/modules/mqtt/android_channel.webp) -

3. Configure Network Settings

+##### 3. Configure Network Settings Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > Network: Turn on the slider for **WiFi enabled**, Enter the **SSID** and **PSK** for your network, then tap **Send**. @@ -171,7 +181,9 @@ Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > Networ -

1. Enable the MQTT Module

+#### Apple + +##### 1. Enable the MQTT Module Navigate to Settings > MQTT: Turn on the slider for MQTT enabled and tap **Save** @@ -182,13 +194,13 @@ Navigate to Settings > MQTT: Turn on the slider for MQTT enabled and tap **Save* [![Client Proxy](/img/modules/mqtt/apple_mqtt_1_proxy_sm.webp)](/img/modules/mqtt/apple_mqtt_1_proxy_encryption.webp) -

2. Enable Channel Uplink & Downlink

+##### 2. Enable Channel Uplink & Downlink Navigate to Settings > Channels > Primary Channel: Turn on the sliders for **Uplink enabled** and **Downlink enabled** - Tap **Save** [![Channel Settings](/img/modules/mqtt/apple_channel_sm.webp)](/img/modules/mqtt/apple_channel.webp) -

3. Configure Network Settings

+##### 3. Configure Network Settings Navigate to Settings > Network: Turn on the slider for **WiFi enabled** - Enter your **SSID** and **PSK** for your network - Tap **Save** @@ -197,13 +209,15 @@ Navigate to Settings > Network: Turn on the slider for **WiFi enabled** - Enter -

1. Enable the MQTT Module

+#### CLI + +##### 1. Enable the MQTT Module ```shell meshtastic --set mqtt.enabled true ``` -

2. Enable Channel Uplink & Downlink

+##### 2. Enable Channel Uplink & Downlink ```shell meshtastic --ch-set uplink_enabled true --ch-index 0 @@ -215,7 +229,7 @@ or chained together: meshtastic --ch-set uplink_enabled true --ch-index 0 --ch-set downlink_enabled true --ch-index 0 ``` -

3. Configure Network Settings

+##### 3. Configure Network Settings ```shell meshtastic --set network.wifi_enabled true @@ -231,7 +245,9 @@ meshtastic --set network.wifi_enabled true --set network.wifi_ssid "your network -

1. Enable the MQTT Module

+#### Web + +##### 1. Enable the MQTT Module Navigate to Config > Module Config > MQTT - Turn on the slider for MQTT enabled - Click the **Save** icon. @@ -248,13 +264,13 @@ Though this option may be visible in your UI, Client Proxy is not yet functional ::: -

2. Enable Channel Uplink & Downlink

+##### 2. Enable Channel Uplink & Downlink Navigate to Channels > Primary: Turn on the sliders for **Uplink Enabled** and **Downlink Enabled** - Click the **Save** icon. [![Channel Settings](/img/modules/mqtt/web_channel_sm.webp)](/img/modules/mqtt/web_channel.webp) -

3. Configure Network Settings

+##### 3. Configure Network Settings Navigate to Radio Config > Device > Network: Turn on the slider for **Enabled** - Enter your **SSID** and **PSK** for your network - Click the **Save** icon. diff --git a/docs/configuration/module/neighbor-info.mdx b/docs/configuration/module/neighbor-info.mdx index 7f6416e6..ceb2dbfa 100644 --- a/docs/configuration/module/neighbor-info.mdx +++ b/docs/configuration/module/neighbor-info.mdx @@ -37,6 +37,7 @@ values={[ ]}> +#### Android :::info All Neighbor Info Module config options are available for Android in app version 2.2.0 and higher. @@ -48,6 +49,8 @@ All Neighbor Info Module config options are available for Android in app version +#### Apple + Not yet implemented. diff --git a/docs/configuration/module/paxcounter.mdx b/docs/configuration/module/paxcounter.mdx index 3208fd95..1878dc41 100644 --- a/docs/configuration/module/paxcounter.mdx +++ b/docs/configuration/module/paxcounter.mdx @@ -34,6 +34,8 @@ values={[ ]}> +#### Android + :::info No Paxcounter Module config options are available for Android. ::: @@ -41,6 +43,8 @@ No Paxcounter Module config options are available for Android. +#### Apple + :::info No Paxcounter Module config options are available on the iOS, iPadOS and macOS app. ::: @@ -48,6 +52,8 @@ No Paxcounter Module config options are available on the iOS, iPadOS and macOS a +#### CLI + :::info All Paxcounter Module config options are available in the python CLI version 2.2.16 and higher. @@ -71,10 +77,12 @@ meshtastic --get paxcounter +#### Web + :::info No Paxcounter module config options are available in the Web UI. ::: - \ No newline at end of file + diff --git a/docs/configuration/module/range-test.mdx b/docs/configuration/module/range-test.mdx index 6f2ca090..b69f8e95 100644 --- a/docs/configuration/module/range-test.mdx +++ b/docs/configuration/module/range-test.mdx @@ -67,6 +67,8 @@ values={[ ]}> +#### Android + :::info Range Test Config options are available for Android. @@ -81,6 +83,8 @@ Android also had the option to download a rangetest.csv file which is stored on +#### Apple + :::info All range test module config options are available on iOS, iPadOS and macOS at Settings > Modules > Range Test. ::: @@ -90,6 +94,8 @@ Apple apps also have the option to download logged position data which is stored +#### CLI + :::info Range Test module config options are available in the python CLI. Example commands are below: @@ -133,6 +139,8 @@ meshtastic --set range_test.sender 0 +#### Web + :::info All range test module config options are available in the Web UI. diff --git a/docs/configuration/module/remote-hardware.mdx b/docs/configuration/module/remote-hardware.mdx index 77ea5ee1..6f2cc5e4 100644 --- a/docs/configuration/module/remote-hardware.mdx +++ b/docs/configuration/module/remote-hardware.mdx @@ -34,6 +34,7 @@ values={[ ]}> +#### Android :::info All Remote Hardware Module config options are available for Android in app. @@ -45,6 +46,8 @@ All Remote Hardware Module config options are available for Android in app. +#### Apple + :::info All Remote Hardware Module config options are available on iOS, iPadOS and macOS app.and higher at Settings > Modules > Remote Hardware ::: @@ -52,6 +55,8 @@ All Remote Hardware Module config options are available on iOS, iPadOS and macOS +#### CLI + :::info All Remote Hardware Module config options are available in the python CLI. @@ -61,6 +66,8 @@ All Remote Hardware Module config options are available in the python CLI. +#### Web + Not implemented. diff --git a/docs/configuration/module/serial.mdx b/docs/configuration/module/serial.mdx index d314e21e..c1320fe1 100644 --- a/docs/configuration/module/serial.mdx +++ b/docs/configuration/module/serial.mdx @@ -79,6 +79,8 @@ values={[ ]}> +#### Android + :::info Serial Module Config options are available for Android. @@ -91,6 +93,8 @@ Serial Module Config options are available for Android. +#### Apple + :::info All serial module config options are available on iOS, iPadOS and macOS at Settings > Modules > Serial. ::: @@ -98,6 +102,8 @@ All serial module config options are available on iOS, iPadOS and macOS at Setti +#### CLI + :::info All serial module config options are available in the python CLI. Example commands are below: @@ -161,6 +167,8 @@ meshtastic --set serial.timeout 15 +#### Web + :::info All serial module config options are available in the Web UI. ::: diff --git a/docs/configuration/module/store-and-forward-module.mdx b/docs/configuration/module/store-and-forward-module.mdx index 012cf85f..62da447d 100644 --- a/docs/configuration/module/store-and-forward-module.mdx +++ b/docs/configuration/module/store-and-forward-module.mdx @@ -106,6 +106,8 @@ values={[ +#### Android + :::info Store and Forward Config options are available for Android. @@ -117,6 +119,8 @@ Store and Forward Config options are available for Android. +#### Apple + :::info Store and Forward configuration is not currently available via the Apple clients. ::: @@ -125,6 +129,8 @@ Store and Forward configuration is not currently available via the Apple clients +#### CLI + | Setting | Acceptable Values | Default | | :---------------------------------: | :---------------: | :-----: | | store_forward.enabled | `true`, `false` | `false` | @@ -143,7 +149,7 @@ meshtastic --set store_forward.enabled true --set store_forward.history_return_m ::: -### Examples of CLI Usage +##### Examples of CLI Usage ```shell title="Enable the module" meshtastic --set store_forward.enabled true @@ -183,6 +189,8 @@ meshtastic --set store_forward.records 100 +#### Web + :::info Store and Forward configuration is not currently available via the web client. ::: diff --git a/docs/configuration/module/telemetry.mdx b/docs/configuration/module/telemetry.mdx index c00f4e0d..d6b4bd5a 100644 --- a/docs/configuration/module/telemetry.mdx +++ b/docs/configuration/module/telemetry.mdx @@ -83,6 +83,8 @@ values={[ ]}> +#### Android + :::info Telemetry Config options are available for Android. @@ -95,6 +97,8 @@ Telemetry Config options are available for Android. +#### Apple + :::info All telemetry module config options are available on iOS, iPadOS and macOS at Settings > Module Configuration > Telemetry. @@ -103,6 +107,8 @@ All telemetry module config options are available on iOS, iPadOS and macOS at Se +#### CLI + :::info All telemetry module config options are available in the python CLI. Example commands are below: @@ -157,6 +163,8 @@ meshtastic --set telemetry.environment_display_fahrenheit false +#### Web + :::info All telemetry module config options are available in the Web UI. diff --git a/docs/configuration/module/traceroute.mdx b/docs/configuration/module/traceroute.mdx index 26e8a528..7532534c 100644 --- a/docs/configuration/module/traceroute.mdx +++ b/docs/configuration/module/traceroute.mdx @@ -28,6 +28,8 @@ values={[ ]}> +#### Android + Make sure the app is at least version 2.1.10. Under the node list, long hold a destination node and select 'Traceroute' to send the request. Depending on the amount of hops that is needed, this might take a while. The result will be shown using a pop-up. @@ -35,6 +37,8 @@ Under the node list, long hold a destination node and select 'Traceroute' to sen +#### Apple + Make sure the app is at least version 2.0.9. Under Contacts > Direct Messages, long hold a destination node and select 'Trace Route' to send the request. Depending on the amount of hops that is needed, this might take a while. The result will be shown in the Mesh Log. @@ -42,6 +46,8 @@ Under Contacts > Direct Messages, long hold a destination node and select 'Trace +#### CLI + Make sure the CLI is at least version 2.0.6. Then use this command: ```shell title="CLI traceroute command" @@ -63,6 +69,8 @@ The first ID shown is the device you are connected to with the CLI. As you can s +#### Web + Not yet implemented. diff --git a/docs/configuration/radio/bluetooth.mdx b/docs/configuration/radio/bluetooth.mdx index f3a9cc57..b9123d60 100644 --- a/docs/configuration/radio/bluetooth.mdx +++ b/docs/configuration/radio/bluetooth.mdx @@ -51,6 +51,8 @@ values={[ ]}> +#### Android + :::info All Bluetooth config options are available for Android. @@ -63,6 +65,8 @@ All Bluetooth config options are available for Android. +#### Apple + :::info All Bluetooth config values are available on iOS, iPadOS and macOS. @@ -75,6 +79,8 @@ All Bluetooth config values are available on iOS, iPadOS and macOS. +#### CLI + :::info All Bluetooth module config options are available in the python CLI. Example commands are below: @@ -107,8 +113,10 @@ meshtastic --set bluetooth.mode FIXED_PIN meshtastic --set bluetooth.fixed_pin 111111 ``` - - + + + +#### Web :::info @@ -119,5 +127,5 @@ All Bluetooth module config options are available for the Web UI. ::: - + diff --git a/docs/configuration/radio/channels.mdx b/docs/configuration/radio/channels.mdx index 38ecff05..2ebd9ef4 100644 --- a/docs/configuration/radio/channels.mdx +++ b/docs/configuration/radio/channels.mdx @@ -118,6 +118,8 @@ values={[ +#### Android + :::info Channel Config options are available on Android. ::: @@ -143,6 +145,8 @@ Tap the Channel Name (or the pen icon) to access the Channel Menu: +#### Apple + :::info Channel settings are only available on Apple platforms by scanning QR codes. ::: @@ -151,6 +155,8 @@ Channel settings are only available on Apple platforms by scanning QR codes. +#### CLI + :::info All Channel config options are available in the python CLI. Example commands are below: ::: @@ -165,7 +171,7 @@ meshtastic --ch-set name "My Channel" --ch-set psk random --ch-set uplink_enable ::: -### Name +##### Name ```shell title="Set channel name for the PRIMARY channel" # without spaces @@ -174,7 +180,7 @@ meshtastic --ch-set name MyChannel --ch-index 0 meshtastic --ch-set name "My Channel" --ch-index 0 ``` -### PSK +##### PSK If you use Meshtastic for exchanging messages you don't want other people to see, `random` is the setting you should use. Selecting `default` or any of the `simple` values from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. @@ -213,7 +219,7 @@ Use this to copy and paste the `base64` encoded (single channel) key from the me meshtastic --ch-set psk none --ch-index 0 ``` -### Uplink / Downlink +##### Uplink / Downlink For configuring gateways, please see [MQTT](/docs/configuration/module/mqtt) @@ -231,6 +237,8 @@ meshtastic --ch-set downlink_enabled false --ch-index 5 +#### Web + :::info All Channel config options are available in the Web UI. ::: diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index 8a850cfb..a2794b6a 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -101,6 +101,8 @@ values={[ ]}> +#### Android + :::info Device Config is available for Android. @@ -113,6 +115,8 @@ Device Config is available for Android. +#### Apple + :::info All device config options other than NTP Server are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Device. ::: @@ -120,6 +124,8 @@ All device config options other than NTP Server are available on iOS, iPadOS and +#### CLI + :::info All device config options are available in the python CLI. Example commands are below: @@ -163,9 +169,11 @@ meshtastic --set device.debug_log_enabled true +#### Web + :::info All device config options are available in the Web UI. ::: - + diff --git a/docs/configuration/radio/display.mdx b/docs/configuration/radio/display.mdx index 11a3eda6..6b91b293 100644 --- a/docs/configuration/radio/display.mdx +++ b/docs/configuration/radio/display.mdx @@ -84,6 +84,8 @@ values={[ ]}> +#### Android + :::info Display Config is available for Android. @@ -96,6 +98,8 @@ Display Config is available for Android. +#### Apple + :::info All display config options are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Display. ::: @@ -103,6 +107,8 @@ All display config options are available on iOS, iPadOS and macOS at Settings > +#### CLI + :::info All display config options are available in the python CLI. Example commands are below: @@ -150,9 +156,11 @@ meshtastic --set display.gps_format UTM +#### Web + :::info All display config options are available in the Web UI. ::: - + diff --git a/docs/configuration/radio/lora.mdx b/docs/configuration/radio/lora.mdx index 53e94bfc..4d1ea645 100644 --- a/docs/configuration/radio/lora.mdx +++ b/docs/configuration/radio/lora.mdx @@ -141,6 +141,8 @@ values={[ ]}> +#### Android + :::info LoRa Config options are available on Android. @@ -153,6 +155,8 @@ LoRa Config options are available on Android. +#### Apple + :::info Configuration of Region, Modem Preset, Transmit Enabled, Hop Limit, Channel Number and RX Boosted gain is available on iOS, iPadOS and macOS at Settings > Radio Configuration > LoRa. ::: @@ -160,6 +164,8 @@ Configuration of Region, Modem Preset, Transmit Enabled, Hop Limit, Channel Numb +#### CLI + :::info LoRa config commands are available in the python CLI. Example commands are below: @@ -217,9 +223,11 @@ meshtastic --set lora.override_duty_cycle false +#### Web + :::info All LoRa config options are available in the Web UI. ::: - + diff --git a/docs/configuration/radio/network.mdx b/docs/configuration/radio/network.mdx index e0095648..da0f99bb 100644 --- a/docs/configuration/radio/network.mdx +++ b/docs/configuration/radio/network.mdx @@ -73,6 +73,8 @@ values={[ +#### Android + :::info Network Config options are available for Android. @@ -86,6 +88,8 @@ Network Config options are available for Android. +#### Apple + :::info Network config options are available on iOS, iPadOS and macOS. @@ -96,6 +100,8 @@ Network config options are available on iOS, iPadOS and macOS. +#### CLI + :::info All Network config options are available in the python CLI. @@ -147,6 +153,8 @@ meshtastic --set network.wifi_psk "my password" +#### Web + :::info All Network config options are available in the Web UI. ::: diff --git a/docs/configuration/radio/position.mdx b/docs/configuration/radio/position.mdx index 592c26ce..795de117 100644 --- a/docs/configuration/radio/position.mdx +++ b/docs/configuration/radio/position.mdx @@ -102,6 +102,8 @@ values={[ ]}> +#### Android + :::info Position Config options are available for Android. @@ -114,6 +116,8 @@ Position Config options are available for Android. +#### Apple + :::info All position config values are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Position. ::: @@ -121,6 +125,8 @@ All position config values are available on iOS, iPadOS and macOS at Settings > +#### CLI + :::info All Position config commands are available in the python CLI. Example commands are below: @@ -199,6 +205,8 @@ meshtastic --pos-fields UNSET +#### Web + :::info All position config options are available in the Web UI. ::: diff --git a/docs/configuration/radio/power.mdx b/docs/configuration/radio/power.mdx index e3a62696..86d58794 100644 --- a/docs/configuration/radio/power.mdx +++ b/docs/configuration/radio/power.mdx @@ -127,6 +127,8 @@ values={[ ]}> +#### Android + :::info Power Config options are available for Android. @@ -139,6 +141,8 @@ Power Config options are available for Android. +#### Apple + :::info Power config is not available on Apple OS's. @@ -147,6 +151,8 @@ Power config is not available on Apple OS's. +#### CLI + :::info All Power config options are available in the python CLI. @@ -201,9 +207,11 @@ meshtastic --set power.min_wake_secs 120 +#### Web + :::info All power config options are available in the Web UI. ::: - + diff --git a/docs/configuration/radio/user.mdx b/docs/configuration/radio/user.mdx index 25f421de..5a394ace 100644 --- a/docs/configuration/radio/user.mdx +++ b/docs/configuration/radio/user.mdx @@ -48,6 +48,8 @@ values={[ +#### Android + :::info All User config options are available for Android. @@ -61,6 +63,8 @@ All User config options are available for Android. +#### Apple + :::info All User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`. ::: @@ -69,6 +73,8 @@ All User config options are available on iOS, iPadOS and macOS at `Settings > Ra +#### CLI + :::info All User config options are available in the python CLI. Example commands are below: @@ -103,6 +109,8 @@ meshtastic --set-ham 'CALLSIGN' +#### Web + :::info All User config options are available in the Web UI. ::: diff --git a/docs/development/documentation/style-guides/settings.mdx b/docs/development/documentation/style-guides/settings.mdx index 54abeb39..bb1ba89f 100644 --- a/docs/development/documentation/style-guides/settings.mdx +++ b/docs/development/documentation/style-guides/settings.mdx @@ -88,15 +88,19 @@ values={[ {label: 'Web', value: 'web'}, ]}> +#### CLI (Required for accessibility) CLI content here +#### Android (Required for accessibility) Android content here +#### iOS (Required for accessibility) iOS content here +#### Web (Required for accessibility) Web content here diff --git a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx index c41f3625..35eabc45 100644 --- a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx +++ b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx @@ -35,6 +35,8 @@ values={[ ]}> +#### Linux + Check if you have `python3` and `pip` installed with the following command ```shell @@ -58,6 +60,8 @@ sudo apt-get install python3-pip +#### macOS + OS X comes with `Python 2.7` installed, but not `pip`. The following uses Homebrew to install `python3` which includes `pip3`. On MacOS you will use `pip3` instead > of `pip`. :::note @@ -93,6 +97,8 @@ pip3 -v +#### Windows + - Download and install [Python](https://www.python.org). When installing, make sure to click `Add Python X.Y to PATH`. - Download and install [Gitbash](https://gitforwindows.org) (or other appropriate shell) and run all subsequent commands from that shell. @@ -130,6 +136,8 @@ values={[ ]}> +#### Linux + :::important On Linux, you may need to explicitly declare esptool as a .py script. Use `esptool.py chip_id`. ::: @@ -137,6 +145,8 @@ On Linux, you may need to explicitly declare esptool as a .py script. Use `espto +#### macOS + :::important On macOS, you may need to explicitly declare esptool as a .py script. Use `esptool.py chip_id`. ::: @@ -144,6 +154,8 @@ On macOS, you may need to explicitly declare esptool as a .py script. Use `espto +#### Windows + :::important On Windows, you must explicitly declare esptool as a .py script. Use `esptool.py chip_id`. ::: @@ -202,13 +214,15 @@ values={[ ]}> -#### Install +#### Linux + +##### Install ```shell title="Command" ./device-install.sh -f firmware-BOARD-VERSION.bin ``` -#### Update +##### Update ```shell title="Command" ./device-update.sh -f firmware-BOARD-VERSION.bin @@ -217,13 +231,15 @@ values={[ -#### Install +#### macOS + +##### Install ```shell title="Command" ./device-install.sh -f firmware-BOARD-VERSION.bin ``` -#### Update +##### Update ```shell title="Command" ./device-update.sh -f firmware-BOARD-VERSION.bin @@ -232,13 +248,15 @@ values={[ -#### Install +#### Windows + +##### Install ```shell title="Command" device-install.bat -f firmware-BOARD-VERSION.bin ``` -#### Update +##### Update ```shell title="Command" device-update.bat -f firmware-BOARD-VERSION.bin diff --git a/docs/getting-started/flashing-firmware/nrf52/ota.mdx b/docs/getting-started/flashing-firmware/nrf52/ota.mdx index 8f278bd5..36632eef 100644 --- a/docs/getting-started/flashing-firmware/nrf52/ota.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/ota.mdx @@ -20,6 +20,8 @@ values={[ +#### Android + :::info As of this writing, the current Android release of the nRF DFU app (v2.3.0) is not compatible with Meshtastic firmware updates. Please use the instructions below for updating via OTA with the nRF Connect App. ::: @@ -38,6 +40,8 @@ OTA firmware updates are available for Android using an older release of the mor +#### Apple + OTA firmware updates are available on iOS & iPadOS using the nRF Device Firmware Update App available through the [Apple App Store](https://apps.apple.com/us/app/nrf-device-firmware-update/id1624454660) 1. Download the firmware release you wish to install from the [Meshtastic Download Page](/downloads), [Meshtastic GitHub](https://github.com/meshtastic/firmware/releases), or via the iOS or iPadOS app. diff --git a/docs/getting-started/initial-config.mdx b/docs/getting-started/initial-config.mdx index 554f15ef..df6985f4 100644 --- a/docs/getting-started/initial-config.mdx +++ b/docs/getting-started/initial-config.mdx @@ -25,6 +25,8 @@ values={[ ]}> +#### Serial + - [Python CLI](/docs/software/python/cli/) - [Web Client](https://client.meshtastic.org) - [Android App](/docs/category/android-app) @@ -32,6 +34,8 @@ values={[ +#### Bluetooth + - [Android App](/docs/category/android-app) - [Web Client](https://client.meshtastic.org) - [iOS/iPadOS/macOS App](/docs/category/apple-apps) @@ -39,6 +43,8 @@ values={[ +#### Network + :::info Connecting over network is only supported on ESP32 devices. ::: @@ -66,6 +72,8 @@ values={[ ]}> +#### Android + 1. Follow the [installation](/docs/software/android/installation) and [usage](/docs/software/python/cli/usage) instructions for [Meshtastic Android](/docs/category/android-app). 2. Open the app, connect to the device from your phone over USB Serial or Bluetooth. 3. Once paired, Click "UNSET" next to the device name. @@ -74,6 +82,8 @@ values={[ +#### Apple + :::info Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS and macOS at Settings > Radio Configuration > LoRa. ::: @@ -81,6 +91,8 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS +#### CLI + 1. Install [Meshtastic PythonCLI](/docs/software/python/cli/installation) ```sh pip3 install --upgrade pytap2 @@ -94,6 +106,8 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS +#### Web + 1. Open the Meshtastic Web interface: [client.meshtastic.org](https://client.meshtastic.org) 2. Navigate to the **LoRa** menu. 3. Under **Regional Settings**, set your **Region** according to your regional location. diff --git a/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx b/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx index 7ae12650..0de4cfcf 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx @@ -26,6 +26,8 @@ values={[ +#### Linux + - [CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) - [CH9102 Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html) @@ -33,6 +35,8 @@ values={[ +#### macOS + - [CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) - [CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos) @@ -40,6 +44,8 @@ values={[ +#### Windows + - [CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) - [CH9102 Driver - Windows Download](http://www.wch.cn/downloads/CH343SER_ZIP.html) - [CH9102 Driver - Windows Download (Direct Download for Windows 7)](https://github.com/Xinyuan-LilyGO/CH9102_Driver) diff --git a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx index 5d2dc7e1..9fd64735 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx @@ -28,12 +28,15 @@ values={[ +#### Linux + - [CH34x Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html) +#### macOS :::info @@ -41,7 +44,7 @@ With the latest versions of MacOS, the USB Serial driver is built-in. If you dow ::: -### Remove the CH34x USB Driver (macOS) +##### Remove the CH34x USB Driver (macOS) If you have already downloaded/installed the macOS WCH-IC CH340/CH341 ("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to @@ -53,7 +56,7 @@ Uninstall the kernel extension: 4. Reboot -### Install the CH34x Driver +##### Install the CH34x Driver - [CH34x Driver- macOS Download](https://github.com/WCHSoftGroup/ch34xser_macos) @@ -63,6 +66,8 @@ Uninstall the kernel extension: +#### Windows + - [CH34x Driver - Windows Download](http://www.wch-ic.com/downloads/CH341SER_EXE.html) 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 6726b51d..f22f1482 100644 --- a/docs/getting-started/serial-drivers/test-serial-driver-installation.mdx +++ b/docs/getting-started/serial-drivers/test-serial-driver-installation.mdx @@ -23,6 +23,8 @@ values={[ ]}> +#### Linux + 1. Connect your Meshtastic device to your USB port 2. Open a **Terminal** and enter the following command: @@ -43,6 +45,8 @@ values={[ +#### macOS + 1. Navigate to `Apple Menu  > About This Mac > More Info > System Report... > Hardware > USB`. 2. You should see similar to one of the following entries: @@ -54,6 +58,8 @@ values={[ +#### Windows + 1. Navigate to `Device Manager > Ports (COM & LPT)` 2. You should see similar to one of the following entries: diff --git a/docs/hardware/devices/nano/buttons.mdx b/docs/hardware/devices/nano/buttons.mdx index b46d7018..28843f25 100644 --- a/docs/hardware/devices/nano/buttons.mdx +++ b/docs/hardware/devices/nano/buttons.mdx @@ -21,7 +21,9 @@ values={[ -### Nano G2 Ultra Buttons +### Nano G2 Ultra + +#### Buttons - **User/Program Button:** - **Single press:** Changes the information page displayed on the device's screen. @@ -30,7 +32,7 @@ values={[ - **Message Read Button:** - **Single press:** Clears the New Message LED. -### Nano G2 Ultra Switches +#### Switches - **Power:** - **Toggle Up:** Turns on the device. @@ -46,7 +48,9 @@ values={[ -### Nano G1 Explorer Buttons +### Nano G1 Explorer + +#### Buttons - **User/Program Button:** - **Single press:** Changes the information page displayed on the device's screen. @@ -54,7 +58,7 @@ values={[ - **Message Read Button:** - **Single press:** Clears the New Message LED. -### Nano G1 Explorer Switches +### Switches - **Power:** - **Toggle Up:** Turns on the device. diff --git a/docs/software/python-cli/installation.mdx b/docs/software/python-cli/installation.mdx index dd2ba9d9..7f1a2067 100644 --- a/docs/software/python-cli/installation.mdx +++ b/docs/software/python-cli/installation.mdx @@ -41,6 +41,8 @@ values={[ ]}> +#### Linux + - Check that your computer has the required serial drivers installed - Connect your Meshtastic device to your USB port @@ -98,6 +100,8 @@ values={[ +#### macOS + - Check that your computer has the required serial drivers installed - Connect your Meshtastic device to your USB port - Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB` @@ -139,6 +143,8 @@ values={[ +#### Windows + - Check that your computer has the required serial drivers installed - Connect your Meshtastic device to your USB port - Open Device Manager @@ -171,6 +177,8 @@ values={[ +#### Termux + :::note Wifi connection is currently under development and may not be working properly just yet. If you would like to provide feedback or test this feature, please visit our [forum](https://meshtastic.discourse.group) or join our [Discord server](https://discord.gg/ktMAKGBnBs) for more information. ::: @@ -219,6 +227,8 @@ values={[ ]}> +#### Ubuntu + - Download meshtastic_ubuntu - Run the following command to make the file executable and rename it 'meshtastic': @@ -240,6 +250,8 @@ Copy (or move) this binary somewhere in your path. +#### Windows + - Download meshtastic_windows - Rename to meshtastic.exe