eink213inch  2.0.0.0
Main Page

eINK 2.13 inch display

eINK click is an adapter Click boardâ„¢, used to interface a compatible eINK display with the host MCU.

click Product page


Click library

  • Author : MikroE Team
  • Date : Feb 2020.
  • Type : SPI type

Software Support

We provide a library for the eInk213Inch Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for eInk213Inch Click driver.

Standard key functions :

Example key functions :

Examples Description

This application demonstrates the use of eINK click board.

The demo application is composed of two sections :

Application Init

Initializes the driver and configures the click board for 2.13 inch eINK display. After that, if the TEXT mode is supported, shows a desired text messages on the display.

void application_init ( void )
{
// Click initialization.
EINK213INCH_MAP_MIKROBUS( cfg, MIKROBUS_1 );
eink213inch_init( &eink213inch, &cfg );
eink213inch_start_config( &eink213inch );
eink213inch_set_lut( &eink213inch, &eink213inch_lut_table[ 0 ], 70 );
Delay_ms ( 1000 );
#ifndef IMAGE_MODE_ONLY
cfg_font.p_font = &guiFont_Tahoma_18_Regular[ 0 ];
eink213inch_set_font( &eink213inch, &cfg_font );
set_text.n_char = 4;
set_text.text_x = 5;
set_text.text_y = 50;
eink213inch_text( &eink213inch, &demo_text[ 0 ], &set_text );
cfg_font.p_font = &guiFont_Tahoma_10_Regular[ 0 ];
eink213inch_set_font( &eink213inch, &cfg_font );
set_text.n_char = 7;
set_text.text_x = 5;
set_text.text_y = 90;
eink213inch_text( &eink213inch, &demo_text1[ 0 ], &set_text );
cfg_font.p_font = &guiFont_Tahoma_8_Regular[ 0 ];
eink213inch_set_font( &eink213inch, &cfg_font );
set_text.n_char = 9;
set_text.text_x = 5;
set_text.text_y = 120;
eink213inch_text( &eink213inch, &demo_text2[ 0 ], &set_text );
#endif
Delay_ms ( 1000 );
}

Application Task

Draws four demo images to the display with a one-second delay between each drawing.

void application_task ( void )
{
Delay_1sec( );
eink213inch_display_image( &eink213inch, &demoImage_dark[ 0 ] );
Delay_1sec( );
Delay_1sec( );
Delay_1sec( );
}

Note

Due to insuficient RAM memory, only the IMAGE mode is supported with 8-bit PIC and AVR microcontrollers.

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.eInk213Inch

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


eink213inch_init
err_t eink213inch_init(eink213inch_t *ctx, eink213inch_cfg_t *cfg)
Initialization function.
eink213inch_text
void eink213inch_text(eink213inch_t *ctx, uint8_t *text, eink213inch_set_text_t *text_set)
Function for draw text on the screen.
eink213inch_t
Click ctx object definition.
Definition: eink213inch.h:189
demo_text1
uint8_t demo_text1[8]
Definition: main.c:59
application_task
void application_task(void)
Definition: main.c:129
eink213inch_start_config
void eink213inch_start_config(eink213inch_t *ctx)
Start configuration display.
eink213inch_lut_table
const uint8_t eink213inch_lut_table[70]
Definition: main.c:64
eink213inch_set_text_t::text_x
uint16_t text_x
Definition: eink213inch.h:180
eink213inch_display_image
void eink213inch_display_image(eink213inch_t *ctx, const uint8_t *image_buffer)
Display image function.
guiFont_Tahoma_18_Regular
const uint8_t guiFont_Tahoma_18_Regular[5525]
Definition: eink213inch_font.h:608
eink213inch_set_text_t::n_char
uint8_t n_char
Definition: eink213inch.h:179
eink213inch_cfg_setup
void eink213inch_cfg_setup(eink213inch_cfg_t *cfg)
Config Object Initialization function.
EINK213INCH_SCREEN_COLOR_WHITE
#define EINK213INCH_SCREEN_COLOR_WHITE
Definition: eink213inch.h:106
demoImage_dark
const uint8_t demoImage_dark[4000]
Definition: eink213inch_image.h:256
demoImage_light_180
const uint8_t demoImage_light_180[4000]
Definition: eink213inch_image.h:511
eink213inch_set_text_t
Definition: eink213inch.h:178
guiFont_Tahoma_10_Regular
const uint8_t guiFont_Tahoma_10_Regular[2040]
Definition: eink213inch_font.h:1960
eink213inch_font_t::p_font
const uint8_t * p_font
Definition: eink213inch.h:152
eink213inch_font_t
Definition: eink213inch.h:151
eink213inch_set_font
void eink213inch_set_font(eink213inch_t *ctx, eink213inch_font_t *cfg_font)
Set font function.
application_init
void application_init(void)
Definition: main.c:80
demoImage_light
const uint8_t demoImage_light[4000]
Definition: eink213inch_image.h:1
eink213inch_font_t::color
uint16_t color
Definition: eink213inch.h:153
guiFont_Tahoma_8_Regular
const uint8_t guiFont_Tahoma_8_Regular[1679]
Definition: eink213inch_font.h:1759
eink213inch_set_text_t::text_y
uint16_t text_y
Definition: eink213inch.h:181
EINK213INCH_MAP_MIKROBUS
#define EINK213INCH_MAP_MIKROBUS(cfg, mikrobus)
Definition: eink213inch.h:67
eink213inch_font_t::orientation
uint8_t orientation
Definition: eink213inch.h:154
eink213inch_cfg_t
Click configuration structure definition.
Definition: eink213inch.h:215
EINK213INCH_FO_HORIZONTAL
#define EINK213INCH_FO_HORIZONTAL
Definition: eink213inch.h:111
eink213inch_set_lut
void eink213inch_set_lut(eink213inch_t *ctx, const uint8_t *lut, uint8_t n_bytes)
Set LUT table.
demo_text
uint8_t demo_text[5]
Definition: main.c:58
demo_text2
uint8_t demo_text2[10]
Definition: main.c:60
demoImage_dark_180
const uint8_t demoImage_dark_180[4000]
Definition: eink213inch_image.h:767