IL3820 E-Paper Display sensorif driver

Library for communicating with the IL3820 E-Paper display driver. More...

Collaboration diagram for IL3820 E-Paper Display sensorif driver:

Macros
#define	SIF_IL3820_BUSY_PIN   31
#define	SIF_IL3820_RST_PIN   15
#define	SIF_IL3820_DC_PIN   34
#define	SIF_IL3820_BUSY_TIMEOUT   5000
#define	SIF_IL3820_WIDTH   128
#define	SIF_IL3820_HEIGHT   296
#define	ARRAY_SIZE   (SIF_IL3820_HEIGHT * SIF_IL3820_WIDTH / 8)

Enumerations
enum	SIF_IL3820_Update_Mode { FULL_UPDATE = 0 , PARTIAL_UPDATE }
enum	SIF_IL3820_Clear_Mode { WITH_CLEAR = 0 , WITHOUT_CLEAR }

Functions
ca_error	SIF_IL3820_Initialise (SIF_IL3820_Update_Mode mode)
	EINK Initialisation. More...
void	SIF_IL3820_Deinitialise (void)
	EINK De-Initialisation. More...
void	SIF_IL3820_ClearDisplay (void)
	Clears the display. More...
void	SIF_IL3820_StrongClearDisplay (void)
	Clears the display many times to make sure there is no ghost image. More...
void	SIF_IL3820_DeepSleep (void)
	Enter deep sleep mode. More...
ca_error	SIF_IL3820_overlay_qr_code (const char *text, uint8_t *image, uint8_t scale, uint8_t x, uint8_t y)
	Creates a QR code and overlays it on top of a pre-existing image at the given coordinates. More...
void	SIF_IL3820_DisplayImage (const uint8_t *image, SIF_IL3820_Clear_Mode mode)
	Follows Routines for clearing, waiting and displaying the image. More...

Detailed Description

Library for communicating with the IL3820 E-Paper display driver.

Macro Definition Documentation

ARRAY_SIZE

#define ARRAY_SIZE   (SIF_IL3820_HEIGHT * SIF_IL3820_WIDTH / 8)

SIF_IL3820_BUSY_PIN

#define SIF_IL3820_BUSY_PIN   31

SIF_IL3820_BUSY_TIMEOUT

#define SIF_IL3820_BUSY_TIMEOUT   5000

SIF_IL3820_DC_PIN

#define SIF_IL3820_DC_PIN   34

SIF_IL3820_HEIGHT

#define SIF_IL3820_HEIGHT   296

SIF_IL3820_RST_PIN

#define SIF_IL3820_RST_PIN   15

SIF_IL3820_WIDTH

#define SIF_IL3820_WIDTH   128

Enumeration Type Documentation

SIF_IL3820_Clear_Mode

enum SIF_IL3820_Clear_Mode

Enumerator
WITH_CLEAR
WITHOUT_CLEAR

SIF_IL3820_Update_Mode

enum SIF_IL3820_Update_Mode

Enumerator
FULL_UPDATE
PARTIAL_UPDATE

Function Documentation

SIF_IL3820_ClearDisplay()

void SIF_IL3820_ClearDisplay

(

void

)

Clears the display.

SIF_IL3820_DeepSleep()

void SIF_IL3820_DeepSleep

(

void

)

Enter deep sleep mode.

Device draws around 2uA in this mode.

SIF_IL3820_Deinitialise()

void SIF_IL3820_Deinitialise

(

void

)

EINK De-Initialisation.

SIF_IL3820_DisplayImage()

void SIF_IL3820_DisplayImage	(	const uint8_t *	image,
		SIF_IL3820_Clear_Mode	mode
	)

Follows Routines for clearing, waiting and displaying the image.

Parameters

image	- The image to be overlaid on the eink screen.
mode	- Whether or not the display will be cleared before the image is displayed

SIF_IL3820_Initialise()

ca_error SIF_IL3820_Initialise

(

SIF_IL3820_Update_Mode

mode

)

EINK Initialisation.

Parameters

mode	- Whether to initialise for FULL_UPDATE or PARTIAL_UPDATE

SIF_IL3820_overlay_qr_code()

ca_error SIF_IL3820_overlay_qr_code	(	const char *	text,
		uint8_t *	image,
		uint8_t	scale,
		uint8_t	x,
		uint8_t	y
	)

Creates a QR code and overlays it on top of a pre-existing image at the given coordinates.

Parameters

text	- The text string that is encoded into a QR symbol.
image	- The image that is overlaid by the QR symbol.
scale	- scaling of the image, 1 or 2 supported.
x	- The x-coordinate of the top-left corner of the QR symbol.
y	- The y-coordinate of the top-left corner of the QR symbol.

SIF_IL3820_StrongClearDisplay()

void SIF_IL3820_StrongClearDisplay

(

void

)

Clears the display many times to make sure there is no ghost image.