Class EPaperBase

Represents a base ePaper display driver

Assembly: EPaper.dll

View Source

public abstract class EPaperBase : ISpiPeripheral, IDisposable

Derived:
Meadow.Foundation.Displays.EPaperMonoBase, Meadow.Foundation.Displays.EPaperTriColorBase, Meadow.Foundation.Displays.Epd5in65f

Implements:
Meadow.Hardware.ISpiPeripheral, System.IDisposable

Properties

DefaultSpiBusSpeed

The default SPI bus speed for the device

View Source

public Frequency DefaultSpiBusSpeed { get; }

SpiBusSpeed

The SPI bus speed for the device

View Source

public Frequency SpiBusSpeed { get; set; }

DefaultSpiBusMode

The default SPI bus mode for the device

View Source

public SpiClockConfiguration.Mode DefaultSpiBusMode { get; }

SpiBusMode

The SPI bus mode for the device

View Source

public SpiClockConfiguration.Mode SpiBusMode { get; set; }

IsDisposed

Is the object disposed

View Source

public bool IsDisposed { get; }

Fields

commandBuffer

The command buffer

View Source

protected readonly byte[] commandBuffer

dataCommandPort

Data command port

View Source

protected IDigitalOutputPort? dataCommandPort

resetPort

Reset port

View Source

protected IDigitalOutputPort? resetPort

chipSelectPort

Chip select port

View Source

protected IDigitalOutputPort? chipSelectPort

busyPort

Busy indicator port

View Source

protected IDigitalInputPort? busyPort

spiComms

SPI Communication bus used to communicate with the peripheral

View Source

protected ISpiCommunications? spiComms

DataState

Const bool representing the data state

View Source

protected const bool DataState = true

CommandState

Const bool representing the command state

View Source

protected const bool CommandState = false

createdPorts

Did we create the port(s) used by the peripheral

View Source

protected bool createdPorts

Methods

Write(byte)

Write a value to the display

View Source

protected void Write(byte value)

Parameters

Type	Name	Description
System.Byte	value	The value as a byte

Reset()

Reset the display

View Source

protected virtual void Reset()

DelayMs(int)

Delay for a specified amount of time

View Source

protected void DelayMs(int millseconds)

Parameters

Type	Name	Description
System.Int32	millseconds	The time in milliseconds

SendCommand(byte)

Send a command to the display

View Source

protected void SendCommand(byte command)

Parameters

Type	Name	Description
System.Byte	command	The command value

SendData(int)

Send data to the display

View Source

protected void SendData(int data)

Parameters

Type	Name	Description
System.Int32	data	The data (is cast to a byte)

SendData(byte)

Send data to the display

View Source

protected void SendData(byte data)

Parameters

Type	Name	Description
System.Byte	data	The data

SendData(byte[])

Send data to the display

View Source

protected void SendData(byte[] data)

Parameters

Type	Name	Description
System.Byte[]	data	The data

WaitUntilIdle()

Wait until the display is idle (not busy)

View Source

protected virtual void WaitUntilIdle()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

View Source

public void Dispose()

Dispose(bool)

Dispose of the object

View Source

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Is disposing

Implements

• Meadow.Hardware.ISpiPeripheral
• System.IDisposable