You are here: eggPlant Functional > Using eggPlant Functional > Connecting to SUTs > Android Connection Methods > Getting Started with Android Gateway

Getting Started with Android Gateway

Android Gateway is a tool for use with eggPlant Functional to assist in making connections to Android devices for test automation. You can connect to Android devices from a local machine where the device is connected via USB, or remotely to a different computer that has a connected Android device.

You use the Viewer window and Connection List in eggPlant Functional to view and manage your connections, letting you create tests against Android devices in the same manner that you would with any other system under test (SUT).

Below is a high-level overview of possible environment architectures for using Android Gateway:

High-level overview of environment architectures for using Android Gateway.

System Requirements for Android Gateway

Android Gateway is a free utility. You can download it from the TestPlant downloads page.

You can install and run Android Gateway on the following supported operating systems:

Windows: Windows 7 and later; Windows Server 2008 and later

Mac: Mac OS X 10.9.5 and later

Android Gateway can be used to connect to Android devices running Android OS 4.1.1 and later.

Note: When running Android Gateway on Windows, you might need to install a USB driver to allow Android Gateway to detect some devices. Please see OEM USB Drivers on the Google Developers website for more information.

Step by Step: Install Android Gateway

To install the Android Gateway, please follow the steps below:

  1. Navigate to the Android section of the eggPlant Mobile downloads page on the TestPlant website, and download the Android Gateway application for the appropriate platform (Windows/Mac).
  2. To install the Android Gateway application, double-click the install package.
    • On Mac OS X, drag the Android Gateway application into the Applications folder on the Mac.
    • On Windows, follow the on-screen instructions in the Setup wizard to finish installation.
  3. Launch the Android Gateway application.

From this point, you should be ready to make connections to your Android devices. You can learn about that process in Using Android Gateway.

The Android Gateway UI

Android Gateway UI

The Android Gateway UI consists of three sections, each with different functions. The sections are as follows:

  1. Device Table: This section shows a list of any detected Android devices. The table displays the model, serial number, connection port, and connection status of each device.
  2. Device status: This area shows the connection status for the device currently selected in the table.
  3. Start: This button lets you start the connection service for the selected device. See Using Android Gateway for detailed information about connecting to devices.
  4. Logs: This area displays the event log. The event log messages are color-coded. Messages displayed in red indicate errors. If you are having trouble making connections, these error messages will usually help you troubleshoot the problem. Orange messages indicate warnings, which might or might not be an actual problem. Informational messages are displayed in blue or green text.
  5. Device Settings: The sidebar section is where you set configuration and connection preferences as well as where you can enable special connection scenarios. See Android Gateway Settings for information about settings options.

In addition to the three sections, you'll find useful options on the main menu under Actions and Help.

The Actions menu lets you perform the follow tasks:

  • Reboot Device: Use this option to reboot the attached Android device.
  • Clear Logs: Use this menu option to clear the Logs area on the screen. Note that the saved log file is not changed or deleted.
  • Save Settings: This option saves any outstanding settings changes. Note that settings are saved automatically whenever you start the connection service and also when you quit the Android Gateway application.
  • Reset Settings: This option returns all settings to their defaults for the selected device. Settings for other devices remain unchanged.

The WiFi/USB menu has the following options:

  • Switch to WiFi mode: This option switches the device into wireless debugging mode.
  • Connect via WiFi: This option allows you to enter the IP address of an Android device and then connect to it over WiFi.
  • Switch to USB mode: This option switches the device into USB debugging mode.
  • Connection List: Shows a list of connected devices. You can add or remove devices here.

The Components menu has the following options:

  • Installed Components: Choosing this option opens a window where you can install or uninstall the VNC server components on the selected Android device and verify version information for the currently installed VNC server. If you've attached a device but haven't started the service, the SystemNative2 and EggSensor versions show as Unknown. Click Refresh to have Android Gateway query the device and update the displayed information.
    Installed components window

    The Installed Components window in Android Gateway

    If the required components aren't installed, Android Gateway installs them automatically when you start the connection service. However, you can use the Install/Reinstall button to install the VNC server components manually. Click Uninstall to remove the VNC server from the device.

The Help menu has the following options:

  • Online Help: Select this option to open the online documentation for Android Gateway in your browser.
  • Custom Parameters: Select this option to open a new window that lists the parameters you can enter in the text box at Device Settings > Advanced > Custom Parameters.
  • Credits: This option displays Android Gateway version information and copyright along with development credits.

 

This topic was last updated on February 13, 2017, at 09:52:10 AM.