DeviceManager

public class DeviceManager
extends Object implements IDeviceManager

java.lang.Object
   ↳ com.android.tradefed.device.DeviceManager


Summary

Nested classes

class DeviceManager.FastbootDevice

 

Constants

String UNKNOWN_DISPLAY_STRING

Display string for unknown properties

Fields

static final IDeviceSelection ANY_DEVICE_OPTIONS

a DeviceSelectionOptions that matches any device.

protected DeviceMonitorMultiplexer mDvcMon

protected boolean mFastbootEnabled

Public constructors

DeviceManager()

The DeviceManager should be retrieved from the GlobalConfiguration

Public methods

void addAvailableDevice(IDevice stubDevice)
void addDeviceMonitor(IDeviceMonitor mon)

Adds a IDeviceMonitor

void addFastbootListener(IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is interested in fastboot state changes.

ITestDevice allocateDevice(IDeviceSelection options)

Request a device for testing that meets certain criteria.

ITestDevice allocateDevice()

Request a physical device for testing

ITestDevice connectToTcpDevice(String ipAndPort)

Connect to a device with adb-over-tcp

This method allocates a new device, which should eventually be freed via disconnectFromTcpDevice(ITestDevice)

The returned ITestDevice will be online, but may not be responsive.

boolean disconnectFromTcpDevice(ITestDevice tcpDevice)

Disconnect from an adb-over-tcp connected device.

void displayDevicesInfo(PrintWriter stream)

Output a user-friendly description containing list of known devices, their state, and values for commonly used IDeviceSelection options.

String executeGlobalAdbCommand(String... cmdArgs)

Execute a adb command not targeted to a particular device eg.

ITestDevice forceAllocateDevice(String serial)

Rudely allocate a device, even if its not currently available.

void freeDevice(ITestDevice device, FreeDeviceState deviceState)

Return a device to the pool

Attempts to return a device that hasn't been previously allocated will be ignored.

String getFastbootPath()

Returns the path to the fastboot binary path to use.

void init(IDeviceSelection globalDeviceFilter, List<IDeviceMonitor> globalDeviceMonitors, IManagedTestDeviceFactory deviceFactory)

Initialize the device manager.

void init(IDeviceSelection globalDeviceFilter, List<IDeviceMonitor> globalDeviceMonitors)

Initialize the device manager.

void init()

Initialize the device manager.

boolean isEmulator(String serial)

Determine if given serial represents a emulator

boolean isNullDevice(String serial)

Determine if given serial represents a null device

void killEmulator(ITestDevice device)

Shut down the given emulator.

void launchEmulator(ITestDevice device, long bootTimeout, IRunUtil runUtil, List<String> emulatorArgs)

Helper method to launch emulator.

List<DeviceDescriptor> listAllDevices()

Returns a map of all known devices and their state

ITestDevice reconnectDeviceToTcp(ITestDevice usbDevice)

A helper method that switches the given usb device to adb-over-tcp mode, and then connects to it via connectToTcpDevice(String).

void removeDeviceMonitor(IDeviceMonitor mon)

Removes a previously added IDeviceMonitor.

void removeFastbootListener(IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is no longer interested in fastboot state changes.

void restartAdbBridge()

Restart (if stopAdbBridge() was called) adb bridge and services depend on adb connections.

void stopAdbBridge()

Stop adb bridge and services depend on adb connections.

void terminate()

Stops device monitoring services, and terminates the ddm library.

void terminateDeviceMonitor()

Stop the Device Monitors.

void terminateDeviceRecovery()

Stops the device recovery thread.

void terminateHard()

Like terminate(), but attempts to forcefully shut down adb as well.

boolean waitForFirstDeviceAdded(long timeout)

Wait until a first physical device is connected.

Constants

UNKNOWN_DISPLAY_STRING

String UNKNOWN_DISPLAY_STRING

Display string for unknown properties

Constant Value: "unknown"

Fields

ANY_DEVICE_OPTIONS

IDeviceSelection ANY_DEVICE_OPTIONS

a DeviceSelectionOptions that matches any device. Visible for testing.

mDvcMon

DeviceMonitorMultiplexer mDvcMon

mFastbootEnabled

boolean mFastbootEnabled

Public constructors

DeviceManager

DeviceManager ()

The DeviceManager should be retrieved from the GlobalConfiguration

Public methods

addAvailableDevice

void addAvailableDevice (IDevice stubDevice)

Parameters
stubDevice IDevice

addDeviceMonitor

void addDeviceMonitor (IDeviceMonitor mon)

Adds a IDeviceMonitor

Parameters
mon IDeviceMonitor

addFastbootListener

void addFastbootListener (IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is interested in fastboot state changes.

Currently a IDeviceManager will only monitor devices in fastboot if there are one or more active listeners.

TODO: this is a bit of a hack - find a better solution

allocateDevice

ITestDevice allocateDevice (IDeviceSelection options)

Request a device for testing that meets certain criteria.

Parameters
options IDeviceSelection: the IDeviceSelection the device should meet.

Returns
ITestDevice a ITestDevice for testing, or null if one is not available

allocateDevice

ITestDevice allocateDevice ()

Request a physical device for testing

Returns
ITestDevice a ITestDevice for testing, or null if one is not available

connectToTcpDevice

ITestDevice connectToTcpDevice (String ipAndPort)

Connect to a device with adb-over-tcp

This method allocates a new device, which should eventually be freed via disconnectFromTcpDevice(ITestDevice)

The returned ITestDevice will be online, but may not be responsive.

Note that performing action such as a reboot on a tcp connected device, will sever the tcp connection to the device, and result in a DeviceNotAvailableException

Parameters
ipAndPort String: the original ip address and port of the device to connect to

Returns
ITestDevice the ITestDevice or null if a tcp connection could not be formed

disconnectFromTcpDevice

boolean disconnectFromTcpDevice (ITestDevice tcpDevice)

Disconnect from an adb-over-tcp connected device.

Switches the device back to usb mode, and frees it.

Parameters
tcpDevice ITestDevice: the device currently in tcp mode, previously allocated via connectToTcpDevice(String)

Returns
boolean true if switch to usb mode was successful

displayDevicesInfo

void displayDevicesInfo (PrintWriter stream)

Output a user-friendly description containing list of known devices, their state, and values for commonly used IDeviceSelection options.

Parameters
stream PrintWriter: the PrintWriter to output the description to

executeGlobalAdbCommand

String executeGlobalAdbCommand (String... cmdArgs)

Execute a adb command not targeted to a particular device eg. 'adb connect'

Returns
String std output if the command succeedm null otherwise.

forceAllocateDevice

ITestDevice forceAllocateDevice (String serial)

Rudely allocate a device, even if its not currently available.

Will have no effect if device is already allocated.

Parameters
serial String: the device serial to allocate

Returns
ITestDevice the ITestDevice, or null if it could not be allocated

freeDevice

void freeDevice (ITestDevice device, 
                FreeDeviceState deviceState)

Return a device to the pool

Attempts to return a device that hasn't been previously allocated will be ignored.

Parameters
device ITestDevice: the ITestDevice to free

deviceState FreeDeviceState: the FreeDeviceState. Used to control if device is returned to available device pool.

getFastbootPath

String getFastbootPath ()

Returns the path to the fastboot binary path to use.

Returns
String

init

void init (IDeviceSelection globalDeviceFilter, 
                List<IDeviceMonitor> globalDeviceMonitors, 
                IManagedTestDeviceFactory deviceFactory)

Initialize the device manager. This must be called once and only once before any other methods are called.

Parameters
globalDeviceFilter IDeviceSelection

globalDeviceMonitors List

deviceFactory IManagedTestDeviceFactory

init

void init (IDeviceSelection globalDeviceFilter, 
                List<IDeviceMonitor> globalDeviceMonitors)

Initialize the device manager. This must be called once and only once before any other methods are called.

Parameters
globalDeviceFilter IDeviceSelection: the device filter

globalDeviceMonitors List

init

void init ()

Initialize the device manager. This must be called once and only once before any other methods are called.

isEmulator

boolean isEmulator (String serial)

Determine if given serial represents a emulator

Parameters
serial String

Returns
boolean

isNullDevice

boolean isNullDevice (String serial)

Determine if given serial represents a null device

Parameters
serial String

Returns
boolean

killEmulator

void killEmulator (ITestDevice device)

Shut down the given emulator.

Blocks until emulator disappears from adb. Will have no effect if emulator is already not available.

Parameters
device ITestDevice: the ITestDevice representing emulator to shut down

Throws
DeviceNotAvailableException

launchEmulator

void launchEmulator (ITestDevice device, 
                long bootTimeout, 
                IRunUtil runUtil, 
                List<String> emulatorArgs)

Helper method to launch emulator.

Will launch the emulator as specified by the caller

Parameters
device ITestDevice: the placeholder ITestDevice representing allocated emulator device

bootTimeout long: the time in ms to wait for the emulator to boot

emulatorArgs List: command line arguments to launch the emulator

Throws
DeviceNotAvailableException

listAllDevices

List<DeviceDescriptor> listAllDevices ()

Returns a map of all known devices and their state

Returns
List<DeviceDescriptor> a list of device serials and their DeviceAllocationState

reconnectDeviceToTcp

ITestDevice reconnectDeviceToTcp (ITestDevice usbDevice)

A helper method that switches the given usb device to adb-over-tcp mode, and then connects to it via connectToTcpDevice(String).

Parameters
usbDevice ITestDevice: the device currently in usb mode

Returns
ITestDevice the newly allocated ITestDevice in tcp mode or null if a tcp connection could not be formed

Throws
DeviceNotAvailableException

removeDeviceMonitor

void removeDeviceMonitor (IDeviceMonitor mon)

Removes a previously added IDeviceMonitor. Has no effect if mon has not been added.

Parameters
mon IDeviceMonitor

removeFastbootListener

void removeFastbootListener (IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is no longer interested in fastboot state changes.

restartAdbBridge

void restartAdbBridge ()

Restart (if stopAdbBridge() was called) adb bridge and services depend on adb connections.

stopAdbBridge

void stopAdbBridge ()

Stop adb bridge and services depend on adb connections.

terminate

void terminate ()

Stops device monitoring services, and terminates the ddm library.

This must be called upon application termination.

terminateDeviceMonitor

void terminateDeviceMonitor ()

Stop the Device Monitors.

terminateDeviceRecovery

void terminateDeviceRecovery ()

Stops the device recovery thread.

terminateHard

void terminateHard ()

Like terminate(), but attempts to forcefully shut down adb as well.

waitForFirstDeviceAdded

boolean waitForFirstDeviceAdded (long timeout)

Wait until a first physical device is connected. If a device was connected before, it returns directly True. If no device was added, it returns false after timeout.

Parameters
timeout long: time to wait in millisecond before returning false.

Returns
boolean