Treehopper C# API
ReadWriteParallelInterface Interface Reference

A parallel interface that can read and write data More...

Inheritance diagram for ReadWriteParallelInterface:
WriteOnlyParallelInterface ParallelInterface

Public Member Functions

Task< ushort[]> ReadCommandAsync (uint command, int length)
 Read one or more words from the command register More...
 
Task< ushort[]> ReadDataAsync (int length)
 Read one or more words from the data register More...
 
Task WriteCommandAsync (uint[] command)
 Write one or more bytes to the command register More...
 
Task WriteDataAsync (uint[] data)
 Write one or more bytes to the data register More...
 

Properties

bool Enabled [get, set]
 Gets or sets whether the bus is enabled More...
 
int DelayMicroseconds [get, set]
 The minimum number of microseconds to delay between each word write. More...
 
int Width [get]
 Gets the width of the bus More...
 

Detailed Description

A parallel interface that can read and write data

Member Function Documentation

◆ ReadCommandAsync()

Task<ushort[]> ReadCommandAsync ( uint  command,
int  length 
)

Read one or more words from the command register

Parameters
commandThe command to write before reading
lengthThe number of words to read
Returns
The words read

Implemented in ParallelInterface.

◆ ReadDataAsync()

Task<ushort[]> ReadDataAsync ( int  length)

Read one or more words from the data register

Parameters
lengthThe number of words to read
Returns
The words read

Implemented in ParallelInterface.

◆ WriteCommandAsync()

Task WriteCommandAsync ( uint []  command)
inherited

Write one or more bytes to the command register

Parameters
commandThe command data to write
Returns
An awaitable task that completes when the write operation finishes

Implemented in FlushableParallelInterface< T >, and ParallelInterface.

◆ WriteDataAsync()

Task WriteDataAsync ( uint []  data)
inherited

Write one or more bytes to the data register

Parameters
dataThe data to write
Returns
An awaitable task that completes when the write operation finishes

Implemented in FlushableParallelInterface< T >, and ParallelInterface.

Property Documentation

◆ Enabled

bool Enabled
getsetinherited

Gets or sets whether the bus is enabled

◆ DelayMicroseconds

int DelayMicroseconds
getsetinherited

The minimum number of microseconds to delay between each word write.

◆ Width

int Width
getinherited

Gets the width of the bus


The documentation for this interface was generated from the following file: