Class Bootloader

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Provides asynchronous operations to update a device firmware using the dedicated bootloader protocol.

public static class Bootloader

Inheritance

object

Bootloader

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

UpdateFirmwareAsync(string, DeviceFirmware, bool, IProgress<int>)

Asynchronously updates the firmware of the Harp device on the specified port.

public static Task UpdateFirmwareAsync(string portName, DeviceFirmware firmware, bool forceUpdate, IProgress<int> progress = null)

Parameters

portName string

The name of the serial port used to communicate with the Harp device.

firmware DeviceFirmware

The binary firmware image to upload to the device.

forceUpdate bool

true to indicate that the firmware should be uploaded even if the device reports unsupported hardware, or is in bootloader mode; false to throw an exception if the firmware is not supported, or the device is in an invalid state.

progress IProgress<int>

The optional IProgress<T> object used to report update progress.

Returns

Task

The task object representing the asynchronous firmware update operation.

UpdateFirmwareAsync(string, DeviceFirmware, IProgress<int>)

Asynchronously updates the firmware of the Harp device on the specified port.

public static Task UpdateFirmwareAsync(string portName, DeviceFirmware firmware, IProgress<int> progress = null)

Parameters

portName string

The name of the serial port used to communicate with the Harp device.

firmware DeviceFirmware

The binary firmware image to upload to the device.

progress IProgress<int>

The optional IProgress<T> object used to report update progress.

Returns

Task

The task object representing the asynchronous firmware update operation.