eink  2.0.0.0
Functions

Functions

void eink_cfg_setup (eink_cfg_t *cfg)
 Config Object Initialization function. More...
 
err_t eink_init (eink_t *ctx, eink_cfg_t *cfg)
 Initialization function. More...
 
void eink_send_cmd (eink_t *ctx, uint8_t command)
 Sending a command. More...
 
void eink_send_data (eink_t *ctx, uint8_t c_data)
 Sending data. More...
 
void eink_reset (eink_t *ctx)
 Reset chip. More...
 
void eink_sleep_mode (eink_t *ctx)
 Sleep mode. More...
 
void eink_start_config (eink_t *ctx)
 Configuration display. More...
 
void eink_set_lut (eink_t *ctx, const uint8_t *lut, uint8_t n_bytes)
 Set LUT table. More...
 
void eink_set_mem_pointer (eink_t *ctx, uint8_t x, uint8_t y)
 Setting pointers in memory. More...
 
void eink_set_mem_area (eink_t *ctx, eink_xy_t *xy)
 Setting area in memory. More...
 
void eink_update_display (eink_t *ctx)
 Update dispaly. More...
 
void eink_fill_screen (eink_t *ctx, uint8_t color)
 Function that fills the screen. More...
 
void eink_display_image (eink_t *ctx, const uint8_t *image_buffer)
 Displays image. More...
 
void eink_text (eink_t *ctx, uint8_t *text, eink_text_set_t *text_set)
 Draw text on the screen. More...
 
void eink_set_font (eink_t *ctx, eink200inch_font_t *cfg_font)
 Set text font. More...
 

Detailed Description

Function Documentation

◆ eink_cfg_setup()

void eink_cfg_setup ( eink_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ eink_display_image()

void eink_display_image ( eink_t ctx,
const uint8_t *  image_buffer 
)

Displays image.

Parameters
ctxClick object.
imageBuffer containing the image

The image can be built from VTFT or image2lcd programs, and image type must be monochrome bmp.

◆ eink_fill_screen()

void eink_fill_screen ( eink_t ctx,
uint8_t  color 
)

Function that fills the screen.

Parameters
ctxClick object.
colorThe color to which the screen will be colored

Options : EINK_SCREEN_COLOR_WHITE EINK_SCREEN_COLOR_BLACK EINK_SCREEN_COLOR_LIGHT_GREY EINK_SCREEN_COLOR_DARK_GREY

◆ eink_init()

err_t eink_init ( eink_t ctx,
eink_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ eink_reset()

void eink_reset ( eink_t ctx)

Reset chip.

Parameters
ctxClick object.

◆ eink_send_cmd()

void eink_send_cmd ( eink_t ctx,
uint8_t  command 
)

Sending a command.

Parameters
ctxClick object.
commandThe command to be sent

◆ eink_send_data()

void eink_send_data ( eink_t ctx,
uint8_t  c_data 
)

Sending data.

Parameters
ctxClick object.
c_dataThe data to be sent

◆ eink_set_font()

void eink_set_font ( eink_t ctx,
eink200inch_font_t cfg_font 
)

Set text font.

Parameters
ctxClick object.
cfg_fontStruct object.

◆ eink_set_lut()

void eink_set_lut ( eink_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_set_mem_area()

void eink_set_mem_area ( eink_t ctx,
eink_xy_t xy 
)

Setting area in memory.

Parameters
ctxClick object.
xyStruct object.

◆ eink_set_mem_pointer()

void eink_set_mem_pointer ( eink_t ctx,
uint8_t  x,
uint8_t  y 
)

Setting pointers in memory.

Parameters
ctxClick object.
xx position
yy position

◆ eink_sleep_mode()

void eink_sleep_mode ( eink_t ctx)

Sleep mode.

Parameters
ctxClick object.

◆ eink_start_config()

void eink_start_config ( eink_t ctx)

Configuration display.

Parameters
ctxClick object.

◆ eink_text()

void eink_text ( eink_t ctx,
uint8_t *  text,
eink_text_set_t text_set 
)

Draw text on the screen.

Parameters
ctxClick object.
textText buffer
text_setStruct object.

◆ eink_update_display()

void eink_update_display ( eink_t ctx)

Update dispaly.

Parameters
ctxClick object.