Karl Zweimüller / UniGraphic

UniGraphic-Fork for ST7920-LCD-controller and SH1106. Tested with 128x64 LCD with SPI and 128x64-OLED with IIC

Dependents:   UniGraphic-St7920-Test AfficheurUTILECO

Fork of UniGraphic by GraphicsDisplay

Embed: (wiki syntax)

« Back to documentation index

LCD Class Reference
Public Member Functions | Protected Member Functions

LCD Class Reference

A common base class for monochrome Display. More...

#include <LCD.h>

Inherits GraphicsDisplay.

Inherited by IST3020, SH1106, SSD1306, ST7565, ST7920, and UC1608.

Public Member Functions

 LCD (proto_t displayproto, PortName port, PinName CS, PinName reset, PinName DC, PinName WR, PinName RD, const int lcdsize_x, const int lcdsize_y, const int ic_x_segs, const int ic_y_coms, const char *name)
 Create a monochrome LCD Parallel Port interface.
 LCD (proto_t displayproto, PinName *buspins, PinName CS, PinName reset, PinName DC, PinName WR, PinName RD, const int lcdsize_x, const int lcdsize_y, const int ic_x_segs, const int ic_y_coms, const char *name)
 Create a monochrome LCD Parallel Bus interface.
 LCD (proto_t displayproto, int Hz, PinName mosi, PinName miso, PinName sclk, PinName CS, PinName reset, PinName DC, const int lcdsize_x, const int lcdsize_y, const int ic_x_segs, const int ic_y_coms, const char *name)
 Create a monochrome LCD SPI interface.
 LCD (proto_t displayproto, int Hz, int address, PinName sda, PinName scl, PinName reset, const int lcdsize_x, const int lcdsize_y, const int ic_x_segs, const int ic_y_coms, const char *name)
 Create a monochrome LCD I2C interface.
virtual ~LCD ()
 Destructor will free framebuffer.
virtual void pixel (int x, int y, unsigned short color)
 Draw a pixel in the specified color.
virtual void window (int x, int y, int w, int h)
 Set the window, which controls where items are written to the screen.
virtual unsigned short pixelread (int x, int y)
 Read pixel color at location.
virtual void window_pushpixel (unsigned short color)
 Push a single pixel into the window and increment position.
virtual void window_pushpixel (unsigned short color, unsigned int count)
 Push some pixels of the same color into the window and increment position.
virtual void window_pushpixelbuf (unsigned short *color, unsigned int lenght)
 Push array of pixel colors into the window and increment position.
virtual void copy_to_lcd ()
 Framebuffer is used, it needs to be sent to LCD from time to time.
virtual void set_contrast (int o)
 set the contrast of the screen
int get_contrast (void)
 read the contrast level
void invert (unsigned char o)
 display inverted colors
virtual void cls ()
 clear the entire screen The inherited one sets windomax then fill with background color We override it to speedup
void set_orientation (int o)
 Set the orientation of the screen x,y: 0,0 is always top left.
virtual void BusEnable (bool enable)
 Set ChipSelect high or low.
int sizeX ()
 get display X size in pixels (native, orientation independent)
int sizeY ()
 get display Y size in pixels (native, orientation independent)
virtual void WindowMax (void)
 Set window to max possible size May be overridden in a derived class.
virtual void circle (int x, int y, int r, unsigned short color)
 draw a circle
virtual void fillcircle (int x, int y, int r, unsigned short color)
 draw a filled circle
virtual void line (int x0, int y0, int x1, int y1, unsigned short color)
 draw a 1 pixel line
void hline (int x0, int x1, int y, unsigned short color)
 draw a horizontal line
void vline (int y0, int y1, int x, unsigned short color)
 draw a vertical line
virtual void rect (int x0, int y0, int x1, int y1, unsigned short color)
 draw a rect
virtual void fillrect (int x0, int y0, int x1, int y1, unsigned short color)
 draw a filled rect
virtual void locate (int x, int y)
 setup cursor position for text
virtual int _putc (int value)
 put a char on the screen
virtual void character (int x, int y, int c)
 draw a character on given position out of the active font to the TFT
void Bitmap (int x, int y, int w, int h, unsigned char *bitmap)
 paint a bitmap on the TFT
void Bitmap_BW (Bitmap_s bm, int x, int y)
 paint monochrome bitmap to screen
int BMP_16 (int x, int y, const char *Name_BMP)
 paint a 16 bit BMP from filesytem on the TFT (slow)
void set_font (unsigned char *f, unsigned char firstascii=32, unsigned char lastascii=127, bool proportional=true)
 select the font to use
void set_font_zoom (unsigned char x_mul, unsigned char y_mul)
 Zoom fount.
virtual int columns ()
 Get the number of columns based on the currently active font.
virtual int rows ()
 Get the number of rows based on the currently active font.
int width ()
 get the current oriented screen width in pixels
int height ()
 get the current oriented screen height in pixels
void set_width (int width)
 set the current oriented screen width in pixels
void set_height (int height)
 set the current oriented screen height in pixels
void set_auto_up (bool up)
 setup auto update of screen
bool get_auto_up (void)
 get status of the auto update function
virtual bool claim (FILE *stream)
 redirect output from a stream (stoud, sterr) to display
virtual void foreground (uint16_t colour)
 set the foreground color
virtual void background (uint16_t colour)
 set the background color

Protected Member Functions

virtual void mirrorXY (mirror_t mode)
 set mirror mode
void wr_cmd8 (unsigned char cmd)
 Send 8bit command to display controller.
void wr_data8 (unsigned char data)
 Send 8bit data to display controller.
void wr_cmd16 (unsigned short cmd)
 Send 16bit command to display controller.
virtual void wr_gram (unsigned short data, unsigned int count)
 Send same 16bit pixeldata to display controller multiple times.
virtual void wr_grambuf (unsigned short *data, unsigned int lenght)
 Send array of pixeldata shorts to display controller.
void hw_reset ()
 HW reset sequence (without display init commands)

Detailed Description

A common base class for monochrome Display.

Definition at line 35 of file LCD.h.

Constructor & Destructor Documentation

LCD ( proto_t  displayproto,
PortName  port,
PinName  CS,
PinName  reset,
PinName  DC,
PinName  WR,
PinName  RD,
const int  lcdsize_x,
const int  lcdsize_y,
const int  ic_x_segs,
const int  ic_y_coms,
const char *  name 
)

Create a monochrome LCD Parallel Port interface.

Parameters:
nameThe name used by the parent class to access the interface

Definition at line 33 of file LCD.cpp.

LCD ( proto_t  displayproto,
PinName *  buspins,
PinName  CS,
PinName  reset,
PinName  DC,
PinName  WR,
PinName  RD,
const int  lcdsize_x,
const int  lcdsize_y,
const int  ic_x_segs,
const int  ic_y_coms,
const char *  name 
)

Create a monochrome LCD Parallel Bus interface.

Parameters:
nameThe name used by the parent class to access the interface

Definition at line 53 of file LCD.cpp.

LCD ( proto_t  displayproto,
int  Hz,
PinName  mosi,
PinName  miso,
PinName  sclk,
PinName  CS,
PinName  reset,
PinName  DC,
const int  lcdsize_x,
const int  lcdsize_y,
const int  ic_x_segs,
const int  ic_y_coms,
const char *  name 
)

Create a monochrome LCD SPI interface.

Parameters:
nameThe name used by the parent class to access the interface

Definition at line 77 of file LCD.cpp.

LCD ( proto_t  displayproto,
int  Hz,
int  address,
PinName  sda,
PinName  scl,
PinName  reset,
const int  lcdsize_x,
const int  lcdsize_y,
const int  ic_x_segs,
const int  ic_y_coms,
const char *  name 
)

Create a monochrome LCD I2C interface.

Parameters:
nameThe name used by the parent class to access the interface

Definition at line 103 of file LCD.cpp.

~LCD (  ) [virtual]

Destructor will free framebuffer.

Definition at line 124 of file LCD.cpp.

Member Function Documentation

int _putc ( int  value ) [virtual, inherited]

put a char on the screen

Parameters:
valuechar to print
Returns:
printed char

Reimplemented from TextDisplay.

Definition at line 256 of file GraphicsDisplay.cpp.

void background ( uint16_t  colour ) [virtual, inherited]

set the background color

Note:
this method may be overridden in a derived class.
Parameters:
coloris color to use for background drawing.

Definition at line 61 of file TextDisplay.cpp.

void Bitmap ( int  x,
int  y,
int  w,
int  h,
unsigned char *  bitmap 
) [inherited]

paint a bitmap on the TFT

Parameters:
x,y: upper left corner
wwidth of bitmap
hhigh of bitmap
*bitmappointer to the bitmap data

bitmap format: 16 bit R5 G6 B5

use Gimp to create / load , save as BMP, option 16 bit R5 G6 B5 use winhex to load this file and mark data stating at offset 0x46 to end use edit -> copy block -> C Source to export C array paste this array into your program

define the array as static const unsigned char to put it into flash memory cast the pointer to (unsigned char *) : tft.Bitmap(10,40,309,50,(unsigned char *)scala);

Definition at line 349 of file GraphicsDisplay.cpp.

void Bitmap_BW ( Bitmap_s  bm,
int  x,
int  y 
) [inherited]

paint monochrome bitmap to screen

Parameters:
bmBitmap in flash
xx start
yy start

Definition at line 324 of file GraphicsDisplay.cpp.

int BMP_16 ( int  x,
int  y,
const char *  Name_BMP 
) [inherited]

paint a 16 bit BMP from filesytem on the TFT (slow)

Parameters:
x,y: position of upper left corner
*Name_BMPname of the BMP file with drive: "/local/test.bmp"
Returns:
1 if bmp file was found and painted
0 if bmp file was found not found
-1 if file is no bmp
-2 if bmp file is no 16 bit bmp
-3 if bmp file is to big for screen
-4 if buffer malloc go wrong

bitmap format: 16 bit R5 G6 B5

use Gimp to create / load , save as BMP, option 16 bit R5 G6 B5 copy to internal file system or SD card

Definition at line 375 of file GraphicsDisplay.cpp.

void BusEnable ( bool  enable ) [virtual]

Set ChipSelect high or low.

Parameters:
enable0/1

Reimplemented in UC1608.

Definition at line 154 of file LCD.cpp.

void character ( int  x,
int  y,
int  c 
) [virtual, inherited]

draw a character on given position out of the active font to the TFT

Parameters:
xx-position of char (top left)
yy-position
cchar to print

Implements TextDisplay.

Definition at line 270 of file GraphicsDisplay.cpp.

void circle ( int  x,
int  y,
int  r,
unsigned short  color 
) [virtual, inherited]

draw a circle

Parameters:
x0,y0center
rradius
color16 bit color *

Definition at line 60 of file GraphicsDisplay.cpp.

bool claim ( FILE *  stream ) [virtual, inherited]

redirect output from a stream (stoud, sterr) to display

Parameters:
streamstream that shall be redirected to the TextDisplay
Note:
this method may be overridden in a derived class.
Returns:
true if the claim succeeded.

Definition at line 65 of file TextDisplay.cpp.

void cls ( void   ) [virtual]

clear the entire screen The inherited one sets windomax then fill with background color We override it to speedup

Reimplemented from GraphicsDisplay.

Reimplemented in SH1106, and ST7920.

Definition at line 342 of file LCD.cpp.

int columns (  ) [virtual, inherited]

Get the number of columns based on the currently active font.

Returns:
number of columns.
Note:
this method may be overridden in a derived class.

Implements TextDisplay.

Definition at line 228 of file GraphicsDisplay.cpp.

void copy_to_lcd ( void   ) [virtual]

Framebuffer is used, it needs to be sent to LCD from time to time.

Implements GraphicsDisplay.

Reimplemented in SH1106, and ST7920.

Definition at line 326 of file LCD.cpp.

void fillcircle ( int  x,
int  y,
int  r,
unsigned short  color 
) [virtual, inherited]

draw a filled circle

Parameters:
x0,y0center
rradius
color16 bit color *

Definition at line 77 of file GraphicsDisplay.cpp.

void fillrect ( int  x0,
int  y0,
int  x1,
int  y1,
unsigned short  color 
) [virtual, inherited]

draw a filled rect

Parameters:
x0,y0top left corner
x1,y1down right corner
color16 bit color

Definition at line 209 of file GraphicsDisplay.cpp.

void foreground ( uint16_t  colour ) [virtual, inherited]

set the foreground color

Note:
this method may be overridden in a derived class.
Parameters:
coloris color to use for foreground drawing.

Definition at line 57 of file TextDisplay.cpp.

bool get_auto_up ( void   ) [inherited]

get status of the auto update function

Returns:
if auto update is on

Definition at line 474 of file GraphicsDisplay.cpp.

int get_contrast ( void   )

read the contrast level

Definition at line 236 of file LCD.cpp.

int height (  ) [inherited]

get the current oriented screen height in pixels

Returns:
screen height in pixels.

Definition at line 56 of file GraphicsDisplay.cpp.

void hline ( int  x0,
int  x1,
int  y,
unsigned short  color 
) [inherited]

draw a horizontal line

Parameters:
x0horizontal start
x1horizontal stop
yvertical position
color16 bit color

Definition at line 98 of file GraphicsDisplay.cpp.

void hw_reset (  ) [protected]

HW reset sequence (without display init commands)

Definition at line 150 of file LCD.cpp.

void invert ( unsigned char  o )

display inverted colors

Parameters:
o= 0 normal, 1 invert

Reimplemented in ST7920.

Definition at line 223 of file LCD.cpp.

void line ( int  x0,
int  y0,
int  x1,
int  y1,
unsigned short  color 
) [virtual, inherited]

draw a 1 pixel line

Parameters:
x0,y0start point
x1,y1stop point
color16 bit color

Definition at line 116 of file GraphicsDisplay.cpp.

void locate ( int  x,
int  y 
) [virtual, inherited]

setup cursor position for text

Parameters:
xx-position (top left)
yy-position

Reimplemented from TextDisplay.

Definition at line 223 of file GraphicsDisplay.cpp.

void mirrorXY ( mirror_t  mode ) [protected, virtual]

set mirror mode

Note:
may be overridden by specific display init class in case of not standard cmds or inverted wiring
Parameters:
modeNONE, X, Y, XY

Reimplemented in SH1106, SSD1306, ST7920, and UC1608.

Definition at line 201 of file LCD.cpp.

void pixel ( int  x,
int  y,
unsigned short  color 
) [virtual]

Draw a pixel in the specified color.

Parameters:
xis the horizontal offset to this pixel.
yis the vertical offset to this pixel.
colordefines the color for the pixel.

Implements GraphicsDisplay.

Reimplemented in SH1106.

Definition at line 296 of file LCD.cpp.

unsigned short pixelread ( int  x,
int  y 
) [virtual]

Read pixel color at location.

Parameters:
xis the horizontal offset to this pixel.
yis the vertical offset to this pixel.
Returns:
16bit color, 0000=Black(pixel set), FFFF=White(pixel clear).

Reimplemented in SH1106.

Definition at line 313 of file LCD.cpp.

void rect ( int  x0,
int  y0,
int  x1,
int  y1,
unsigned short  color 
) [virtual, inherited]

draw a rect

Parameters:
x0,y0top left corner
x1,y1down right corner
color16 bit color *

Reimplemented in SEPS225.

Definition at line 187 of file GraphicsDisplay.cpp.

int rows (  ) [virtual, inherited]

Get the number of rows based on the currently active font.

Returns:
number of rows.
Note:
this method may be overridden in a derived class.

Implements TextDisplay.

Definition at line 232 of file GraphicsDisplay.cpp.

void set_auto_up ( bool  up ) [inherited]

setup auto update of screen

Parameters:
up1 = on , 0 = off if switched off the program has to call copy_to_lcd() to update screen from framebuffer

Definition at line 466 of file GraphicsDisplay.cpp.

void set_contrast ( int  o ) [virtual]

set the contrast of the screen

Parameters:
ocontrast 0-63
Note:
may be overrided in case of not standard command

Reimplemented in SH1106, SSD1306, ST7920, and UC1608.

Definition at line 229 of file LCD.cpp.

void set_font ( unsigned char *  f,
unsigned char  firstascii = 32,
unsigned char  lastascii = 127,
bool  proportional = true 
) [inherited]

select the font to use

Parameters:
fpointer to font array
firstasciifirst ascii code present in font array, default 32 (space)
lastasciilast ascii code present in font array, default 127 (DEL)
proportionalenable/disable variable font width (default enabled)

font array can created with GLCD Font Creator from http://www.mikroe.com you have to add 4 parameter at the beginning of the font array to use:

  • the number of byte / char (not used in this revision, set to whatever)
  • the vertial size in pixel
  • the horizontal size in pixel
  • the number of byte per vertical line (not used in this revision, set to whatever) you also have to change the array to cont unsigned char[] and __align(2)

Definition at line 236 of file GraphicsDisplay.cpp.

void set_font_zoom ( unsigned char  x_mul,
unsigned char  y_mul 
) [inherited]

Zoom fount.

Parameters:
x_mulhorizontal size multiplier
y_mulvertical size multiplier

Definition at line 251 of file GraphicsDisplay.cpp.

void set_height ( int  height ) [inherited]

set the current oriented screen height in pixels

Parameters:
heightscreen height in pixels.

Definition at line 48 of file GraphicsDisplay.cpp.

void set_orientation ( int  o )

Set the orientation of the screen x,y: 0,0 is always top left.

Parameters:
odirection to use the screen (0-3) 0 = -90° 1 = default 0° 2 = +90° 3 = +180°

Definition at line 163 of file LCD.cpp.

void set_width ( int  width ) [inherited]

set the current oriented screen width in pixels

Parameters:
widthscreen width in pixels.

Definition at line 44 of file GraphicsDisplay.cpp.

int sizeX (  )

get display X size in pixels (native, orientation independent)

Returns:
X size in pixels

Definition at line 358 of file LCD.cpp.

int sizeY (  )

get display Y size in pixels (native, orientation independent)

Returns:
Y size in pixels

Definition at line 362 of file LCD.cpp.

void vline ( int  y0,
int  y1,
int  x,
unsigned short  color 
) [inherited]

draw a vertical line

Parameters:
xhorizontal position
y0vertical start
y1vertical stop
color16 bit color

Definition at line 107 of file GraphicsDisplay.cpp.

int width (  ) [inherited]

get the current oriented screen width in pixels

Returns:
screen width in pixels.

Definition at line 52 of file GraphicsDisplay.cpp.

void window ( int  x,
int  y,
int  w,
int  h 
) [virtual]

Set the window, which controls where items are written to the screen.

When something hits the window width, it wraps back to the left side and down a row. If the initial write is outside the window, it will be captured into the window when it crosses a boundary.

Parameters:
xis the left edge in pixels.
yis the top edge in pixels.
wis the window width in pixels.
his the window height in pixels.

Implements GraphicsDisplay.

Definition at line 240 of file LCD.cpp.

void window_pushpixel ( unsigned short  color,
unsigned int  count 
) [virtual]

Push some pixels of the same color into the window and increment position.

You must first call window() then push pixels.

Parameters:
coloris the pixel color.
count,:how many

Implements GraphicsDisplay.

Definition at line 261 of file LCD.cpp.

void window_pushpixel ( unsigned short  color ) [virtual]

Push a single pixel into the window and increment position.

You must first call window() then push pixels in loop.

Parameters:
coloris the pixel color.

Implements GraphicsDisplay.

Definition at line 250 of file LCD.cpp.

void window_pushpixelbuf ( unsigned short *  color,
unsigned int  lenght 
) [virtual]

Push array of pixel colors into the window and increment position.

You must first call window() then push pixels.

Parameters:
coloris the pixel color.

Implements GraphicsDisplay.

Definition at line 278 of file LCD.cpp.

void WindowMax ( void   ) [virtual, inherited]

Set window to max possible size May be overridden in a derived class.

Definition at line 40 of file GraphicsDisplay.cpp.

void wr_cmd16 ( unsigned short  cmd ) [protected]

Send 16bit command to display controller.

Parameters:
cmd,:halfword to send

Reimplemented in ST7920.

Definition at line 138 of file LCD.cpp.

void wr_cmd8 ( unsigned char  cmd ) [protected]

Send 8bit command to display controller.

Parameters:
cmd,:byte to send
Note:
if protocol is SPI16, it will insert NOP cmd before, so if cmd is a 2byte cmd, the second cmd will be broken. Use wr_cmd16 for 2bytes cmds

Reimplemented in ST7920.

Definition at line 129 of file LCD.cpp.

void wr_data8 ( unsigned char  data ) [protected]

Send 8bit data to display controller.

Parameters:
data,:byte to send

Definition at line 134 of file LCD.cpp.

void wr_gram ( unsigned short  data,
unsigned int  count 
) [protected, virtual]

Send same 16bit pixeldata to display controller multiple times.

Parameters:
data,:halfword to send
count,:how many

Reimplemented in ST7920.

Definition at line 142 of file LCD.cpp.

void wr_grambuf ( unsigned short *  data,
unsigned int  lenght 
) [protected, virtual]

Send array of pixeldata shorts to display controller.

Parameters:
data,:unsigned short pixeldata array
lenght,:lenght (in shorts)

Reimplemented in ST7920.

Definition at line 146 of file LCD.cpp.

Generated on Tue Jul 12 2022 18:00:35 by  doxygen 1.7.2