Class Ssd1681

Namespace

Iot.Device.EPaper.Drivers.Ssd168x.Ssd1681

Assembly

Iot.Device.ePaper.dll

A driver class for the SSD1681 display controller.

public sealed class Ssd1681 : Ssd168x, IEPaperDisplay

Inheritance

object

Ssd168x

Ssd1681

Implements

IEPaperDisplay

Inherited Members

Ssd168x.SpiClockFrequency

Ssd168x.SpiMode

Ssd168x.BeginFrameDraw()

Ssd168x.Clear(bool)

Ssd168x.DirectDrawBuffer(int, int, params byte[])

Ssd168x.DirectDrawColorBuffer(int, int, params byte[])

Ssd168x.DrawPixel(int, int, bool)

Ssd168x.DrawPixel(int, int, Color)

Ssd168x.EndFrameDraw()

Ssd168x.Flush()

Ssd168x.Initialize()

Ssd168x.NextFramePage()

Ssd168x.PerformFullRefresh()

Ssd168x.PerformPartialRefresh()

Ssd168x.PowerDown(SleepMode)

Ssd168x.PowerOn()

Ssd168x.SendCommand(params byte[])

Ssd168x.SendData(params byte[])

Ssd168x.SendData(params ushort[])

Ssd168x.SetPosition(int, int)

Ssd168x.WaitReady(CancellationToken)

Ssd168x.Dispose()

Ssd168x.Width

Ssd168x.Height

Ssd168x.FrameBuffer

Ssd168x.PagedFrameDrawEnabled

Ssd168x.PowerState

Constructors

Ssd1681(SpiDevice, int, int, int, int, int, GpioController, bool, bool)

Initializes a new instance of the Ssd1681 class.

public Ssd1681(SpiDevice spiDevice, int resetPin, int busyPin, int dataCommandPin, int width, int height, GpioController gpioController = null, bool enableFramePaging = true, bool shouldDispose = true)

Parameters

spiDevice SpiDevice

The communication channel to the SSD1681-based dispay.

resetPin int

The reset GPIO pin. Passing an invalid pin number such as -1 will prevent this driver from opening the pin. Caller should handle hardware resets.

busyPin int

The busy GPIO pin.

dataCommandPin int

The data/command GPIO pin.

width int

The width of the display.

height int

The height of the display.

gpioController GpioController

The GpioController to use when initializing the pins.

enableFramePaging bool

Page the frame buffer and all operations to use less memory.

shouldDispose bool

true to dispose of the GpioController.

Remarks

For a 200x200 SSD1681 display, a full Frame requires about 5KB of RAM ((200 * 200) / 8). SSD1681 has 2 RAMs for B/W and Red pixel. This means to have a full frame in memory, you need about 10KB of RAM. If you can't guarantee 10KB to be available to the driver then enable paging by setting enableFramePaging to true. A page uses about 2KB (1KB for B/W and 1KB for Red).

Exceptions

ArgumentNullException

spiDevice is null.

ArgumentOutOfRangeException

Display width and height can't be less than 0 or greater than 200.

Properties

PagesPerFrame

Gets the number of pages in every frame buffer.

protected override int PagesPerFrame { get; }

Property Value

int