Class AsyncDevice

Namespace: Bonsai.Harp

Assembly: Bonsai.Harp.dll

Represents an asynchronous API to configure and interface with Harp devices.

public class AsyncDevice : IDisposable

Inheritance: object

AsyncDevice

Implements: IDisposable

Derived: AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

AsyncDevice

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

AsyncDevice(string): Initializes a new instance of the AsyncDevice class on the specified port.

Methods

CommandAsync(HarpMessage, CancellationToken): Sends a command to the Harp device and awaits the response as an asynchronous operation.

Dispose(): Releases all resources used by the current instance of the AsyncDevice.

ReadAssemblyVersionAsync(CancellationToken): Asynchronously reads the assembly version of the device.

ReadByteArrayAsync(int, CancellationToken): Asynchronously reads the value of an 8-bit unsigned integer array register with the specified address.

ReadByteAsync(int, CancellationToken): Asynchronously reads the value of an 8-bit unsigned integer register with the specified address.

ReadClockConfigurationAsync(CancellationToken): Asynchronously reads the configuration for the device synchronization clock.

ReadCoreVersionAsync(CancellationToken): Asynchronously reads the version of the Harp core implemented by the device firmware.

ReadDeviceNameAsync(CancellationToken): Asynchronously reads the display name of the device.

ReadFirmwareVersionAsync(CancellationToken): Asynchronously reads the firmware version of the device.

ReadHardwareVersionAsync(CancellationToken): Asynchronously reads the hardware version of the device.

ReadInt16ArrayAsync(int, CancellationToken): Asynchronously reads the value of a 16-bit signed integer array register with the specified address.

ReadInt16Async(int, CancellationToken): Asynchronously reads the value of a 16-bit signed integer register with the specified address.

ReadInt32ArrayAsync(int, CancellationToken): Asynchronously reads the value of a 32-bit signed integer array register with the specified address.

ReadInt32Async(int, CancellationToken): Asynchronously reads the value of a 32-bit signed integer register with the specified address.

ReadInt64ArrayAsync(int, CancellationToken): Asynchronously reads the value of a 64-bit signed integer array register with the specified address.

ReadInt64Async(int, CancellationToken): Asynchronously reads the value of a 64-bit signed integer register with the specified address.

ReadOperationControlAsync(CancellationToken): Asynchronously reads the contents of the OperationControl register.

ReadResetDeviceAsync(CancellationToken): Asynchronously reads the contents of the ResetDevice register.

ReadSByteArrayAsync(int, CancellationToken): Asynchronously reads the value of an 8-bit signed integer array register with the specified address.

ReadSByteAsync(int, CancellationToken): Asynchronously reads the value of an 8-bit signed integer register with the specified address.

ReadSerialNumberAsync(CancellationToken): Asynchronously reads the unique serial number of the device.

ReadSingleArrayAsync(int, CancellationToken): Asynchronously reads the value of a single-precision floating point array register with the specified address.

ReadSingleAsync(int, CancellationToken): Asynchronously reads the value of a single-precision floating point register with the specified address.

ReadTimestampMicrosecondsAsync(CancellationToken): Asynchronously reads the fractional part of the system timestamp, in microseconds.

ReadTimestampSecondsAsync(CancellationToken): Asynchronously reads the integral part of the system timestamp, in seconds.

ReadUInt16ArrayAsync(int, CancellationToken): Asynchronously reads the value of a 16-bit unsigned integer array register with the specified address.

ReadUInt16Async(int, CancellationToken): Asynchronously reads the value of a 16-bit unsigned integer register with the specified address.

ReadUInt32ArrayAsync(int, CancellationToken): Asynchronously reads the value of a 32-bit unsigned integer array register with the specified address.

ReadUInt32Async(int, CancellationToken): Asynchronously reads the value of a 32-bit unsigned integer register with the specified address.

ReadUInt64ArrayAsync(int, CancellationToken): Asynchronously reads the value of a 64-bit unsigned integer array register with the specified address.

ReadUInt64Async(int, CancellationToken): Asynchronously reads the value of a 64-bit unsigned integer register with the specified address.

ReadWhoAmIAsync(CancellationToken): Asynchronously reads the identity class of the device.

WriteByteAsync(int, byte, CancellationToken): Asynchronously writes a value to an 8-bit unsigned integer register with the specified address.

WriteByteAsync(int, byte[], CancellationToken): Asynchronously writes an array of values to an 8-bit unsigned integer register with the specified address.

WriteClockConfigurationAsync(ClockConfigurationFlags, CancellationToken): Asynchronously updates the configuration for the device synchronization clock.

WriteDeviceNameAsync(string, CancellationToken): Asynchronously updates the display name of the device.

WriteInt16Async(int, short, CancellationToken): Asynchronously writes a value to a 16-bit signed integer register with the specified address.

WriteInt16Async(int, short[], CancellationToken): Asynchronously writes an array of values to a 16-bit signed integer register with the specified address.

WriteInt32Async(int, int, CancellationToken): Asynchronously writes a value to a 32-bit signed integer register with the specified address.

WriteInt32Async(int, int[], CancellationToken): Asynchronously writes an array of values to a 32-bit signed integer register with the specified address.

WriteInt64Async(int, long, CancellationToken): Asynchronously writes a value to a 64-bit signed integer register with the specified address.

WriteInt64Async(int, long[], CancellationToken): Asynchronously writes an array of values to a 64-bit signed integer register with the specified address.

WriteResetDeviceAsync(ResetFlags, CancellationToken): Asynchronously sends a command to reset the device and restore or save non-volatile registers.

WriteSByteAsync(int, sbyte, CancellationToken): Asynchronously writes a value to an 8-bit signed integer register with the specified address.

WriteSByteAsync(int, sbyte[], CancellationToken): Asynchronously writes an array of values to an 8-bit signed integer register with the specified address.

WriteSingleAsync(int, float, CancellationToken): Asynchronously writes a value to a single-precision floating point register with the specified address.

WriteSingleAsync(int, float[], CancellationToken): Asynchronously writes an array of values to a single-precision floating point register with the specified address.

WriteTimestampSecondsAsync(uint, CancellationToken): Asynchronously updates the integral part of the system timestamp, in seconds.

WriteUInt16Async(int, ushort, CancellationToken): Asynchronously writes a value to a 16-bit unsigned integer register with the specified address.

WriteUInt16Async(int, ushort[], CancellationToken): Asynchronously writes an array of values to a 16-bit unsigned integer register with the specified address.

WriteUInt32Async(int, uint, CancellationToken): Asynchronously writes a value to a 32-bit unsigned integer register with the specified address.

WriteUInt32Async(int, uint[], CancellationToken): Asynchronously writes an array of values to a 32-bit unsigned integer register with the specified address.

WriteUInt64Async(int, ulong, CancellationToken): Asynchronously writes a value to a 64-bit unsigned integer register with the specified address.

WriteUInt64Async(int, ulong[], CancellationToken): Asynchronously writes an array of values to a 64-bit unsigned integer register with the specified address.

Edit this page