Meadow.Foundation.Displays.TftSpiBase

TftSpi
Status
Source code	GitHub
NuGet package

The Meadow.Foundation TftSpi package contains a selection of drivers for common color displays that use the SPI bus. This includes common TFT and color OLED displays.

These displays commonly include additional pins for Reset, Data control and Chip select. If your display doesn't include any of these pins, you can typically pass null for that pin.

Some displays require alternate SPI modes. If your display isn't working, try creating a SpiClockConfiguration, set the SPI mode, and pass it to the SpiBus during instantiation. See the ST7789 sample for an example.

Sample projects available on GitHub

Class TftSpiBase

Base class for TFT SPI displays These displays typically support 16 and 18 bit, some also include 8, 9, 12 and/or 24 bit color

Assembly: TftSpi.dll

View Source

Declaration

public abstract class TftSpiBase : IPixelDisplay, IDisplay, ISpiPeripheral, IDisposable

Derived:

Expand

Meadow.Foundation.Displays.Gc9a01

Implements:
Meadow.Peripherals.Displays.IPixelDisplay, Meadow.Peripherals.Displays.IDisplay, Meadow.Hardware.ISpiPeripheral, System.IDisposable

Properties

SetAddressBuffer

Temporary buffer that can be used to batch set address window buffer commands

View Source

Declaration

protected byte[] SetAddressBuffer { get; }

ColorMode

The currently set color mode for the display

View Source

Declaration

public ColorMode ColorMode { get; }

SupportedColorModes

The Color mode supported by the display

View Source

Declaration

public abstract ColorMode SupportedColorModes { get; }

Rotation

The current rotation of the display

View Source

Declaration

public RotationType Rotation { get; protected set; }

DefaultColorMode

The display default color mode

View Source

Declaration

public abstract ColorMode DefaultColorMode { get; }

Width

Width of the display in pixels

View Source

Declaration

public int Width { get; }

Height

Height of the display in pixels

View Source

Declaration

public int Height { get; }

PixelBuffer

Provide a buffer that matches this display's color depth, height, and width This should be the buffer that is sent to the device when Show is called

View Source

Declaration

public IPixelBuffer PixelBuffer { get; }

DefaultSpiBusSpeed

The default SPI bus speed for the device

View Source

Declaration

public virtual Frequency DefaultSpiBusSpeed { get; }

SpiBusSpeed

The SPI bus speed for the device

View Source

Declaration

public Frequency SpiBusSpeed { get; set; }

DefaultSpiBusMode

The default SPI bus mode for the device

View Source

Declaration

public virtual SpiClockConfiguration.Mode DefaultSpiBusMode { get; }

SpiBusMode

The SPI bus mode for the device

View Source

Declaration

public SpiClockConfiguration.Mode SpiBusMode { get; set; }

IsDisposed

Is the object disposed

View Source

Declaration

public bool IsDisposed { get; }

Fields

dataCommandPort

The data command port

View Source

Declaration

protected IDigitalOutputPort dataCommandPort

resetPort

The reset port

View Source

Declaration

protected IDigitalOutputPort? resetPort

chipSelectPort

The chip select port

View Source

Declaration

protected IDigitalOutputPort? chipSelectPort

spiDisplay

The spi peripheral for the display

View Source

Declaration

protected ISpiCommunications spiDisplay

imageBuffer

The off-screen image buffer

View Source

Declaration

protected IPixelBuffer imageBuffer

readBuffer

The read buffer

View Source

Declaration

protected Memory<byte> readBuffer

Data

Data convenience bool

View Source

Declaration

protected const bool Data = true

Command

Command convenience bool

View Source

Declaration

protected const bool Command = false

nativeHeight

The display's native height without rotation

View Source

Declaration

protected int nativeHeight

nativeWidth

The display's native width without rotation

View Source

Declaration

protected int nativeWidth

setAddressLastX0

Previous x0 value passed to SetAddressWindow Used for optimization to avoid unnecessary SPI commands

View Source

Declaration

protected int setAddressLastX0

setAddressLastX1

Previous x1 value passed to SetAddressWindow Used for optimization to avoid unnecessary SPI commands

View Source

Declaration

protected int setAddressLastX1

setAddressLastY0

Previous y0 value passed to SetAddressWindow Used for optimization to avoid unnecessary SPI commands

View Source

Declaration

protected int setAddressLastY0

setAddressLastY1

Previous y1 value passed to SetAddressWindow Used for optimization to avoid unnecessary SPI commands

View Source

Declaration

protected int setAddressLastY1

Methods

Initialize()

Initialize the display

View Source

Declaration

protected abstract void Initialize()

SetColorMode(ColorMode)

Set color mode for the display

View Source

Declaration

public virtual void SetColorMode(ColorMode colorMode)

Parameters

Type	Name
Meadow.Peripherals.Displays.ColorMode	colorMode

Exceptions

System.ArgumentException
throw if the color mode isn't supported by the display

IsColorTypeSupported(ColorMode)

Is the color mode supported on this display

View Source

Declaration

public virtual bool IsColorTypeSupported(ColorMode colorType)

Returns

System.Boolean: true if supported

Parameters

Type	Name	Description
Meadow.Peripherals.Displays.ColorMode	colorType	The color mode

CreateBuffer(ColorMode, int, int)

Create an off-screen buffer for the display

View Source

Declaration

protected void CreateBuffer(ColorMode colorMode, int width, int height)

Parameters

Type	Name	Description
Meadow.Peripherals.Displays.ColorMode	colorMode	The color mode
System.Int32	width	The width in pixels
System.Int32	height	The height in pixels

Exceptions

System.ArgumentException
Throws an exception if the color mode isn't supported

SetAddressWindow(int, int, int, int)

Set address window for display updates

View Source

Declaration

protected virtual void SetAddressWindow(int x0, int y0, int x1, int y1)

Parameters

Type	Name	Description
System.Int32	x0	X start in pixels
System.Int32	y0	Y start in pixels
System.Int32	x1	X end in pixels
System.Int32	y1	Y end in pixels

Clear(bool)

Clear the display.

View Source

Declaration

public void Clear(bool updateDisplay = false)

Parameters

Type	Name	Description
System.Boolean	updateDisplay	Update the display once the buffer has been cleared when true.

Fill(Color, bool)

Fill the display buffer with a color

View Source

Declaration

public void Fill(Color color, bool updateDisplay = false)

Parameters

Type	Name	Description
Meadow.Color	color	The fill color
System.Boolean	updateDisplay	If true, update the display after filling the buffer

WriteBuffer(int, int, IPixelBuffer)

Write a buffer to the display off-screen buffer

View Source

Declaration

public void WriteBuffer(int x, int y, IPixelBuffer buffer)

Parameters

Type	Name	Description
System.Int32	x	The x position in pixels to write the buffer
System.Int32	y	The y position in pixels to write the buffer
Meadow.Peripherals.Displays.IPixelBuffer	buffer	The buffer to write

DrawPixel(int, int, bool)

Draw pixel at a location Primarily used for monochrome displays, prefer overload that accepts a Color

View Source

Declaration

public void DrawPixel(int x, int y, bool enabled)

Parameters

Type	Name	Description
System.Int32	x	x location in pixels
System.Int32	y	y location in pixels
System.Boolean	enabled	Turn the pixel on (true) or off (false).

DrawPixel(int, int, Color)

Draw a single pixel

View Source

Declaration

public void DrawPixel(int x, int y, Color color)

Parameters

Type	Name	Description
System.Int32	x	x location in pixels
System.Int32	y	y location in pixels
Meadow.Color	color	Color of pixel.

DrawPixel(int, int, byte, byte, byte)

Draw a single pixel

View Source

Declaration

public void DrawPixel(int x, int y, byte r, byte g, byte b)

Parameters

Type	Name	Description
System.Int32	x	x location in pixels
System.Int32	y	y location in pixels
System.Byte	r	8 bit red value
System.Byte	g	8 bit green value
System.Byte	b	8 bit blue value

InvertPixel(int, int)

Invert the color of a single pixel as represented in the display buffer

View Source

Declaration

public void InvertPixel(int x, int y)

Parameters

Type	Name	Description
System.Int32	x	x location in pixels
System.Int32	y	y location in pixels

Fill(int, int, int, int, Color)

Fill with a color

View Source

Declaration

public void Fill(int x, int y, int width, int height, Color color)

Parameters

Type	Name	Description
System.Int32	x	X start position in pixels
System.Int32	y	Y start position in pixels
System.Int32	width	Width in pixels
System.Int32	height	Height in pixels
Meadow.Color	color	The fill color

Show()

Draw the display buffer to screen

View Source

Declaration

public void Show()

Show(int, int, int, int)

Transfer part of the contents of the buffer to the display bounded by left, top, right and bottom

View Source

Declaration

public void Show(int left, int top, int right, int bottom)

Parameters

Type	Name
System.Int32	left
System.Int32	top
System.Int32	right
System.Int32	bottom

Write(byte)

Write a byte to the display

View Source

Declaration

protected void Write(byte value)

Parameters

Type	Name	Description
System.Byte	value	The byte to send

Write(byte[])

Write a buffer to the display

View Source

Declaration

protected void Write(byte[] data)

Parameters

Type	Name	Description
System.Byte[]	data	The data to send

DelayMs(int)

Delay

View Source

Declaration

protected void DelayMs(int millseconds)

Parameters

Type	Name	Description
System.Int32	millseconds	Milliseconds to delay

SendCommand(Register)

Send a command to the display

View Source

Declaration

protected void SendCommand(TftSpiBase.Register command)

Parameters

Type	Name	Description
Meadow.Foundation.Displays.TftSpiBase.Register	command	The command to send

SendCommand(LcdCommand)

Send a command to the display

View Source

Declaration

protected void SendCommand(TftSpiBase.LcdCommand command)

Parameters

Type	Name	Description
Meadow.Foundation.Displays.TftSpiBase.LcdCommand	command	The command to send as an LcdCommand

SendCommand(byte)

Send a command to the display

View Source

Declaration

protected void SendCommand(byte command)

Parameters

Type	Name	Description
System.Byte	command	The command to send as a byte

SendData(int)

Send a single byte to the display (convenience method)

View Source

Declaration

protected void SendData(int data)

Parameters

Type	Name	Description
System.Int32	data	The data to send

SendData(byte)

Send a single byte to the display

View Source

Declaration

protected void SendData(byte data)

Parameters

Type	Name	Description
System.Byte	data	The byte to send

SendData(byte[])

Send a byte array of data to the display

View Source

Declaration

protected void SendData(byte[] data)

Parameters

Type	Name	Description
System.Byte[]	data	The data

Clear(Color)

Clear the display buffer to a color

View Source

Declaration

public void Clear(Color color)

Parameters

Type	Name	Description
Meadow.Color	color	The clear color

UpdateBuffer()

Update the display buffer if the dimensions change on rotation

View Source

Declaration

protected void UpdateBuffer()

Dispose()

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

View Source

Declaration

public void Dispose()

Dispose(bool)

Dispose of the object

View Source

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Is disposing

Implements

• Meadow.Peripherals.Displays.IPixelDisplay
• Meadow.Peripherals.Displays.IDisplay
• Meadow.Hardware.ISpiPeripheral
• System.IDisposable