Android - ArchWiki

# Android

From ArchWiki

Related articles

- Android tethering

## Exploring Android device

When you connect a modern Android device via USB to a computer you can use MTP to transfer files and #Android Debug Bridge to debug it.

Files can generally be transferred with various protocols (SSH, FTP, Samba, HTTP). You just need to setup a client and a server (via apps Android can act as either one).

For flashing and restoring Android firmware see #Restoring Android.

See #Connection software for software available for Arch Linux that can be used to connect to Android.

## Android development

To develop Android applications you need three things:

- the Android SDK core component
- one or several Android SDK Platform packages
- an IDE

The official IDE for Android is #Android Studio, which comes with its own SDK manager.

### Android Studio

Android Studio is the official Android development environment based on IntelliJ Idea. It provides integrated Android developer tools for development and debugging.

You can install it with the android-studioAUR package. If you get an error about a missing SDK, refer to #Android SDK platform API above.

Note:

- If you are using a tiling window manager other than i3, you may need to apply one of the fixes mentioned in this issue page.
- Make sure you properly set the Java environment otherwise android-studio will not start.

Normally, apps are built through the Android Studio GUI. To build apps from the commandline (using e.g. `./gradlew assembleDebug`), add the following to your `~/.bashrc`:

    export ANDROID_HOME=/opt/android-sdk

### Manual SDK installation

If you are using #Android Studio and want the IDE to manage your SDK installation, you can skip this section.

#### Android SDK core components

Note:

- If you are running a 64-bit system, make sure the multilib repository is enabled to avoid `error: target not found: lib32-*` error messages.

Before developing Android applications, you need to install the Android SDK, which is made of 4 distinct packages, all installable from AUR:

1. android-platformAUR
2. android-sdkAUR
3. android-sdk-platform-toolsAUR
4. android-sdk-build-toolsAUR

If supporting older devices, or working with older code, android-supportAUR and android-support-repositoryAUR might be required.

Android-sdk will be installed on `/opt/android-sdk/`. This folder has root permissions, so keep in mind to run sdk manager as root, otherwise you will not be able to modify anything in this directory. If you intend to use it as a regular user, create the Android sdk users group:

    # groupadd sdkusers

Add your user into this group:

    # gpasswd -a <user> sdkusers

Change folder's group.

    # chown -R :sdkusers /opt/android-sdk/

Change permissions of the folder so the user that was just added to the group will be able to write in it:

    # chmod -R g+w /opt/android-sdk/

Re-login or as <user> log your terminal in to the newly created group:

    $ newgrp sdkusers

Note: As an alternative to a global install with the AUR packages, the SDK can be installed to a user's home directory via the upstream instructions. You may also use the android-*-dummy packages in the AUR to handle the system dependencies.

#### Android SDK platform API

Install the desired Android SDK Platform package from the AUR:

- android-platformAUR – the latest API
- the AUR also contains older APIs[1]

#### Android System Images

Install the desired Android system image package from the AUR. The Images are needed for emulating a specific android device. They are not needed if you want to develop with an android phone.

### Other IDEs

Android Studio is the official Android development environment based on IntelliJ IDEA. Alternatively, you can use Netbeans with the NBAndroid plugin. All are described below.

#### Netbeans

If you prefer using Netbeans as your IDE and want to develop Android applications, download the NBAndroid by going to Tools > Plugins > Settings.

Add the following URL: http://nbandroid.org/release81/updates/updates.xml

Then go to Available Plugins and install the Android and JUnit plugins. Once you have installed go to Tools > Options > Miscellaneous > Android.

and select the path where the SDK is installed (`/opt/android-sdk` by default). That is it, now you can create a new Android project and start developing using Netbeans.

#### Eclipse

Note: The Eclipse ADT plugin is no longer supported. Google recommends to use Android Studio instead.[2]

The official, but deprecated, Eclipse ADT plugin can be installed with the eclipse-androidAUR package.

Note:

- if you get a message about unresolvable dependencies, install Java manually and try again.
- as an alternative, you can install the ADT via eclipse's built in "add new software" command (see instructions on ADT site).
- if you are in real trouble, it is also possible to download Android SDK and use the bundled Eclipse. This usually works without problems.
- if you need to install extra SDK plugins not found in the AUR, you must change the file ownership of /opt/android-sdk first. You can do this with `# chgrp -R users /opt/android-sdk ; chmod -R 0775 /opt/android-sdk` (see File Permissions for more details).

Enter the path to the Android SDK Location in Windows > Preferences > Android.

Note: If the plugins do not show up in Eclipse after the AUR package has been upgraded, then eclipse probably has out-of-date caches. Running `sudo eclipse -clean` once should clear them. If the problem persists, uninstall eclipse and all the plugins, delete `/usr/share/eclipse`, and reinstall everything.

### Android Debug Bridge

Tip:

- For some devices, you may have to enable MTP on the device, before ADB will work. Some other devices require enable PTP mode to work.
- Many devices' udev rules are included in libmtp, so if you have this installed, the following steps may not be necessary.
- Make sure your USB cable is capable of both charge and data. Many USB cables bundled with mobile devices do not include the USB data pin.

#### Connect device

To connect to a real device or phone via ADB under Arch, you must:

1. Install android-tools. In addition, you might want to install android-udev if you wish to connect the device to the proper `/dev/` entries.
2. plug in your android device via USB.
3. Enable USB Debugging on your phone or device:
   - Jelly Bean (4.2) and newer: Go to Settings > About Phone tap Build Number 7 times until you get a popup that you have become a developer. Then go to Settings > Developer > USB debugging and enable it. The device will ask to allow the computer with its fingerprint to connect. allowing it permanent will copy `$HOME/.android/adbkey.pub` onto the devices `/data/misc/adb/adb_keys` folder.
   - Older versions: This is usually done from Settings > Applications > Development > USB debugging. Reboot the phone after checking this option to make sure USB debugging is enabled.

If ADB recognizes your device (`adb devices` shows it as `"device" and not as "unauthorized"`, or it is visible and accessible in IDE), you are done. Otherwise see instructions below.

#### Figure out device IDs

Each Android device has a USB vendor/product ID. An example for HTC Evo is:

    vendor id: 0bb4
    product id: 0c8d

Plug in your device and execute:

    $ lsusb

It should come up something like this:

    Bus 002 Device 006: ID 0bb4:0c8d High Tech Computer Corp.

#### Adding udev Rules

Use the rules from android-udev (or android-udev-gitAUR), install them manually from Android developer, or use the following template for your udev rules, just replace `[VENDOR ID]` and `[PRODUCT ID]` with yours. Copy these rules into `/etc/udev/rules.d/51-android.rules`:

    /etc/udev/rules.d/51-android.rules

    SUBSYSTEM=="usb", ATTR{idVendor}=="[VENDOR ID]", MODE="0660", GROUP="adbusers"
    SUBSYSTEM=="usb",ATTR{idVendor}=="[VENDOR ID]",ATTR{idProduct}=="[PRODUCT ID]",SYMLINK+="android_adb"
    SUBSYSTEM=="usb",ATTR{idVendor}=="[VENDOR ID]",ATTR{idProduct}=="[PRODUCT ID]",SYMLINK+="android_fastboot"

Then, to reload your new udev rules, execute:

    # udevadm control --reload-rules

Make sure you are member of `adbusers` group to access `adb` devices.

#### Configuring adb

Instead of using udev rules, you may create/edit `~/.android/adb_usb.ini` which contains a list of vendor IDs.

    ~/.android/adb_usb.ini

    0x27e8

#### Detect the device

After you have setup the udev rules, unplug your device and replug it.

After running:

    $ adb devices

you should see something like:

    List of devices attached
    HT07VHL00676    device

#### General usage

You can now use adb to transfer files between the device and your computer. To transfer files to the device, use

    $ adb push <what-to-copy> <where-to-place>

To transfer files from the device, use

    $ adb pull <what-to-pull> <where-to-place>

#### Notes & Troubleshooting

- ADB can also be installed via platform tools(usually available in `/opt/android-sdk/platform-tools/`), so it might not be necessary to install android-tools (available in `/usr/bin/`).

- If you are getting an empty list (your device is not there), it may be because you have not enabled USB debugging on your device. You can do that by going to Settings > Applications > Development and enabling USB debugging. On Android 4.2 (Jelly Bean) the Development menu is hidden; to enable it go to Settings > About phone and tap Build number 7 times.

- If there are still problems such as adb displaying `???????? no permissions` under devices, try restarting the adb server as root.

    # adb kill-server
    # adb start-server

- On moto e it could happen to have a different vendor/product id while you are on sideload or fastboot, verify again lsusb if you get no permission.

### NVIDIA Tegra platform

If you target your application at NVIDIA Tegra platform, you might also want to install tools, samples and documentation provided by NVIDIA. In NVIDIA Developer Zone for Mobile there are two tools:

1. The Tegra Android Development Pack provides tools (NVIDIA Debug Manager) related to Eclipse ADT and their documentation.
2. The Tegra Toolkit provides tools (mostly CPU and GPU optimization related), samples and documentation.

Both are currently not available in the AUR anymore, because NVIDIA requires a registration/login for the download.

## Building Android

Please note that these instructions are based on the official AOSP build instructions. Other Android-derived systems such as LineageOS will often require extra steps.

### Required packages

To build any version of Android, you need to install these packages:

- lib32-gcc-libs git gnupg flex bison gperf sdl wxgtk2 squashfs-tools curl ncurses zlib schedtool perl-switch zip unzip libxslt python2-virtualenv bc rsync ncurses5-compat-libsAUR lib32-zlib lib32-ncurses lib32-readline lib32-ncurses5-compat-libsAUR

The aosp-develAUR metapackage provides them all for simple installation.

Note: The PGP signatures for ncurses5-compat-libsAUR and lib32-ncurses5-compat-libsAUR may cause errors, that can be solved by manually importing the needed signature:

    $ gpg --recv-keys 702353E0F7E48EDB

Additionally, LineageOS requires the following packages: xml2, lzop, pngcrush, imagemagick

They can be installed with the lineageos-develAUR metapackage.

Note: Installing both maven and gradle to build LineageOS may result in a build speed improvement as the build process will prefer the system's

### Java Development Kit

The required JDK version depends on the Android version you're building:

- For Android 7 and 8 (Nougat and Oreo), OpenJDK 8 is required, which is available with the jdk8-openjdk package.
- For Android 5 and 6 (Lollipop and Marshmallow), OpenJDK 7 is required, which is available with the jdk7-openjdk package.

Older versions require a working Oracle JDK installed on your build system. It will not work with OpenJDK.

- For Gingerbread through KitKat (2.3 - 4.4), Java 6 is required, which is available as jdk6AUR from the AUR.
- For Cupcake through Froyo (1.5 - 2.2), Java 5 is required, which is available as jdk5AUR from the AUR.

Note: Android expect java in /usr/lib/jvm/java-x-openjdk-amd64, where x is the java version.

Set JAVA_HOME to avoid this requirement and match archlinux installation path. Example:

    $ export JAVA_HOME=/usr/lib/jvm/java-x-openjdk

This change will be valid only for the current terminal session.

### Setting up the build environment

Install the repo package.

Create a directory to build.

    $ mkdir ~/android
    $ cd ~/android

The Android build process expects `python` to be python2. Create a python2 virtual environment and activate it:

    $ virtualenv2 venv
    $ source venv/bin/activate

Note:

- This activation is only active for the current terminal session. The virtual env will be kept in the `venv` folder.
- During build you may receive error pertaining to missing python modules. A quick and dirty fix is to symlink /usr/lib/python2.7/* to ~/android/venv/lib/python2.7/ (Change ~/android to reflect your build directory if different than above).

Example:

    $ ln -s /usr/lib/python2.7/* ~/android/venv/lib/python2.7/

or (assuming build directory Data/Android_Build):

    $ ln -s /usr/lib/python2.7/* /Data/Android_Build/venv/lib/python2.7/

### Downloading the source code

This will clone the repositories. You only need to do this the first time you build Android, or if you want to switch branches.

- The `repo` has a `-j` switch that operates similarly to the one used with `make`. Since it controls the number of simultaneous downloads, you should adjust the value depending on downstream network bandwidth.

- You will need to specify a branch (release of Android) to check out with the `-b` switch. If you leave the switch out, you will get the so-called master branch.

    $ repo init -u https://android.googlesource.com/platform/manifest -b master
    $ repo sync -j4

Note: To further decrease sync times, you can utilize the -c switch with the repo command as such:

    $ repo sync -j8 -c

The `-c` switch will only sync the branch which is specified in the manifest, which in turn is determined by the branch specified with the `-b` switch, or the default branch set by the repository maintainer.

Wait a long time. Just the uncompiled source code, along with the `.repo` and `.git` directories that are used to keep track of it, are well over 10 GB. As of Android 6.0.1, the entire codebase totals 40 GB.

Note: If you want to update your local copy of the Android source, at a later time, simply enter the build directory, load the Virtualenv, and re-sync:

    $ repo sync

### Building the code

This should do what you need for AOSP:

    $ source build/envsetup.sh
    $ lunch full-eng
    $ make -j4

If you run lunch without arguments, it will ask what build you want to create. Use -j with a number between one and two times number of cores/threads.

The build takes a very long time.

Note:

- Make sure you have enough RAM. Android will use the /tmp directory heavily. By default the size of the partition the /tmp folder is mounted on is half the size of your RAM. If it fills up, the build will fail. 4GB of RAM or more is recommended. Alternatively, you can get rid of the tmpfs from fstab all together.
- From the Android Building and Running guide:

"GNU make can handle parallel tasks with a -jN argument, and it's common to use a number of tasks N that's between 1 and 2 times the number of hardware threads on the computer being used for the build. E.g. on a dual-E5520 machine (2 CPUs, 4 cores per CPU, 2 threads per core), the fastest builds are made with commands between make -j16 and make -j32."

### Testing the build

When finished, run/test the final image(s).

    $ emulator

### Creating a Flashable Image

To create an image that can be flashed it is necessary to:

    make -j8 updatepackage

This will create a zip image under `out/target/product/hammerhead` (hammerhead being the device name) that can be flashed.

## Restoring Android

This article or section needs expansion.

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Talk:Android#)

In some cases, you want to return to the stock Android after flashing custom ROMs to your Android mobile device. For flashing instructions of your device, please use XDA forums.

### Fastboot

Fastboot (as well as ADB) is included in the android-tools package.

Note: Restoring firmwares using `fastboot` can be quite tricky, but you might want to browse XDA developers forums for a stock firmware, which is mostly a `*.zip` file, but inside of it, comes with the firmware files and `flash-all.sh` script. For example, Google Nexus firmwares include `flash-all.sh` script or another example could be for OnePlus One - XDA thread, where you can find firmwares with included `flash-all.sh` script.

### Samsung devices

Samsung devices can't be flashed using Fastboot tool. Alternatives are only Heimdall and Odin (by using Windows and VirtualBox).

#### Heimdall

Heimdall is a cross-platform open-source tool suite used to flash firmware (also known as ROMs) onto Samsung mobile devices and is also known as an alternative to Odin. It can be installed as heimdall or heimdall-gitAUR.

The flashing instructions can be found on Heimdall's GitHub page or on XDA forums.

#### Odin (Virtualbox)

Note: This section only covers preparation and not flashing instructions. Search XDA developers forums to find a flashing instructions for specific device. For example, Samsung Galaxy S4.

It is also possible to restore firmware (Android) on the Samsung devices using Odin, but inside the VirtualBox.

Arch Linux (host) preparation:

1. Install VirtualBox together with its extension pack and guest additions.
2. Install your preferred, but compatible with Odin, Windows operating system (with VirtualBox guest additions) into a virtual hard drive using VirtualBox.
3. Open VirtualBox settings of your Windows operating system, navigate to USB, then tick (or make sure it is ticked) Enable USB 2.0 (EHCI) Controller.
4. At VirtualBox running Windows operating system, click in the menu bar Devices > USB Devices, then click on your Samsung mobile device from the list, which is connected to your computer via USB.

Windows (guest) preparation:

1. Install Samsung drivers.
2. Install Odin.
3. Download required Samsung firmware (Android) for your smartphone model.

Check if configuration is working:

1. Turn your device into Download mode and connect to your Linux machine.
2. In virtual machine toolbar, select Devices > USB > ...Samsung... device.
3. Open Odin. The white box (a big one at the bottom-left side) named Message, should print a line similar to this:

    <ID:0/003> Added!!

which means that your device is visible to Odin & Windows operating system and is ready to be flashed.

## Connection software

- adb-sync (available as adb-sync-gitAUR) – a tool to synchronize files between a PC and an Android device using the ADB protocol.
- AndroidScreencast (available as androidscreencast-binAUR) – view and control your Android device from a PC (via ADB).
- kdeconnect – integrates your Android device with the KDE desktop (featuring synced notifications & clipboard, multimedia control, and file/URL sharing).
- sendanywhereAUR – cross-platform file sharing

## Tips & Tricks

### During Debugging "Source not found"

Most probably the debugger wants to step into the Java code. As the source code of Android does not come with the Android SDK, this leads to an error. The best solution is to use step filters to not jump into the Java source code. Step filters are not activated by default. To activate them: Window > Preferences > Java > Debug > Step Filtering. Consider to select them all. If appropriate you can add the android.* package. See the forum post for more information: http://www.eclipsezone.com/eclipse/forums/t83338.rhtml

### Linux distribution on the sdcard

You can install Debian like in this thread. Excellent guide to installing Arch in chroot (in parallel with Android) can be found on archlinuxarm.org forum.

## Troubleshooting

### Android Studio: Android Virtual Devices show 'failed to load'.

Make sure you've exported the variable `ANDROID_HOME` as explained in #Android Studio.

### Android Studio: 'failed to create the SD card'

If you try to run an AVD (Android Virtual Device) under x86_64 Arch and get the error above, install the lib32-gcc-libs package from the Multilib repository.

### ValueError: unsupported pickle protocol

One fix is to issue:

    $ rm ~/.repopickle_.gitconfig

If that does not work, then try this:

    $ find /path/to/android-root -name .repopickle_config -exec rm {} +

### libGL error: failed to load driver: swrast OR AVD doesn't load and no error message displayed

Sometimes, beginning to load an AVD will cause an error message similar to this to be displayed, or the loading process will appear to finish but no AVD will load and no error message will be displayed.

The AVD loads an incorrect version of libstdc++, you can remove the folder libstdc++ from `~/Android/Sdk/emulator/lib64/` (for 64-bit) or `~/Android/Sdk/emulator/lib/` (for 32-bit) , e.g.:

    $ rm -r ~/Android/Sdk/emulator/lib64/libstdc++

Alternatively you can set and export ANDROID_EMULATOR_USE_SYSTEM_LIBS in ~/.profile as:

    export ANDROID_EMULATOR_USE_SYSTEM_LIBS=1

Reference: Android Studio user guide, https://developer.android.com/studio/command-line/variables.html#studio_jdk

Fix for the .desktop file might be achieved by using env command, prefixing the Exec line Desktop entries#Modify environment variables

    env ANDROID_EMULATOR_USE_SYSTEM_LIBS=1

### sh: glxinfo: command not found

Here's the full error:

    Cannot launch AVD in emulator.
    Output:
    sh: glxinfo: command not found
    sh: glxinfo: command not found
    libGL error: unable to load driver: swrast_dri.so
    libGL error: failed to load driver: swrast
    X Error of failed request:  BadValue (integer parameter out of range for operation)
      Major opcode of failed request:  154 (GLX)
      Minor opcode of failed request:  24 (X_GLXCreateNewContext)
      Value in failed request:  0x0
      Serial number of failed request:  32
      Current serial number in output stream:  33
    QObject::~QObject: Timers cannot be stopped from another thread

You can try to install glxinfo (Its mesa-demos) but if your computer has enough power you could simply use software to render graphics. To do so, go to Tools > Android > AVD Manager, edit the AVD (click the pencil icon), then select Software - GLES 2.0 for Emulated Performance > Graphics.

### Android Emulator: no keyboard input in xfwm4

In xfwm4, the vertical toolbar buttons window that's on the right of the emulator takes focus from the emulator and consumes keyboard events.

The bug is opened here https://issuetracker.google.com/issues/37094173

You can use the workaround described in this StackOverflow answer:

1. Go to xfwm4 settings
2. Find Focus tab
3. Change Focus Model to "Focus follow mouse"
4. Disable "Automatically raise windows when they receive focus" option bellow.

Categories:

- Development
- Mobile devices

Hidden category:

- Pages or sections flagged with Template:Expansion