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 :

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( 5000 );
#endif
}

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( );
}

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.


eink200inch_font_t::orientation
uint8_t orientation
Definition: eink.h:165
demo_image_black
const unsigned char demo_image_black[3096]
Definition: eink200inch_image.h:197
eink_lut_table
const uint8_t eink_lut_table[90]
Definition: main.c:58
eink_text_set_t::text_x
uint8_t text_x
Definition: eink.h:190
demo_text1
uint8_t demo_text1[8]
Definition: main.c:76
guiFont_Tahoma_10_Regular
const uint8_t guiFont_Tahoma_10_Regular[2040]
Definition: eink200inch_font.h:1961
application_task
void application_task(void)
Definition: main.c:118
eink_cfg_setup
void eink_cfg_setup(eink_cfg_t *cfg)
Config Object Initialization function.
eink_text_set_t::text_y
uint8_t text_y
Definition: eink.h:191
eink200inch_font_t::p_font
const uint8_t * p_font
Definition: eink.h:163
eink_set_lut
void eink_set_lut(eink_t *ctx, const uint8_t *lut, uint8_t n_bytes)
Set LUT table.
eink_init
err_t eink_init(eink_t *ctx, eink_cfg_t *cfg)
Initialization function.
demo_image_white
const unsigned char demo_image_white[3096]
Definition: eink200inch_image.h:1
eink_start_config
void eink_start_config(eink_t *ctx)
Configuration display.
eink_set_font
void eink_set_font(eink_t *ctx, eink200inch_font_t *cfg_font)
Set text font.
eink_display_image
void eink_display_image(eink_t *ctx, const uint8_t *image_buffer)
Displays image.
EINK_MAP_MIKROBUS
#define EINK_MAP_MIKROBUS(cfg, mikrobus)
Definition: eink.h:53
EINK_FO_HORIZONTAL
#define EINK_FO_HORIZONTAL
Definition: eink.h:97
application_init
void application_init(void)
Definition: main.c:81
eink200inch_font_t::color
uint16_t color
Definition: eink.h:164
eink_text_set_t::n_char
uint8_t n_char
Definition: eink.h:192
eink200inch_font_t
Definition: eink.h:162
eink_text
void eink_text(eink_t *ctx, uint8_t *text, eink_text_set_t *text_set)
Draw text on the screen.
eink_text_set_t
Definition: eink.h:189
eink_cfg_t
Click configuration structure definition.
Definition: eink.h:224
eink_t
Click ctx object definition.
Definition: eink.h:200
EINK_SCREEN_COLOR_WHITE
#define EINK_SCREEN_COLOR_WHITE
Definition: eink.h:92
demo_text
uint8_t demo_text[5]
Definition: main.c:75
demo_text2
uint8_t demo_text2[10]
Definition: main.c:77