mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add headings to all TabItems (#1021)

Browse source
This commit is contained in:
Tommy Ekstrand 2024-02-22 15:09:26 -06:00 committed by GitHub
parent 700f9a40f2
commit 68ceb52407
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
33 changed files with 317 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/about/overview/range-test.mdx
View file

@ -19,13 +19,15 @@ values={[
<TabItem value="ground"> <TabItem value="ground">
## Current Ground Record: 254km #### Ground
##### Current Ground Record: 254km
- **Range:** 254km (158 miles) - **Range:** 254km (158 miles)
- **Record Holders:** _kboxlabs_ - **Record Holders:** _kboxlabs_
- **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/137) - **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/137)
<h2 id="modem-settings-254">Modem Settings</h2> <h5 id="modem-settings-254">Modem Settings</h5>
Default Long_Fast Default Long_Fast
- **Frequency:** 915MHz - **Frequency:** 915MHz
@ -33,13 +35,13 @@ Default Long_Fast
- **Spread Factor:** 11 - **Spread Factor:** 11
- **Coding Rate:** 4/8 - **Coding Rate:** 4/8
<h2 id="node-a-254">Node A</h2> <h5 id="node-a-254">Node A</h5>
- **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) - **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 - **Firmware Version:** 2.1.17
- **Antenna:** 902-928MHz 5.8 dBi Slinkdsco Outdoor - **Antenna:** 902-928MHz 5.8 dBi Slinkdsco Outdoor
<h2 id="node-b-254">Node B</h2> <h5 id="node-b-254">Node B</h5>
- **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) - **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 - **Firmware Version:** 2.1.18
@ -52,26 +54,26 @@ Default Long_Fast
<img src="/img/records/kboxlabs_map.webp" alt="Geographic Locations" /> <img src="/img/records/kboxlabs_map.webp" alt="Geographic Locations" />
## Previous Record 166km ##### Previous Record 166km
- **Range:** 166km (103 miles) - **Range:** 166km (103 miles)
- **Record Holder:** _PuzzledPancake_ - **Record Holder:** _PuzzledPancake_
- **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/44) - **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/44)
<h2 id="modem-settings-166">Modem Settings</h2> <h5 id="modem-settings-166">Modem Settings</h5>
- **Frequency:** 868MHz - **Frequency:** 868MHz
- **Bandwidth:** 125 - **Bandwidth:** 125
- **Spread Factor:** 12 - **Spread Factor:** 12
- **Coding Rate:** 4/8 - **Coding Rate:** 4/8
<h2 id="node-a-166">Node A</h2> <h5 id="node-a-166">Node A</h5>
- **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam) - **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam)
- **Firmware Version:** 1.2 - **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) - **Antenna:** [868MHz 5dBi Antenna](https://ivent.co.nz/product/category/1000/868mhz%205dbi%20antenna%20193mm%20black%20sma%20%28m%29/38646)
<h2 id="node-b-166">Node B</h2> <h5 id="node-b-166">Node B</h5>
- **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam) - **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam)
- **Firmware Version:** 1.2 - **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) ![Node B](https://canada1.discourse-cdn.com/free1/uploads/meshtastic/optimized/2X/1/1c8bd5fc41f7bab925404b657a9c481882de9313_2_1332x1000.jpeg)
<h2>Resources Used</h2> <h5>Resources Used</h5>
- http://www.heywhatsthat.com - http://www.heywhatsthat.com
</TabItem> </TabItem>
<TabItem value="air"> <TabItem value="air">
## Current Air Record: 206km #### Air
##### Current Air Record: 206km
- **Range:** 206km (128 miles) - **Range:** 206km (128 miles)
- **Record Holders:** _StarWatcher, CVR, rook, kboxlabs_ - **Record Holders:** _StarWatcher, CVR, rook, kboxlabs_
- **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/130) - **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/130)
<h2 id="modem-settings-206">Modem Settings</h2> <h5 id="modem-settings-206">Modem Settings</h5>
Default Long_Fast Default Long_Fast
- **Frequency:** 915MHz - **Frequency:** 915MHz
@ -104,13 +108,13 @@ Default Long_Fast
- **Spread Factor:** 11 - **Spread Factor:** 11
- **Coding Rate:** 4/8 - **Coding Rate:** 4/8
<h2 id="node-a-206">Node A</h2> <h5 id="node-a-206">Node A</h5>
- **Device:** [LILYGO TTGO T-Beam](/docs/hardware/devices/tbeam) - **Device:** [LILYGO TTGO T-Beam](/docs/hardware/devices/tbeam)
- **Firmware Version:** 2.1.10 - **Firmware Version:** 2.1.10
- **Antenna:** Stock Antenna - **Antenna:** Stock Antenna
<h2 id="node-b-206">Node B</h2> <h5 id="node-b-206">Node B</h5>
- **Device:** [LILYGO TTGO T-Beam](/docs/hardware/devices/tbeam) - **Device:** [LILYGO TTGO T-Beam](/docs/hardware/devices/tbeam)
- **Firmware Version:** 2.1.10 (modified to place GPS in flight mode) - **Firmware Version:** 2.1.10 (modified to place GPS in flight mode)

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

@ -46,6 +46,7 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
All Ambient Lighting Module config options are available for Android in app version 2.2.3 and higher. 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
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::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 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Ambient Lighting Module config options are available in the python CLI version 2.2.3 and higher. All Ambient Lighting Module config options are available in the python CLI version 2.2.3 and higher.
@ -99,6 +104,8 @@ meshtastic --get ambient_lighting
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All Ambient Lighting module config options are available in the Web UI. All Ambient Lighting module config options are available in the Web UI.

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

@ -68,6 +68,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Audio Config options are available for Android. Audio Config options are available for Android.
@ -81,6 +83,8 @@ Audio Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
Audio module config is not available on iOS, iPadOS and macOS. 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.
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All audio module config options are available in the python CLI. Example commands are below: 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
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All audio module config options are available in the Web UI. All audio module config options are available in the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>
:::warning :::warning

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

@ -86,6 +86,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Canned Message Config options are available for Android. Canned Message Config options are available for Android.
@ -98,6 +100,8 @@ Canned Message Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All canned message module config options are available on iOS, iPadOS and macOS at Settings > Modules > Canned Messages. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All canned message module config options are available in the python CLI. All canned message module config options are available in the python CLI.
@ -192,11 +198,13 @@ meshtastic --set canned_message.inputbroker_event_press ""
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All canned message module config options are available in the Web UI. All canned message module config options are available in the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>
:::warning :::warning

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

@ -59,6 +59,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
All Detection Sensor Module config options are available for Android in app version 2.2.2 and higher. 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
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::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 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Detection Sensor Module config options are available in the python CLI version 2.2.2 and higher. 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
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All Detection Sensor module config options are available in the Web UI. All Detection Sensor module config options are available in the Web UI.

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

@ -63,6 +63,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
External Notification Config options are available for Android. External Notification Config options are available for Android.
@ -75,6 +77,8 @@ External Notification Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All external notification module config options are available on iOS, iPadOS and macOS at Settings > Modules > External Notification. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All external notification module config options are available in the python CLI. Example commands are below: 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
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All External Notification module config is available for the Web UI. All External Notification module config is available for the Web UI.
::: :::

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

@ -61,6 +61,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
MQTT Config options are available for Android. MQTT Config options are available for Android.
@ -73,6 +75,8 @@ MQTT Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
MQTT Config options are available on iOS, iPadOS and macOS at Settings > Modules > MQTT. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All MQTT module config options are available in the python CLI. Example commands are below: 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 meshtastic --set mqtt.json_enabled false
``` ```
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All MQTT module config options are available for the Web UI. All MQTT module config options are available for the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>
## Connect to the Default Public Server ## Connect to the Default Public Server
@ -146,7 +154,9 @@ values={[
<TabItem value="android"> <TabItem value="android">
<h3>1. Enable the MQTT Module</h3> #### 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**. 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) [![Client Proxy](/img/modules/mqtt/android_mqtt_proxy_sm.webp)](/img/modules/mqtt/android_mqtt_proxy_encryption.webp)
<h3>2. Enable Channel Uplink & Downlink</h3> ##### 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**. 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) [![Channel Settings](/img/modules/mqtt/android_channel_sm.webp)](/img/modules/mqtt/android_channel.webp)
<h3>3. Configure Network Settings</h3> ##### 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**. 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
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
<h3>1. Enable the MQTT Module</h3> #### Apple
##### 1. Enable the MQTT Module
Navigate to Settings > MQTT: Turn on the slider for MQTT enabled and tap **Save** 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) [![Client Proxy](/img/modules/mqtt/apple_mqtt_1_proxy_sm.webp)](/img/modules/mqtt/apple_mqtt_1_proxy_encryption.webp)
<h3>2. Enable Channel Uplink & Downlink</h3> ##### 2. Enable Channel Uplink & Downlink
Navigate to Settings > Channels > Primary Channel: Turn on the sliders for **Uplink enabled** and **Downlink enabled** - Tap **Save** 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) [![Channel Settings](/img/modules/mqtt/apple_channel_sm.webp)](/img/modules/mqtt/apple_channel.webp)
<h3>3. Configure Network Settings</h3> ##### 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** 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
<h3>1. Enable the MQTT Module</h3> #### CLI
##### 1. Enable the MQTT Module
```shell ```shell
meshtastic --set mqtt.enabled true meshtastic --set mqtt.enabled true
``` ```
<h3>2. Enable Channel Uplink & Downlink</h3> ##### 2. Enable Channel Uplink & Downlink
```shell ```shell
meshtastic --ch-set uplink_enabled true --ch-index 0 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 meshtastic --ch-set uplink_enabled true --ch-index 0 --ch-set downlink_enabled true --ch-index 0
``` ```
<h3>3. Configure Network Settings</h3> ##### 3. Configure Network Settings
```shell ```shell
meshtastic --set network.wifi_enabled true meshtastic --set network.wifi_enabled true
@ -231,7 +245,9 @@ meshtastic --set network.wifi_enabled true --set network.wifi_ssid "your network
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
<h3>1. Enable the MQTT Module</h3> #### Web
##### 1. Enable the MQTT Module
Navigate to Config > Module Config > MQTT - Turn on the slider for MQTT enabled - Click the **Save** icon. 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
::: :::
<h3>2. Enable Channel Uplink & Downlink</h3> ##### 2. Enable Channel Uplink & Downlink
Navigate to Channels > Primary: Turn on the sliders for **Uplink Enabled** and **Downlink Enabled** - Click the **Save** icon. 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) [![Channel Settings](/img/modules/mqtt/web_channel_sm.webp)](/img/modules/mqtt/web_channel.webp)
<h3>3. Configure Network Settings</h3> ##### 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. Navigate to Radio Config > Device > Network: Turn on the slider for **Enabled** - Enter your **SSID** and **PSK** for your network - Click the **Save** icon.

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

@ -37,6 +37,7 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
All Neighbor Info Module config options are available for Android in app version 2.2.0 and higher. 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
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
Not yet implemented. Not yet implemented.
</TabItem> </TabItem>

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

@ -34,6 +34,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
No Paxcounter Module config options are available for Android. No Paxcounter Module config options are available for Android.
::: :::
@ -41,6 +43,8 @@ No Paxcounter Module config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
No Paxcounter Module config options are available on the iOS, iPadOS and macOS app. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Paxcounter Module config options are available in the python CLI version 2.2.16 and higher. All Paxcounter Module config options are available in the python CLI version 2.2.16 and higher.
@ -71,6 +77,8 @@ meshtastic --get paxcounter
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
No Paxcounter module config options are available in the Web UI. No Paxcounter module config options are available in the Web UI.

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

@ -67,6 +67,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Range Test Config options are available for Android. 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
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All range test module config options are available on iOS, iPadOS and macOS at Settings > Modules > Range Test. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
Range Test module config options are available in the python CLI. Example commands are below: 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
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All range test module config options are available in the Web UI. All range test module config options are available in the Web UI.

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

@ -34,6 +34,7 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
All Remote Hardware Module config options are available for Android in app. 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.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All Remote Hardware Module config options are available on iOS, iPadOS and macOS app.and higher at Settings > Modules > Remote Hardware 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Remote Hardware Module config options are available in the python CLI. 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.
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
Not implemented. Not implemented.
</TabItem> </TabItem>

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

@ -79,6 +79,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Serial Module Config options are available for Android. Serial Module Config options are available for Android.
@ -91,6 +93,8 @@ Serial Module Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All serial module config options are available on iOS, iPadOS and macOS at Settings > Modules > Serial. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All serial module config options are available in the python CLI. Example commands are below: All serial module config options are available in the python CLI. Example commands are below:
@ -161,6 +167,8 @@ meshtastic --set serial.timeout 15
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All serial module config options are available in the Web UI. All serial module config options are available in the Web UI.
::: :::

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

@ -106,6 +106,8 @@ values={[
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Store and Forward Config options are available for Android. Store and Forward Config options are available for Android.
@ -117,6 +119,8 @@ Store and Forward Config options are available for Android.
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
Store and Forward configuration is not currently available via the Apple clients. 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
<TabItem value="cli"> <TabItem value="cli">
#### CLI
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :---------------------------------: | :---------------: | :-----: | | :---------------------------------: | :---------------: | :-----: |
| store_forward.enabled | `true`, `false` | `false` | | 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" ```shell title="Enable the module"
meshtastic --set store_forward.enabled true meshtastic --set store_forward.enabled true
@ -183,6 +189,8 @@ meshtastic --set store_forward.records 100
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
Store and Forward configuration is not currently available via the web client. Store and Forward configuration is not currently available via the web client.
::: :::

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

@ -83,6 +83,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Telemetry Config options are available for Android. Telemetry Config options are available for Android.
@ -95,6 +97,8 @@ Telemetry Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All telemetry module config options are available on iOS, iPadOS and macOS at Settings > Module Configuration > Telemetry. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All telemetry module config options are available in the python CLI. Example commands are below: 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
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All telemetry module config options are available in the Web UI. All telemetry module config options are available in the Web UI.

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

@ -28,6 +28,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
Make sure the app is at least version 2.1.10. 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. 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
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
Make sure the app is at least version 2.0.9. 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. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
Make sure the CLI is at least version 2.0.6. Then use this command: Make sure the CLI is at least version 2.0.6. Then use this command:
```shell title="CLI traceroute 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
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
Not yet implemented. Not yet implemented.
</TabItem> </TabItem>

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

@ -51,6 +51,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
All Bluetooth config options are available for Android. All Bluetooth config options are available for Android.
@ -63,6 +65,8 @@ All Bluetooth config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All Bluetooth config values are available on iOS, iPadOS and macOS. 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.
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Bluetooth module config options are available in the python CLI. Example commands are below: 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 meshtastic --set bluetooth.fixed_pin 111111
``` ```
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
@ -119,5 +127,5 @@ All Bluetooth module config options are available for the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>

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

@ -118,6 +118,8 @@ values={[
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Channel Config options are available on Android. Channel Config options are available on Android.
::: :::
@ -143,6 +145,8 @@ Tap the Channel Name (or the pen icon) to access the Channel Menu:
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
Channel settings are only available on Apple platforms by scanning QR codes. 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.
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Channel config options are available in the python CLI. Example commands are below: 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" ```shell title="Set channel name for the PRIMARY channel"
# without spaces # without spaces
@ -174,7 +180,7 @@ meshtastic --ch-set name MyChannel --ch-index 0
meshtastic --ch-set name "My Channel" --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. 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 meshtastic --ch-set psk none --ch-index 0
``` ```
### Uplink / Downlink ##### Uplink / Downlink
For configuring gateways, please see [MQTT](/docs/configuration/module/mqtt) For configuring gateways, please see [MQTT](/docs/configuration/module/mqtt)
@ -231,6 +237,8 @@ meshtastic --ch-set downlink_enabled false --ch-index 5
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All Channel config options are available in the Web UI. All Channel config options are available in the Web UI.
::: :::

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

@ -101,6 +101,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Device Config is available for Android. Device Config is available for Android.
@ -113,6 +115,8 @@ Device Config is available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All device config options other than NTP Server are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Device. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All device config options are available in the python CLI. Example commands are below: 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
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All device config options are available in the Web UI. All device config options are available in the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>

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

@ -84,6 +84,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Display Config is available for Android. Display Config is available for Android.
@ -96,6 +98,8 @@ Display Config is available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All display config options are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Display. 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 >
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All display config options are available in the python CLI. Example commands are below: All display config options are available in the python CLI. Example commands are below:
@ -150,9 +156,11 @@ meshtastic --set display.gps_format UTM
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All display config options are available in the Web UI. All display config options are available in the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>

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

@ -141,6 +141,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
LoRa Config options are available on Android. LoRa Config options are available on Android.
@ -153,6 +155,8 @@ LoRa Config options are available on Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::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. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
LoRa config commands are available in the python CLI. Example commands are below: LoRa config commands are available in the python CLI. Example commands are below:
@ -217,9 +223,11 @@ meshtastic --set lora.override_duty_cycle false
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All LoRa config options are available in the Web UI. All LoRa config options are available in the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>

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

@ -73,6 +73,8 @@ values={[
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Network Config options are available for Android. Network Config options are available for Android.
@ -86,6 +88,8 @@ Network Config options are available for Android.
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
Network config options are available on iOS, iPadOS and macOS. Network config options are available on iOS, iPadOS and macOS.
@ -96,6 +100,8 @@ Network config options are available on iOS, iPadOS and macOS.
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Network config options are available in the python CLI. All Network config options are available in the python CLI.
@ -147,6 +153,8 @@ meshtastic --set network.wifi_psk "my password"
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All Network config options are available in the Web UI. All Network config options are available in the Web UI.
::: :::

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

@ -102,6 +102,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Position Config options are available for Android. Position Config options are available for Android.
@ -114,6 +116,8 @@ Position Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All position config values are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Position. 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 >
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Position config commands are available in the python CLI. Example commands are below: All Position config commands are available in the python CLI. Example commands are below:
@ -199,6 +205,8 @@ meshtastic --pos-fields UNSET
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All position config options are available in the Web UI. All position config options are available in the Web UI.
::: :::

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

@ -127,6 +127,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
Power Config options are available for Android. Power Config options are available for Android.
@ -139,6 +141,8 @@ Power Config options are available for Android.
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
Power config is not available on Apple OS's. Power config is not available on Apple OS's.
@ -147,6 +151,8 @@ Power config is not available on Apple OS's.
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All Power config options are available in the python CLI. All Power config options are available in the python CLI.
@ -201,9 +207,11 @@ meshtastic --set power.min_wake_secs 120
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All power config options are available in the Web UI. All power config options are available in the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>

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

@ -48,6 +48,8 @@ values={[
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::info
All User config options are available for Android. All User config options are available for Android.
@ -61,6 +63,8 @@ All User config options are available for Android.
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
All User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`. 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
<TabItem value="cli"> <TabItem value="cli">
#### CLI
:::info :::info
All User config options are available in the python CLI. Example commands are below: All User config options are available in the python CLI. Example commands are below:
@ -103,6 +109,8 @@ meshtastic --set-ham 'CALLSIGN'
<TabItem value="web"> <TabItem value="web">
#### Web
:::info :::info
All User config options are available in the Web UI. All User config options are available in the Web UI.
::: :::

4
docs/development/documentation/style-guides/settings.mdx
View file

@ -88,15 +88,19 @@ values={[
{label: 'Web', value: 'web'}, {label: 'Web', value: 'web'},
]}> ]}>
<TabItem value="cli"> <TabItem value="cli">
#### CLI (Required for accessibility)
CLI content here CLI content here
</TabItem> </TabItem>
<TabItem value="android"> <TabItem value="android">
#### Android (Required for accessibility)
Android content here Android content here
</TabItem> </TabItem>
<TabItem value="iOS"> <TabItem value="iOS">
#### iOS (Required for accessibility)
iOS content here iOS content here
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web (Required for accessibility)
Web content here Web content here
</TabItem> </TabItem>
</Tabs> </Tabs>

30
docs/getting-started/flashing-firmware/esp32/cli-script.mdx
View file

@ -35,6 +35,8 @@ values={[
]}> ]}>
<TabItem value="linux"> <TabItem value="linux">
#### Linux
Check if you have `python3` and `pip` installed with the following command Check if you have `python3` and `pip` installed with the following command
```shell ```shell
@ -58,6 +60,8 @@ sudo apt-get install python3-pip
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### 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`. 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 :::note
@ -93,6 +97,8 @@ pip3 -v
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
#### Windows
- Download and install [Python](https://www.python.org). When installing, make sure to click `Add Python X.Y to PATH`. - 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. - Download and install [Gitbash](https://gitforwindows.org) (or other appropriate shell) and run all subsequent commands from that shell.
@ -130,6 +136,8 @@ values={[
]}> ]}>
<TabItem value="linux"> <TabItem value="linux">
#### Linux
:::important :::important
On Linux, you may need to explicitly declare esptool as a .py script. Use `esptool.py chip_id`. 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
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### macOS
:::important :::important
On macOS, you may need to explicitly declare esptool as a .py script. Use `esptool.py chip_id`. 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
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
#### Windows
:::important :::important
On Windows, you must explicitly declare esptool as a .py script. Use `esptool.py chip_id`. On Windows, you must explicitly declare esptool as a .py script. Use `esptool.py chip_id`.
::: :::
@ -202,13 +214,15 @@ values={[
]}> ]}>
<TabItem value="linux"> <TabItem value="linux">
#### Install #### Linux
##### Install
```shell title="Command" ```shell title="Command"
./device-install.sh -f firmware-BOARD-VERSION.bin ./device-install.sh -f firmware-BOARD-VERSION.bin
``` ```
#### Update ##### Update
```shell title="Command" ```shell title="Command"
./device-update.sh -f firmware-BOARD-VERSION.bin ./device-update.sh -f firmware-BOARD-VERSION.bin
@ -217,13 +231,15 @@ values={[
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### Install #### macOS
##### Install
```shell title="Command" ```shell title="Command"
./device-install.sh -f firmware-BOARD-VERSION.bin ./device-install.sh -f firmware-BOARD-VERSION.bin
``` ```
#### Update ##### Update
```shell title="Command" ```shell title="Command"
./device-update.sh -f firmware-BOARD-VERSION.bin ./device-update.sh -f firmware-BOARD-VERSION.bin
@ -232,13 +248,15 @@ values={[
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
#### Install #### Windows
##### Install
```shell title="Command" ```shell title="Command"
device-install.bat -f firmware-BOARD-VERSION.bin device-install.bat -f firmware-BOARD-VERSION.bin
``` ```
#### Update ##### Update
```shell title="Command" ```shell title="Command"
device-update.bat -f firmware-BOARD-VERSION.bin device-update.bat -f firmware-BOARD-VERSION.bin

4
docs/getting-started/flashing-firmware/nrf52/ota.mdx
View file

@ -20,6 +20,8 @@ values={[
<TabItem value="android"> <TabItem value="android">
#### Android
:::info :::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. 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
<TabItem value="apple"> <TabItem value="apple">
#### 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) 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. 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.

14
docs/getting-started/initial-config.mdx
View file

@ -25,6 +25,8 @@ values={[
]}> ]}>
<TabItem value="serial"> <TabItem value="serial">
#### Serial
- [Python CLI](/docs/software/python/cli/) - [Python CLI](/docs/software/python/cli/)
- [Web Client](https://client.meshtastic.org) - [Web Client](https://client.meshtastic.org)
- [Android App](/docs/category/android-app) - [Android App](/docs/category/android-app)
@ -32,6 +34,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="ble"> <TabItem value="ble">
#### Bluetooth
- [Android App](/docs/category/android-app) - [Android App](/docs/category/android-app)
- [Web Client](https://client.meshtastic.org) - [Web Client](https://client.meshtastic.org)
- [iOS/iPadOS/macOS App](/docs/category/apple-apps) - [iOS/iPadOS/macOS App](/docs/category/apple-apps)
@ -39,6 +43,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="network"> <TabItem value="network">
#### Network
:::info :::info
Connecting over network is only supported on ESP32 devices. Connecting over network is only supported on ESP32 devices.
::: :::
@ -66,6 +72,8 @@ values={[
]}> ]}>
<TabItem value="android"> <TabItem value="android">
#### Android
1. Follow the [installation](/docs/software/android/installation) and [usage](/docs/software/python/cli/usage) instructions for [Meshtastic Android](/docs/category/android-app). 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. 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. 3. Once paired, Click "UNSET" next to the device name.
@ -74,6 +82,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
#### Apple
:::info :::info
Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS and macOS at Settings > Radio Configuration > LoRa. 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
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
#### CLI
1. Install [Meshtastic PythonCLI](/docs/software/python/cli/installation) 1. Install [Meshtastic PythonCLI](/docs/software/python/cli/installation)
```sh ```sh
pip3 install --upgrade pytap2 pip3 install --upgrade pytap2
@ -94,6 +106,8 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web
1. Open the Meshtastic Web interface: [client.meshtastic.org](https://client.meshtastic.org) 1. Open the Meshtastic Web interface: [client.meshtastic.org](https://client.meshtastic.org)
2. Navigate to the **LoRa** menu. 2. Navigate to the **LoRa** menu.
3. Under **Regional Settings**, set your **Region** according to your regional location. 3. Under **Regional Settings**, set your **Region** according to your regional location.

6
docs/getting-started/serial-drivers/serial-drivers-esp32.mdx
View file

@ -26,6 +26,8 @@ values={[
<TabItem value="linux"> <TabItem value="linux">
#### Linux
- [CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) - [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) - [CH9102 Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html)
@ -33,6 +35,8 @@ values={[
<TabItem value="macos"> <TabItem value="macos">
#### macOS
- [CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) - [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) - [CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
@ -40,6 +44,8 @@ values={[
<TabItem value="windows"> <TabItem value="windows">
#### Windows
- [CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) - [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](http://www.wch.cn/downloads/CH343SER_ZIP.html)
- [CH9102 Driver - Windows Download (Direct Download for Windows 7)](https://github.com/Xinyuan-LilyGO/CH9102_Driver) - [CH9102 Driver - Windows Download (Direct Download for Windows 7)](https://github.com/Xinyuan-LilyGO/CH9102_Driver)

9
docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx
View file

@ -28,12 +28,15 @@ values={[
<TabItem value="linux"> <TabItem value="linux">
#### Linux
- [CH34x Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html) - [CH34x Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html)
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### macOS
:::info :::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 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 ("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to
@ -53,7 +56,7 @@ Uninstall the kernel extension:
4. Reboot 4. Reboot
### Install the CH34x Driver ##### Install the CH34x Driver
- [CH34x Driver- macOS Download](https://github.com/WCHSoftGroup/ch34xser_macos) - [CH34x Driver- macOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
@ -63,6 +66,8 @@ Uninstall the kernel extension:
<TabItem value="windows"> <TabItem value="windows">
#### Windows
- [CH34x Driver - Windows Download](http://www.wch-ic.com/downloads/CH341SER_EXE.html) - [CH34x Driver - Windows Download](http://www.wch-ic.com/downloads/CH341SER_EXE.html)
</TabItem> </TabItem>

6
docs/getting-started/serial-drivers/test-serial-driver-installation.mdx
View file

@ -23,6 +23,8 @@ values={[
]}> ]}>
<TabItem value="linux"> <TabItem value="linux">
#### Linux
1. Connect your Meshtastic device to your USB port 1. Connect your Meshtastic device to your USB port
2. Open a **Terminal** and enter the following command: 2. Open a **Terminal** and enter the following command:
@ -43,6 +45,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### macOS
1. Navigate to `Apple Menu  > About This Mac > More Info > System Report... > Hardware > USB`. 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: 2. You should see similar to one of the following entries:
@ -54,6 +58,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
#### Windows
1. Navigate to `Device Manager > Ports (COM & LPT)` 1. Navigate to `Device Manager > Ports (COM & LPT)`
2. You should see similar to one of the following entries: 2. You should see similar to one of the following entries:

12
docs/hardware/devices/nano/buttons.mdx
View file

@ -21,7 +21,9 @@ values={[
<TabItem value="g2"> <TabItem value="g2">
### Nano G2 Ultra Buttons ### Nano G2 Ultra
#### Buttons
- **User/Program Button:** - **User/Program Button:**
- **Single press:** Changes the information page displayed on the device's screen. - **Single press:** Changes the information page displayed on the device's screen.
@ -30,7 +32,7 @@ values={[
- **Message Read Button:** - **Message Read Button:**
- **Single press:** Clears the New Message LED. - **Single press:** Clears the New Message LED.
### Nano G2 Ultra Switches #### Switches
- **Power:** - **Power:**
- **Toggle Up:** Turns on the device. - **Toggle Up:** Turns on the device.
@ -46,7 +48,9 @@ values={[
</TabItem> </TabItem>
<TabItem value="g1-e"> <TabItem value="g1-e">
### Nano G1 Explorer Buttons ### Nano G1 Explorer
#### Buttons
- **User/Program Button:** - **User/Program Button:**
- **Single press:** Changes the information page displayed on the device's screen. - **Single press:** Changes the information page displayed on the device's screen.
@ -54,7 +58,7 @@ values={[
- **Message Read Button:** - **Message Read Button:**
- **Single press:** Clears the New Message LED. - **Single press:** Clears the New Message LED.
### Nano G1 Explorer Switches ### Switches
- **Power:** - **Power:**
- **Toggle Up:** Turns on the device. - **Toggle Up:** Turns on the device.

12
docs/software/python-cli/installation.mdx
View file

@ -41,6 +41,8 @@ values={[
]}> ]}>
<TabItem value="linux"> <TabItem value="linux">
#### Linux
- Check that your computer has the required serial drivers installed - Check that your computer has the required serial drivers installed
- Connect your Meshtastic device to your USB port - Connect your Meshtastic device to your USB port
@ -98,6 +100,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### macOS
- Check that your computer has the required serial drivers installed - Check that your computer has the required serial drivers installed
- Connect your Meshtastic device to your USB port - Connect your Meshtastic device to your USB port
- Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB` - Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`
@ -139,6 +143,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
#### Windows
- Check that your computer has the required serial drivers installed - Check that your computer has the required serial drivers installed
- Connect your Meshtastic device to your USB port - Connect your Meshtastic device to your USB port
- Open Device Manager - Open Device Manager
@ -171,6 +177,8 @@ values={[
</TabItem> </TabItem>
<TabItem value="termux"> <TabItem value="termux">
#### Termux
:::note :::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. 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={[
]}> ]}>
<TabItem value="ubuntu"> <TabItem value="ubuntu">
#### Ubuntu
- Download meshtastic_ubuntu - Download meshtastic_ubuntu
- Run the following command to make the file executable and rename it 'meshtastic': - 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.
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
#### Windows
- Download meshtastic_windows - Download meshtastic_windows
- Rename to meshtastic.exe - Rename to meshtastic.exe