This is a tool for using Android with open-source mesh radios.

Go to file

James Rich 5cfa44cb64 feat(ci): migrate to fastlane for release management (#3038 ) Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>		2025-09-09 21:08:11 +00:00
.github	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
.idea	fix(#1787 ): handle unknown hardware details crash (#1789 )	2025-04-26 19:37:49 -05:00
app	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
buildSrc	fix(release): Simplify Play Store deployment to upload-only (#3027 )	2025-09-09 01:52:34 +00:00
config	chore(ci): remove Crowdin integration from scheduled updates (#2708 )	2025-08-14 02:47:47 +00:00
design@90014f40e8	chore(deps): update design digest to 90014f4 (#2037 )	2025-06-06 16:32:31 -05:00
fastlane	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
gradle	chore(deps): update google maps compose to v6.10.0 (#3036 )	2025-09-09 19:55:50 +00:00
mesh_service_example	chore(deps): update meshtastic protobufs to 8caf423 (#3025 )	2025-09-08 22:38:35 +00:00
network	ci: add Dokka for kdoc documentation generation and deployment (#3024 )	2025-09-08 23:31:53 +00:00
.gitignore	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
.gitmodules	feat: add MeshServiceExample project to repo (#2038 )	2025-06-06 15:43:32 -05:00
.ruby-version	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
AGENT.md	docs: add AGENT.md (#2657 )	2025-08-07 18:55:42 +00:00
CONTRIBUTING.md	docs: add information about spotless for code formatting (#2622 )	2025-08-02 16:10:04 +00:00
Gemfile	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
Gemfile.lock	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
LICENSE	Add license and copyright	2020-03-01 16:39:53 -08:00
README.md	ci: add Dokka for kdoc documentation generation and deployment (#3024 )	2025-09-08 23:31:53 +00:00
RELEASE_PROCESS.md	feat(ci): migrate to fastlane for release management (#3038 )	2025-09-09 21:08:11 +00:00
build.gradle.kts	ci: add Dokka for kdoc documentation generation and deployment (#3024 )	2025-09-08 23:31:53 +00:00
crowdin.yml	Update Crowdin configuration file	2025-08-29 07:34:07 -05:00
debugging-android.md	add instructions on how to capture logcat logs	2020-03-07 17:19:36 -08:00
gradle.properties	feat(docs): migrate configs to dokka 2 (#3031 )	2025-09-09 03:14:16 +00:00
gradlew	chore(deps): update gradle to v8.14 (#1785 )	2025-04-25 16:40:48 -05:00
gradlew.bat	chore(deps): update gradle to v8.14 (#1785 )	2025-04-25 16:40:48 -05:00
secrets.defaults.properties	refactor: maps (#2097 )	2025-08-13 17:51:19 +00:00
settings.gradle.kts	build: centralize repository declarations in settings.gradle.kts (#2858 )	2025-08-26 22:00:32 +00:00

README.md

Meshtastic Logo

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 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 Obtainum to get the latest updates.

Alternatively, these other providers are also available, but may be slower to update.

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.

View Documentation

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/html directory. You can open the index.html file in your browser to view the documentation.

Translations

You can help translate the app into your native language using Crowdin.

Building the Android App

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.