Method DetectAsync

Namespace: Belay.Core
Assembly: Belay.Core.dll

DetectAsync(DeviceConnection, ILogger?, CancellationToken)

Detects device capabilities using a single batched Python script execution.

public static Task<SimpleDeviceCapabilities> DetectAsync(DeviceConnection connection, ILogger? logger = null, CancellationToken cancellationToken = default)

Parameters

connection DeviceConnection

The device connection interface.

logger ILogger?

Optional logger for diagnostic output.

cancellationToken CancellationToken

Cancellation token for the operation.

Returns

Task<SimpleDeviceCapabilities>

A containing the detected capabilities.

Examples

var capabilities = await SimplifiedCapabilityDetection.DetectAsync(
    communication, logger, cancellationToken);

Console.WriteLine($"Platform: {capabilities.Platform}");
Console.WriteLine($"Features: {capabilities.SupportedFeatures}");
Console.WriteLine($"Memory: {capabilities.AvailableMemory} bytes");

Exceptions

ArgumentNullException

Thrown when communication is null.

DeviceException

Thrown when the device is not connected.