kevin tseng / libEinkShield_mbedcli_ARM_KL25Z

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

EinkShield Class Reference
Public Member Functions

EinkShield Class Reference

class EinkShield for mbed-os More...

#include <EinkShield.h>

Public Member Functions

 EinkShield (EPD_driver driver, PinName bsi_pin, PinName rstn_pin, PinName busyn_pin, PinName csb_pin, PinName dc_pin, PinName scl_pin, PinName sda_pin)
 Constructor to set pin assignment and driver.
void EPD_Init (void)
 Driver initial.
void EPD_Display_KWR (unsigned char const *img_kw, unsigned char const *img_r)
 Display image with color: black, white and red.
void EPD_Display_Red (void)
 Display full screen red.

Detailed Description

class EinkShield for mbed-os

Definition at line 51 of file EinkShield.h.

Constructor & Destructor Documentation

EinkShield ( EPD_driver  driver,
PinName  bsi_pin,
PinName  rstn_pin,
PinName  busyn_pin,
PinName  csb_pin,
PinName  dc_pin,
PinName  scl_pin,
PinName  sda_pin 
)

Constructor to set pin assignment and driver.

Parameters:
driverselect different size display driver for EinkShield, for example: EL029TR1
bsi_pinbus selection pin
rstn_pinreset pin, L: driver will reset when low
busyn_pinbusy pin, L: driver is busy
csb_pinchip-select pin
dc_pindata/command pin
scl_pinserial clock pin
sda_pinserial data pin
Returns:
none

Member Function Documentation

void EPD_Display_KWR ( unsigned char const *  img_kw,
unsigned char const *  img_r 
)

Display image with color: black, white and red. 

    Resolution of EL029TR1 is 128x296.
    Pixel data alignment is from left to right and from top to bottom.
    img_kw point to black and white raw pixel data of image, 
    1 bit per pixel, 0 = black, 1 = white,  
    Total size of img_kw is 128x296/8 = 4736 bytes for EL029TR1.
    img_r point to red raw pixel data of image, 
    1 bit per pixel, 0 = red, 1 = reserved, 
    Total size of img_r is 128x296/8 = 4736 bytes for EL029TR1.
Parameters:
img_kw
point to black and white raw pixel data of image, 
    1 bit per pixel, 0 = black, 1 = white,
img_r
point to red raw pixel data of image, 
    1 bit per pixel, 0 = red, 1 = reserved,
Returns:
none
void EPD_Display_Red ( void   )

Display full screen red.

Parameters:
none
Returns:
none
void EPD_Init ( void   )

Driver initial.

Parameters:
none
Returns:
none
Generated on Wed Jul 13 2022 19:31:02 by  doxygen 1.7.2