|
|
||
|---|---|---|
| .github | ||
| .idea | ||
| .run | ||
| app | ||
| build-logic | ||
| config | ||
| core | ||
| fastlane | ||
| feature | ||
| gradle | ||
| mesh_service_example | ||
| .gitignore | ||
| .gitmodules | ||
| .ruby-version | ||
| AGENTS.md | ||
| build.gradle.kts | ||
| CODE_OF_CONDUCT.md | ||
| codecov.yml | ||
| compose_compiler_config.conf | ||
| config.properties | ||
| CONTRIBUTING.md | ||
| crowdin.yml | ||
| debugging-android.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| jitpack.yml | ||
| LICENSE | ||
| README.md | ||
| RELEASE_PROCESS.md | ||
| secrets.defaults.properties | ||
| settings.gradle.kts | ||
Meshtastic-Android
This is a tool for using Android with open-source mesh radios. For more information see our webpage: meshtastic.org. If you are looking for the device side code, see here.
This project is currently beta testing across various providers. If you have questions or feedback please Join our discussion forum or the Discord Group . We would love to hear from you!
Get Meshtastic
The easiest, and fastest way to get the latest beta releases is to use our github releases. It is recommend to use these with Obtainium to get the latest updates.
Alternatively, these other providers are also available, but may be slower to update.
![Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh]](https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png){kind=icon}
The play store is the last to update of these options, but if you want to join the Play Store testing program go to this URL and opt-in to become a tester. If you encounter any problems or have questions, ask us on the discord, create an issue, or post in the forum and we'll help as we can.
Documentation
The project's documentation is generated with Dokka and hosted on GitHub Pages. It is automatically updated on every push to the main branch.
Generating Locally
You can generate the documentation locally to preview your changes.
- Run the Dokka task:
./gradlew :app:dokkaHtml - View the output:
The generated HTML files will be located in the
app/build/dokka/htmldirectory. You can open theindex.htmlfile in your browser to view the documentation.
Translations
You can help translate the app into your native language using Crowdin.
API & Integration
Developers can integrate with the Meshtastic Android app using our published API library via JitPack. This allows third-party applications (like the ATAK plugin) to communicate with the mesh service via AIDL.
For detailed integration instructions, see core/api/README.md.
Building the Android App
Warning
Debug and release builds can be installed concurrently. This is solely to enable smoother development, and you should avoid running both apps simultaneously. To ensure proper function, force quit the app not in use.
https://meshtastic.org/docs/development/android/
Note: when building the google flavor locally you will need to supply your own Google Maps Android SDK api key MAPS_API_KEY in local.properties in order to use Google Maps.
e.g.
MAPS_API_KEY=your_google_maps_api_key_here
Contributing guidelines
For detailed instructions on how to contribute, please see our CONTRIBUTING.md file. For details on our release process, see the RELEASE_PROCESS.md file.
Repository Statistics
Copyright 2025, Meshtastic LLC. GPL-3.0 license