Creating an Android Virtual Device (AVD) in Android Studio

From Techotopia
Revision as of 19:54, 18 March 2014 by Neil (Talk | contribs) (About Android Virtual Devices)

Jump to: navigation, search



In the course of developing Android apps in Android Studio it will be necessary to compile and run an application multiple times. An Android application may be tested by installing and running it either on a physical device or in an Android Virtual Device (AVD) emulator environment. Before an AVD can be used, it must first be created and configured to match the specification of a particular device model. The goal of this chapter, therefore, is to work through the steps involved in creating such a virtual device using the Nexus 7 tablet as a reference example.


Contents


About Android Virtual Devices

AVDs are essentially emulators that allow Android applications to be tested without the necessity to install the application on a physical Android based device. An AVD may be configured to emulate a variety of hardware features including options such as screen size, memory capacity and the presence or otherwise of features such as a camera, GPS navigation support or an accelerometer. As part of the standard Android Studio installation, a number of emulator templates are installed allowing AVDs to be configured for a range of different devices. Additional templates may be loaded or custom configurations created to match any physical Android device by specifying properties such as processor type, memory capacity and the size and pixel density of the screen. Check the online developer documentation for your device to find out if emulator definitions are available for download and installation into the AVD environment.

When launched, an AVD will appear as a window containing an emulated Android device environment. Figure 3-1, for example, shows an AVD session configured to emulate the Google Nexus 7 device. New AVDs are created and managed using the Android Virtual Device Manager, which may be used either in command-line mode or with a more user-friendly graphical user interface.


An AVD instance running

Figure 3-1

Creating a New AVD

In order to test the behavior of an application, it will be necessary to create an AVD for a specific Android device configuration.

To create a new AVD, the first step is to launch the AVD Manager. This can be achieved from within the Android Studio environment by selecting the Tools -> Android -> AVD Manager menu option from within the main window. Alternatively, the tool may be launched from a terminal or command-line prompt using the following command:

android avd

Once launched, the tool will appear as outlined in Figure 3-2. Assuming a new Android SDK installation, no AVDs will currently be listed:


The Android Studio Virtual Device Manager window

Figure 3-2


Begin the AVD creation process by clicking on the New… button in order to invoke the Create a New Android Virtual Device (AVD) dialog. Within the dialog, perform the following steps to create a first generation Nexus 7 compatible emulator:

1. Enter a descriptive name (for example Nexus7) into the name field. Note that spaces and other special characters are not permitted in the name.
2. Set the Device menu to Nexus 7 (7.27” 800 x 1280: tvhdpi).
3. Set the Target menu to Android 4.4 – API Level 19.
4. Set the CPU/ABI menu to ARM (armeabi-v7a).
5. Leave the default RAM value in Memory Options and the Internal Storage value unchanged from the default settings. Keep in mind however, that it may be necessary to reduce the RAM value below 768M on Windows systems with less available memory.
6. If the host computer contains a web cam the Front Camera: emulation may be configured to use this camera. Alternatively, an emulated camera may be selected. If camera functionality is not required by the application, simply leave this set to None.

Whether or not you enable the Hardware Keyboard and Display skin with hardware controls options is a matter of personal preference. When the hardware keyboard option is selected, it will be possible to use the physical keyboard on the system on which the emulator is running. As such, the Android software keyboard will not appear within the emulator when text input is required by a running application.

The “skin with hardware controls” option controls whether or not buttons appear as part of the emulator to simulate the hardware buttons present on the sides of the physical Android device (such as the volume and power buttons).

Note that it may also be possible to speed the performance of the emulator by enabling the Use Host GPU option. In the event that the emulator crashes during startup when this option is selected, edit the virtual device properties and disable this option. Figure 3 3 illustrates the dialog with the appropriate settings implemented for a Nexus 7 emulator. Once the configuration settings are complete, click on the OK button.


[[Image:|Creating a new AVD in Android Studio]]

Figure 3-3


With the AVD created, the AVD Manager may now be closed. If future modifications to the AVD are necessary, simply re-open the AVD Manager, select the AVD from the list and click on the Edit… button.


Starting the Emulator

To perform a test run of the newly created AVD emulator, simply select the emulator from the AVD Manager and click on the Start… button followed by Launch in the resulting Launch Options dialog. The emulator will appear in a new window and, after a short period of time, the “android” logo will appear in the center of the screen. The first time the emulator is run, it can take up to 10 minutes for the emulator to fully load and start. On subsequent invocations, this will typically reduce to a few minutes. In the event that the startup time on your system is considerable, do not hesitate to leave the emulator running. The system will detect that it is already running and attach to it when applications are launched, thereby saving considerable amounts of startup time.

Another option when using the emulator is to enable the Snapshot option in the AVD settings screen. This option, which can only be used when the Use Host GPU option is disabled, enables the state of an AVD instance to be saved and reloaded next time it is launched. This can result in an emulator startup time of just a few seconds.

When using snapshots, make sure that the Launch from snapshot and Save to snapshot options are both enabled in the Launch Options dialog. The first time an emulator instance is launched with snapshots enabled, the AVD will start in the normal manner. On closing the emulator window, a slight delay will occur while the state of the AVD is saved. Next time the emulator is a launched it will load more quickly and revert to the previously saved state.

To revert the AVD to its original, pre-snapshot state, simply a launch it with the Launch from snapshot option disabled.

To save time in the next section of this chapter, leave the emulator running before proceeding.

Running the Application in the AVD

With an AVD emulator configured, the example AndroidSample application created in the earlier chapter now can be compiled and run. With the AndroidSample project loaded into Android Studio, simply click on the run button represented by a green triangle located in the Android Studio toolbar as shown in Figure 3 4 below, select the Run -> Run… menu option or use the Shift+F10 keyboard shortcut:


The Android Studio toolbar Run button

Figure 3-4


By default, Android Studio will respond to the run request by displaying the Choose Device dialog. This provides the option to execute the application on an AVD instance that is already running, or to launch a new AVD session specifically for this application. Figure 3 5 lists the previously created Nexus7 AVD as a running device as a result of the steps performed in the preceding section. With this device selected in the dialog, click on OK to install and run the application on the emulator.


The Android Studio Device Chooser window

Figure 3-5


Once the application is installed and running, the user interface for the AndroidSampleActivity class will appear within the emulator:


A sample Android App running in an AVD

Figure 3-6


In the event that the activity does not automatically launch, check to see if the launch icon has appeared among the apps on the emulator. If it has, simply click on it to launch the application. Once the run process begins, the Run and Android tool windows will become available. The Run tool window will display diagnostic information as the application package is installed and launched. Figure 3 7 shows the Run tool window output from a successful application launch:


The Android Studio Run tool window

Figure 3-7


If problems are encountered during the launch process, the Run tool will provide information that will hopefully help to isolate the cause of the problem.

Assuming that the application loads into the emulator and runs as expected, we have safely verified that the Android development environment is correctly installed and configured.

Run/Debug Configurations

A particular project can be configured such that a specific device or emulator is used automatically each time it is run from within Android Studio. This avoids the necessity to make a selection from the device chooser each time the application is executed. To review and modify the Run/Debug configuration, click on the button to the left of the run button in the Android Studio toolbar and select the Edit Configurations… option from the resulting menu:


Editing the run configruation of a project in Android Studio

Figure 3-8


In the Run/Debug Configurations dialog, the application may be configured to always use a preferred emulator by enabling the Emulator option listed in the Target Device section and selecting the emulator from the drop down menu. Figure 3-9, for example, shows the AndroidSample application configured to run by default on the previously created Nexus7 emulator:


The Android Studio Run/Debug configuration window

Figure 3-9


Stopping a Running Application

When building and running an application for testing purposes, each time a new revision of the application is compiled and run, the previous instance of the application running on the device or emulator will be terminated automatically and replaced with the new version. It is also possible, however, to manually stop a running application from within Android Studio.

To stop a running application, begin by displaying the Android tool window either using the window bar button, or via the quick access menu (invoked by moving the mouse pointer over the button in the left hand corner of the status bar as shown in Figure 3-10).


Launching the Android Studio Android tool window using the quick access menu

Figure 3-10


Once the Android tool window appears, make sure that the Devices | ADB Logs tab is selected, and that the Emulator Nexus7 entry is selected in the Devices panel. From the list of processes located beneath the device name, find and select the androidsample process as outlined in Figure 3-11:


A list of currently running process in the Android Studio Android tool window

Figure 3-11


With the process selected, stop it by clicking on the red Terminate Application button in the vertical toolbar to the left of the process list:


Terminating a running app in the Android Studio Android tool window

Figure 3-12


An alternative to using the Android tool window is to open the Android Debug Monitor. This can be launched via the Tools -> Android -> Monitor (DDMS included) menu option. Once launched, the process may be selected from the list (Figure 3-13) and terminated by clicking on the red Stop button located in the toolbar above the list.


The Android Studio Debug Monitor window

Figure 3-13

AVD Command-line Creation

As previously discussed, in addition to the graphical user interface it is also possible to create a new AVD directly from the command-line. This is achieved using the android tool in conjunction with some command-line options. Once initiated, the tool will prompt for additional information before creating the new AVD.

Assuming that the system has been configured such that the Android SDK tools directory is included in the PATH environment variable, a list of available targets for the new AVD may be obtained by issuing the following command in a terminal or command window:

android list targets

The resulting output from the above command will contain a list of Android SDK versions that are available on the system. For example:

Available Android targets:
----------
id: 1 or "android-19"
     Name: Android 4.4
     Type: Platform
     API level: 19
     Revision: 1
     Skins: HVGA, QVGA, WQVGA400, WQVGA432, WSVGA, WVGA800 (default), WVGA854, WXGA720, WXGA800, WXGA800-7in
     ABIs : armeabi-v7a

The syntax for AVD creation is as follows:

android create avd -n <name> -t <targetID> [-<option> <value>]

For example, to create a new AVD named Nexus7 using the target id for the Android 4.4 API level 19 device (in this case id 1), the following command may be used:

android create avd -n Nexus7 -t 1

The android tool will create the new AVD to the specifications required for a basic Android 4.4 device, also providing the option to create a custom configuration to match the specification of a specific device if required. Once a new AVD has been created from the command line, it may not show up in the Android Device Manager tool until the Refresh button is clicked.

In addition to the creation of new AVDs, a number of other tasks may be performed from the command line. For example, a list of currently available AVDs may be obtained using the list avd command line arguments:

android list avd

C:\Users\nas>android list avd
Available Android Virtual Devices:
---------
    Name: KindleFireHD7
    Path: C:\Users\nas\.android\avd\KindleFireHD7.avd
  Target: Kindle Fire HD 7" (Amazon)
          Based on Android 4.0.3 (API level 15)
     ABI: armeabi-v7a
    Skin: 800x1280
---------
    Name: Nexus7
    Path: C:\Users\nas\.android\avd\Nexus7.avd
  Target: Android 4.4 (API level 19)
     ABI: armeabi-v7a
    Skin: 800x1280
---------
    Name: Nexus7Google
    Path: C:\Users\nas\.android\avd\Nexus7Google.avd
  Target: Google APIs (Google Inc.)
          Based on Android 4.2.2 (API level 17)
     ABI: armeabi-v7a
    Skin: 800x1280

Similarly, to delete an existing AVD, simply use the delete option as follows:

android delete avd –name <avd name>

Android Virtual Device Configuration Files

By default, the files associated with an AVD are stored in the .android/avd sub-directory of the user’s home directory, the structure of which is as follows (where <avd name> is replaced by the name assigned to the AVD):

<avd name>.avd/config.ini
<avd name>.avd/userdata.img
<avd name>.ini

The config.ini file contains the device configuration settings such as display dimensions and memory specified during the AVD creation process. These settings may be changed directly within the configuration file and will be adopted by the AVD when it is next invoked.

The <avd name>.ini file contains a reference to the target Android SDK and the path to the AVD files. Note that a change to the image.sysdir value in the config.ini file will also need to be reflected in the target value of this file.

Moving and Renaming an Android Virtual Device

The current name or the location of the AVD files may be altered from the command line using the android tool’s move avd argument. For example, to rename an AVD named Nexus7 to Nexus7B, the following command may be executed:

android move avd -n Nexus7 -r Nexus7B

To physically relocate the files associated with the AVD, the following command syntax should be used:

android move avd -n <avd name> -p <path to new location>

For example, to move an AVD from its current file system location to /tmp/Nexus7Test:

android move avd -n Nexus7 -p /tmp/Nexus7Test

Note that the destination directory must not already exist prior to executing the command to move an AVD.

Summary

A typical application development process follows a cycle of coding, compiling and running in a test environment. Android applications may be tested on either a physical Android device or using an Android Virtual Device (AVD) emulator. AVDs are created and managed using the Android AVD Manager tool which may be used either as a command line tool or using a graphical user interface. When creating an AVD to simulate a specific Android device model it is important that the virtual device be configured with a hardware specification that matches that of the physical device.