#include "st7567.h"
#include <string.h>

Macros
#define	ABS(x) ((x) > 0 ? (x) : -(x))

Functions
void	ST7567_WriteData (uint8_t dat)
	Write a single byte data to ST7567.

void	ST7567_WriteSameData (uint8_t dat, uint32_t size)

void	ST7567_WriteCommand (uint8_t command)
	Write a single byte command to ST7567.

static void	ST7567_Transmit (const uint8_t *pDat, uint32_t size)

void	ST7567_Reset (void)
	Hardware reset ST7567 LCD.

void	ST7567_Init (void)
	Initializes ST7567 LCD.

void	ST7567_SetPowerSaveMode (HAL_State_t state)
	Powersave mode control.

void	ST7567_SetBackLightState (HAL_State_t state)
	Turn ST7567 LCD backlight on or off.

void	ST7567_SetContrast (uint8_t val)
	Turn ST7567 LCD backlight off.

void	ST7567_UpdateScreen (void)
	Update LCD display with buffer changes.

void	ST7567_ToggleInvert (void)
	Toggles pixels invertion inside internal RAM.

void	ST7567_Fill (uint8_t color)
	Fills entire LCD with specified color.

void	ST7567_DrawPixel (uint8_t x, uint8_t y, uint8_t color)
	Draws pixel at desired location.

void	ST7567_GotoXY (uint16_t x, uint16_t y)
	Sets cursor pointer to desired location for strings.

char	ST7567_Putc (char ch, FontDef_t *font, uint8_t color)
	Puts character to internal RAM.

char	ST7567_Puts (char str, FontDef_t Font, uint8_t color)
	Puts string to internal RAM.

void	ST7567_DrawLine (uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint8_t c)
	Draws line on LCD.

Variables
__BIT	ST7567_colorInverted = RESET

uint8_t	ST7567_currentX = 0

uint8_t	ST7567_currentY = 0

static __XDATA uint8_t	ST7567_Buffer_all [ST7567_WIDTH *ST7567_PAGES]

static __CODE uint8_t	Font3x5 []

static __CODE uint8_t	Font5x7 []

__CODE FontDef_t	Font_3x5 = {3, 5, 1, 1, Font3x5}

__CODE FontDef_t	Font_5x7 = {5, 7, 1, 1, Font5x7}

Macro Definition Documentation

◆ ABS

#define ABS ( x ) ((x) > 0 ? (x) : -(x))

Definition at line 19 of file st7567.c.

Function Documentation

◆ ST7567_DrawLine()

void ST7567_DrawLine	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	x1,
		uint16_t	y1,
		uint8_t	c
	)

Draws line on LCD.

Note: ST7567_UpdateScreen() must be called after that in order to see updated LCD screen

Parameters

x0	Line X start point. Valid input is 0 to ST7567_WIDTH - 1
y0	Line Y start point. Valid input is 0 to ST7567_HEIGHT - 1
x1	Line X end point. Valid input is 0 to ST7567_WIDTH - 1
y1	Line Y end point. Valid input is 0 to ST7567_HEIGHT - 1
c	Color to be used. This parameter can be a value of ST7567_COLOR_t enumeration

Return values

None

Definition at line 257 of file st7567.c.

{
    int16_t dx, dy, sx, sy, err, e2, i, tmp; 
    
    /* Check for overflow */
    if (x0 >= ST7567_WIDTH)
    {
        x0 = ST7567_WIDTH - 1;
    }
    if (x1 >= ST7567_WIDTH)
    {
        x1 = ST7567_WIDTH - 1;
    }
    if (y0 >= ST7567_HEIGHT)
    {
        y0 = ST7567_HEIGHT - 1;
    }
    if (y1 >= ST7567_HEIGHT)
    {
        y1 = ST7567_HEIGHT - 1;
    }
    
    dx = (x0 < x1) ? (x1 - x0) : (x0 - x1); 
    dy = (y0 < y1) ? (y1 - y0) : (y0 - y1); 
    sx = (x0 < x1) ? 1 : -1; 
    sy = (y0 < y1) ? 1 : -1; 
    err = ((dx > dy) ? dx : -dy) / 2; 
 
    if (dx == 0)
    {
        if (y1 < y0)
        {
            tmp = y1;
            y1 = y0;
            y0 = tmp;
        }
        
        if (x1 < x0)
        {
            tmp = x1;
            x1 = x0;
            x0 = tmp;
        }
        
        /* Vertical line */
        for (i = y0; i <= y1; i++)
        {
            ST7567_DrawPixel(x0, i, c);
        }
        
        /* Return from function */
        return;
    }
    
    if (dy == 0)
    {
        if (y1 < y0)
        {
            tmp = y1;
            y1 = y0;
            y0 = tmp;
        }
        
        if (x1 < x0)
        {
            tmp = x1;
            x1 = x0;
            x0 = tmp;
        }
        
        /* Horizontal line */
        for (i = x0; i <= x1; i++)
        {
            ST7567_DrawPixel(i, y0, c);
        }
        
        /* Return from function */
        return;
    }
 
    while (1)
    {
        ST7567_DrawPixel(x0, y0, c);
        if (x0 == x1 && y0 == y1)
        {
            break;
        }
        e2 = err;
        if (e2 > -dx)
        {
            err -= dy;
            x0 += sx;
        }
        if (e2 < dy)
        {
            err += dx;
            y0 += sy;
        }
    }
}

◆ ST7567_DrawPixel()

void ST7567_DrawPixel	(	uint8_t	x,
		uint8_t	y,
		uint8_t	color
	)

Draws pixel at desired location.

Note: ST7567_UpdateScreen() must called after that in order to see updates

Parameters

x	X location. This parameter can be a value between 0 and ST7567_WIDTH - 1
y	Y location. This parameter can be a value between 0 and ST7567_HEIGHT - 1
color	Color to be used for screen fill. This parameter can be a value of ST7567_COLOR_t enumeration

Return values

None

Definition at line 164 of file st7567.c.

{
    uint8_t page, column;
    if (x >= ST7567_WIDTH || y >= ST7567_HEIGHT)
    {
        /* Error */
        return;
    }
 
    if (color == ST7567_COLOR_FRONT)
    {
        ST7567_Buffer_all[x + (y / 8) * ST7567_WIDTH] |= 1 << (y % 8);
    }
    else
    {
        ST7567_Buffer_all[x + (y / 8) * ST7567_WIDTH] &= ~(1 << (y % 8));
    }
}

◆ ST7567_Fill()

void ST7567_Fill ( uint8_t Color )

Fills entire LCD with specified color.

Note: ST7567_UpdateScreen() must be called after that in order to see updates

Parameters

Color Color to be used for screen fill, ST7567_COLOR_FRONT or ST7567_COLOR_BACK

Return values

None

Definition at line 158 of file st7567.c.

{
    /* Set memory */
    memset((uint8_t *)ST7567_Buffer_all, (color == ST7567_COLOR_BACK) ? 0x00 : 0xFF, sizeof(ST7567_Buffer_all));
}

◆ ST7567_GotoXY()

void ST7567_GotoXY	(	uint16_t	x,
		uint16_t	y
	)

Sets cursor pointer to desired location for strings.

Parameters

x	X location. This parameter can be a value between 0 and ST7567_WIDTH - 1
y	Y location. This parameter can be a value between 0 and ST7567_HEIGHT - 1

Return values

None

Definition at line 183 of file st7567.c.

{
    /* Set write pointers */
    ST7567_currentX = x;
    ST7567_currentY = y;
}

◆ ST7567_Init()

void ST7567_Init ( void )

Initializes ST7567 LCD.

Parameters

None

Return values

None

Definition at line 68 of file st7567.c.

{
    ST7567_Reset();
    ST7567_SetBackLightState(HAL_State_ON);
 
    ST7567_WriteCommand(ST7567_RESET);
    // adjust contrast 
    ST7567_WriteCommand(ST7567_SET_EV);
    ST7567_WriteCommand(ST7567_SET_EV_MASK & 0x20); 
    // adjust regular voltage. LCD may fail to display if it is set too low.
    ST7567_WriteCommand(ST7567_REGULATION_RATIO | ST7567_REGULATION_RATIO_5_0);
    ST7567_WriteCommand(ST7567_BIAS_1_9);
    ST7567_WriteCommand(ST7567_X_ORIENT);
    ST7567_WriteCommand(ST7567_Y_ORIENT);
    ST7567_WriteCommand(ST7567_INVERSE_DISPLAY_OFF);
    // Start from line 0
    ST7567_WriteCommand(ST7567_SET_START_LINE | (0x00 & ST7567_SET_START_LINE_MASK));
    // Start from page 0
    ST7567_WriteCommand(ST7567_SET_PAGE_ADDRESS | (0x00 & ST7567_SET_PAGE_ADDRESS_MASK));
    // Start from column 0
    ST7567_WriteCommand(ST7567_SET_COLUMN_ADDRESS_MSB | (0x00 & ST7567_SET_COLUMN_ADDRESS_MSB_MASK));
    ST7567_WriteCommand(ST7567_SET_COLUMN_ADDRESS_LSB | (0x00 & ST7567_SET_COLUMN_ADDRESS_LSB_MASK));
    // power control, LCD may fail to display if it is not properly set.
    // recommend to set them all
    ST7567_WriteCommand(ST7567_POWER_CONTROL
        |ST7567_POWER_CONTROL_VB
        |ST7567_POWER_CONTROL_VR
        |ST7567_POWER_CONTROL_VF);
    ST7567_WriteCommand(ST7567_DISPLAY_ON);
    ST7567_WriteCommand(ST7567_ALL_PIXEL_NORMAL);
}

◆ ST7567_Putc()

char ST7567_Putc	(	char	ch,
		FontDef_t *	Font,
		uint8_t	color
	)

Puts character to internal RAM.

Note: ST7567_UpdateScreen() must be called after that in order to see updated LCD screen

Parameters

ch	Character to be written
*Font	Pointer to FontDef_t structure with used font
color	Color used for drawing. This parameter can be a value of ST7567_COLOR_t enumeration

Return values

Character written

Definition at line 190 of file st7567.c.

{
    uint32_t i, b, j, k;
 
    for (i = 0; i < font->height; i++)
    {
        for (j = 0; j < font->bytes; j++)
        {
            b = font->dat[((ch - 32) * font->height + i) * font->bytes + j];
            if (font->order == 0)
            {
                for (k = 0; k < 8 && k < font->width - j * 8; k++)
                {
                    if ((b << k) & 0x80)
                    {
                        ST7567_DrawPixel(ST7567_currentX + (j * 8) + k, (ST7567_currentY + i), (uint8_t) color);
                    }
                    else
                    {
                        ST7567_DrawPixel(ST7567_currentX + (j * 8) + k, (ST7567_currentY + i), (uint8_t) !color);
                    }
                }
            }
            else
            {
                for (k = 0; k < 8 && k < font->width - j * 8; k++)
                {
                    if (b & (0x0001 << k))
                    {
                        ST7567_DrawPixel(ST7567_currentX + (j * 8) + k, (ST7567_currentY + i), (uint8_t) color);
                    }
                    else
                    {
                        ST7567_DrawPixel(ST7567_currentX + (j * 8) + k, (ST7567_currentY + i), (uint8_t) !color);
                    }
                }
            }
        }
    }
 
    /* Increase pointer */
    ST7567_currentX += font->width + 1;
 
    /* Return character written */
    return ch;
}

◆ ST7567_Puts()

char ST7567_Puts	(	char *	str,
		FontDef_t *	Font,
		uint8_t	color
	)

Puts string to internal RAM.

Note: ST7567_UpdateScreen() must be called after that in order to see updated LCD screen

Parameters

*str	String to be written
*Font	Pointer to FontDef_t structure with used font
color	Color used for drawing. This parameter can be a value of ST7567_COLOR_t enumeration

Return values

Zero	on success or character value when function failed

Definition at line 237 of file st7567.c.

{
    /* Write characters */
    while (*str)
    {
        /* Write character by character */
        if (ST7567_Putc(*str, Font, color) != *str)
        {
            /* Return error */
            return *str;
        }
        
        /* Increase string pointer */
        str++;
    }
    
    /* Everything OK, zero should be returned */
    return *str;
}

◆ ST7567_Reset()

void ST7567_Reset ( void )

Hardware reset ST7567 LCD.

Parameters

None

Return values

None

Definition at line 61 of file st7567.c.

{
    ST7567_RES = 0;
    SYS_Delay(5);
    ST7567_RES = 1;
}

◆ ST7567_SetBackLightState()

void ST7567_SetBackLightState ( HAL_State_t state )

Turn ST7567 LCD backlight on or off.

Parameters

state HAL_State_ON:on, HAL_State_OFF:off

Return values

None

Definition at line 121 of file st7567.c.

{
    ST7567_BL = (state == HAL_State_ON)? SET : RESET;
}

◆ ST7567_SetContrast()

void ST7567_SetContrast ( uint8_t val )

Turn ST7567 LCD backlight off.

Parameters

val	value between 0x00 ~ 0x3F

Return values

None

Definition at line 126 of file st7567.c.

{
    ST7567_WriteCommand(ST7567_SET_EV);
    ST7567_WriteCommand(ST7567_SET_EV_MASK & val);
}

◆ ST7567_SetPowerSaveMode()

void ST7567_SetPowerSaveMode ( HAL_State_t state )

Powersave mode control.

Parameters

state HAL_State_ON:powersave mode, HAL_State_OFF:work mode

Return values

None

Definition at line 100 of file st7567.c.

{
#if (ST7567_MODEL == ST7567_MODEL_ST7565)
    if (state == HAL_State_ON)
        ST7567_WriteCommand(ST7567_MODE_SLEEP);
    else
        ST7567_WriteCommand(ST7567_MODE_NORMAL);
#else
    if (state == HAL_State_ON)
    {
        ST7567_WriteCommand(ST7567_DISPLAY_OFF);
        ST7567_WriteCommand(ST7567_ALL_PIXEL_ON);
    }
    else
    {
        ST7567_WriteCommand(ST7567_ALL_PIXEL_NORMAL);
        ST7567_WriteCommand(ST7567_DISPLAY_ON);
    }
#endif
}

◆ ST7567_ToggleInvert()

void ST7567_ToggleInvert ( void )

Toggles pixels invertion inside internal RAM.

Note: ST7567_UpdateScreen() must be called after that in order to see updated LCD screen

Parameters

None

Return values

None

Definition at line 144 of file st7567.c.

{
    /* Toggle invert */
    ST7567_colorInverted = !ST7567_colorInverted;
    if (ST7567_colorInverted)
    {
        ST7567_WriteCommand(ST7567_INVERSE_DISPLAY_ON);
    }
    else
    {
        ST7567_WriteCommand(ST7567_INVERSE_DISPLAY_OFF);
    }
}

◆ ST7567_Transmit()

static void ST7567_Transmit	(	const uint8_t *	pDat,
		uint32_t	size
	)

static

Definition at line 51 of file st7567.c.

{
    ST7567_CS = 0;
    do
    {
        SPI_TxRx(*pDat++);
    } while (--size);
    ST7567_CS = 1;
}

◆ ST7567_UpdateScreen()

void ST7567_UpdateScreen ( void )

Update LCD display with buffer changes.

Note: Call this function each time when display is changed

Parameters

None

Return values

None

Definition at line 132 of file st7567.c.

{
    uint8_t i = 0, *pt = ST7567_Buffer_all;
    for (i = 0; i < ST7567_PAGES; i++)
    {
        ST7567_WriteCommand(ST7567_SET_PAGE_ADDRESS|(i & ST7567_SET_PAGE_ADDRESS_MASK));
        ST7567_WriteCommand(ST7567_SET_COLUMN_ADDRESS_MSB|(0 >> 4));
        ST7567_WriteCommand(ST7567_SET_COLUMN_ADDRESS_LSB|(0 & 0x0F));
        ST7567_Transmit(pt + (ST7567_WIDTH * i), ST7567_WIDTH);
    }
}

◆ ST7567_WriteCommand()

void ST7567_WriteCommand ( uint8_t command )

Write a single byte command to ST7567.

Parameters

command command

Return values

None

Definition at line 44 of file st7567.c.

{
    ST7567_DC = 0;
    ST7567_WriteData(command);
    ST7567_DC = 1;
}

◆ ST7567_WriteData()

void ST7567_WriteData ( uint8_t dat )

Write a single byte data to ST7567.

Parameters

dat data

Return values

None

Definition at line 27 of file st7567.c.

{
    ST7567_CS = 0;
    SPI_TxRx(dat);
    ST7567_CS = 1;
}

◆ ST7567_WriteSameData()

void ST7567_WriteSameData	(	uint8_t	dat,
		uint32_t	size
	)

Definition at line 34 of file st7567.c.

{
    ST7567_CS = 0;
    do
    {
        SPI_TxRx(dat);
    } while (--size);
    ST7567_CS = 1;
}

Variable Documentation

◆ Font3x5

__CODE uint8_t Font3x5[]

static

Definition at line 358 of file st7567.c.

◆ Font5x7

__CODE uint8_t Font5x7[]

static

Definition at line 457 of file st7567.c.

◆ Font_3x5

__CODE FontDef_t Font_3x5 = {3, 5, 1, 1, Font3x5}

Definition at line 556 of file st7567.c.

◆ Font_5x7

__CODE FontDef_t Font_5x7 = {5, 7, 1, 1, Font5x7}

Definition at line 557 of file st7567.c.

◆ ST7567_Buffer_all

__XDATA uint8_t ST7567_Buffer_all[ST7567_WIDTH *ST7567_PAGES]

static

Definition at line 25 of file st7567.c.

◆ ST7567_colorInverted

__BIT ST7567_colorInverted = RESET

Definition at line 22 of file st7567.c.

◆ ST7567_currentX

uint8_t ST7567_currentX = 0

Definition at line 23 of file st7567.c.

◆ ST7567_currentY

uint8_t ST7567_currentY = 0

Definition at line 24 of file st7567.c.

Macros

Functions

Variables

Macro Definition Documentation

◆ ABS

Function Documentation

◆ ST7567_DrawLine()

◆ ST7567_DrawPixel()

◆ ST7567_Fill()

◆ ST7567_GotoXY()

◆ ST7567_Init()

◆ ST7567_Putc()

◆ ST7567_Puts()

◆ ST7567_Reset()

◆ ST7567_SetBackLightState()

◆ ST7567_SetContrast()

◆ ST7567_SetPowerSaveMode()

◆ ST7567_ToggleInvert()

◆ ST7567_Transmit()

◆ ST7567_UpdateScreen()

◆ ST7567_WriteCommand()

◆ ST7567_WriteData()

◆ ST7567_WriteSameData()

Variable Documentation

◆ Font3x5

◆ Font5x7

◆ Font_3x5

◆ Font_5x7

◆ ST7567_Buffer_all

◆ ST7567_colorInverted

◆ ST7567_currentX

◆ ST7567_currentY