eink_154inch  2.0.0.0
Main Page

eINK 1.54 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 Eink154Inch 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 Eink154Inch 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 1.54 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.
EINK_154INCH_MAP_MIKROBUS( cfg, MIKROBUS_1 );
eink_154inch_init( &eink_154inch, &cfg );
eink154_start_config( &eink_154inch );
eink154_set_lut( &eink_154inch, EINK154_LUT_TABLE, 30 );
Delay_ms( 1000 );
#ifndef IMAGE_MODE_ONLY
eink154_set_font( &eink_154inch, &cfg_font );
text_set.n_char = 4;
text_set.text_x = 10;
text_set.text_y = 50;
eink154_text( &eink_154inch, &demo_text[ 0 ], &text_set );
text_set.n_char = 7;
text_set.text_x = 10;
text_set.text_y = 90;
eink154_text( &eink_154inch, &demo_text1[ 0 ], &text_set );
text_set.n_char = 8;
text_set.text_x = 10;
text_set.text_y = 130;
eink154_text( &eink_154inch, &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 )
{
eink154_display_image( &eink_154inch, &demoImage_light[ 0 ] );
Delay_1sec( );
eink154_display_image( &eink_154inch, &demoImage_dark[ 0 ] );
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.Eink154Inch

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.


EINK_154INCH_MAP_MIKROBUS
#define EINK_154INCH_MAP_MIKROBUS(cfg, mikrobus)
Definition: eink_154inch.h:53
eink_154inch_font_t::orientation
uint8_t orientation
Definition: eink_154inch.h:156
eink_154_text_set_t::text_x
uint8_t text_x
Definition: eink_154inch.h:181
guiFont_Tahoma_18_Regular
const uint8_t guiFont_Tahoma_18_Regular[5525]
Definition: eINK_154_display_font.h:609
eink_154inch_cfg_t
Click configuration structure definition.
Definition: eink_154inch.h:217
eink_154_text_set_t::n_char
uint8_t n_char
Definition: eink_154inch.h:183
demo_text
char demo_text[5]
Definition: main.c:66
eink_154inch_font_t::color
uint16_t color
Definition: eink_154inch.h:155
EINK154_SCREEN_COLOR_WHITE
#define EINK154_SCREEN_COLOR_WHITE
Definition: eink_154inch.h:94
demo_text2
char demo_text2[10]
Definition: main.c:68
EINK154_FO_HORIZONTAL
#define EINK154_FO_HORIZONTAL
Definition: eink_154inch.h:99
eink154_display_image
void eink154_display_image(eink_154inch_t *ctx, const uint8_t *image_buffer)
Displays image.
eink_154inch_cfg_setup
void eink_154inch_cfg_setup(eink_154inch_cfg_t *cfg)
Config Object Initialization function.
application_task
void application_task(void)
Definition: main.c:110
demo_text1
char demo_text1[8]
Definition: main.c:67
eink_154inch_init
EINK_154INCH_RETVAL eink_154inch_init(eink_154inch_t *ctx, eink_154inch_cfg_t *cfg)
Initialization function.
eink_154inch_font_t::p_font
const uint8_t * p_font
Definition: eink_154inch.h:154
eink154_set_font
void eink154_set_font(eink_154inch_t *ctx, eink_154inch_font_t *cfg_font)
Set text font.
eink154_start_config
void eink154_start_config(eink_154inch_t *ctx)
Configuration display.
EINK154_LUT_TABLE
const uint8_t EINK154_LUT_TABLE[30]
Definition: main.c:58
eink154_set_lut
void eink154_set_lut(eink_154inch_t *ctx, const uint8_t *lut, uint8_t n_bytes)
Set LUT table.
eink154_text
void eink154_text(eink_154inch_t *ctx, char *text, eink_154_text_set_t *text_set)
Draw text on the screen.
eink_154_text_set_t
Definition: eink_154inch.h:179
application_init
void application_init(void)
Definition: main.c:72
eink_154inch_font_t
Definition: eink_154inch.h:152
demoImage_light
const uint8_t demoImage_light[5000]
Definition: eINK_154_display_image.h:316
eink_154_text_set_t::text_y
uint8_t text_y
Definition: eink_154inch.h:182
demoImage_dark
const uint8_t demoImage_dark[5000]
Definition: eINK_154_display_image.h:1