Bouwen van de app

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 dertails.

## Important notes

Please note With AndroidAPS version 2.3 it is not possible to build the APK with the latest Android Studio version. Please use Android Studio 3.4 from here.

Please note when building AndroidAPS 2.0 apk: Configuration on demand is not supported by the current version of the Android Gradle plugin!

Als je een foutmelding krijgt die gaat over “on demand configuration” kun je het volgende doen:

  • Open het Preferences (Voorkeuren) venster door op File > Settings (Bestand > Instellingen) te klikken (op Mac, Android Studio > Voorkeuren).
  • In het linkerscherm, klik op Build, Execution, Deployment > Compiler.
  • Vink de Configure on demand checkbox uit.
  • Klik op Apply (Toepassen) of OK.

Dit artikel is verdeeld in twee delen.

  • 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.

Overzicht

In general, the steps necessary to build the APK file:

  • Install git
  • Install and setup Android Studio.
  • Use git to clone the source code from the central Github repository where the developers have put the actual code for the app.
  • Open the cloned project in Android Studio as active project.
  • Build the signed APK.
  • Transfer the signed APK to your smartphone.

Step by step walkthrough

Detailed description of the steps necessary to build the APK file.

Installeer Git (als je dat nog niet hebt)

Windows

  • Elke versie van Git zou moeten werken. Bijvoorbeeld https://git-scm.com/download/win. Volg de instructies op die site om Git te installeren.

  • Onthoud of noteer in welke map Git op jouw computer geïnstalleerd wordt. You will need it later after you installed Android Studio.

    Git installatie pad

Mac

Install Android Studio

The following screenshots have been taken from Android Studio Version 3.1.3. Your screen might look a bit different depending on the Android Studio version you use. But you should be able to find your way through. Help from the community is provided for example in the AndroidAPS Facebook group and other places.

Install Android Studio and setup during first start.

Select “Do not import settings” as you have not used it before.

Screenshot 1

Click “Next”.

Screenshot 2

Select “Standard” installation and click “Next”.

Screenshot 3

Select the theme for the user interface you like. (In this manual we used “Intellij”. 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.

Screenshot 4

Click “Next” on the “Verify Settings” dialog.

Screenshot 5

The Android emulator (to emulate the smartphone on your PC or Mac) is not used to build the APK. You can click “Finish” to finish the installation and read the documentation later on demand.

Screenshot 6

Android Studio is downloading a lot of software components it uses. You can click on the “Show Details” button to the what happens but that’s not important at all.

Screenshot 7

Screenshot 8

After the downloads are completed click the “Finish” button.

Screenshot 9

  • Applause, applause you have now finished the Android Studio installation and can start cloning the source code. Maybe it’s time for a short break?

Set git path in preferences

Windows

  • Laat Studio weten waar git.exe zich bevindt: File - Settings (Bestand - Instellingen)

    Android Studio - open instellingen

  • In het volgende venster: Versie Control - Git

  • Kies het juiste pad: .../Git/bin

  • Zorg ervoor dat de update methode “Merge” (“Samenvoegen”) is geselecteerd.

    Android Studio - GIT pad

Mac

  • Als je git installeert via homebrew, hoef je niets aan de instellingen te wijzigen. Voor het geval je ze toch zoekt: je vind ze hier: Android Studio - Preferences.

Download code and additional components

  • Use git clone in Android Studio as shown in screenshots below. Select “Check out project from Version Control” with “Git” as concrete version control system.

Screenshot 10

Version_Control_Git

Fill in the URL to the main AndroidAPS repository (“https://github.com/MilosKozak/AndroidAPS”) and click “clone”.

Screenshot 13

Android Studio will start cloning. Don’t click “Background” as it goes fast and makes things more complicated at the moment.

Screenshot 14

Finish the checkout from version control with opening the project by clicking “Yes”.

Screenshot 15

Use the standard “default gradle wrapper” and click “OK”.

Screenshot 16

Read and close the “Tip of Day” screen of Android Studio by pressing “Close”.

Screenshot 17

  • Excellent, you have your own copy of the source code and are ready to start the build.
  • Now we are approaching our first error message. Fortunately, Android Studio will directly give us the solution for this.

Click “Install missing platform(s) and sync project” as Android Studio needs to install a missing platform.

Screenshot 18

Accept the license agreement by selecting “Accept” and clicking “Next”.

Screenshot 19

As it is said in the dialog please wait until the download is finished.

Screenshot 20

Now it’s finished. Please click “Finish”.

Screenshot 21

Aaaahhh, next error. But Android Studio suggests a similar solution. Click “Install Build Tools and sync project” as Android Studio needs to download missing Tools.

Screenshot 22

As it is said in the dialog please wait until the download is finished.

Screenshot 23

Now it’s finished. Please click “Finish”.

Screenshot 24

And another error to handle as Android Studio needs to download again a missing platform. Click “Install missing platform(s) and sync project”.

Screenshot 25

As it is said in the dialog please wait until the download is finished.

Screenshot 26

Now it’s finished. Please click “Finish”.

Screenshot 27

Click “Install Build Tools and sync project” as Android Studio needs to download missing Tools.

Screenshot 28

As it is said in the dialog please wait until the download is finished.

Screenshot 29

Now it’s finished. Please click “Finish”.

Screenshot 30

Yeah, the error messages are gone and the first gradle build is runing. Maybe it’s time to drink some water?

Screenshot 31

Android Studio recommends to update the gradle system. Never update gradle! This might lead to difficulties!

Please click “Don’t remind me again for this project”.

Screenshot 32

The build is running again.

Screenshot 33

Yeah, the first build is successful but we are not finished.

Screenshot 34

Bouwen van de ondertekende APK

Selecteer in het menu “Build” en vervolgens “Generate Signed Bundle / APK...”. (Het menu in Android Studio is gewijzigd per september 2018. In older versions select in the menu “Build” and then “Generate Signed APK...”.)

Signing means that you sign your generated app but in a digital way as a kind of digital fingerprint in the app itself. Dat is nodig omdat Android om veiligheidsredenen voorschrijft dat een app altijd zo’n handtekening moet hebben. Voor meer informatie over dit onderwerp, volg de link hier. Veiligheid van apps is een groot en ingewikkeld onderwerp waarin je je niet verder hoeft te verdiepen.

Screenshot 39a

In het volgende dialoogvenster selecteer je “APK” in plaats van “Android App Bundle” en klik op “Volgende”.

Screenshot 39b

Selecteer “App” en klik op “Next”.

Screenshot 40

Click “Create new...” to start creating your keystore. A keystore 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. We suggest storing it in your home folder and remember the passwords but if you lose this information it’s not a big issue because then you just have to create a new one. Best practice is to store this information carefully.

Screenshot 41

  • Fill in the information for the next dialog.
    • Key store path: is the path to the keystore file
    • The password fields below are for the keystore to double check for typing errors.
    • Alias is a name for the key you need. You can leave the default or give it a fancy name you want.
    • The password fields below the key are for the key itself. As always to double check for typing errors.
    • You can let the validity at the default of 25 years.
    • You only have to fill out first name and last name but feel free to complete the rest of information. Then click “OK”.

Screenshot 42

Fill in the information of the last dialog in this dialog and click “Next”.

Screenshot 43

Selecteer “full” (volledig) als “Flavour” (smaak) om de volledige AndroidAPS app te maken. Selecteer “V1 Jar Signature” (V2 is optioneel) en klik op “Finish”. De volgende informatie kan handig zijn voor later.

  • ‘Release’ is wat je hoort te kiezen als “Build Type”, ‘Debug’ is alleen voor programmeurs.
  • Kies de “Flavour” die je wilt bouwen:
    • full (dwz je pomp wordt automatisch aangestuurd tijdens closed looping)
    • openloop (dwz voorstellen voor tijdelijke basaalstanden, die de gebruiker handmatig op de pomp instelt)
    • pumpcontrol (dwz alleeneen afstandsbediening voor de pomp, zonder te loopen)
    • nsclient (dwz de gegevens van een andere gebruiker worden weergegeven en care portal bijdragen kunnen worden toegevoegd)

Screenshot 44

In het Event Log kun je zien dat de Signed APK (ondertekende APK) succesvol is gebouwd.

Screenshot 45

Klik op de “locate” link in het Event Log.

Screenshot 46

Overzetten van de APK naar je telefoon

Een Verkenner venster zal openen. Het kan dat het er iets anders uitziet, dit screenshot is met een Linux computer gemaakt. In Windows zal de “Verkenner” openen, op een Mac OS X de “Finder” Hier zul je een map zien met daarin een APK bestand. Helaas is dit de VERKEERDE locatie, omdat “wear-release.apk” NIET de ondertekende app die we zoeken.

Screenshot 47

Om de juiste locatie te openen, ga naar de map met AndroidAPS/app/full/release om het bestand “app-full-release.apk” te vinden. Zet dit bestand op jouw Android telefoon. Het overzetten op je telefoon kun je simpelweg via een usb-kabeltje doen. Andere opties zijn Bluetooth, cloud upload, e-mail. Kies wat je makkelijk vindt. In dit voorbeeld wordt Gmail gebruikt. Om de zelf-ondertekende app te kunnen installeren, moet je Android hiervoor toestemming geven ookal is dit bestand via Gmail ontvangen, wat normaal gesproken niet toegestaan is. Als je een andere manier gebruikt om de APK over te zetten op je telefoon, geef dan de toestemmingen waar hij naar vraagt zodat je verder kunt.

Screenshot 48

In de instellingen van je telefoon is een optie om “Apps uit onbekende bronnen” toestemming te geven om te kunnen installeren. Daar moet je Gmail (in dit voorbeeld) toestemming geven om de APK te installeren.

Selecteer “Toestaan van deze bron”. Nadat je klaar bent met installeren, wordt het aanbevolen om de instellingen weer terug te zetten op “niet toestaan”.

Installeren uit onbekende bronnen

De laatste stap is om op het APK bestand te tikken en de app te installeren. Als hij niet uit zichzelf installeert en je hebt een vorige versie van AndroidAPS op je telefoon staan die met een andere handtekening is ondertekend, dan moet je die versie van de app eerst verwijderen. Vergeet niet om eerst je instellingen van die versie te exporteren vóórdat je de app verwijdert!

Van harte! Je hebt de app geïnstalleerd op je telefoon en nu kun je verder met het instellen van AndroidAPS.