meshtastic-android/README.md

91 wiersze
4.2 KiB
Markdown
Czysty Zwykły widok Historia

2020-01-23 14:46:23 +00:00
# Meshtastic-Android
2020-01-20 23:54:41 +00:00
2020-04-03 05:37:48 +00:00
![Android CI](https://github.com/meshtastic/Meshtastic-Android/workflows/Android%20CI/badge.svg?branch=master)
2020-03-01 02:48:23 +00:00
This is a tool for using Android with open-source mesh radios. For more information see our webpage: [meshtastic.org](https://www.meshtastic.org). If you are looking for the the device side code, see [here](https://github.com/meshtastic/Meshtastic-esp32).
2020-01-20 23:54:41 +00:00
2021-02-11 05:47:46 +00:00
This project is currently beta testing, if you have questions or feedback please [Join our discussion forum](https://meshtastic.discourse.group/). We would love to hear from you.
2020-06-04 18:21:24 +00:00
The production version of our application is here:
2020-02-26 22:08:15 +00:00
2020-06-16 03:42:13 +00:00
[![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)](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub-android-readme)
2020-02-26 22:08:15 +00:00
2020-06-04 18:21:24 +00:00
But if you want the beta-test app now, we'd love to have your help testing. Three steps to opt-in to the test:
2020-02-26 22:08:15 +00:00
2020-06-04 18:21:24 +00:00
1. Join [this Google group](https://groups.google.com/forum/#!forum/meshtastic-alpha-testers) with the account you use in Google Play. **Optional** - if you just want 'beta builds'
not bleeding edge alpha test builds skip to the next step.
2. Go to this [URL](https://play.google.com/apps/testing/com.geeksville.mesh) to opt-in to the alpha/beta test.
3. If you encounter any problems or have questions, [post in the forum](https://meshtastic.discourse.group/)t and we'll help.
2020-01-26 17:48:25 +00:00
2020-07-24 22:07:51 +00:00
The app is also distributed for Amazon Fire devices via the Amazon appstore: [![Amazon appstore link](https://raw.githubusercontent.com/meshtastic/Meshtastic-device/master/images/amazon-fire-button.png)](https://www.amazon.com/Geeksville-Industries-Meshtastic/dp/B08CY9394Q)
2020-04-15 14:31:53 +00:00
## Build instructions
2020-06-04 18:21:24 +00:00
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.
2020-05-24 15:36:29 +00:00
* Use Android Studio 4.0 RC 1 to build/debug (other versions might work but no promises)
* 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:
2020-04-15 14:31:53 +00:00
2020-05-24 15:36:29 +00:00
```
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/
```
2020-04-15 14:31:53 +00:00
* (unfortunately) you need to get a (free) mapbox developer token [here](https://docs.mapbox.com/android/maps/guides/install/) and put that token in your user gradle.properties.
```
~/development/meshtastic/MeshUtil$ cat ~/.gradle/gradle.properties
MAPBOX_DOWNLOADS_TOKEN=sk.yourtokenherexxx
```
2020-05-24 15:36:29 +00:00
* 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.
2020-04-15 14:31:53 +00:00
2020-06-04 18:21:24 +00:00
## Analytics setup
* analytics are included but can be disabled by the user on the settings screen
2020-08-11 13:51:45 +00:00
* on dev devices
```shell
adb shell setprop debug.firebase.analytics.app com.geeksville.mesh
2020-06-04 18:21:24 +00:00
adb shell setprop log.tag.FirebaseCrashlytics DEBUG
2020-08-11 13:51:45 +00:00
```
2020-06-04 18:21:24 +00:00
for verbose logging:
2020-08-11 13:51:45 +00:00
```shell
2020-06-04 18:21:24 +00:00
adb shell setprop log.tag.FA VERBOSE
```
## Publishing to google play
(Only supported if you are a core developer that needs to do releases)
# Credits
This project is the work of volunteers:
2020-04-11 20:42:12 +00:00
* @artemisoftnian: Contributed Spanish translations.
2020-04-11 04:24:43 +00:00
* @CycloMies: Contributed Swedish, Finnish and German translations.
2020-04-11 16:50:28 +00:00
* @eriktheV-king: Contributed Dutch and French translations.
* @Lgoix: Contributed tooltip for radio mode
* @Eugene: Contributed Russian translation.
2020-06-27 22:30:07 +00:00
* @Jinx17: Contributed Slovenian translation.
2020-05-24 15:36:29 +00:00
* @Konradrundfunk: Contributed German fixes.
2020-04-11 16:50:28 +00:00
* @Mango-sauce: Contributed Chinese translation.
2020-05-29 21:02:03 +00:00
* @NEKLAN: Contributed Japanese translation.
2020-04-11 16:50:28 +00:00
* @Ohcdh: Contributed Irish and Italian translations.
* @Slavino: Contributed Slovak translation.
2020-06-22 23:30:40 +00:00
* @Zone: Contributed Turkish translation.
2020-03-30 20:45:14 +00:00
Copyright 2019, Geeksville Industries, LLC. GPL V3 license
2020-01-22 21:19:51 +00:00
2020-01-23 14:46:23 +00:00