meshtastic/docs/software/android/installation.mdx
rcarteraz fa11f7aa7f
Some checks are pending
CI / quality (push) Waiting to run
CI / build (push) Waiting to run
remove discourse links
2024-10-28 08:43:03 -07:00

75 lines
3.6 KiB
Plaintext

---
id: installation
title: Android Application Installation
sidebar_label: Installation
sidebar_position: 1
---
## Installation Methods
Our Android application is available on our F-Droid repo and Google Play Store. This allows you to connect to your Meshtastic device from your Android phone via Bluetooth, Wi-Fi (if on the same network) or USB On-The-Go (OTG).
The minimum Android version is 5.0 (Lollipop 2014, first BLE support), however Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable.
### Install with F-Droid
<p float="center">
<a href="https://f-droid.org/packages/com.geeksville.mesh/">
<img
alt="Get it on F-Droid"
src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
width="49%"
/>
</a>
</p>
1. Download and Install the F-Droid app from [f-droid.org](https://f-droid.org/)
2. Navigate to the `Categories` page and refresh (scroll down).
3. Search for and install the `Meshtastic` App.
### Install from Play Store
<p float="center">
<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"
src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
width="49%"
/>
</a>
</p>
There is a Play Store [testing program](https://play.google.com/apps/testing/com.geeksville.mesh) with the latest cutting edge changes, though this may come with extra bugs.
_Google Play and the Google Play logo are trademarks of Google LLC._
### Install by Sideloading
<p float="center">
<a href="https://github.com/meshtastic/Meshtastic-Android/releases/latest">
<img
alt="Download at https://github.com/meshtastic/Meshtastic-Android/releases/latest"
src="/img/android/get-it-on-github.webp"
width="49%"
/>
</a>
</p>
The app can also be sideloaded by downloading the .APK from the [Github Releases](https://github.com/meshtastic/Meshtastic-Android/releases/latest) 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 [GitHub page](https://github.com/meshtastic/Meshtastic-Android)
### Install with Obtainium
1. Download and Install the Obtanium app from [Github](https://github.com/ImranR98/Obtainium).
2. Open the Obtanium app and navigate to `+ Add App`.
3. You can easily search for the Android repo with the search field by typing `Meshtastic-Android` and selecting the `Meshtastic/Meshtastic-Android` repo. You may also manually enter the Meshtastic Android Github Releases address as follows: `https://github.com/meshtastic/Meshtastic-Android/releases`.
4. Under `Additional Options for Github` toggle as desired `Include prereleases`\* or `Fallback to older releases` and press `Add`.
5. The first time you add an application, obtainium will prompt you for permission to install unknown apps, you will need to toggle `Allow from this source` and press back. Obtainium will download the Android .APK from the Github release page.
6. Press `Install`. Android Installer will prompt "Do you want to install this app?" press `Install`.
7. Press `Open`.
Obtainium allows you to install and update Open-Source Apps directly from their releases pages, and receive notifications when new releases are made available.
\*Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the Meshtastic Alpha Testers Channel on [Discord](https://discord.com/invite/ktMAKGBnBs) if you decide to use these versions.