mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-20 08:07:33 -07:00
update android docs
This commit is contained in:
andrekir
parent
cc3cbaf962
commit
e03441d4ae
|
|
@ -15,19 +15,10 @@ If you would like to develop this application we'd love your help! These build i
|
|||
```
|
||||
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](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
|
||||
```
|
||||
|
||||
- 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
|
||||
|
|
|
|||
|
|
@ -1,29 +0,0 @@
|
|||
---
|
||||
id: mapbox
|
||||
title: Setting up Mapbox with Meshtastic
|
||||
sidebar_label: Mapbox Setup
|
||||
---
|
||||
|
||||
If you build Meshtastic as per the standard instructions then you may notice that the maps are not shown. This is because there is an extra step to setting up MapBox (an external service) with Meshtastic.
|
||||
|
||||
## Getting MapBox to work with your local copy of Meshtastic
|
||||
|
||||
In order to compile a new version of Meshtastic that can use MapBox you will need to provide a token associated with your MapBox user account.
|
||||
|
||||
This is fairly simple to do.
|
||||
|
||||
- Create an account at MapBox
|
||||
- Copy the public token associated with that account to the clipboard
|
||||
- Paste that into the file "…/src/main/res/values/mapbox-token.xml"
|
||||
|
||||
## Examples of what can be achieved with MapBox
|
||||
|
||||
MapBox is an external service with many features that can be included in the Meshtastic app.
|
||||
|
||||
The following link shows many of the available features:
|
||||
https://docs.mapbox.com/mapbox-gl-js/examples/
|
||||
|
||||
## Basics of using MapBox with Android Apps
|
||||
|
||||
MapBox provide a simple example of how to display a basic map in an Android App:
|
||||
https://docs.mapbox.com/android/maps/overview/#add-a-map
|
||||
|
|
@ -5,20 +5,21 @@ sidebar_label: Android App
|
|||
sidebar_position: 1
|
||||
---
|
||||
|
||||
Our Android application is available to download on Google Play Store. This allows you to connect to your Meshtastic® device from your Android phone.
|
||||
Our Android application is available on F-Droid and Google Play Store. This allows you to connect to your Meshtastic device from your Android phone.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://mesh.tastic.app/fdroid/repo">
|
||||
<img alt="Get it on F-Droid"
|
||||
src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
|
||||
width="49%"/>
|
||||
</a>
|
||||
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh">
|
||||
<img
|
||||
alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh"
|
||||
<img alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh"
|
||||
src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
|
||||
style={{ zoom: '35%' }}
|
||||
/>
|
||||
width="49%"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
The app is also distributed via F-Droid repo: [https://mesh.tastic.app/fdroid/repo](https://mesh.tastic.app/fdroid/repo)
|
||||
|
||||
The application may not be found if your phone/Android version are too old. The minimum Android version is 5.0 (Lollipop 2014, first BLE support). However, Android 6, Marshmallow 2015, is recommended as the Bluetooth is more stable.
|
||||
|
||||
The app can also be sideloaded by downloading the .apk from the <a href="https://github.com/meshtastic/Meshtastic-Android/releases/latest">GitHub releases</a> page. If you do sideload, you may have to give your browser permissions to run a package installer. If you wish to view the code or contribute to development of the app, please visit the app's <a href="https://github.com/meshtastic/Meshtastic-Android">GitHub page</a>.
|
||||
|
|
@ -26,12 +27,10 @@ The app can also be sideloaded by downloading the .apk from the <a href="https:/
|
|||
Be aware that you may have to open the drop down menu for "Compare" to see the latest alpha/beta builds. Generally the versions will follow the device versions.
|
||||
:::
|
||||
|
||||
After installing the Meshtastic app, open it and navigate to the settings page. The app will ask you to give it permissions to access your location. This is needed for any app to use Bluetooth, as the app is then able to scan the local area for Bluetooth devices. If you give location permissions "only while using the app", the app will only be able to use Bluetooth while it is open and visible to the user. This means if the screen is locked, or you are using another app, Meshtastic will not be able to use Bluetooth, and will not be able to receive any messages from the node.
|
||||
|
||||
[](/img/android/android-messages-sm.png) [](/img/android/android-nodes.png) [](/img/android/android-channel.png) [](/img/android/android-settings.png) [](/img/android/android-debug.png)
|
||||
|
||||
:::note
|
||||
Be aware that every OS has a different way of handling permissions. In order to prevent the user from accidentally allowing background location services, the dialog box may not give you the option.
|
||||
Be aware that Android versions have different ways of handling permissions. In order to prevent users from accidentally allowing background location services, the dialog box may not give you the option.
|
||||
|
||||
Click on the image to see a quick video of where I found it on my phone.
|
||||
|
||||
|
|
@ -40,7 +39,7 @@ Click on the image to see a quick video of where I found it on my phone.
|
|||
|
||||
There is a [beta program](https://play.google.com/apps/testing/com.geeksville.mesh) for the app, which will let you test the cutting edge changes, though this may come with extra bugs. You can join this via Google Play. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to join this.
|
||||
|
||||
The app uses anonymous usage statistics and crash reports to allow us to catch problems with Meshtastic and fix them. Analytics are also required to be able to use the "free" plan of our map provider [Mapbox](https://docs.mapbox.com/help/how-mapbox-works). You can disable this by unticking the checkbox on the settings page.
|
||||
The app uses anonymous usage statistics and crash reports to allow us to catch problems with Meshtastic and fix them. You can disable this by unticking the checkbox on the settings page.
|
||||
|
||||
[](/img/android/android-stats-consent.png)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue