Interface IFirmwareUpgrader

Namespace

Huddly.Sdk.Upgraders

Assembly

Huddly.Sdk.dll

public interface IFirmwareUpgrader

Properties

DesiredVersion

FirmwareVersion DesiredVersion { get; }

Property Value

FirmwareVersion

FirmwareVersion

[Obsolete("Use DesiredVersion instead. Method will be removed in SDK version 3.")]
SemVersion FirmwareVersion { get; }

Property Value

SemVersion

Methods

Execute(CancellationToken)

Executes a firmware upgrade. To track upgrade progress, see ProgressUpdated

Task<Result> Execute(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<Result>

Remarks

When a firmware upgrade is run, the device will typically become non-responsive for other methods. It is recommended to cease all other communication with the device before executing an upgrade.

In the course of an upgrade, a device will disconnect and reconnect again. As such, the original IDevice instance that was used to create the IFirmwareUpgrader will disconnect. To continue communicating with the device when it has reconnected, consumers should use the new IDevice instance emitted in the DeviceConnected event

Events

ProgressUpdated

Event that triggers on upgrade progress

event EventHandler<UpgradeProgressEventArgs> ProgressUpdated

Event Type

EventHandler<UpgradeProgressEventArgs>