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

Go to file

Phil Oliver 6529432302 Flatten BluetoothViewModel		2025-09-17 22:31:47 -04:00
.github	refactor(build): simplify lint, spotless, and detekt configurations (#3133 )	2025-09-17 21:43:23 +00:00
.idea	…
app	Flatten BluetoothViewModel	2025-09-17 22:31:47 -04:00
build-logic	refactor(build): simplify lint, spotless, and detekt configurations (#3133 )	2025-09-17 21:43:23 +00:00
config	feat(build): Convention Plugins (#3081 )	2025-09-15 10:47:03 +00:00
design@90014f40e8	…
fastlane	fix: missed commas	2025-09-14 10:30:48 -05:00
gradle	chore(deps): update androidx lifecycle to v2.9.4 (#3130 )	2025-09-17 18:59:54 +00:00
mesh_service_example	refactor(build): simplify lint, spotless, and detekt configurations (#3133 )	2025-09-17 21:43:23 +00:00
navigation	Move nav routes to new `:navigation` project module (#3124 )	2025-09-17 10:46:43 +00:00
network	Use Ktor/Ktorfit for API calls (#3122 )	2025-09-16 18:45:59 +00:00
.gitignore	feat(build): Convention Plugins (#3081 )	2025-09-15 10:47:03 +00:00
.gitmodules	…
.ruby-version	chore(deps): update ruby to v3.4.6 (#3120 )	2025-09-16 13:06:21 +00:00
AGENT.md	feat(build): Convention Plugins (#3081 )	2025-09-15 10:47:03 +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	…
README.md	feat(ci): add kover for test coverage reporting (#3041 )	2025-09-10 15:30:47 +00:00
RELEASE_PROCESS.md	feat(build): Convention Plugins (#3081 )	2025-09-15 10:47:03 +00:00
build.gradle.kts	Use Ktor/Ktorfit for API calls (#3122 )	2025-09-16 18:45:59 +00:00
codecov.yml	ci: add coverage status configuration to codecov.yml (#3104 )	2025-09-15 06:59:55 -05:00
compose_compiler_config.conf	feat(build-logic): modularize build-logic & update dependencies (#3110 )	2025-09-15 21:48:27 +00:00
crowdin.yml	Update Crowdin configuration file	2025-09-14 10:14:19 -05:00
debugging-android.md	…
gradle.properties	feat(build-logic): modularize build-logic & update dependencies (#3110 )	2025-09-15 21:48:27 +00:00
gradlew	…
gradlew.bat	…
secrets.defaults.properties	refactor: maps (#2097 )	2025-08-13 17:51:19 +00:00
settings.gradle.kts	Move nav routes to new `:navigation` project module (#3124 )	2025-09-17 10:46:43 +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.