patagona.AdbClient 5.0.0

dotnet add package patagona.AdbClient --version 5.0.0
NuGet\Install-Package patagona.AdbClient -Version 5.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="patagona.AdbClient" Version="5.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add patagona.AdbClient --version 5.0.0
#r "nuget: patagona.AdbClient, 5.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install patagona.AdbClient as a Cake Addin
#addin nuget:?package=patagona.AdbClient&version=5.0.0

// Install patagona.AdbClient as a Cake Tool
#tool nuget:?package=patagona.AdbClient&version=5.0.0

AdbClient.NET

A .NET Client for the Android Debug Bridge (ADB)

Nuget

Features

  • Simple
  • Thread-Safe
  • Implemented Services:
    • GetHostVersion (host:version)
    • GetDevices (host:devices)
    • TrackDevices (host:track-devices)
    • Sync (sync:)
      • Push (SEND)
      • Pull (RECV)
      • List (LIST)
      • ListV2 (LIS2)
      • Stat (STAT)
      • StatV2 (LST2/STA2)
    • Execute (shell,v2:)
    • ScreenCapture (framebuffer:)

Compared to madb / SharpAdbClient

  • Pros:
    • Simple
    • Thread-Safe
    • Async
    • CancellationToken support
  • Cons:
    • Some services not (yet) implemented (pull requests are welcome)

Examples

Get ADB host version

var adbClient = new AdbServicesClient();
int hostVersion = await adbClient.GetHostVersion();

Get Devices

var adbClient = new AdbServicesClient();
IList<(string Serial, AdbConnectionState State)> devices = await adbClient.GetDevices();

Track Devices

This tracks all device changes (connect, disconnect, etc.) until the CancellationToken is cancelled (in this case, for 60 seconds)

var adbClient = new AdbServicesClient();
var cts = new CancellationTokenSource(60000);
await foreach ((string Serial, AdbConnectionState State) deviceStateChange in adbClient.TrackDevices(cts.Token))
{
    [...]
}

List root directory

var adbClient = new AdbServicesClient();
using (var syncClient = await adbClient.GetSyncClient("abcdefghijklmnop"))
{
    IList<StatV2Entry> entries = syncClient.ListV2("/");
}

Upload file to device

using (var fs = File.OpenRead("test.mp3"))
using (var syncClient = await client.GetSyncClient("abcdefghijklmnop"))
{
    await syncClient.Push("/storage/emulated/0/Music/test.mp3", fs);
}

Download file from device

using (var fs = File.OpenWrite("test.mp3"))
using (var syncClient = await client.GetSyncClient("abcdefghijklmnop"))
{
    await syncClient.Pull("/storage/emulated/0/Music/test.mp3", fs);
}

Execute command

Simple
var adbClient = new AdbServicesClient();
int exitCode = await adbClient.Execute("abcdefghijklmnop", "touch", new string[] { "/storage/emulated/0/test.txt" }, null, null, null);
With stdout/stderr redirection
var adbClient = new AdbServicesClient();
using var stdout = new MemoryStream();
using var stderr = new MemoryStream();
int exitCode = await adbClient.Execute("abcdefghijklmnop", "ls", new string[] { "-la", "/storage/emulated/0/test.txt" }, null, stdout, stderr);
if (exitCode != 0)
    throw new Exception(Encoding.UTF8.GetString(stderr.ToArray()));
Console.WriteLine(Encoding.UTF8.GetString(stdout.ToArray())); // prints directory listing
With everything redirected
var adbClient = new AdbServicesClient();
using var stdin = new MemoryStream(Encoding.UTF8.GetBytes("Hello World"));
using var stdout = new MemoryStream();
using var stderr = new MemoryStream();
int exitCode = await adbClient.Execute("abcdefghijklmnop", "cat", new string[] {}, stdin, stdout, stderr);
if (exitCode != 0)
    throw new Exception(Encoding.UTF8.GetString(stderr.ToArray()));
Console.WriteLine(Encoding.UTF8.GetString(stdout.ToArray())); // prints "Hello World"

Capture screen

Capture and save as png
var adbClient = new AdbServicesClient();
using Image img = await adbClient.ScreenCapture("abcdefghijklmnop");
img.SaveAsPng("image.png");
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0 250 7/23/2023
4.0.0 409 2/23/2023
3.2.0 243 2/18/2023
3.1.1 244 2/12/2023
3.1.0 232 2/11/2023
3.0.0 231 2/11/2023
2.1.0 247 2/10/2023
2.0.0 361 12/7/2022
1.1.0 332 11/17/2022
1.0.0 320 11/17/2022

- feat!: make `ListV2` and `StatV2` return an error code for each entry instead of throwing exceptions. Callers of these methods must now check the new property `Error` on each stat entry
           - feat!: use enum for device connection state instead of string
           - feat: add documentation