Driver_EPD_Virtual Class Reference

Generic driver class. More...

#include <Driver_EPD_Virtual.h>

Inheritance diagram for Driver_EPD_Virtual:

Collaboration diagram for Driver_EPD_Virtual:

Public Member Functions
	Driver_EPD_Virtual ()=default
	Constructor.
	Driver_EPD_Virtual (eScreen_EPD_t eScreen_EPD, pins_t board)
	Constructor.
	~Driver_EPD_Virtual ()=default
	Destructor.
virtual void	begin ()
	Initialisation.
virtual STRING_CONST_TYPE	reference ()
	Driver reference.
void	setTemperatureC (int8_t temperatureC=25)
	Set temperature in Celsius.
void	setTemperatureF (int16_t temperatureF=77)
	Set temperature in Fahrenheit.
virtual void	updateNormal (FRAMEBUFFER_CONST_TYPE frame, uint32_t sizeFrame)
	Normal update.
virtual void	updateNormal (FRAMEBUFFER_CONST_TYPE frame1, FRAMEBUFFER_CONST_TYPE frame2, uint32_t sizeFrame)
	Normal update.
virtual void	updateNormal (FRAMEBUFFER_CONST_TYPE frameM1, FRAMEBUFFER_CONST_TYPE frameM2, FRAMEBUFFER_CONST_TYPE frameS1, FRAMEBUFFER_CONST_TYPE frameS2, uint32_t sizeFrame)
	Normal update.
virtual void	updateFast (FRAMEBUFFER_CONST_TYPE frame1, FRAMEBUFFER_CONST_TYPE frame2, uint32_t sizeFrame)
	Fast update.
virtual void	updateFast (FRAMEBUFFER_CONST_TYPE frameM1, FRAMEBUFFER_CONST_TYPE frameM2, FRAMEBUFFER_CONST_TYPE frameS1, FRAMEBUFFER_CONST_TYPE frameS2, uint32_t sizeFrame)
	Fast update.
Public Member Functions inherited from hV_Board
	hV_Board ()
	Constructor.

Friends
class	Screen_EPD

Detailed Description

Generic driver class.

This class provides the functions for the drivers

Constructor & Destructor Documentation

Driver_EPD_Virtual()

Driver_EPD_Virtual::Driver_EPD_Virtual	(	eScreen_EPD_t	eScreen_EPD,
		pins_t	board )

Constructor.

Parameters

eScreen_EPD
board

Member Function Documentation

begin()

virtual void Driver_EPD_Virtual::begin ( )

virtual

Initialisation.

Warning

Definition for this method is compulsory.

Reimplemented in Pervasive_BWRY_Large, Pervasive_BWRY_Medium, Pervasive_BWRY_Small, Pervasive_Touch_Small, Pervasive_Wide_Large, Pervasive_Wide_Medium, and Pervasive_Wide_Small.

reference()

virtual STRING_CONST_TYPE Driver_EPD_Virtual::reference ( )

virtual

Driver reference.

Returns

STRING_CONST_TYPE scope and release number

Reimplemented in Pervasive_BWRY_Large, Pervasive_BWRY_Medium, Pervasive_BWRY_Small, Pervasive_Touch_Small, Pervasive_Wide_Large, Pervasive_Wide_Medium, and Pervasive_Wide_Small.

setTemperatureC()

void Driver_EPD_Virtual::setTemperatureC

(

int8_t

temperatureC = 25

)

Set temperature in Celsius.

Set the temperature for update

Parameters

temperatureC

temperature in °C, default = 25 °C

Note

Refer to data-sheets for authorised operating temperatures

setTemperatureF()

void Driver_EPD_Virtual::setTemperatureF

(

int16_t

temperatureF = 77

)

Set temperature in Fahrenheit.

Set the temperature for update

Parameters

temperatureF

temperature in °F, default = 77 °F = 25 °C

Note

Refer to data-sheets for authorised operating temperatures

updateFast() [1/2]

virtual void Driver_EPD_Virtual::updateFast ( FRAMEBUFFER_CONST_TYPE frame1, FRAMEBUFFER_CONST_TYPE frame2, uint32_t sizeFrame )

virtual

Fast update.

Scope

• Fast BW small and medium screens, with embedded fast update
• Wide BW small and medium screens, with wide temperature and embedded fast update

  Parameters

  frame1	next image
  frame2	previous image
  sizeFrame	size of the frame

Reimplemented in Pervasive_Touch_Small, Pervasive_Wide_Medium, and Pervasive_Wide_Small.

updateFast() [2/2]

virtual void Driver_EPD_Virtual::updateFast ( FRAMEBUFFER_CONST_TYPE frameM1, FRAMEBUFFER_CONST_TYPE frameM2, FRAMEBUFFER_CONST_TYPE frameS1, FRAMEBUFFER_CONST_TYPE frameS2, uint32_t sizeFrame )

virtual

Fast update.

Scope

• Fast BW large screens, with embedded fast update
• Wide BW large screens, with wide temperature and embedded fast update

  Parameters

  frameM1	next image, master
  frameM2	previous image, master
  frameS1	next image, slave
  frameS2	previous image, slave
  sizeFrame	size of the frame

Reimplemented in Pervasive_Wide_Large.

updateNormal() [1/3]

virtual void Driver_EPD_Virtual::updateNormal ( FRAMEBUFFER_CONST_TYPE frame, uint32_t sizeFrame )

virtual

Normal update.

Scope

• Normal BW small and medium screens
• BWRY small and medium screens, with BWRY colours
• Fast BW small and medium screens, with embedded fast update
• Wide BW small and medium screens, with wide temperature and embedded fast update

Parameters

frame	next image
sizeFrame	size of the frame

Reimplemented in Pervasive_BWRY_Medium, Pervasive_BWRY_Small, Pervasive_Touch_Small, Pervasive_Wide_Medium, and Pervasive_Wide_Small.

updateNormal() [2/3]

virtual void Driver_EPD_Virtual::updateNormal ( FRAMEBUFFER_CONST_TYPE frame1, FRAMEBUFFER_CONST_TYPE frame2, uint32_t sizeFrame )

virtual

Normal update.

Scope

• Normal BW large screens
• Normal BWR small and medium screens

  Parameters

  frame1	next image, black
  frame2	next image, red

• Fast BW large screens, with wide temperature and embedded fast update
• Wide BW large screens, with wide temperature and embedded fast update

  Parameters

  frame1	next image, black, master
  frame2	next image, black, slave
  sizeFrame	size of the frame

Reimplemented in Pervasive_BWRY_Large, and Pervasive_Wide_Large.

updateNormal() [3/3]

virtual void Driver_EPD_Virtual::updateNormal ( FRAMEBUFFER_CONST_TYPE frameM1, FRAMEBUFFER_CONST_TYPE frameM2, FRAMEBUFFER_CONST_TYPE frameS1, FRAMEBUFFER_CONST_TYPE frameS2, uint32_t sizeFrame )

virtual

Normal update.

Scope

• Normal BWR large screens

  Parameters

  frameM1	next image, black, master
  frameM2	next image, red, master
  frameS1	next image, black, slave
  frameS2	next image, red, slave
  sizeFrame	size of the frame

---

The documentation for this class was generated from the following file:

• Driver_EPD_Virtual.h