Ssd1351 Class

Definition

Namespace:

Iot.Device.Ssd1351

Assembly:

Iot.Device.Bindings.dll

Package:

Iot.Device.Bindings v3.0.0

A single-chip CMOS OLED/PLED driver with controller for organic/polymer light emitting diode dot-matrix graphic display system.

C#

public class Ssd1351 : IDisposable

Inheritance

Object

Ssd1351

Implements

IDisposable

Constructors

Ssd1351(SpiDevice, Int32, Int32, Int32, GpioController, Boolean)

Initializes new instance of Ssd1351 device that will communicate using SPI bus. A single-chip CMOS OLED/PLED driver with controller for organic/polymer light emitting diode dot-matrix graphic display system.

Methods

ClearScreen()	Clears screen
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
FillRect(Color, Byte, Byte, Byte, Byte)	Send filled rectangle to the ssd1351 display.
GetBitmapPixelData(BitmapImage, Rectangle)	Convert a bitmap into an array of pixel data suitable for sending to the display
Lock()	This command is used to lock the OLED driver IC from accepting any command except itself.
MakeAccessible()	Make commands A2,B1,B3,BB,BE,C1 accessible in the unlocked state
MakeInaccessible()	Make commands A2,B1,B3,BB,BE,C1 inaccessible in both lock and unlock state
ResetDisplayAsync()	Resets the display.
SendBitmap(BitmapImage, Point, Rectangle)	Send a bitmap to the ssd1351 display specifying the starting position and destination clipping rectangle.
SendBitmap(BitmapImage, Rectangle)	Send a bitmap to the ssd1351 display specifying the starting position and destination clipping rectangle.
SendBitmap(BitmapImage)	Send a bitmap to the ssd1351 display specifying the starting position and destination clipping rectangle.
SendBitmapPixelData(Span<Byte>, Rectangle)	Send an array of pixel data to the display.
SendData(Span<Byte>)	Send data to the display controller.
Set3rdPreChargePeriod(Byte)	This double byte command is used to set the phase 3 second pre-charge period. The period of phase 3 is ranged from 1 to 15 DCLK's.
SetColumnAddress(Byte, Byte)	This triple byte command specifies column start address and end address of the display data RAM. This command also sets the column address pointer to column start address. This pointer is used to define the current read/write column address in graphic display data RAM. If horizontal address increment mode is enabled by command 20h, after finishing read/write one column data, it is incremented automatically to the next column address. Whenever the column address pointer finishes accessing the end column address, it is reset back to start column address and the row address is incremented to the next row. This command is only for horizontal or vertical addressing modes.
SetContrastABC(Byte, Byte, Byte)	This command is used to set Contrast Setting of the display. The chip has 256 contrast steps from 00h to FFh. The segment output current ISEG increases linearly with the contrast step, which results in brighter display.
SetDisplayAllOff()	This command sets the display to have all pixels at GS0.
SetDisplayAllOn()	This command sets the display to have all pixels at GS63.
SetDisplayClockDivideRatioOscillatorFrequency(Byte, Byte)	This command sets the divide ratio to generate DCLK (Display Clock) from CLK and programs the oscillator frequency Fosc that is the source of CLK if CLS pin is pulled high.
SetDisplayEnhancement(Boolean)	This command enhances display performance.
SetDisplayOff()	This command turns the OLED panel display off.
SetDisplayOffset(Byte)	This command specifies the mapping of the display start line to one of COM0-COM127 (assuming that COM0 is the display start line then the display start line register is equal to 0).
SetDisplayOn()	This command turns the OLED panel display on.
SetDisplayStartLine(Byte)	This command sets the Display Start Line register to determine starting address of display RAM, by selecting a value from 0 to 127. With value equal to 0, RAM row 0 is mapped to COM0. With value equal to 1, RAM row 1 is mapped to COM0 and so on.
SetGpio(GpioMode, GpioMode)	This double byte command is used to set the states of GPIO0 and GPIO1 pins
SetGrayLevels(Byte[])	This command sets the gray levels GS0 -> GS63.
SetHorizontalScroll(ScrollDirection, Byte, Byte, ScrollSpeed)	Set Horizontal Scroll
SetInverseDisplay()	This command sets the display to be inverse. The gray level of display data are swapped such that “GS0” ↔ “GS63”, “GS1” ↔ “GS62”
SetMasterContrast(Byte)	This double byte command is to control the segment output current by a scaling factor. The chip has 16 master control steps, with the factor ranges from 1 [0000b] to 16 [1111b – default]. The smaller the master current value, the dimmer the OLED panel display is set. For example, if original segment output current is 160uA at scale factor = 16, setting scale factor to 8 would reduce the current to 80uA
SetMultiplexRatio(Byte)	This command switches the default 63 multiplex mode to any multiplex ratio, ranging from 15 to 127. The output pads COM0-COM127 will be switched to the corresponding COM signal.
SetNormalDisplay()	This command sets the display to be normal where the display reflects the contents of the RAM..
SetPreChargePeriods(Byte, Byte)	This double byte command sets the length of phase 1 and 2 of segment waveform of the driver. Phase 1: Set the period from 5 to 31 in the unit of 2 DCLKs. A larger capacitance of the OLED pixel may require longer period to discharge the previous data charge completely. Phase 2 (A[7:4]): Set the period from 3 to 15 in the unit of DCLKs. A longer period is needed to charge up a larger capacitance of the OLED pixel to the target voltage.
SetPreChargeVoltageLevel(Byte)	This double byte command is used to set the pre-charge voltage level. The precharge voltage level ranges from 0.20 x Vcc -> 0.60 x Vcc.
SetRowAddress(Byte, Byte)	This triple byte command specifies row start address and end address of the display data RAM.This command also sets the row address pointer to row start address.This pointer is used to define the current read/write row address in graphic display data RAM. If vertical address increment mode is enabled by command A0h, after finishing read/write one row data, it is incremented automatically to the next row address. Whenever the row address pointer finishes accessing the end row address, it is reset back to start row address.
SetSegmentReMapColorDepth(ColorDepth, CommonSplit, Seg0Common, ColorSequence)	This command changes the mapping between the display data column address and the segment driver. It allows flexibility in OLED module design. This command only affects subsequent data input. Data already stored in GDDRAM will have no changes.
SetVcomhDeselectLevel(VComHDeselectLevel)	This double byte command sets the high voltage level of common pins, VCOMH. The level of VCOMH is programmed with reference to VC.
SetVDDSource(VDDSource)	This double byte command is used to enable or disable the VDD regulator
SetVSL(Byte, Byte, Byte)	Set the segment voltage reference values. Note that for the Adafruit board then use the defaults (in fact not sure if you can use anything but the defaults accoring to the datasheet)
StartScrolling()	Start horizontal scrolling
StopScrolling()	Stop horizontal scrolling
Unlock()	This command allows the driver IC to resume from the “Lock” state. And the driver IC will then respond to the command and memory access.

Applies to