Treehopper C# API
FlushableParallelInterface< T > Class Template Reference

A class that represents a WriteOnlyParallelInterface constructed from a IFlushableOutputPort<TDigitalPin> More...

Inheritance diagram for FlushableParallelInterface< T >:
WriteOnlyParallelInterface

Public Member Functions

 FlushableParallelInterface (IFlushableOutputPort< T > outputPort)
 Construct a FlushableParallelInterface from a IFlushableOutputPort<TDigitalPin>. 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...
 

Public Attributes

int Width => DataBus.Count
 Gets the width of the bus More...
 

Properties

Collection< DigitalOutDataBus = new Collection<DigitalOut>() [get, set]
 A collection of pins to use for the data bus More...
 
DigitalOut RegisterSelectPin [get, set]
 The Register Select (RS) pin to use More...
 
DigitalOut ReadWritePin [get, set]
 The Read/Write (R/W) pin to use More...
 
DigitalOut EnablePin [get, set]
 The enable (E) pin to use More...
 
int DelayMicroseconds [get, set]
 The number of microseconds to delay between transactions. More...
 
bool Enabled [get, set]
 Whether this parallel interface is enabled or disabled More...
 

Detailed Description

A class that represents a WriteOnlyParallelInterface constructed from a IFlushableOutputPort<TDigitalPin>

Template Parameters
TA type that implements DigitalOut
Type Constraints
T :DigitalOut 

Constructor & Destructor Documentation

◆ FlushableParallelInterface()

Construct a FlushableParallelInterface from a IFlushableOutputPort<TDigitalPin>.

Parameters
outputPort

Member Function Documentation

◆ WriteCommandAsync()

Task WriteCommandAsync ( uint []  command)

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

Implements WriteOnlyParallelInterface.

◆ WriteDataAsync()

Task WriteDataAsync ( uint []  data)

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

Implements WriteOnlyParallelInterface.

Member Data Documentation

◆ Width

int Width => DataBus.Count

Gets the width of the bus

Property Documentation

◆ DataBus

Collection<DigitalOut> DataBus = new Collection<DigitalOut>()
getset

A collection of pins to use for the data bus

◆ RegisterSelectPin

DigitalOut RegisterSelectPin
getset

The Register Select (RS) pin to use

◆ ReadWritePin

DigitalOut ReadWritePin
getset

The Read/Write (R/W) pin to use

◆ EnablePin

DigitalOut EnablePin
getset

The enable (E) pin to use

◆ DelayMicroseconds

int DelayMicroseconds
getset

The number of microseconds to delay between transactions.

◆ Enabled

bool Enabled
getset

Whether this parallel interface is enabled or disabled


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