diff --git a/docs/1.2-End-of-life/index.mdx b/docs/1.2-End-of-life/index.mdx index b6ff0d1d..f8495081 100644 --- 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) diff --git a/docs/configuration/device-config/bluetooth.mdx b/docs/configuration/device-config/bluetooth.mdx index 04f5d7b9..384da701 100644 --- 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** ::: diff --git a/docs/configuration/device-config/channels.mdx b/docs/configuration/device-config/channels.mdx index b30b2ecc..da72f43d 100644 --- a/docs/configuration/device-config/channels.mdx +++ b/docs/configuration/device-config/channels.mdx @@ -111,7 +111,7 @@ values={[ :::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. ::: diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 5d7b91c9..8c9f26c0 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -50,7 +50,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/device-config/display.mdx b/docs/configuration/device-config/display.mdx index 87d4aafa..4d3512ad 100644 --- a/docs/configuration/device-config/display.mdx +++ b/docs/configuration/device-config/display.mdx @@ -67,7 +67,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/device-config/lora.mdx b/docs/configuration/device-config/lora.mdx index c1209454..bbb7a5c2 100644 --- a/docs/configuration/device-config/lora.mdx +++ b/docs/configuration/device-config/lora.mdx @@ -82,7 +82,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/device-config/network.mdx b/docs/configuration/device-config/network.mdx index d90caa60..68566f9f 100644 --- a/docs/configuration/device-config/network.mdx +++ b/docs/configuration/device-config/network.mdx @@ -77,7 +77,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/device-config/position.mdx b/docs/configuration/device-config/position.mdx index 1f474cb5..01544690 100644 --- a/docs/configuration/device-config/position.mdx +++ b/docs/configuration/device-config/position.mdx @@ -89,7 +89,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/device-config/power.mdx b/docs/configuration/device-config/power.mdx index cda97b17..dfbaf642 100644 --- a/docs/configuration/device-config/power.mdx +++ b/docs/configuration/device-config/power.mdx @@ -80,7 +80,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/device-config/user.mdx b/docs/configuration/device-config/user.mdx index a80ec458..469b19f1 100644 --- a/docs/configuration/device-config/user.mdx +++ b/docs/configuration/device-config/user.mdx @@ -51,7 +51,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/module-config/audio.mdx b/docs/configuration/module-config/audio.mdx index dd5f546c..f77cbbc4 100644 --- a/docs/configuration/module-config/audio.mdx +++ b/docs/configuration/module-config/audio.mdx @@ -59,7 +59,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/module-config/canned-message.mdx b/docs/configuration/module-config/canned-message.mdx index 52537a83..17c72edf 100644 --- a/docs/configuration/module-config/canned-message.mdx +++ b/docs/configuration/module-config/canned-message.mdx @@ -87,7 +87,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/module-config/external-notification.mdx b/docs/configuration/module-config/external-notification.mdx index 293992b7..1f2f4cba 100644 --- a/docs/configuration/module-config/external-notification.mdx +++ b/docs/configuration/module-config/external-notification.mdx @@ -57,7 +57,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index 3670fe9a..c4f64841 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -55,7 +55,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/module-config/range-test.mdx b/docs/configuration/module-config/range-test.mdx index f2d1b117..a7beac91 100644 --- a/docs/configuration/module-config/range-test.mdx +++ b/docs/configuration/module-config/range-test.mdx @@ -43,7 +43,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/module-config/serial.mdx b/docs/configuration/module-config/serial.mdx index 2fb1444b..52591123 100644 --- a/docs/configuration/module-config/serial.mdx +++ b/docs/configuration/module-config/serial.mdx @@ -76,7 +76,12 @@ values={[ :::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** + ::: diff --git a/docs/configuration/module-config/telemetry.mdx b/docs/configuration/module-config/telemetry.mdx index 741cae9e..bc4be744 100644 --- a/docs/configuration/module-config/telemetry.mdx +++ b/docs/configuration/module-config/telemetry.mdx @@ -74,7 +74,12 @@ values={[ :::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** + ::: diff --git a/docs/software/community/atak.mdx b/docs/software/community/atak.mdx new file mode 100644 index 00000000..efe45244 --- /dev/null +++ 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). diff --git a/docs/software/community/index.mdx b/docs/software/community/index.mdx index 29cefad4..87f7bb59 100644 --- 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 \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/software/community/meshtasticator.mdx b/docs/software/community/meshtasticator.mdx new file mode 100644 index 00000000..b7ebbd69 --- /dev/null +++ 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)