Inheritance diagram for Pcd8544:

Public Member Functions
	Pcd8544 (Spi spi, SpiChipSelectPin csPin, DigitalOut dc, DigitalOut rst, byte biasValue=0x04)

async Task	SetCursorPosition (int left, int top)
	Set left/right cursor position More...

void	SetPixel (int row, int column, bool state)
	Set a pixel's state. More...

async Task	Write (dynamic value)
	Display an alphanumeric value using a 5x7 font at the given character column and row More...

async Task	WriteLine (dynamic value)
	Write a line of text, advancing the cursor to the next line More...

override Task	Clear ()
	Clear the display More...

Task	FlushAsync (bool force=false)
	Flush changed data to the port expander More...

Protected Member Functions
override async Task	flush ()
	Flush any updates to the RawBuffer to the display More...

override void	setBrightness (double brightness)
	Sets the global brightness of the graphic display More...

Properties
bool [,]	PixelBuffer `[get, set]`
	The raw byte buffer used by the display in its native format More...

int	Columns `[get]`

int	Rows `[get]`

int	CursorLeft `[get, set]`

int	CursorTop `[get, set]`

int	Height `[get, protected set]`
	The height of the display, in pixels More...

int	Width `[get, protected set]`
	The width of the display, in pixels. More...

byte []	RawBuffer `[get, protected set]`
	The raw byte buffer used by the display in its native format More...

double	Brightness `[get, set]`
	Gets or sets the global brightness of the display More...

bool	AutoFlush = true `[get, set]`

IFlushable	Parent `[get]`

Constructor & Destructor Documentation

◆ Pcd8544()

Pcd8544	(	Spi	spi,
		SpiChipSelectPin	csPin,
		DigitalOut	dc,
		DigitalOut	rst,
		byte	biasValue = `0x04`
	)

Member Function Documentation

◆ flush()

override async Task flush ( )

protectedvirtual

Flush any updates to the RawBuffer to the display

Returns: An awaitable task that completes upon sending the update to the display

Internal function called by the implementation to flush the RawBuffer to the display

Returns: An awaitable task that completes upon success

Implements GraphicDisplay.

◆ setBrightness()

override void setBrightness ( double brightness )

protectedvirtual

Sets the global brightness of the graphic display

Parameters

brightness The brightness of the display

Implements GraphicDisplay.

◆ SetCursorPosition()

async Task SetCursorPosition	(	int	left,
		int	top
	)

inherited

Set left/right cursor position

Parameters

left	The left position
top	The top position

Returns: An awaitable task that completes once the cursor is updated

Implements ICharacterDisplay.

◆ SetPixel()

void SetPixel	(	int	row,
		int	column,
		bool	state
	)

inherited

Set a pixel's state.

You must explicitly flush to the display to write out the changes.

Parameters

row	The row of the pixel
column	The column of the pixel
state	Whether the pixel should be on or off

◆ Write()

async Task Write ( dynamic value )

inherited

Display an alphanumeric value using a 5x7 font at the given character column and row

Parameters

value The alphanumeric value to use

Returns: An awaitable task that will finish upon completion

This method is used for quickly rendering fixed-size sharp, monospaced text on a monochrome graphic display, allowing these displays to be dropped into a project in place of a (usually more costly and older) character display. If you want control over the size and font family used to display the text, use the extremely extensible System.Drawing.Graphics class.

If you want control over

Implements ICharacterDisplay.

◆ WriteLine()

async Task WriteLine ( dynamic value )

inherited

Write a line of text, advancing the cursor to the next line

Parameters

value the text to write

Returns: An awaitable task that completes when finished

Implements ICharacterDisplay.

◆ Clear()

override Task Clear ( )

virtualinherited

Clear the display

Returns: An awaitable task

Reimplemented from GraphicDisplay.

◆ FlushAsync()

Task FlushAsync ( bool force = false )

inherited

Flush changed data to the port expander

Parameters

force whether to flush all data to the port expander, even if it doesn't appear to have been changed

Implements IFlushable.

Property Documentation

◆ PixelBuffer

bool [,] PixelBuffer

getsetinherited

The raw byte buffer used by the display in its native format

The format of this raw buffer depends on the particular implementation of this class

◆ Columns

int Columns

getinherited

◆ Rows

int Rows

getinherited

◆ CursorLeft

int CursorLeft

getsetinherited

◆ CursorTop

int CursorTop

getsetinherited

◆ Height

int Height

getprotected setinherited

The height of the display, in pixels

◆ Width

int Width

getprotected setinherited

The width of the display, in pixels.

◆ RawBuffer

byte [] RawBuffer

getprotected setinherited

The raw byte buffer used by the display in its native format

The format of this raw buffer depends on the particular implementation of this class

◆ Brightness

double Brightness

getsetinherited

Gets or sets the global brightness of the display

◆ AutoFlush

bool AutoFlush = true

getsetinherited

◆ Parent

IFlushable Parent

getinherited

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

F:/Git/treehopper-sdk/NET/API/Treehopper.Libraries/Displays/Pcd8544.cs

Public Member Functions

Protected Member Functions

Properties

Constructor & Destructor Documentation

◆ Pcd8544()

Member Function Documentation

◆ flush()

◆ setBrightness()

◆ SetCursorPosition()

◆ SetPixel()

◆ Write()

◆ WriteLine()

◆ Clear()

◆ FlushAsync()

Property Documentation

◆ PixelBuffer

◆ Columns

◆ Rows

◆ CursorLeft

◆ CursorTop

◆ Height

◆ Width

◆ RawBuffer

◆ Brightness

◆ AutoFlush

◆ Parent