Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
niccellular authored Jun 4, 2024
1 parent 5a41576 commit e4362c9
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# Meshtastic Plugin
Offical Meshtastic ATAK Plugin for sending CoT to IMeshService in the Meshtastic Android app.

# Meshtastic Plugin Tool menu
There is now a Meshtastic Tool menu, it currently is only used for recording Voice Memos. Voice memos will record your speech to text then send a Meshtastic text message. If users enable "Text to Speech" in preferecnes the message will be read outloud. Only English is supported currently. The Speech to Text is performed with the Vosk library.

# Settings
The plugin currently has the following settings:
- Enable relay to server, this forwards all CotEvents (except DMs) to any connected TAKServers
- Show all Meshtastic devices, this will place Sensor CoTs on the map for meshtastic devices that have non-zero GPS
- Do not show your local node, this will not place a Sensor CoT on the map for the meshtastic device currently bound to the EUD
- Enable reporting rate controls, this will set ATAK's reporting rate to Constant and allow you to pick a interval from 1,5,10,20,30 minutes
- Reporting rate, the menu to pick the interval

-
![Screenshot_20240509-143030](https://github.com/meshtastic/ATAK-Plugin/assets/79813408/c918e588-48bf-4ac9-b065-8036f0671ad3)
![Screenshot_20240509-143034](https://github.com/meshtastic/ATAK-Plugin/assets/79813408/10680f3a-722f-4587-b517-3f1961fe5459)
- Reporting rate, the menu to pick the interval in minutes
- Only send PLI and Chat messages, this will only use the atak.protos which are optimized for speed (no libcotshrink)
- Use Text to Speech for incoming messages, this will read outloud any Meshtastic TEXT_MESSAGE_APP (basic meshtastic text messages)
- PTT KeyCode, this allows you to define what hardware key to use to enable voice recording (see the Mestastic Plugin's Tool menu "Voice Memo")
- Meshtastic Channel Index, this allows you to define what channel to send ATAK messages on (0 by default)
- Meshtastic Hop Limit, this allows you to adjust the hop limit for ATAK messages (3 by default, 8 max)
- Allow SWITCH command, this opts-in for allowing nodes to switch your node to Short/Fast for file transfers

0 comments on commit e4362c9

Please sign in to comment.