eink 2.0.0.0
Main Page

eINK click

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 Eink 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 Eink Click driver.

Standard key functions :

  • eink_cfg_setup Config Object Initialization function.
    void eink_cfg_setup ( eink_cfg_t *cfg );
    void eink_cfg_setup(eink_cfg_t *cfg)
    Config Object Initialization function.
    Click configuration structure definition.
    Definition eink.h:238
  • eink_init Initialization function.
    err_t eink_init ( eink_t *ctx, eink_cfg_t *cfg );
    err_t eink_init(eink_t *ctx, eink_cfg_t *cfg)
    Initialization function.
    Click ctx object definition.
    Definition eink.h:214

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.00 inch eINK display. After that, if the TEXT mode is supported, shows a desired text messages on the display.

void application_init ( void )
{
eink_cfg_t cfg;
eink_text_set_t text_set;
// Click initialization.
eink_cfg_setup( &cfg );
EINK_MAP_MIKROBUS( cfg, MIKROBUS_1 );
eink_init( &eink, &cfg );
Delay_ms ( 1000 );
#ifndef IMAGE_MODE_ONLY
eink_set_font( &eink, &cfg_font );
text_set.n_char = 4;
text_set.text_x = 10;
text_set.text_y = 50;
eink_text( &eink, &demo_text[ 0 ], &text_set );
text_set.n_char = 7;
text_set.text_x = 10;
text_set.text_y = 90;
eink_text( &eink, &demo_text1[ 0 ], &text_set );
text_set.n_char = 8;
text_set.text_x = 10;
text_set.text_y = 130;
eink_text( &eink, &demo_text2[ 0 ], &text_set );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
#endif
}
const uint8_t guiFont_Tahoma_10_Regular[2040]
Definition eink200inch_font.h:1961
#define EINK_SCREEN_COLOR_WHITE
Definition eink.h:106
#define EINK_FO_HORIZONTAL
Definition eink.h:111
#define EINK_MAP_MIKROBUS(cfg, mikrobus)
Definition eink.h:67
void eink_text(eink_t *ctx, uint8_t *text, eink_text_set_t *text_set)
Draw text on the screen.
void eink_start_config(eink_t *ctx)
Configuration display.
void application_init(void)
Definition main.c:83
const uint8_t eink_lut_table[90]
Definition main.c:60
uint8_t demo_text1[8]
Definition main.c:78
uint8_t demo_text[5]
Definition main.c:77
uint8_t demo_text2[10]
Definition main.c:79
uint16_t color
Definition eink.h:178
const uint8_t * p_font
Definition eink.h:177
uint8_t orientation
Definition eink.h:179
Definition eink.h:203
uint8_t n_char
Definition eink.h:206
uint8_t text_x
Definition eink.h:204
uint8_t text_y
Definition eink.h:205

Application Task

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

void application_task ( void )
{
Delay_1sec( );
Delay_1sec( );
}
const unsigned char demo_image_black[3096]
Definition eink200inch_image.h:197
const unsigned char demo_image_white[3096]
Definition eink200inch_image.h:1
void application_task(void)
Definition main.c:124

Note

‍Due to insuficient RAM memory, only the IMAGE mode is supported with 8-bit PIC 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.Eink

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.