Building the APK¶
Build yourself instead of download¶
AndroidAPS is not available as download due to regulation for medial devices. It is legal to build the app for your own use but you must not give a copy to others! See FAQ page for details.
## Important notes¶
- Please use Android Studio Version 4.1.1 or newer to build the apk.
- Windows 10 32-bit systems are not supported by Android Studio 4.1.1.
Configuration on demand is not supported by the current version of the Android Gradle plugin!
If your build fails with an error regarding “on demand configuration” you can do the following:
- Open the Preferences window by clicking File > Settings (on Mac, Android Studio > Preferences).
- In the left pane, click Build, Execution, Deployment > Compiler.
- Uncheck the Configure on demand checkbox.
- Click Apply or OK.
This article is divided into two parts.¶
- In the overview part there is an explanation on what steps are necessary to build the APK file.
- In the step by step walkthrough part you will find the screenshots of a concrete installation. Because the versions of Android Studio - the software development environment which we will use to build the APK - will change very quickly this will be not identical to your installation but it should give you a good starting point. Android Studio also runs on Windows, Mac OS X and Linux and there might be small differences in some aspects between each platform. If you find that something important is wrong or missing, please inform the facebook group “AndroidAPS users” or in the Gitter chats Android APS or AndroidAPSwiki so that we can have a look at this.
In general, the steps necessary to build the APK file:
Step by step walkthrough¶
Detailed description of the steps necessary to build the APK file.
Install Android Studio¶
The following screenshots have been taken from Android Studio Version 3.6.1. Your screen might look a bit different if you use a newer version of Android Studio. But you should be able to find your way through. Help from the community is provided.
One of the most important things when installing Android Studio: Be patient! During installation and setup Android Studio is downloading a lot of stuff which will take its time.
Install Android Studio and setup during first start.
Select “Do not import settings” as you have not used it before.
Decide whether you want to share data with Google or not.
On the following screen click “Next”.
Select “Standard” installation and click “Next”.
Select the theme for the user interface you like. (In this manual we used “Light”.) Then click “Next”. This is just the color scheme. You can select any you like (i.e. “Darcula” for dark mode). This selection has no influence on building the APK.
Click “Finish” on the “Verify Settings” dialog.
Wait while Android Studio downloads additional components and be patient. Once everything is downloaded button “Finish” turns blue. Click the button now.
Set git path in preferences¶
Make sure git is installed on your computer.
On the Android Studio welcome screen click the small triangle (1. in next screenshot) and select “Settings” (2.).
Click the small triangle next to Version Control (1.) to open the sub-menu.
Click Git (2.).
Make sure update method “Merge” (3.) is selected.
Check if Android Studio can locate path to git.exe automatically by clicking the button “Test” (4.)
If automatic setting is successful git version will be displayed.
Click “OK” in the dialog box (1.) and “OK” in the settings window (2.).
In case file git.exe cannot be found click “OK” in the dialog box (1.) and then the button with the three dots (2.).
Use search function in windows explorer to find “git.exe” if you are unsure where it can be found. You are looking for git.exe located in \bin\ folder.
Select path to git.exe and make sure you selected the one in ** \bin\ ** folder (3.) and click “OK” (4.).
Close settings window by clicking “OK” button (5.).
Reboot your computer to update system environment.
- Any git version should work. For example https://git-scm.com/download/mac.
- Use homebrew to install git:
$ brew install git.
- For details on installing git see the official git documentation.
- If you install git via homebrew there is no need to change any preferences. Just in case: They can be found here: Android Studio - Preferences.
Download AndroidAPS code¶
If you haven’t already rebooted your computer after setting git path in preferences do it now. System environment must be updated.
There are two options to start a new project:
On the Android Studio welcome screen click “Get from version control”
If you already opened Android Studio and do not see the welcome screen anymore select File (1.) > New (2.) > Project from Version Control... (3.)
Fill in the URL to the main AndroidAPS repository (https://github.com/nightscout/AndroidAPS) (1.).
Choose the directory where you want to save the cloned code. (2.)
Click button “Clone” (3.).
Do not click “Background” while repository is cloned!
After repository is cloned successfully open your local copy by clicking “Yes”.
In the lower right corner you will see the information that Android Studio is running background tasks.
Grant access if your firewall is asking for permission.
Once the background tasks are finished you will probably see the following error message:
Download Android SDK¶
Click File > Settings.
Click the small triangle next to Appearance & Behaviour (1.).
Click the small triangle next to System Settings (2.) and select Android SDK (3.)
Check the box left of “Android 9.0 (Pie)” (4.) (API Level 28).
Confirm changes by clicking OK.
Accept licence agreement (1.) and click “Next” (2.).
Wait until installation is finished.
When SDK installation is completed the “Finish” button will turn blue. Click this button.
Android Studio might recommend to update the gradle system. Never update gradle! This might lead to difficulties!
If you see an information on the lower right side of your Android Studio window that Android Gradle Plugin is ready to update click on the text “update” (1.) and in the dialog box on “Don’t remind me again for this project” (2.).
Generate signed APK¶
Signing means that you indicate your app to be your own creation but in a digital way as a kind of digital fingerprint within the app itself. That is necessary because Android has a rule that it only accepts signed code to run for security reasons. For more information on this topic, follow this link.
Click “Build” in the menu bar and select “Generate Signed Bundle / APK...”.
Select “APK” (1.) instead of “Android App Bundle” and click “Next” (2.).
Make sure that module is set to “app” (1.).
Click “Create new...” (2.) to start creating your key store.
A key store in this case is nothing more than a file in which the information for signing is stored. It is encrypted and the information is secured with passwords.
Click the folder symbol (1.) to select your key store path.
Select the path where your key store shall be saved (2.). Do not save in same folder as project. You must use a different directory! One option might be your home folder.
Type a file name for your key store (3.).
Click “OK” (4.).
Passwords for key store and key do not have to be very sophisticated. Make sure to remember those or make a note in a safe place. In case you will not remember your passwords in the future you see troubleshooting for lost key store.
Enter (5.) and confirm (6.) the password for your key store.
Do the same for your key (7. + 8.).
Validity (9.) is 25 years by default. You do not have to change the default value.
First and last name must be entered (10.). All other information is optional.
Click “OK” (11.) when you are done.
Make sure the box to remember passwords is checked (1.). So you don’t have to enter them again next time you build the apk (i.e. when updating to a new AndroidAPS version).
Click “Next” (2.).
Select build variant “fullRelease” (1.).
Check boxes V1 and V2 for signature versions (2.).
Click “Finish”. (3.)
Android Studio will display the information “APK(s) generated successfully...” after build is finished.
In case build was not successful refer to the troubleshooting section.
Easiest way to find the apk is to click on “Event log”.
In the event log section click “locate”.
app-full-release.apk is the file you are looking for.
Transfer APK to smartphone¶
Easiest way to transfer app-full-release.apk to your phone is via USB cable or Google Drive. Please note that transfer by mail might cause difficulties and is not the preferred way.