eink_213inch  2.0.0.0
Functions

Functions

void eink_213inch_cfg_setup (eink_213inch_cfg_t *cfg)
 Config Object Initialization function. More...
 
EINK213INCH_RETVAL eink_213inch_init (eink_213inch_t *ctx, eink_213inch_cfg_t *cfg)
 Initialization function. More...
 
void eink_213inch_generic_transfer (eink_213inch_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
void eink_213_send_command (eink_213inch_t *ctx, uint8_t command)
 Function for sending a command. More...
 
void eink_213_send_data (eink_213inch_t *ctx, uint8_t c_data)
 Function for sending data. More...
 
void eink_213_reset (eink_213inch_t *ctx)
 Function for reset chip. More...
 
void eink_213_sleep_mode (eink_213inch_t *ctx)
 Function for go to sleep mode. More...
 
void eink_213_set_lut (eink_213inch_t *ctx, const uint8_t *lut, uint8_t n_bytes)
 Set LUT table. More...
 
void eink_213_start_config (eink_213inch_t *ctx)
 Start configuration display. More...
 
void eink_213_set_memory_pointer (eink_213inch_t *ctx, uint16_t x, uint16_t y)
 Function for setting pointers in memory. More...
 
void eink_213_set_memory_area (eink_213inch_t *ctx, eink_213inch_xy_t *xy)
 Function for setting area in memory. More...
 
void eink_213_update_display (eink_213inch_t *ctx)
 Functions for update display. More...
 
void eink_213_fill_screen (eink_213inch_t *ctx, uint8_t color)
 Function that fills the screen. More...
 
void eink_213_display_image (eink_213inch_t *ctx, const uint8_t *image_buffer)
 Display image function. More...
 
void eink_213_text (eink_213inch_t *ctx, char *text, eink_213inch_set_text_t *text_set)
 Function for draw text on the screen. More...
 
void eink_213_set_font (eink_213inch_t *ctx, eink_213inch_font_t *cfg_font)
 Set font function. More...
 

Detailed Description

Function Documentation

◆ eink_213_display_image()

void eink_213_display_image ( eink_213inch_t ctx,
const uint8_t *  image_buffer 
)

Display image function.

Parameters
ctxClick object.
imageBuffer containing the image

@description The image can be built from VTFT or image2lcd programs

Note
The image type must be monochrome bmp

◆ eink_213_fill_screen()

void eink_213_fill_screen ( eink_213inch_t ctx,
uint8_t  color 
)

Function that fills the screen.

Parameters
ctxClick object.
colorThe color to which the screen will be colored
Note
Options : EINK213_SCREEN_COLOR_WHITE EINK213_SCREEN_COLOR_BLACK EINK213_SCREEN_COLOR_LIGHT_GREY EINK213_SCREEN_COLOR_DARK_GREY

◆ eink_213_reset()

void eink_213_reset ( eink_213inch_t ctx)

Function for reset chip.

Parameters
ctxClick object.

◆ eink_213_send_command()

void eink_213_send_command ( eink_213inch_t ctx,
uint8_t  command 
)

Function for sending a command.

Parameters
ctxClick object.
commandThe command to be sent

◆ eink_213_send_data()

void eink_213_send_data ( eink_213inch_t ctx,
uint8_t  c_data 
)

Function for sending data.

Parameters
ctxClick object.
c_dataThe data to be sent

◆ eink_213_set_font()

void eink_213_set_font ( eink_213inch_t ctx,
eink_213inch_font_t cfg_font 
)

Set font function.

Parameters
ctxClick object.
cfg_fontStruct object

◆ eink_213_set_lut()

void eink_213_set_lut ( eink_213inch_t ctx,
const uint8_t *  lut,
uint8_t  n_bytes 
)

Set LUT table.

Parameters
ctxClick object.
lutLut table
n_bytesNumber of bytes in Lut table

@Note Changing the "lut table" can change the display's performance.

◆ eink_213_set_memory_area()

void eink_213_set_memory_area ( eink_213inch_t ctx,
eink_213inch_xy_t xy 
)

Function for setting area in memory.

Parameters
ctxClick object.
xyStruct object

◆ eink_213_set_memory_pointer()

void eink_213_set_memory_pointer ( eink_213inch_t ctx,
uint16_t  x,
uint16_t  y 
)

Function for setting pointers in memory.

Parameters
ctxClick object.
xx position
yy position

◆ eink_213_sleep_mode()

void eink_213_sleep_mode ( eink_213inch_t ctx)

Function for go to sleep mode.

Parameters
ctxClick object.

◆ eink_213_start_config()

void eink_213_start_config ( eink_213inch_t ctx)

Start configuration display.

Parameters
ctxClick object.

◆ eink_213_text()

void eink_213_text ( eink_213inch_t ctx,
char *  text,
eink_213inch_set_text_t text_set 
)

Function for draw text on the screen.

Parameters
ctxClick object.
textText buffer
text_setStruct object

◆ eink_213_update_display()

void eink_213_update_display ( eink_213inch_t ctx)

Functions for update display.

Parameters
ctxClick object.

◆ eink_213inch_cfg_setup()

void eink_213inch_cfg_setup ( eink_213inch_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ eink_213inch_generic_transfer()

void eink_213inch_generic_transfer ( eink_213inch_t ctx,
uint8_t *  wr_buf,
uint16_t  wr_len,
uint8_t *  rd_buf,
uint16_t  rd_len 
)

Generic transfer function.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ eink_213inch_init()

EINK213INCH_RETVAL eink_213inch_init ( eink_213inch_t ctx,
eink_213inch_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.