InterfaceSH1106< I > Class Template Reference

#include <lcd_sh1106.h>

Inheritance diagram for InterfaceSH1106< I >:

Collaboration diagram for InterfaceSH1106< I >:

Public Member Functions
template<typename... Args>
	InterfaceSH1106 (NanoDisplayBase< InterfaceSH1106< I >> &base, int8_t dc, Args &&... data)
void	startBlock (lcduint_t x, lcduint_t y, lcduint_t w)
	Sets block in RAM of lcd display controller to write data to. More...
void	nextBlock ()
void	endBlock ()
void	setDataMode (uint8_t mode)
void	commandStart ()
void	setStartLine (uint8_t line)
uint8_t	getStartLine ()
void	normalMode ()
void	invertMode ()
void	setContrast (uint8_t contrast)
void	displayOff ()
void	displayOn ()
void	flipHorizontal (uint8_t mode)
	performs horizontal flip More...
void	flipVertical (uint8_t mode)
	performs vertical flip More...

Detailed Description

template<typename I>
class InterfaceSH1106< I >

Class implements interface functions to SH1106 displays

Definition at line 43 of file lcd_sh1106.h.

Constructor & Destructor Documentation

InterfaceSH1106()

template<typename I>

template<typename... Args>

InterfaceSH1106< I >::InterfaceSH1106 ( NanoDisplayBase< InterfaceSH1106< I >> &  base, int8_t  dc, Args &&...  data  )

inline

Creates instance of interface to LCD display.

Parameters

base	Reference to base class, which represents Display
dc	Data/command control pin number, for i2c communication should be -1
data	variable argument list, accepted by platform interface (PlatformI2c, PlatformSpi)

Definition at line 54 of file lcd_sh1106.h.

Member Function Documentation

commandStart()

template<class I >

void InterfaceSH1106< I >::commandStart

(

)

Starts communication with LCD display in command mode. To stop communication use m_intf.end().

Definition at line 74 of file lcd_sh1106.inl.

displayOff()

template<class I >

void InterfaceSH1106< I >::displayOff

(

)

Turns off display

Definition at line 118 of file lcd_sh1106.inl.

displayOn()

template<class I >

void InterfaceSH1106< I >::displayOn

(

)

Turns on display

Definition at line 125 of file lcd_sh1106.inl.

endBlock()

template<class I >

void InterfaceSH1106< I >::endBlock

(

)

Closes data send operation to lcd display.

Definition at line 61 of file lcd_sh1106.inl.

flipHorizontal()

template<class I >

void InterfaceSH1106< I >::flipHorizontal

(

uint8_t

mode

)

performs horizontal flip

Performs horizontal flip. If you need to turn display by 180 degree, please use both flipHorizontal() and flipVertical().

Parameters

mode	- 0 to disable horizontal flip 1 to enable horizontal flip

Definition at line 132 of file lcd_sh1106.inl.

flipVertical()

template<class I >

void InterfaceSH1106< I >::flipVertical

(

uint8_t

mode

)

performs vertical flip

Performs vertical flip. If you need to turn display by 180 degree, please use both flipHorizontal() and flipVertical().

Parameters

mode	- 0 to disable vertical flip 1 to enable vertical flip

Definition at line 139 of file lcd_sh1106.inl.

getStartLine()

template<class I >

uint8_t InterfaceSH1106< I >::getStartLine

(

)

returns start line in gdram.

Definition at line 91 of file lcd_sh1106.inl.

invertMode()

template<class I >

void InterfaceSH1106< I >::invertMode

(

)

Switches display to normal mode. This feature is specific for SH1106 based controllers.

Definition at line 103 of file lcd_sh1106.inl.

nextBlock()

template<class I >

void InterfaceSH1106< I >::nextBlock

(

)

Switches to the start of next RAM page for the block, specified by startBlock(). For SSD1306 it does nothing, while for SH1106 the function moves cursor to next page.

Definition at line 55 of file lcd_sh1106.inl.

normalMode()

template<class I >

void InterfaceSH1106< I >::normalMode

(

)

Switches display to normal mode. This feature is specific for SH1106 based controllers.

Definition at line 96 of file lcd_sh1106.inl.

setContrast()

template<class I >

void InterfaceSH1106< I >::setContrast

(

uint8_t

contrast

)

Set display contrast, ie light intensity

Parameters

contrast

- contrast value to see, refer to SH1106 datasheet

Definition at line 110 of file lcd_sh1106.inl.

setDataMode()

template<class I >

void InterfaceSH1106< I >::setDataMode

(

uint8_t

mode

)

Enables either data or command mode on SPI bus

Parameters

mode	1 to enable data mode, or 0 to enable command mode

Definition at line 66 of file lcd_sh1106.inl.

setStartLine()

template<class I >

void InterfaceSH1106< I >::setStartLine

(

uint8_t

line

)

Sets start line in gdram to start display content with

Parameters

line	start line in range 0 - 63

Definition at line 83 of file lcd_sh1106.inl.

startBlock()

template<class I >

void InterfaceSH1106< I >::startBlock	(	lcduint_t	x,
		lcduint_t	y,
		lcduint_t	w
	)

Sets block in RAM of lcd display controller to write data to.

Sets block in RAM of lcd display controller to write data to. For SH1106 it uses horizontal addressing mode, while for sh1106 the function uses page addressing mode. Width can be specified as 0, thus the library will set the right boundary to region of RAM block to the right column of the display.

Parameters

x	- column (left region)
y	- row (top region)
w	- width of the block in pixels to control

Warning

- this function initiates session (i2c or spi) and does not close it. To close session, please, call endBlock().

Definition at line 35 of file lcd_sh1106.inl.

---

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

• src/v2/lcd/sh1106/lcd_sh1106.h
• src/v2/lcd/sh1106/lcd_sh1106.inl