![]() |
||
---|---|---|
.github | ||
.idea | ||
.settings | ||
app | ||
deprecated | ||
design@a810741521 | ||
geeksville-androidlib@74b05e465b | ||
gradle/wrapper | ||
images | ||
scripts | ||
.gitignore | ||
.gitmodules | ||
.project | ||
LICENSE | ||
README.md | ||
TODO.md | ||
build.gradle | ||
debugging-android.md | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
settings.gradle |
README.md
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, if you have questions or feedback please Join our discussion forum. We would love to hear from you!
The production version of our application is here:
To join the beta program for the app go to this URL to opt-in to the alpha/beta test. If you encounter any problems or have questions, post in the forum and we'll help.
The app is also distributed via F-Droid repo: https://mesh.tastic.app/fdroid/repo
However, if you must use 'raw' APKs you can get them from our github releases. This is not recommended because if you manually install an APK it will not automatically update.
Build instructions
If you would like to develop this application we'd love your help! These build instructions are brief and should be improved, please send a PR if you can.
- Use Android Studio to build/debug
- Use "git submodule update --init --recursive" to pull in the various submodules we depend on
- There are a few config files which you'll need to copy from templates included in the project. Run the following commands to do so:
rm ./app/google-services.json
cp ./app/google-services-example.json ./app/google-services.json
rm ./app/src/main/res/values/mapbox-token.xml
cp ./app/special/mapbox-token.xml ./app/src/main/res/values/
rm ./app/src/main/res/values/curfirmwareversion.xml
cp ./app/special/curfirmwareversion.xml ./app/src/main/res/values/
- (unfortunately) you need to get a (free) mapbox developer token here and put that token in your user gradle.properties.
cat ~/.gradle/gradle.properties
MAPBOX_DOWNLOADS_TOKEN=sk.yourtokenherexxx
-
(optional) to run CI tests on your fork: 1) allow GitHub Actions; 2) add your token at: Settings > Secrets > Actions > New repository secret: Name: MAPBOXTOKEN Value: sk.yourtokenherexxx
-
Now you should be able to select "Run / Run" in the IDE and it will happily start running on your phone or the emulator. Note: The emulators don't support bluetooth, so some features can not be used in that environment.
Analytics setup
-
analytics are included but can be disabled by the user on the settings screen
-
on dev devices
adb shell setprop debug.firebase.analytics.app com.geeksville.mesh
adb shell setprop log.tag.FirebaseCrashlytics DEBUG
for verbose logging:
adb shell setprop log.tag.FA VERBOSE
Credits
This project is the work of volunteers:
- @artemisoftnian: Contributed Spanish translations.
- @CycloMies: Contributed Swedish, Finnish and German translations.
- @eriktheV-king: Contributed Dutch and French translations.
- @Lgoix: Contributed tooltip for radio mode
- @Eugene: Contributed Russian translation.
- @Jinx17: Contributed Slovenian translation.
- @Konradrundfunk: Contributed German fixes.
- @Mango-sauce: Contributed Chinese translation.
- @NEKLAN: Contributed Japanese translation.
- @Ohcdh: Contributed Irish and Italian translations.
- @Slavino: Contributed Slovak translation.
- @Zone: Contributed Turkish translation.
Copyright 2022, Geeksville Industries, LLC. GPL V3 license