Characteristic Locus
Inheritance object > EPaperBase > EPaperMonoBase > EPaperTriColorBase > Epd5in65f
Implements ISpiPeripheral IDisposable
Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString()
Namespace Meadow.Foundation.Displays
Assembly EPaper.dll

Syntax

public abstract class EPaperBase : ISpiPeripheral, IDisposable

Fields

CommandState

Const bool representing the command state

Declaration
protected const bool CommandState = false

Field Value

Type Description
bool

DataState

Const bool representing the data state

Declaration
protected const bool DataState = true

Field Value

Type Description
bool

busyPort

Busy indicator port

Declaration
protected IDigitalInputPort? busyPort

Field Value

Type Description
IDigitalInputPort

chipSelectPort

Chip select port

Declaration
protected IDigitalOutputPort? chipSelectPort

Field Value

Type Description
IDigitalOutputPort

commandBuffer

The command buffer

Declaration
protected readonly byte[] commandBuffer

Field Value

Type Description
byte[]

createdPorts

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

Declaration
protected bool createdPorts

Field Value

Type Description
bool

dataCommandPort

Data command port

Declaration
protected IDigitalOutputPort? dataCommandPort

Field Value

Type Description
IDigitalOutputPort

resetPort

Reset port

Declaration
protected IDigitalOutputPort? resetPort

Field Value

Type Description
IDigitalOutputPort

spiComms

SPI Communication bus used to communicate with the peripheral

Declaration
protected ISpiCommunications? spiComms

Field Value

Type Description
ISpiCommunications

Properties

DefaultSpiBusMode

The default SPI bus mode for the device

Declaration
public SpiClockConfiguration.Mode DefaultSpiBusMode { get; }

Property Value

Type Description
SpiClockConfiguration.Mode

DefaultSpiBusSpeed

The default SPI bus speed for the device

Declaration
public Frequency DefaultSpiBusSpeed { get; }

Property Value

Type Description
Frequency

IsDisposed

Is the object disposed

Declaration
public bool IsDisposed { get; }

Property Value

Type Description
bool

SpiBusMode

The SPI bus mode for the device

Declaration
public SpiClockConfiguration.Mode SpiBusMode { get; set; }

Property Value

Type Description
SpiClockConfiguration.Mode

SpiBusSpeed

The SPI bus speed for the device

Declaration
public Frequency SpiBusSpeed { get; set; }

Property Value

Type Description
Frequency

Methods

DelayMs(int)

Delay for a specified amount of time

Declaration
protected void DelayMs(int millseconds)

Parameters

Type Name Description
int millseconds

The time in milliseconds

Dispose()

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

Declaration
public void Dispose()

Dispose(bool)

Dispose of the object

Declaration
protected virtual void Dispose(bool disposing)

Parameters

Type Name Description
bool disposing

Is disposing

Reset()

Reset the display

Declaration
protected virtual void Reset()

SendCommand(byte)

Send a command to the display

Declaration
protected void SendCommand(byte command)

Parameters

Type Name Description
byte command

The command value

SendData(byte)

Send data to the display

Declaration
protected void SendData(byte data)

Parameters

Type Name Description
byte data

The data

SendData(byte[])

Send data to the display

Declaration
protected void SendData(byte[] data)

Parameters

Type Name Description
byte[] data

The data

SendData(int)

Send data to the display

Declaration
protected void SendData(int data)

Parameters

Type Name Description
int data

The data (is cast to a byte)

WaitUntilIdle()

Wait until the display is idle (not busy)

Declaration
protected virtual void WaitUntilIdle()

Write(byte)

Write a value to the display

Declaration
protected void Write(byte value)

Parameters

Type Name Description
byte value

The value as a byte