Merge branch 'master' into patch-2

2024-12-25 21:54:20 -08:00 · 2022-12-09 15:34:01 -08:00 · 2022-12-09 15:34:01 -08:00 · 2b6b0d7fc2
parent 5f7b49f902 013a3399cf
commit 2b6b0d7fc2
20 changed files with 154 additions and 27 deletions
--- a/docs/1.2-End-of-life/index.mdx
+++ b/docs/1.2-End-of-life/index.mdx
@ -7,8 +7,6 @@ sidebar_position: 20

 Meshtastic 1.2 was a beta version that has been superceded by 1.3. Version 1.2 is fundamentally incompatible with any 1.3 versions of device firmware, flashing utilities, or client applications.

-While 1.2 is end of life, it may continue to be useful for certain networks with Android only users, or users of ATAK until the forwarder is updated.
-
 - Last 1.2 Python api version install: pip install meshtastic==1.2.95
 - Final 1.2 Meshtastic Flasher install: pip install meshtastic-flasher==1.0.106 (Do not attempt to install 1.3.x firmware with this release)
 - [Final 1.2 Device Firmware](https://github.com/meshtastic/firmware/releases/tag/v1.2.65.0adc5ce)
--- a/docs/configuration/device-config/bluetooth.mdx
+++ b/docs/configuration/device-config/bluetooth.mdx
@ -57,7 +57,7 @@ values={[
 All Bluetooth config options are available for Android.

 1. Open the Meshtastic App
-2. Navigate to: **Vertical Ellipsis (3 dots top right) > Advanced Settings > Bluetooth Config**
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Bluetooth Config**

 :::

--- a/docs/configuration/device-config/channels.mdx
+++ b/docs/configuration/device-config/channels.mdx
@ -111,7 +111,7 @@ values={[
 <TabItem value="android">

 :::info
-Limited Channel config options are available on android. QR code scanning is available.
+Limited Channel Config options are available on Android. QR code scanning is available.
 :::

 </TabItem>
--- a/docs/configuration/device-config/device.mdx
+++ b/docs/configuration/device-config/device.mdx
@ -50,7 +50,12 @@ values={[
 <TabItem value="android">

 :::info
-Device config is not available for Android.
+
+Device Config is available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Device Config**
+
 :::

 </TabItem>
--- a/docs/configuration/device-config/display.mdx
+++ b/docs/configuration/device-config/display.mdx
@ -67,7 +67,12 @@ values={[
 <TabItem value="android">

 :::info
-Display config is not available for Android.
+
+Display Config is available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Display Config**
+
 :::

 </TabItem>
--- a/docs/configuration/device-config/lora.mdx
+++ b/docs/configuration/device-config/lora.mdx
@ -82,7 +82,12 @@ values={[
 <TabItem value="android">

 :::info
-Region and Modem Preset can be configured on Android.
+
+LoRa Config options such as Region, Modem Preset, and Hop Limit can be configured on Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > LoRa Config**
+
 :::

 </TabItem>
--- a/docs/configuration/device-config/network.mdx
+++ b/docs/configuration/device-config/network.mdx
@ -77,7 +77,12 @@ values={[
 <TabItem value="android">

 :::info
-Network config is not available for Android.
+
+Network Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Network Config**
+
 :::

 </TabItem>
--- a/docs/configuration/device-config/position.mdx
+++ b/docs/configuration/device-config/position.mdx
@ -89,7 +89,12 @@ values={[
 <TabItem value="android">

 :::info
-Position config is not available for Android.
+
+Position Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Position Config**
+
 :::

 </TabItem>
--- a/docs/configuration/device-config/power.mdx
+++ b/docs/configuration/device-config/power.mdx
@ -80,7 +80,12 @@ values={[
 <TabItem value="android">

 :::info
-Light Sleep Interval and Wait Bluetooth Interval are available under advanced settings for Android.
+
+Power Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Power Config**
+
 :::

 </TabItem>
--- a/docs/configuration/device-config/user.mdx
+++ b/docs/configuration/device-config/user.mdx
@ -51,7 +51,12 @@ values={[
 <TabItem value="android">

 :::info
-`LongName` can be edited on Android.
+
+User Config options are available for Android. 
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > User Config**
+
 :::

 </TabItem>
--- a/docs/configuration/module-config/audio.mdx
+++ b/docs/configuration/module-config/audio.mdx
@ -59,7 +59,12 @@ values={[
 <TabItem value="android">

 :::info
-Audio module config is not available for Android.
+
+Audio Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Audio Config**
+
 :::

 </TabItem>
--- a/docs/configuration/module-config/canned-message.mdx
+++ b/docs/configuration/module-config/canned-message.mdx
@ -87,7 +87,12 @@ values={[
 <TabItem value="android">

 :::info
-Canned Message module config is not available for Android.
+
+Canned Message Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Canned Message Config**
+
 :::

 </TabItem>
--- a/docs/configuration/module-config/external-notification.mdx
+++ b/docs/configuration/module-config/external-notification.mdx
@ -57,7 +57,12 @@ values={[
 <TabItem value="android">

 :::info
-External notification module config is not available for Android.
+
+External Notification Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > External Notification Config**
+
 :::

 </TabItem>
--- a/docs/configuration/module-config/mqtt.mdx
+++ b/docs/configuration/module-config/mqtt.mdx
@ -55,7 +55,12 @@ values={[
 <TabItem value="android">

 :::info
-MQTT module config is not available for Android.
+
+MQTT Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > MQTT Config**
+
 :::

 </TabItem>
--- a/docs/configuration/module-config/range-test.mdx
+++ b/docs/configuration/module-config/range-test.mdx
@ -43,7 +43,12 @@ values={[
 <TabItem value="android">

 :::info
-Range Test features are available for Android.
+
+Range Test Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Range Test Config**
+
 :::

 </TabItem>
--- a/docs/configuration/module-config/serial.mdx
+++ b/docs/configuration/module-config/serial.mdx
@ -12,6 +12,9 @@ The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmi

 This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.

+![image](https://user-images.githubusercontent.com/9000580/205529843-962c3187-8411-452c-b729-42c58b1571f5.png)
+
+
 ## Serial Module Config Values

 ### Enabled
@ -73,7 +76,12 @@ values={[
 <TabItem value="android">

 :::info
-Serial module config is not available for Android.
+
+Serial Module Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Serial Config**
+
 :::

 </TabItem>
@ -161,10 +169,12 @@ Default is to use RX GPIO 16 and TX GPIO 17.

 1. Enable the module by setting `serial.enabled` to `1`.
 2. Set the pins (`serial.rxd` / `serial.txd`) for your preferred RX and TX GPIO pins. On tbeam boards it is recommended to use:
-   - RXD 35
-   - TXD 15
+   - RXD 13
+   - TXD 14
 3. Set `serial.timeout` to the amount of time to wait before we consider your packet as "done".
-4. (Optional) set serial.mode to TESTMSG if you want to send messages to/from the general text message channel
+4. (Optional) set serial.mode to TEXTMSG if you want to send messages to/from the general text message channel
 5. Connect to your device over the serial interface at `38400 8N1`.
-6. Send a packet up to 237 bytes in length. This will get relayed over the mesh network.
-7. (Optional) Set `serial.echo` to `1` and any message you send out will be echoed back to your device.
+
+    With [tio](https://github.com/tio/tio) &ndash; `tio -e -b 38400 -f none /dev/myserialport`
+7. Send a packet up to 237 bytes in length. This will get relayed over the mesh network.
+8. (Optional) Set `serial.echo` to `1` and any message you send out will be echoed back to your device.
--- a/docs/configuration/module-config/telemetry.mdx
+++ b/docs/configuration/module-config/telemetry.mdx
@ -74,7 +74,12 @@ values={[
 <TabItem value="android">

 :::info
-Telemetry Module config is not available for Android.
+
+Telemetry Config options are available for Android.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Telemetry Config**
+
 :::

 </TabItem>
--- a/docs/software/community/atak.mdx
+++ b/docs/software/community/atak.mdx
@ -0,0 +1,33 @@
+---
+id: community-atak
+title: ATAK Forwarder
+sidebar_label: ATAK Forwarder
+sidebar_position: 1
+---
+
+:::note
+
+This is a community project maintained by @paulmandal.
+Development can be followed on [GitHub](https://github.com/paulmandal/atak-forwarder).
+Support should be sought from the respective authors.
+
+:::
+
+:::info
+
+The ATAK Forwarder plugin has recently been updated to support Meshtastic 2.0.6+ but is currently a pre-release version to allow for additional testing to be completed.
+- After installing you need to open the Meshtastic app and click the add device "+" so it will ask for Bluetooth permissions.
+
+:::
+
+The ATAK Forwarder plugin requires the Meshtastic Android app to be installed.
+
+This is a plugin for ATAK (Android Team Awareness Kit) that uses Meshtastic to provide off-grid communications. This includes plotting the position of others on the map, transmission of markers and routes, and chat messages. It has been signed by the TAK Product Center for use with the Play Store version of ATAK. He is currently distributing development builds via [Google Drive](https://drive.google.com/drive/folders/1xeKJnn9tmzkkmuDbMp0LCLOV9OzHU-Ex), aiming to publish it to the Play Store in the future.
+
+![ATAK Module](/img/atak-animation.gif)
+
+The builds of the module on the Google Drive are now signed for the Play Store version of ATAK, as of 6/3/2021.
+
+- A walk-through on how to [set up ATAK](https://paul-mandal.medium.com/atak-for-hikers-d96d5246193e).
+- The module source is available on [GitHub](https://github.com/paulmandal/atak-forwarder), along with instructions for setting it up.
+- Development builds are available on [Google Drive](https://drive.google.com/drive/folders/1xeKJnn9tmzkkmuDbMp0LCLOV9OzHU-Ex).
--- a/docs/software/community/index.mdx
+++ b/docs/software/community/index.mdx
@ -1,10 +1,15 @@
 ---
-title: Community
+title: Community Apps
 slug: /software/community
-sidebar_label: Community
+sidebar_label: Community Apps
 sidebar_position: 10
 ---

-## Simulator
+The Meshtastic ecosystem is highly extensible, and a number of community projects have been made to fit different people's needs. If you wish to create your own application or module, please read the information in the developers section, and tell us about your project on the forum.

- https://github.com/GUVWAF/Meshtasticator
+Current community projects:
+
+- [ATAK (Android Team Awareness Kit) Forwarder](/docs/software/community/community-atak) - An ATAK plugin for forwarding CoT messages via a hardware layer which supports Meshtastic devices.
+- [Meshtasticator (Simulator)](/docs/software/community/community-meshtasticator) - Meshtasticator is a discrete-event and interactive simulator that mimics the radio section of the device software.
+
+Support for these projects should be sought from their respective authors.
--- a/docs/software/community/meshtasticator.mdx
+++ b/docs/software/community/meshtasticator.mdx
@ -0,0 +1,16 @@
+---
+id: community-meshtasticator
+title: Meshtasticator
+sidebar_label: Meshtasticator (Simulator)
+sidebar_position: 2
+---
+
+:::note
+
+This is a community project maintained by @GUVWAF.
+Development can be followed on [GitHub](https://github.com/GUVWAF/Meshtasticator).
+Support should be sought from the respective authors.
+
+:::
+
+Meshtasticator is a discrete-event and interactive simulator that mimics the radio section of the device software and can be used to assess the performance of your scenario, or the scalability of the protocol. Meshtasticator was created and is maintained by GUVWAF and more information on its use and setup can be found on the [Meshtasticator Github page](https://github.com/GUVWAF/Meshtasticator)