ICharacterLcd Interface

Definition

Namespace:

Iot.Device.CharacterLcd

Assembly:

Iot.Device.Bindings.dll

Package:

Iot.Device.Bindings v3.0.0

Interface for character LCD Low-Level handler

public interface ICharacterLcd : IDisposable

type ICharacterLcd = interface
    interface IDisposable

Public Interface ICharacterLcd
Implements IDisposable

Derived

Iot.Device.CharacterLcd.Hd44780

Iot.Device.Display.Pcd8544

Implements

IDisposable

Properties

BacklightOn	Enable/disable the backlight. (Will always return false if no backlight pin was provided.)
BlinkingCursorVisible	Enable/disable the blinking cursor.
DisplayOn	Enable/disable the display.
NumberOfCustomCharactersSupported	Returns the number of custom characters for this display. A custom character is one that can be user-defined and assigned to a slot using CreateCustomCharacter(Int32, ReadOnlySpan<Byte>)
Size	Returns the size of the display.
UnderlineCursorVisible	Enable/disable the underline cursor.

Methods

Clear()	Clears the display and moves the cursor to the top left.
CreateCustomCharacter(Int32, Byte[])	Fill one of the 8 CGRAM locations (character codes 0 - 7) with custom characters. See CreateCustomCharacter(Int32, ReadOnlySpan<Byte>) for details.
CreateCustomCharacter(Int32, ReadOnlySpan<Byte>)	Fill one of the 8 CGRAM locations (character codes 0 - 7) with custom characters.
SetCursorPosition(Int32, Int32)	Moves the cursor to an explicit column and row position.
Write(Char[])	Write a raw byte stream to the display. Used if character translation already took place.
Write(ReadOnlySpan<Char>)	Write a raw byte stream to the display. Used if character translation already took place.
Write(String)	Write text to the display, without any character translation.

Extension Methods

CreateCustomCharacter(ICharacterLcd, Byte, Byte, Byte, Byte, Byte, Byte, Byte, Byte, Byte)

Creates a custom character for standard displays with 8-pixel-per-row characters. See CreateCustomCharacter(Int32, ReadOnlySpan<Byte>) for details.