MadBee.

A managed port of the Android Debug Bridge.

Project Source Download Issues Discussions

About

This is a Managed port of the Android Debug Bridge to allow communication from .NET applications to Android devices. This wraps the same methods that the ddms uses to directly communicate with ADB. This gives more flexibility to the developer than launching an adb process and executing one of its built in commands.

Nuget

PM> Install-Package Managed.Adb

License

Documentation

Managed.Adb

AdbHelper

The ADB Helper class

References

SERVICES.TXT
adb_client.c
adb.c

AdbHelper Instance

Gets an instance of the AdbHelper.

Void Backup IPEndPoint address

Backups the specified address.

Parameters

Name Description
address The address.

Exceptions

Type Description
System.IO.IOException failed asking to backup device

References

backup_service.c

Byte[] CreateAdbForwardRequest String address Int32 port

Creates the adb forward request.

Parameters

Name Description
address The address.
port The port.

Boolean CreateForward IPEndPoint adbSockAddr Device device Int32 localPort Int32 remotePort

Creates the forward.

Parameters

Name Description
adbSockAddr The adb sock addr.
device The device.
localPort The local port.
remotePort The remote port.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException failed to submit the forward command.
Managed.Adb.Exceptions.AdbException Device rejected command: + resp.Message

Socket CreatePassThroughConnection IPEndPoint endpoint Device device Int32 pid

Creates and connects a new pass-through socket, from the host to a port on the device.

Parameters

Name Description
endpoint The endpoint.
device the device to connect to. Can be null in which case the connection will be to the first available device.
pid the process pid to connect to.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException failed submitting request to ADB
Managed.Adb.Exceptions.AdbException connection request rejected: + resp.Message

Void ExecuteRemoteCommand IPEndPoint endPoint String command Device device IShellOutputReceiver rcvr

Executes a shell command on the remote device

Parameters

Name Description
endPoint The socket end point
command The command to execute
device The device to execute on
rcvr The shell output receiver

Exceptions

Type Description
System.IO.FileNotFoundException Throws if the result is 'command': not found
System.IO.IOException Throws if there is a problem reading / writing to the socket
System.OperationCanceledException Throws if the execution was canceled
System.IO.EndOfStreamException Throws if the Socket.Receice ever returns -1

Void ExecuteRemoteCommand IPEndPoint endPoint String command Device device IShellOutputReceiver rcvr Int32 maxTimeToOutputResponse

Executes the remote command.

Parameters

Name Description
endPoint The end point.
command The command.
device The device.
rcvr The RCVR.
maxTimeToOutputResponse The max time to output response.

Exceptions

Type Description
System.OperationCanceledException System.OperationCanceledException
System.IO.FileNotFoundException System.IO.FileNotFoundException
Managed.Adb.Exceptions.UnknownOptionException Managed.Adb.Exceptions.UnknownOptionException
Managed.Adb.Exceptions.CommandAbortingException Managed.Adb.Exceptions.CommandAbortingException
Managed.Adb.Exceptions.PermissionDeniedException Managed.Adb.Exceptions.PermissionDeniedException
Managed.Adb.Exceptions.ShellCommandUnresponsiveException Managed.Adb.Exceptions.ShellCommandUnresponsiveException
Managed.Adb.Exceptions.AdbException failed submitting shell command
Managed.Adb.Exceptions.UnknownOptionException Managed.Adb.Exceptions.UnknownOptionException
Managed.Adb.Exceptions.CommandAbortingException Managed.Adb.Exceptions.CommandAbortingException
Managed.Adb.Exceptions.PermissionDeniedException Managed.Adb.Exceptions.PermissionDeniedException

Void ExecuteRemoteRootCommand IPEndPoint endPoint String command Device device IShellOutputReceiver rcvr

Executes a shell command on the remote device

Should check if you CanSU before calling this.

Parameters

Name Description
endPoint The end point.
command The command.
device The device.
rcvr The RCVR.

Void ExecuteRemoteRootCommand IPEndPoint endPoint String command Device device IShellOutputReceiver rcvr Int32 maxTimeToOutputResponse

Executes a shell command on the remote device

Parameters

Name Description
endPoint The end point.
command The command.
device The device.
rcvr The RCVR.
maxTimeToOutputResponse The max time to output response.

Byte[] FormAdbRequest String req

Forms the adb request.

Parameters

Name Description
req The req.

Int32 GetAdbVersion IPEndPoint address

Gets the adb version of the server.

Parameters

Name Description
address The address.

Exceptions

Type Description
System.IO.IOException failed asking for adb version

List<Device> GetDevices IPEndPoint address

Gets the devices that are available for communication.

Parameters

Name Description
address The address.

RawImage GetFrameBuffer IPEndPoint adbSockAddr IDevice device

Gets the frame buffer from the specified end point.

Parameters

Name Description
adbSockAddr The adb sock addr.
device The device.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException failed asking for frame buffer
Managed.Adb.Exceptions.AdbException failed nudging

Boolean IsOkay Byte[] reply

Determines whether the specified reply is okay.

Parameters

Name Description
reply The reply.

Int32 KillAdb IPEndPoint address

Kills the running adb server.

Parameters

Name Description
address The address.

Exceptions

Type Description
System.IO.IOException failed asking to kill adb

Void ListForward IPEndPoint address Device device

Lists the forward.

Parameters

Name Description
address The address.
device The device.

Exceptions

Type Description
System.NotImplementedException System.NotImplementedException

Socket Open IPAddress address IDevice device Int32 port

Opens the specified address on the device on the specified port.

Parameters

Name Description
address The address.
device The device.
port The port.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException failed submitting request to ADB
Managed.Adb.Exceptions.AdbException connection request rejected

Boolean Read Socket socket Byte[] data

Reads the data from specified socket.

Parameters

Name Description
socket The socket.
data The data.

Void Read Socket socket Byte[] data Int32 length Int32 timeout

Reads the data from specified socket.

Parameters

Name Description
socket The socket.
data The data.
length The length.
timeout The timeout.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException EOF
Managed.Adb.Exceptions.AdbException No Data to read: exception.Message

AdbResponse ReadAdbResponse Socket socket Boolean readDiagString

Reads the adb response.

Parameters

Name Description
socket The socket.
readDiagString [read diag string].

Void Reboot IPEndPoint adbSocketAddress Device device

Reboots the specified adb socket address.

Parameters

Name Description
adbSocketAddress The adb socket address.
device The device.

Void Reboot String into IPEndPoint adbSockAddr Device device

Reboots the specified device in to the specified mode.

Parameters

Name Description
into The into.
adbSockAddr The adb sock addr.
device The device.

Boolean RemoveAllForward IPEndPoint address Device device

Removes all forwards.

Parameters

Name Description
address The address.
device The device.

Boolean RemoveForward IPEndPoint address Device device Int32 localPort

Removes the forward.

Parameters

Name Description
address The adb socket address.
device The device.
localPort The local port.

String ReplyToString Byte[] reply

Replies to string.

Parameters

Name Description
reply The reply.

Void Restore

Restores this instance.

Exceptions

Type Description
System.NotImplementedException System.NotImplementedException

References

backup_service.c

Void RunEventLogService IPEndPoint address Device device LogReceiver rcvr

Runs the Event log service on the Device, and provides its output to the LogReceiver.

Parameters

Name Description
address The address.
device The device.
rcvr The RCVR.

Void RunLogService IPEndPoint address Device device String logName LogReceiver rcvr

Runs the Event log service on the Device, and provides its output to the LogReceiver.

Parameters

Name Description
address The address.
device The device.
logName Name of the log.
rcvr The RCVR.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException failed asking for log
Managed.Adb.Exceptions.AdbCommandRejectedException Managed.Adb.Exceptions.AdbCommandRejectedException

Void SetDevice Socket adbChan IDevice device

Sets the device.

Parameters

Name Description
adbChan The adb chan.
device The device.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException failed submitting device ( + device + ) request to ADB
Managed.Adb.Exceptions.AdbException device ( + device + ) request rejected: + resp.Message
Managed.Adb.Exceptions.DeviceNotFoundException Managed.Adb.Exceptions.DeviceNotFoundException

Boolean Write Socket socket Byte[] data

Writes the specified data to the specified socket.

Parameters

Name Description
socket The socket.
data The data.

Void Write Socket socket Byte[] data Int32 length Int32 timeout

Writes the specified data to the specified socket.

Parameters

Name Description
socket The socket.
data The data.
length The length.
timeout The timeout.

Exceptions

Type Description
Managed.Adb.Exceptions.AdbException channel EOF
Managed.Adb.Exceptions.AdbException timeout

AdbResponse

An Adb Communication Response

Boolean IOSuccess

Gets or sets a value indicating whether the IO communication was a success.

String Message

Gets or sets the message.

Boolean Okay

Gets or sets a value indicating whether this is okay.

Boolean Timeout

Gets or sets a value indicating whether this is timeout.

AllocationInfo

Holds Allocation information.

String AllocatedClass

Gets the allocated class.

Int32 AllocationSize

Gets the size of the allocation.

StackTrace StackTrace

Gets the stack trace.

Int16 ThreadId

Gets the thread id.

Int32 CompareTo AllocationInfo other

Compares the current object with another object of the same type.

Parameters

Name Description
other An object to compare with this object.

AndroidDebugBridge

The android debug bridge

String AdbOsLocation

Gets or Sets the adb location on the OS.

AndroidDebugBridge Bridge

Gets an instance of .

Boolean ClientSupport

Gets a value indicating whether there is client support.

Int32 ConnectionAttemptCount

Returns the number of times the AndroidDebugBridge object attempted to connect

DeviceMonitor DeviceMonitor

Gets the device monitor

IList<Device> Devices

Gets the devices.

IPAddress HostAddress

Gets or sets the host address.

AndroidDebugBridge Instance

Gets an instance of .

Boolean IsConnected

Returns whether the AndroidDebugBridge object is still connected to the adb daemon.

Int32 RestartAttemptCount

Returns the number of times the AndroidDebugBridge object attempted to restart the adb daemon.

IClient SelectedClient

Gets or sets the client to accept debugger connection on the custom "Selected debug port".

Not Yet Implemented

IPEndPoint SocketAddress

Gets or sets the socket address.

AndroidDebugBridge CreateBridge

Creates a {@link AndroidDebugBridge} that is not linked to any particular executable. This bridge will expect adb to be running. It will not be able to start/stop/restart

AndroidDebugBridge CreateBridge String osLocation Boolean forceNewBridge

Creates a new debug bridge from the location of the command line tool.

Any existing server will be disconnected, unless the location is the same and is set to false.

Parameters

Name Description
osLocation the location of the command line tool 'adb'
forceNewBridge force creation of a new bridge even if one with the same location already exists.

Void DisconnectBridge

Disconnects the current debug bridge, and destroy the object.

This also stops the current adb host server.

Object GetLock

Gets the lock.

Boolean HasInitialDeviceList

Returns whether the bridge has acquired the initial list from adb after being created.

Calling getDevices() right after createBridge(String, boolean) will generally result in an empty list. This is due to the internal asynchronous communication mechanism with that does not guarantee that the IDevice list has been built before the call to getDevices(). The recommended way to get the list of IDevice objects is to create a IDeviceChangeListener object.

Void Initialize Boolean clientSupport

Initializes the library.

Parameters

Name Description
clientSupport [client support].

Boolean Restart

Restarts adb, but not the services around it.

Boolean Start

Starts the debug bridge.

Boolean Stop

Kills the debug bridge, and the adb host server.

Void Terminate

Terminates the ddm library. This must be called upon application termination.

BatteryInfo

Boolean ACPowered

Gets or sets a value indicating whether AC powered.

Int32 CalculatedLevel

Gets the calculated battery level.

HealthTypes Health

Gets or sets the health.

Int32 Level

Gets or sets the level.

Boolean Present

Gets or sets a value indicating whether a battery is present.

Int32 Scale

Gets or sets the scale.

StatusTypes Status

Gets or sets the status.

Int32 Temperature

Gets or sets the temperature.

String Type

Gets or sets the type.

Boolean UsbPowered

Gets or sets a value indicating whether usb powered.

Int32 Voltage

Gets or sets the voltage.

BusyBox

A class to help with working with BusyBox

Boolean Available

Gets if busybox is available on this device.

List<String> Commands

Gets a collection of the supported commands

Device Device

Gets or sets the device.

Version Version

Gets the version of busybox

Void ExecuteRootShellCommand String command IShellOutputReceiver receiver Object[] commandArgs

Executes a busybox command on the device as root

Parameters

Name Description
command The command.
receiver The receiver.
commandArgs The command args.

Void ExecuteShellCommand String command IShellOutputReceiver receiver Object[] commandArgs

Executes a busybox command on the device

Boolean Install String busybox

Attempts to install on the device

Parameters

Name Description
busybox The path to the busybox binary to install.

Boolean Supports String command

Gets if the specified command name is supported by this version of busybox

Parameters

Name Description
command The command name to check

MultiLineReceiver

Boolean IsCancelled

Gets a value indicating whether this instance is canceled.

Boolean TrimLines

Gets or sets a value indicating whether [trim lines].

Void AddOutput Byte[] data Int32 offset Int32 length

Adds the output.

Parameters

Name Description
data The data.
offset The offset.
length The length.

Void Flush

Flushes the output.

Client

A debug client

ClientChangeState ChangeState

Gets the state of the change.

Socket Channel

Gets or sets the channel.

ClientData ClientData

Gets the client data.

ClientConnectionState ConnectionState

Gets the state of the connection.

Debugger Debugger

Gets the debugger.

Int32 DebuggerListenPort

Gets the debugger listen port.

IDevice Device

Gets the device.

Device DeviceImplementation

Gets the device implementation.

Boolean IsDdmAware

Returns if the client VM is DDM-aware.

Calling here is only allowed after the connection has been established.

Boolean IsDebuggerAttached

Gets a value indicating whether this instance is debugger attached.

Boolean IsHeapUpdateEnabled

Gets or sets a value indicating whether this instance is heap update enabled.

Boolean IsSelectedClient

Gets or sets a value indicating whether this instance is selected client.

Boolean IsThreadUpdateEnabled

Gets or sets a value indicating whether this instance is thread update enabled.

Boolean IsValid

Gets a value indicating whether this instance is valid.

Void AddRequestId Int32 id ChunkHandler handler

Adds the request id.

Parameters

Name Description
id The id.
handler The handler.

Void Close Boolean notify

Closes the specified notify.

Parameters

Name Description
notify [notify].

Boolean DdmSeen

DDMs the seen.

Void DumpHprof

Dumps the hprof.

Void EnableAllocationTracker Boolean enable

Enables the allocation tracker.

Parameters

Name Description
enable [enable].

Void ExecuteGarbageCollector

Executes the garbage collector.

Void ForwardPacketToClient Object packet

Forwards the packet to client.

Parameters

Name Description
packet The packet.

Object GetJdwpPacket

Gets the JDWP packet.

ChunkHandler IsResponseToUs Int32 id

Determines whether [is response to us] [the specified id].

Parameters

Name Description
id The id.

Void Kill

Kills this instance.

Void ListenForDebugger Int32 listenPort

Listens for debugger.

Parameters

Name Description
listenPort The listen port.

Void PacketFailed Object packet

Packets the failed.

Parameters

Name Description
packet The packet.

Void Read

Reads this instance.

Void Register Object selector

Registers the specified selector.

Parameters

Name Description
selector The selector.

Void RemoveRequestId Int32 id

Removes the request id.

Parameters

Name Description
id The id.

Void RequestAllocationDetails

Requests the allocation details.

Void RequestAllocationStatus

Requests the allocation status.

Void RequestMethodProfilingStatus

Requests the method profiling status.

Boolean RequestNativeHeapInformation

Requests the native heap information.

Void RequestThreadStackTrace Int32 threadID

Requests the thread stack trace.

Parameters

Name Description
threadID The thread ID.

Void RequestThreadUpdate

Requests the thread update.

Void SendAndConsume Object packet

Sends the and consume.

Parameters

Name Description
packet The packet.

Void SendAndConsume Object packet ChunkHandler replyHandler

Sends the and consume.

Parameters

Name Description
packet The packet.
replyHandler The reply handler.

Boolean SendHandshake

Sends the handshake.

Void ToggleMethodProfiling

Toggles the method profiling.

Void Update ClientChangeMask changeMask

Updates the specified change mask.

Parameters

Name Description
changeMask The change mask.

ClientData

DebuggerStatus DebuggerConnectionStatus

Gets or sets the debugger connection status.

DebuggerStatus DebuggerInterest

Gets or sets the debugger interest.

String Description

Gets or sets the description.

Boolean IsDdmAware

Gets or sets a value indicating whether this instance is DDM aware.

Int32 Pid

Gets the pid.

String VmIdentifier

Gets or sets the vm identifier.

RawImage

Data representing an image taken from a device frame buffer.

ColorData Alpha

Gets or sets the alpha.

ColorData Blue

Gets or sets the blue.

Int32 Bpp

Gets or sets the BPP.

Byte[] Data

Gets or sets the data.

ColorData Green

Gets or sets the green.

Int32 Height

Gets or sets the height.

ColorData Red

Gets or sets the red.

Int32 Size

Gets or sets the size.

Int32 Version

Gets or sets the version.

Int32 Width

Gets or sets the width.

Int32 GetHeaderSize Int32 version

RawImage GetRotated

Boolean ReadHeader Int32 version BinaryReader buf

Image ToImage

Converts this raw image to an Image

Image ToImage PixelFormat format

Converts this raw image to an Image

Parameters

Name Description
format The format.

BatteryReceiver

BatteryInfo BatteryInfo

Gets or sets the battery info.

CommandResultReceiver

String Result

Gets the result.

ConsoleOutputReceiver

ConsoleOutputReceiver Instance

Gets the instance.

DdmPreferences

Int32 DebugPortBase

Boolean InitialHeapUpdate

Boolean InitialThreadUpdate

LogLevelInfo LogLevel

Int32 SelectedDebugPort

Int32 Timeout

DebugPortManager

Centralized point to provide a IDebugPortProvider to ddmlib.

DebugPortManager Instance

Returns an instance of the debug port manager

IDebugPortProvider Provider

Gets or sets the IDebugPortProvider that will be used when a new Client requests

DeviceMonitor

A Device monitor. This connects to the Android Debug Bridge and get device and debuggable process information from it.

Dictionary<IClient, Int32> ClientsToReopen

Gets the clients to reopen.

Int32 ConnectionAttemptCount

Gets the connection attempt count.

IList<Int32> DebuggerPorts

Gets the debugger ports.

IList<Device> Devices

Gets the devices.

Boolean HasInitialDeviceList

Gets a value indicating whether this instance has initial device list.

Boolean IsMonitoring

Gets a value indicating whether this instance is monitoring.

Boolean IsRunning

Gets a value indicating whether this instance is running.

Int32 RestartAttemptCount

Gets the restart attempt count.

AndroidDebugBridge Server

Gets the server.

Void AddClientToDropAndReopen IClient client Int32 port

Adds the client to drop and reopen.

Parameters

Name Description
client The client.
port The port.

Void AddPortToAvailableList Int32 port

Adds the port to available list.

Parameters

Name Description
port The port.

Void Start

Starts the monitoring

Void Stop

Stops the monitoring

EnvironmentVariablesReceiver

Device Device

Gets or sets the device.

ChunkHandler

Void ClientDisconnected IClient client

Void ClientReady IClient client

Void HandleChunk IClient client Int32 type Byte[] data Boolean isReply Int32 msgId

ClientEventArgs

ClientChangeMask ChangeMask

Gets the change mask.

IClient Client

Gets the client.

Debugger

Socket Channel

IClient Client

ConnectionStates ConnectionState

Boolean IsDebuggerAttached

Socket ListenChannel

Int32 ListenPort

BinaryWriter PreDataBuffer

BinaryReader ReadBuffer

Socket Accept

Socket Accept Socket listenChan

Void Close

Void CloseData

Void ForwardPacketToClient Object packet

Object GetJdwpPacket

Void Read

Void SendAndConsume Object packet

Boolean SendHandshake

Device

String AvdName

Gets or sets the Avd name.

BusyBox BusyBox

Gets the busy box object for this device.

Socket ClientMonitoringSocket

Gets or sets the client monitoring socket.

List<IClient> Clients

Gets the list of clients

String DeviceProperty

Gets the device.

IPEndPoint Endpoint

Gets the TCP endpoint defined when the transport is TCP.

Dictionary<String, String> EnvironmentVariables

Gets the environment variables.

FileListingService FileListingService

Returns a for this device.

FileSystem FileSystem

Gets the file system for this device.

Boolean HasClients

Gets a value indicating whether this instance has clients.

Boolean IsBootLoader

Gets a value indicating whether this device is in boot loader mode.

Boolean IsEmulator

Gets a value indicating whether this device is emulator.

Boolean IsOffline

Gets a value indicating whether this device is offline.

Boolean IsOnline

Gets a value indicating whether the device is online.

Boolean IsRecovery

Gets a value indicating whether this instance is recovery.

String Model

Gets the model.

Dictionary<String, MountPoint> MountPoints

Gets the device mount points.

PackageManager PackageManager

Returns a for this device.

String Product

Gets the product.

Dictionary<String, String> Properties

Returns the device properties. It contains the whole output of 'getprop'

RawImage Screenshot

Takes a screen shot of the device and returns it as a

String SerialNumber

Gets the device serial number

DeviceState State

Gets the device state

SyncService SyncService

Returns a object to push / pull files to and from the device.

if the SyncService couldn't be created. This can happen if adb refuse to open the connection because the {@link IDevice} is invalid (or got disconnected).

Exceptions

Type Description
System.IO.IOException Throws IOException if the connection with adb failed.

TransportType TransportType

Void Backup

Backups this device.

Boolean CanBackup

Determines whether this device can perform a backup.

Boolean CanSU

Determines whether this instance can use the SU shell.

Boolean CreateForward Int32 localPort Int32 remotePort

Creates a port forwarding between a local and a remote port.

Parameters

Name Description
localPort the local port to forward
remotePort the remote port.

Device CreateFromAdbData String data

Create a device from Adb Device list data

Parameters

Name Description
data the line data for the device

Void ExecuteRootShellCommand String command IShellOutputReceiver receiver

Executes a shell command on the device as root, and sends the result to a receiver.

Parameters

Name Description
command The command to execute
receiver The receiver object getting the result from the command.

Void ExecuteRootShellCommand String command IShellOutputReceiver receiver Int32 timeout

Executes a shell command on the device as root, and sends the result to a receiver.

Parameters

Name Description
command The command.
receiver The receiver.

Void ExecuteRootShellCommand String command IShellOutputReceiver receiver Object[] commandArgs

Executes a root shell command on the device, and sends the result to a receiver.

Parameters

Name Description
command The command.
receiver The receiver.
commandArgs The command args.

Void ExecuteRootShellCommand String command IShellOutputReceiver receiver Int32 timeout Object[] commandArgs

Executes a root shell command on the device, and sends the result to a receiver.

Parameters

Name Description
command The command.
receiver The receiver.
timeout The timeout.
commandArgs The command args.

Void ExecuteShellCommand String command IShellOutputReceiver receiver

Executes a shell command on the device, and sends the result to a receiver.

Parameters

Name Description
command The command to execute
receiver The receiver object getting the result from the command.

Void ExecuteShellCommand String command IShellOutputReceiver receiver Int32 timeout

Executes a shell command on the device, and sends the result to a receiver.

Parameters

Name Description
command The command.
receiver The receiver.
timeout The timeout.

Void ExecuteShellCommand String command IShellOutputReceiver receiver Object[] commandArgs

Executes a shell command on the device, and sends the result to a receiver.

Parameters

Name Description
command The command.
receiver The receiver.
commandArgs The command args.

Void ExecuteShellCommand String command IShellOutputReceiver receiver Int32 timeout Object[] commandArgs

Executes a shell command on the device, and sends the result to a receiver.

Parameters

Name Description
command The command.
receiver The receiver.
timeout The timeout.
commandArgs The command args.

BatteryInfo GetBatteryInfo

Gets the battery level.

BatteryInfo GetBatteryInfo Int64 freshness

Gets the battery level.

Parameters

Name Description
freshness The freshness.

String GetProperty String name

Gets the property value.

Parameters

Name Description
name The name of the property.

String GetProperty String[] name

Gets the first property that exists in the array of property names.

Parameters

Name Description
name The array of property names.

Void InstallPackage String packageFilePath Boolean reinstall

Installs an Android application on device. This is a helper method that combines the syncPackageToDevice, installRemotePackage, and removePackage steps

Parameters

Name Description
packageFilePath the absolute file system path to file on local host to install
reinstall if re-install of app should be performed

Void InstallRemotePackage String remoteFilePath Boolean reinstall

Installs the application package that was pushed to a temporary location on the device.

Parameters

Name Description
remoteFilePath absolute file path to package file on device
reinstall if re-install of app should be performed

Void Reboot

Reboots the device in to the specified state

Void Reboot String into

Reboots the device in to the specified state

Parameters

Name Description
into The reboot state

Void RefreshEnvironmentVariables

Refreshes the environment variables.

Void RefreshMountPoints

Refreshes the mount points.

Void RefreshProperties

Refreshes the properties.

Void RemountMountPoint MountPoint mnt Boolean readOnly

Remounts the mount point.

Parameters

Name Description
mnt The mount point.
readOnly the mount poine will be set to read-only.

Void RemountMountPoint String mountPoint Boolean readOnly

Remounts the mount point.

Parameters

Name Description
mountPoint the mount point
readOnly the mount poine will be set to read-only.

Exceptions

Type Description
System.IO.IOException Throws if the mount point does not exist.

Boolean RemoveForward Int32 localPort

Removes a port forwarding between a local and a remote port.

Parameters

Name Description
localPort the local port to forward
remotePort the remote port.

Void RemoveRemotePackage String remoteFilePath

Remove a file from device

Parameters

Name Description
remoteFilePath path on device of file to remove

Exceptions

Type Description
System.IO.IOException if file removal failed

Void RunEventLogService LogReceiver receiver

Runs the event log service.

Parameters

Name Description
receiver The receiver.

Void RunLogService String logname LogReceiver receiver

Runs the log service.

Parameters

Name Description
logname The logname.
receiver The receiver.

String SyncPackageToDevice String localFilePath

Pushes a file to device

Parameters

Name Description
localFilePath the absolute path to file on local host

Exceptions

Type Description
System.IO.IOException if fatal error occurred when pushing file

Void UninstallPackage String packageName

Uninstall an package from the device.

Parameters

Name Description
packageName Name of the package.

Exceptions

Type Description
System.IO.IOException System.IO.IOException
PackageInstallException PackageInstallException

DeviceEventArgs

IDevice Device

Gets the device.

ErrorCodeHelper

String ErrorCodeToString Int32 code

FileEntry

Represents a file entry on a device

List<FileEntry> Children

Gets or sets the children.

Note that this is not populated by default. Use the FileListingService.GetChildren to populate it.

DateTime Date

Gets or sets the date.

Device Device

Gets the device associated with this file entry.

Boolean Exists

Gets a value indicating whether this is exists.

Int64 FetchTime

Indicates whether the entry content has been fetched yet, or not.

String FullEscapedPath

Gets the fully escaped path of the entry. This path is safe to use in a shell command line.

String FullPath

Gets the full path of the entry.

String FullResolvedPath

Gets the full resolved path.

String Group

Gets or sets the group.

String Info

Gets or sets the info.

Boolean IsApplicationFileName

Gets a value indicating whether this instance is application file name.

Boolean IsApplicationPackage

Gets a value indicating whether this instance is application package.

Boolean IsDirectory

Gets a value indicating whether this instance is directory.

Boolean IsExecutable

Gets a value indicating whether this instance is executable.

Boolean IsRoot

Gets a value indicating whether this instance is root.

String LinkName

Gets or sets the name of the link.

String Name

Gets the name.

String Owner

Gets or sets the owner.

FileEntry Parent

Gets the parent.

String[] PathSegments

Gets the path as a list of segments.

FilePermissions Permissions

Gets or sets the permissions.

Int64 Size

Gets or sets the size.

FileTypes Type

Gets the type.

Void AddChild FileEntry child

Adds a child file entry

Parameters

Name Description
child The child file entry

Boolean Create

Creates the file entry, if it does not exist.

FileEntry CreateNoPermissions Device device String path

Boolean Delete

Deletes the file entry from the file system.

FileEntry Find Device device String path

Gets a file entry from the specified path on the device.

Parameters

Name Description
device The device to check
path the path to check

Exceptions

Type Description
System.IO.IOException If the device is not connected.
System.ArgumentNullException If the device
System.ArgumentNullException path is null.
System.IO.FileNotFoundException If the entrty is not found.

FileEntry FindChild String name

Returns the child FileEntry matching the name. This uses the cached children list.

Parameters

Name Description
name the name of the child to return.

FileEntry FindOrCreate Device device String path

Finds the file entry, or creates an empty FileEntry if it does not exist.

This does not create the FileEntry on disk. It only creates the FileEntry object.

Parameters

Name Description
device The device.
path The path.

FileListingService

Provides Device side file listing service.

Device Device

Gets or sets the device.

Boolean ForceBusyBox

Gets or sets a value indicating whether [force busy box].

FileEntry Root

Gets or sets the root.

FileEntry FindFileEntry String path

Finds an entry from the path.

Parameters

Name Description
path The file path of

Exceptions

Type Description
System.IO.FileNotFoundException Throws if unable to locate the file
System.IO.FileNotFoundException directory

FileEntry FindFileEntry FileEntry parent String path

Finds the file entry.

Parameters

Name Description
parent The parent.
path The path.

FileEntry[] GetChildren FileEntry entry Boolean useCache IListingReceiver receiver

Gets the children.

Parameters

Name Description
entry The entry.
useCache [use cache].
receiver The receiver.

FilePermissions

String ToChmod

FilePermission

Boolean CanDelete

Gets or sets a value indicating whether this instance can delete.

Boolean CanExecute

Gets or sets a value indicating whether this instance can execute.

Boolean CanRead

Gets or sets a value indicating whether this instance can read.

Boolean CanWrite

Gets or sets a value indicating whether this instance can write.

Modes ToChmod

Converts the permissions to bit value that can be casted to an integer and used for calling chmod

String ToString

FileSystem

IEnumerable<FileEntry> DeviceBlocks

Gets the dev blocks for the device.

Exceptions

Type Description
System.IO.FileNotFoundException Throws if unable to locate /dev/block

Void Chmod String path String permissions

Chmods the specified path.

Parameters

Name Description
path The path.
permissions The permissions.

Void Chmod String path FilePermissions permissions

Chmods the specified path.

Parameters

Name Description
path The path.
permissions The permissions.

Void Copy String source String destination

Copies the specified source to the specified destination.

Parameters

Name Description
source The source.
destination The destination.

FileEntry Create String path

Creates the specified path.

Parameters

Name Description
path The path.

FileEntry Create FileEntry fileEntry

Creates the specified file entry.

Parameters

Name Description
fileEntry The file entry.

Void Delete String path

Deletes the specified path.

Parameters

Name Description
path The path.

Exceptions

Type Description
System.ArgumentNullException If device is null
System.ArgumentNullException If path is null
System.ArgumentNullException empty.
System.IO.IOException If the command fails.

Void Delete FileEntry fileEntry

Deletes the specified path.

Parameters

Name Description
fileEntry The file entry.

Exceptions

Type Description
System.IO.IOException If the command fails.

Boolean Exists String path

Gets if the specified path exists on the device.

Parameters

Name Description
path the path to check

Exceptions

Type Description
System.IO.IOException If the device is not connected.
System.ArgumentNullException If the device
System.ArgumentNullException path is null.

Boolean IsMountPointReadOnly String mount

Gets if the specified mount point is read-only

Exceptions

Type Description
System.IO.IOException If mount point doesnt exist

Void MakeDirectory String path

Makes the directory from the specified path.

Parameters

Name Description
path The path.

Void MakeDirectory String path Boolean forceDeviceMethod

Makes the directory.

Parameters

Name Description
path The path.
forceDeviceMethod forces the use of the "non-busybox" method.

Void Mount String mountPoint

Attempts to mount the mount point to the associated device without knowing the device or the type. Some devices may not support this method.

Void Mount MountPoint mountPoint

Mounts the specified mount point.

Parameters

Name Description
mountPoint The mountPoint.

Void Mount MountPoint mountPoint String options

Mounts the specified device.

Parameters

Name Description
mountPoint The mp.
options The options.

Void Mount String directory String device String fileSytemType Boolean isReadOnly

Mounts the specified devices to the specified directory.

Parameters

Name Description
directory The directory.
device The device.
fileSytemType Type of the file sytem.
isReadOnly is read only.

Void Mount String directory String device String fileSytemType Boolean isReadOnly String options

Mounts the specified devices to the specified directory.

Parameters

Name Description
directory The directory.
device The device.
fileSytemType Type of the file sytem.
isReadOnly is read only.
options The options.

Void Move String source String destination

Moves the specified source to the specified destination.

Parameters

Name Description
source The source.
destination The destination.

Void Unmount MountPoint mountPoint

Unmounts the specified mount point.

Parameters

Name Description
mountPoint The mountPoint.

Void Unmount String mountPoint

Unmounts the specified mount point.

Parameters

Name Description
mountPoint The mount point.

Void Unmount MountPoint mountPoint String options

Unmounts the specified mount point.

Parameters

Name Description
mountPoint The mountPoint.
options The options.

Void Unmount String mountPoint String options

Unmounts the specified mount point.

Parameters

Name Description
mountPoint The mount point.
options The options.

GetPropReceiver

Device Device

Gets or sets the device.

InstallReceiver

String ErrorMessage

Gets the error message if the install was unsuccessful.

Boolean Success

Gets a value indicating whether the install was a success.

ListingServiceReceiver

FileEntry[] CurrentChildren

Gets or sets the current children.

List<FileEntry> Entries

Gets or sets the entries.

Boolean IsCancelled

Gets a value indicating whether this instance is cancelled.

FileEntry Parent

Gets or sets the parent.

Log

LogLevelInfo Level

Gets or sets the level.

ILogOutput LogOutput

Gets or sets the

Void d String tag String message

Outputs a Debug level message.

Parameters

Name Description
tag The tag associated with the message.
message The message to output

Void d String tag String format Object[] args

Outputs a Debug level message.

Parameters

Name Description
tag The tag associated with the message.
format The message to output format string.
args The values for the format message

Void e String tag String message

Outputs a Error level message.

Parameters

Name Description
tag The tag associated with the message.
message The message to output.

Void e String tag Exception exception

Outputs a Error level message.

Parameters

Name Description
tag The tag associated with the message.
exception The exception to warn

Void e String tag String format Object[] args

Outputs a Error level message.

Parameters

Name Description
tag The tag associated with the message.
format The message to output format string.
args The values for the format message

Void e String tag String message Exception exception

Outputs a Error level message.

Parameters

Name Description
tag The tag associated with the message.
message The message to output.
exception The exception to warn

String GetLogFormatString LogLevelInfo logLevel String tag String message

Void i String tag String message

Outputs a Info level message.

Parameters

Name Description
tag The tag associated with the message.
format The message to output.

Void i String tag String format Object[] args

Outputs a Info level message.

Parameters

Name Description
tag The tag associated with the message.
format The message to output format string.
args The values for the format message

Void LogAndDisplay LogLevelInfo logLevel String tag String message

Void v String tag String message

Outputs a Verbose level message.

Parameters

Name Description
tag The tag associated with the message.
message The message to output

Void v String tag String format Object[] args

Outputs a Verbose level message.

Parameters

Name Description
tag The tag associated with the message.
format The message to output format string.
args The values for the format message

Void w String tag String message

Outputs a Warn level message.

Parameters

Name Description
tag The tag associated with the message.
message The message to output.

Void w String tag Exception exception

Outputs a Warn level message.

Parameters

Name Description
tag The tag associated with the message.
exception The exception to warn

Void w String tag String format Object[] args

Outputs a Warn level message.

Parameters

Name Description
tag The tag associated with the message.
format The message to output format string.
args The values for the format message

Void w String tag String message Exception exception

Outputs a Warn level message.

Parameters

Name Description
tag The tag associated with the message.
message The message to output.
exception The exception to warn

Void Write LogLevelInfo logLevel String tag String message

LogLevel

LogLevelInfo Assert

Gets or sets the assert log level.

LogLevelInfo Debug

Gets or sets the debug log level.

LogLevelInfo Error

Gets or sets the error log level.

LogLevelInfo Info

Gets or sets the info log level.

Dictionary<String, LogLevelInfo> Levels

Gets or sets the levels.

ValueCollection<String, LogLevelInfo> Values

Gets the values.

LogLevelInfo Verbose

Gets or sets the verbose log level.

LogLevelInfo Warn

Gets or sets the warn log level.

LogLevelInfo GetByLetter String letter

Gets the by letter.

Parameters

Name Description
letter The letter.

LogLevelInfo GetByLetter Char letter

Gets the by letter.

Parameters

Name Description
letter The letter.

LogLevelInfo GetByString String value

MountPoint

Represents a mount point.

String Block

Gets the mount point block

String FileSystem

Gets the mount point file system

Boolean IsReadOnly

Gets the mount point access

String Name

Gets the mount point name

MountPoint Clone

Creates a clone of this MountPoint

MountPointReceiver

A dynamic mount point receiver.

Works on busybox and non-busybox devices

Device Device

Gets or sets the device.

NullOutputReceiver

IShellOutputReceiver Instance

Gets the instance.

Boolean IsCancelled

Gets a value indicating whether this instance is cancelled.

Void AddOutput Byte[] data Int32 offset Int32 length

Adds the output.

Parameters

Name Description
data The data.
offset The offset.
length The length.

Void Flush

Flushes the output.

This should always be called at the end of the "process" in order to indicate that the data is ready to be processed further if needed.

NullSyncProgressMonitor

A Sync progress monitor that does nothing

Boolean IsCanceled

Sent to query for possible cancellation.

Void Advance Int64 work

Sent when some progress have been made.

Parameters

Name Description
work the amount of work done.

Void Start Int64 totalWork

Sent when the transfer starts

Parameters

Name Description
totalWork the total amount of work.

Void StartSubTask String source String destination

Sent when a sub task is started.

Parameters

Name Description
source
destination the destination.

Void Stop

Sent when the transfer is finished or interrupted.

PackageManager

Dictionary<String, FileEntry> Packages

Gets or sets the packages.

Boolean Exists String package

Existses the specified package.

Parameters

Name Description
package The package.

FileEntry GetApkFileEntry String package

Gets the apk file entry.

Parameters

Name Description
package The package.

String GetApkPath String package

Gets the apk path.

Parameters

Name Description
package The package.

Void RefreshPackages

Refreshes the packages.

PackageManagerReceiver

Device Device

Gets or sets the device.

PackageManager PackageManager

Gets or sets the package manager.

PackageManagerListingReceiver

Dictionary<String, FileEntry> Map

Gets or sets the map.

IListingReceiver Receiver

Gets or sets the receiver.

SyncResult

Int32 Code

Gets the error code

String Message

Gets the error message

SyncService

IPEndPoint Address

Gets the address.

Device Device

Gets the device.

Boolean IsOpen

Gets a value indicating whether this instance is open.

NullSyncProgressMonitor NullProgressMonitor

Gets the null progress monitor.

Void Close

Closes this connection.

Void Dispose

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Boolean Open

Opens this connection.

SyncResult Pull IEnumerable<FileEntry> entries String localPath ISyncProgressMonitor monitor

Pulls file(s) or folder(s).

Parameters

Name Description
entries the remote item(s) to pull
localPath The local destination. If the entries count is > 1 or if the unique entry is a folder, this should be a folder.
monitor The progress monitor. Cannot be null.

Exceptions

Type Description
System.ArgumentNullException monitor;Monitor cannot be null

SyncResult PullFile FileEntry remote String localFilename ISyncProgressMonitor monitor

Pulls a single file.

Parameters

Name Description
remote remote the remote file
localFilename The local destination.
monitor The progress monitor. Cannot be null.

Exceptions

Type Description
System.ArgumentNullException monitor;Monitor cannot be null
System.ArgumentNullException Throws if monitor is null

SyncResult PullFile String remoteFilepath String localFilename ISyncProgressMonitor monitor

Pulls a single file.

Parameters

Name Description
remoteFilepath the full path to the remote file
localFilename The local destination.
monitor The progress monitor. Cannot be null.

Exceptions

Type Description
System.ArgumentNullException monitor;Monitor cannot be null
System.ArgumentNullException Throws if monitor is null

SyncResult Push IEnumerable<String> local FileEntry remote ISyncProgressMonitor monitor

Push several files.

Parameters

Name Description
local An array of local files to push
remote the remote FileEntry representing a directory.
monitor The progress monitor. Cannot be null.

Exceptions

Type Description
System.ArgumentNullException Monitor cannot be null

SyncResult PushFile String local String remote ISyncProgressMonitor monitor

Push a single file.

Parameters

Name Description
local the local filepath.
remote The remote filepath.
monitor The progress monitor. Cannot be null.

Exceptions

Type Description
System.ArgumentNullException monitor;Monitor cannot be null
System.ArgumentNullException Throws if monitor is null

Managed.Adb.Exceptions

AdbException

Represents an exception with communicating with ADB

AdbCommandRejectedException

Exception thrown when adb refuses a command.

Boolean IsDeviceOffline

Boolean WasErrorDuringDeviceSelection

CommandAbortingException

Thrown when an executed command identifies that it is being aborted.

ShellCommandUnresponsiveException

UnknownOptionException

Thrown when a command has an unknown option passed

DeviceNotFoundException

Unable to connect to the device because it was not found in the list of available devices.

PackageInstallationException

An exception while installing a package on the device

PermissionDeniedException

BadPacketException

Managed.Adb.IO

LinuxPath

Just like System.IO.Path, except it is geared for Linux

String ChangeExtension String path String extension

Changes the extension of a path string.

Parameters

Name Description
extension The new extension (with a leading period). Specify null to remove an existing extension from path.
path .

Exceptions

Type Description
System.ArgumentException ,
System.ArgumentException contains a wildcard character.

String Combine String[] paths

Combine the specified paths to form one path

Parameters

Name Description
paths The paths.

String Combine String path1 String path2

Combines two path strings.

Parameters

Name Description
path2 The second path.
path1 The first path.

Exceptions

Type Description
System.ArgumentNullException path1
System.ArgumentNullException path2 is null.
System.ArgumentException ,
System.ArgumentException contains a wildcard character.

String Combine String path1 String path2 String path3

Combine the specified paths to form one path

Parameters

Name Description
path1 The path1.
path2 The path2.
path3 The path3.

String Combine String path1 String path2 String path3 String path4

Combine the specified paths to form one path

Parameters

Name Description
path1 The path1.
path2 The path2.
path3 The path3.
path4 The path4.

String Escape String path

Returns an escaped version of the entry name.

Parameters

Name Description
path The path.

String GetDirectoryName String path

Returns the directory information for the specified path string.

Parameters

Name Description
path The path of a file or directory.

Exceptions

Type Description
System.ArgumentException The path parameter contains invalid characters, is empty,
System.ArgumentException contains only white spaces,
System.ArgumentException contains a wildcard character.
System.IO.PathTooLongException The path parameter is longer than the system-defined maximum length.

String GetExtension String path

Returns the extension of the specified path string.

Parameters

Name Description
path The path string from which to get the extension.

Exceptions

Type Description
System.ArgumentException ,
System.ArgumentException contains a wildcard character.

String GetFileName String path

Returns the file name and extension of the specified path string.

Parameters

Name Description
path The path string from which to obtain the file name and extension.

Exceptions

Type Description
System.ArgumentException ,
System.ArgumentException contains a wildcard character.

String GetFileNameWithoutExtension String path

Returns the file name of the specified path string without the extension.

Parameters

Name Description
path The path of the file.

Exceptions

Type Description
System.ArgumentException ,
System.ArgumentException contains a wildcard character.

Char[] GetInvalidFileNameChars

Gets an array containing the characters that are not allowed in file names.

Char[] GetInvalidPathChars

Gets an array containing the characters that are not allowed in path names.

String GetPathRoot String path

Gets the root directory information of the specified path.

Parameters

Name Description
path The path from which to obtain root directory information.

Exceptions

Type Description
System.ArgumentException was passed to path.

String GetPathWithoutFile String path

Gets the path without file name.

Parameters

Name Description
path The path.

Boolean HasExtension String path

Determines whether a path includes a file name extension.

Parameters

Name Description
path The path to search for an extension.

Exceptions

Type Description
System.ArgumentException ,
System.ArgumentException contains a wildcard character.

Boolean IsPathRooted String path

Gets a value indicating whether the specified path string contains absolute or relative path information.

Parameters

Name Description
path The path to test.

Exceptions

Type Description
System.ArgumentException ,
System.ArgumentException contains a wildcard character.

String Quote String path

Quotes the specified path.

Parameters

Name Description
path The path.

Rgb565

A class that represents Rgb565 Image information

Image ToImage Byte[] data Int32 width Int32 height

Converts the data to an image

Parameters

Name Description
data The data.
width The width.
height The height.

Image ToImage PixelFormat format Byte[] data Int32 width Int32 height

Gets the Image from the raw image data

Parameters

Name Description
format The format.
data The data.
width The width.
height The height.

Boolean Image.ToRgb565 Image image String file

Saves the image as an Rgb565 bitmap to disk

Parameters

Name Description
file The file.

Boolean Image.ToRgb565 Image image Stream stream

Saves the image as an Rgb565 bitmap to the specified stream

Parameters

Name Description
stream The stream.

Managed.Adb.Logs

LogEntry

Byte[] Data

Int32 Length

Int32 NanoSeconds

Int32 ProcessId

Int32 ThreadId

DateTime TimeStamp

LogReceiver

Boolean IsCancelled

Void Cancel

Void ParseNewData Byte[] data Int32 offset Int32 length