GxEPD2_371 Class Reference

#include <GxEPD2_371.h>

Inheritance diagram for GxEPD2_371:

Public Member Functions
	GxEPD2_371 (int16_t cs, int16_t dc, int16_t rst, int16_t busy)
void	clearScreen (uint8_t value=0xFF)
void	writeScreenBuffer (uint8_t value=0xFF)
void	writeImage (const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	writeImagePart (const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	writeImage (const uint8_t *black, const uint8_t *color, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	writeImagePart (const uint8_t *black, const uint8_t *color, int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	writeImageAgain (const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	writeImagePartAgain (const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	writeNative (const uint8_t *data1, const uint8_t *data2, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	drawImage (const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	drawImagePart (const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	drawImage (const uint8_t *black, const uint8_t *color, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	drawImagePart (const uint8_t *black, const uint8_t *color, int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	drawNative (const uint8_t *data1, const uint8_t *data2, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void	refresh (bool partial_update_mode=false)
void	refresh (int16_t x, int16_t y, int16_t w, int16_t h)
void	powerOff ()
void	hibernate ()
Public Member Functions inherited from GxEPD2_EPD
	GxEPD2_EPD (int16_t cs, int16_t dc, int16_t rst, int16_t busy, int16_t busy_level, uint32_t busy_timeout, uint16_t w, uint16_t h, GxEPD2::Panel p, bool c, bool pu, bool fpu)
virtual void	init (uint32_t serial_diag_bitrate=0)
virtual void	init (uint32_t serial_diag_bitrate, bool initial, uint16_t reset_duration=10, bool pulldown_rst_mode=false)
virtual void	writeImageForFullRefresh (const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
virtual void	writeScreenBufferAgain (uint8_t value=0xFF)
virtual void	setPaged ()
void	setBusyCallback (void(*busyCallback)(const void *), const void *busy_callback_parameter=0)
void	selectSPI (SPIClass &spi, SPISettings spi_settings)

Static Public Attributes
static const uint16_t	WIDTH = 240
static const uint16_t	HEIGHT = 416
static const GxEPD2::Panel	panel = GxEPD2::GDEW0371W7
static const bool	hasColor = false
static const bool	hasPartialUpdate = true
static const bool	usePartialUpdateWindow = false
static const bool	hasFastPartialUpdate = true
static const uint16_t	power_on_time = 200
static const uint16_t	power_off_time = 50
static const uint16_t	full_refresh_time = 3000
static const uint16_t	partial_refresh_time = 1500

Additional Inherited Members
Static Public Member Functions inherited from GxEPD2_EPD
static uint16_t	gx_uint16_min (uint16_t a, uint16_t b)
static uint16_t	gx_uint16_max (uint16_t a, uint16_t b)
Public Attributes inherited from GxEPD2_EPD
const uint16_t	WIDTH
const uint16_t	HEIGHT
const GxEPD2::Panel	panel
const bool	hasColor
const bool	hasPartialUpdate
const bool	hasFastPartialUpdate
Protected Member Functions inherited from GxEPD2_EPD
void	_reset ()
void	_waitWhileBusy (const char *comment=0, uint16_t busy_time=5000)
void	_writeCommand (uint8_t c)
void	_writeData (uint8_t d)
void	_writeData (const uint8_t *data, uint16_t n)
void	_writeDataPGM (const uint8_t *data, uint16_t n, int16_t fill_with_zeroes=0)
void	_writeDataPGM_sCS (const uint8_t *data, uint16_t n, int16_t fill_with_zeroes=0)
void	_writeCommandData (const uint8_t *pCommandData, uint8_t datalen)
void	_writeCommandDataPGM (const uint8_t *pCommandData, uint8_t datalen)
void	_startTransfer ()
void	_transfer (uint8_t value)
void	_endTransfer ()
Protected Attributes inherited from GxEPD2_EPD
int16_t	_cs
int16_t	_dc
int16_t	_rst
int16_t	_busy
int16_t	_busy_level
uint32_t	_busy_timeout
bool	_diag_enabled
bool	_pulldown_rst_mode
SPIClass *	_pSPIx
SPISettings	_spi_settings
bool	_initial_write
bool	_initial_refresh
bool	_power_is_on
bool	_using_partial_mode
bool	_hibernating
uint16_t	_reset_duration
void(*	_busy_callback )(const void *)
const void *	_busy_callback_parameter

Detailed Description

Definition at line 19 of file GxEPD2_371.h.

Constructor & Destructor Documentation

GxEPD2_371()

GxEPD2_371::GxEPD2_371	(	int16_t	cs,
		int16_t	dc,
		int16_t	rst,
		int16_t	busy )

Definition at line 16 of file GxEPD2_371.cpp.

                                                                        :
  GxEPD2_EPD(cs, dc, rst, busy, LOW, 10000000, WIDTH, HEIGHT, panel, hasColor, hasPartialUpdate, hasFastPartialUpdate)
{
}

Member Function Documentation

clearScreen()

void GxEPD2_371::clearScreen ( uint8_t value = 0xFF )

virtual

Implements GxEPD2_EPD.

Definition at line 21 of file GxEPD2_371.cpp.

{
  writeScreenBuffer(value);
  refresh(true);
  writeScreenBuffer(value);
}

drawImage() [1/2]

void GxEPD2_371::drawImage	(	const uint8_t *	black,
		const uint8_t *	color,
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 196 of file GxEPD2_371.cpp.

{
  writeImage(black, color, x, y, w, h, invert, mirror_y, pgm);
  refresh(x, y, w, h);
  writeImage(black, color, x, y, w, h, invert, mirror_y, pgm);
}

drawImage() [2/2]

void GxEPD2_371::drawImage	(	const uint8_t	bitmap[],
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 181 of file GxEPD2_371.cpp.

{
  writeImage(bitmap, x, y, w, h, invert, mirror_y, pgm);
  refresh(x, y, w, h);
  writeImage(bitmap, x, y, w, h, invert, mirror_y, pgm);
}

drawImagePart() [1/2]

void GxEPD2_371::drawImagePart	(	const uint8_t *	black,
		const uint8_t *	color,
		int16_t	x_part,
		int16_t	y_part,
		int16_t	w_bitmap,
		int16_t	h_bitmap,
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 203 of file GxEPD2_371.cpp.

{
  writeImagePart(black, color, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
  refresh(x, y, w, h);
  writeImagePart(black, color, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
}

drawImagePart() [2/2]

void GxEPD2_371::drawImagePart	(	const uint8_t	bitmap[],
		int16_t	x_part,
		int16_t	y_part,
		int16_t	w_bitmap,
		int16_t	h_bitmap,
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 188 of file GxEPD2_371.cpp.

{
  writeImagePart(bitmap, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
  refresh(x, y, w, h);
  writeImagePart(bitmap, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
}

drawNative()

void GxEPD2_371::drawNative	(	const uint8_t *	data1,
		const uint8_t *	data2,
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 211 of file GxEPD2_371.cpp.

{
  writeNative(data1, data2, x, y, w, h, invert, mirror_y, pgm);
  refresh(x, y, w, h);
  writeNative(data1, data2, x, y, w, h, invert, mirror_y, pgm);
}

hibernate()

void GxEPD2_371::hibernate ( )

virtual

Implements GxEPD2_EPD.

Definition at line 256 of file GxEPD2_371.cpp.

{
  _PowerOff();
  if (_rst >= 0)
  {
    _writeCommand(0x07); // deep sleep
    _writeData(0xA5);    // check code
    _hibernating = true;
  }
}

powerOff()

void GxEPD2_371::powerOff ( void )

virtual

Implements GxEPD2_EPD.

Definition at line 251 of file GxEPD2_371.cpp.

{
  _PowerOff();
}

refresh() [1/2]

void GxEPD2_371::refresh ( bool partial_update_mode = false )

virtual

Implements GxEPD2_EPD.

Definition at line 218 of file GxEPD2_371.cpp.

{
  if (partial_update_mode) refresh(0, 0, WIDTH, HEIGHT);
  else
  {
    if (_using_partial_mode) _Init_Full();
    _Update_Full();
    _initial_refresh = false; // initial full update done
  }
}

refresh() [2/2]

void GxEPD2_371::refresh ( int16_t x, int16_t y, int16_t w, int16_t h )

virtual

Implements GxEPD2_EPD.

Definition at line 229 of file GxEPD2_371.cpp.

{
  if (_initial_refresh) return refresh(false); // initial update needs be full update
  // intersection with screen
  int16_t w1 = x < 0 ? w + x : w; // reduce
  int16_t h1 = y < 0 ? h + y : h; // reduce
  int16_t x1 = x < 0 ? 0 : x; // limit
  int16_t y1 = y < 0 ? 0 : y; // limit
  w1 = x1 + w1 < int16_t(WIDTH) ? w1 : int16_t(WIDTH) - x1; // limit
  h1 = y1 + h1 < int16_t(HEIGHT) ? h1 : int16_t(HEIGHT) - y1; // limit
  if ((w1 <= 0) || (h1 <= 0)) return; 
  // make x1, w1 multiple of 8
  w1 += x1 % 8;
  if (w1 % 8 > 0) w1 += 8 - w1 % 8;
  x1 -= x1 % 8;
  if (!_using_partial_mode) _Init_Part();
  if (usePartialUpdateWindow) _writeCommand(0x91); // partial in
  _setPartialRamArea(x1, y1, w1, h1);
  _Update_Part();
  if (usePartialUpdateWindow) _writeCommand(0x92); // partial out
}

writeImage() [1/2]

void GxEPD2_371::writeImage	(	const uint8_t *	black,
		const uint8_t *	color,
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 156 of file GxEPD2_371.cpp.

{
  if (black)
  {
    writeImage(black, x, y, w, h, invert, mirror_y, pgm);
  }
}

writeImage() [2/2]

void GxEPD2_371::writeImage ( const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false )

virtual

Implements GxEPD2_EPD.

Definition at line 51 of file GxEPD2_371.cpp.

{
  if (_initial_write) writeScreenBuffer(); // initial full screen buffer clean
  delay(1); // yield() to avoid WDT on ESP8266 and ESP32
  int16_t wb = (w + 7) / 8; // width bytes, bitmaps are padded
  x -= x % 8; // byte boundary
  w = wb * 8; // byte boundary
  int16_t x1 = x < 0 ? 0 : x; // limit
  int16_t y1 = y < 0 ? 0 : y; // limit
  int16_t w1 = x + w < int16_t(WIDTH) ? w : int16_t(WIDTH) - x; // limit
  int16_t h1 = y + h < int16_t(HEIGHT) ? h : int16_t(HEIGHT) - y; // limit
  int16_t dx = x1 - x;
  int16_t dy = y1 - y;
  w1 -= dx;
  h1 -= dy;
  if ((w1 <= 0) || (h1 <= 0)) return;
  if (!_using_partial_mode) _Init_Part();
  _writeCommand(0x91); // partial in
  _setPartialRamArea(x1, y1, w1, h1);
  _writeCommand(0x13);
  _startTransfer();
  for (int16_t i = 0; i < h1; i++)
  {
    for (int16_t j = 0; j < w1 / 8; j++)
    {
      uint8_t data;
      // use wb, h of bitmap for index!
      int16_t idx = mirror_y ? j + dx / 8 + ((h - 1 - (i + dy))) * wb : j + dx / 8 + (i + dy) * wb;
      if (pgm)
      {
#if defined(__AVR) || defined(ESP8266) || defined(ESP32)
        data = pgm_read_byte(&bitmap[idx]);
#else
        data = bitmap[idx];
#endif
      }
      else
      {
        data = bitmap[idx];
      }
      if (invert) data = ~data;
      _transfer(data);
    }
  }
  _endTransfer();
  _writeCommand(0x92); // partial out
  delay(1); // yield() to avoid WDT on ESP8266 and ESP32
}

writeImageAgain()

void GxEPD2_371::writeImageAgain ( const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false )

inlinevirtual

Reimplemented from GxEPD2_EPD.

Definition at line 49 of file GxEPD2_371.h.

{};

writeImagePart() [1/2]

void GxEPD2_371::writeImagePart	(	const uint8_t *	black,
		const uint8_t *	color,
		int16_t	x_part,
		int16_t	y_part,
		int16_t	w_bitmap,
		int16_t	h_bitmap,
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 164 of file GxEPD2_371.cpp.

{
  if (black)
  {
    writeImagePart(black, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
  }
}

writeImagePart() [2/2]

void GxEPD2_371::writeImagePart ( const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false )

virtual

Implements GxEPD2_EPD.

Definition at line 100 of file GxEPD2_371.cpp.

{
  if (_initial_write) writeScreenBuffer(); // initial full screen buffer clean
  delay(1); // yield() to avoid WDT on ESP8266 and ESP32
  if ((w_bitmap < 0) || (h_bitmap < 0) || (w < 0) || (h < 0)) return;
  if ((x_part < 0) || (x_part >= w_bitmap)) return;
  if ((y_part < 0) || (y_part >= h_bitmap)) return;
  int16_t wb_bitmap = (w_bitmap + 7) / 8; // width bytes, bitmaps are padded
  x_part -= x_part % 8; // byte boundary
  w = w_bitmap - x_part < w ? w_bitmap - x_part : w; // limit
  h = h_bitmap - y_part < h ? h_bitmap - y_part : h; // limit
  x -= x % 8; // byte boundary
  w = 8 * ((w + 7) / 8); // byte boundary, bitmaps are padded
  int16_t x1 = x < 0 ? 0 : x; // limit
  int16_t y1 = y < 0 ? 0 : y; // limit
  int16_t w1 = x + w < int16_t(WIDTH) ? w : int16_t(WIDTH) - x; // limit
  int16_t h1 = y + h < int16_t(HEIGHT) ? h : int16_t(HEIGHT) - y; // limit
  int16_t dx = x1 - x;
  int16_t dy = y1 - y;
  w1 -= dx;
  h1 -= dy;
  if ((w1 <= 0) || (h1 <= 0)) return;
  if (!_using_partial_mode) _Init_Part();
  _writeCommand(0x91); // partial in
  _setPartialRamArea(x1, y1, w1, h1);
  _writeCommand(0x13);
  _startTransfer();
  for (int16_t i = 0; i < h1; i++)
  {
    for (int16_t j = 0; j < w1 / 8; j++)
    {
      uint8_t data;
      // use wb_bitmap, h_bitmap of bitmap for index!
      int16_t idx = mirror_y ? x_part / 8 + j + dx / 8 + ((h_bitmap - 1 - (y_part + i + dy))) * wb_bitmap : x_part / 8 + j + dx / 8 + (y_part + i + dy) * wb_bitmap;
      if (pgm)
      {
#if defined(__AVR) || defined(ESP8266) || defined(ESP32)
        data = pgm_read_byte(&bitmap[idx]);
#else
        data = bitmap[idx];
#endif
      }
      else
      {
        data = bitmap[idx];
      }
      if (invert) data = ~data;
      _transfer(data);
    }
  }
  _endTransfer();
  _writeCommand(0x92); // partial out
  delay(1); // yield() to avoid WDT on ESP8266 and ESP32
}

writeImagePartAgain()

void GxEPD2_371::writeImagePartAgain ( const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false )

inlinevirtual

Reimplemented from GxEPD2_EPD.

Definition at line 50 of file GxEPD2_371.h.

                                                                                                                                       {};

writeNative()

void GxEPD2_371::writeNative	(	const uint8_t *	data1,
		const uint8_t *	data2,
		int16_t	x,
		int16_t	y,
		int16_t	w,
		int16_t	h,
		bool	invert = false,
		bool	mirror_y = false,
		bool	pgm = false )

Definition at line 173 of file GxEPD2_371.cpp.

{
  if (data1)
  {
    writeImage(data1, x, y, w, h, invert, mirror_y, pgm);
  }
}

writeScreenBuffer()

void GxEPD2_371::writeScreenBuffer ( uint8_t value = 0xFF )

virtual

Implements GxEPD2_EPD.

Definition at line 28 of file GxEPD2_371.cpp.

{
  _initial_write = false; // initial full screen buffer clean done
  if (!_using_partial_mode) _Init_Part();
  _writeCommand(0x13); // set current
  _startTransfer();
  for (uint32_t i = 0; i < uint32_t(WIDTH) * uint32_t(HEIGHT) / 8; i++)
  {
    _transfer(value);
  }
  _endTransfer();
  if (_initial_refresh)
  {
    _writeCommand(0x10); // preset previous
    _startTransfer();
    for (uint32_t i = 0; i < uint32_t(WIDTH) * uint32_t(HEIGHT) / 8; i++)
    {
      _transfer(0xFF); // 0xFF is white
    }
    _endTransfer();
  }
}

Member Data Documentation

full_refresh_time

const uint16_t GxEPD2_371::full_refresh_time = 3000

static

Definition at line 32 of file GxEPD2_371.h.

hasColor

const bool GxEPD2_371::hasColor = false

static

Definition at line 26 of file GxEPD2_371.h.

hasFastPartialUpdate

const bool GxEPD2_371::hasFastPartialUpdate = true

static

Definition at line 29 of file GxEPD2_371.h.

hasPartialUpdate

const bool GxEPD2_371::hasPartialUpdate = true

static

Definition at line 27 of file GxEPD2_371.h.

HEIGHT

const uint16_t GxEPD2_371::HEIGHT = 416

static

Definition at line 24 of file GxEPD2_371.h.

panel

const GxEPD2::Panel GxEPD2_371::panel = GxEPD2::GDEW0371W7

static

Definition at line 25 of file GxEPD2_371.h.

partial_refresh_time

const uint16_t GxEPD2_371::partial_refresh_time = 1500

static

Definition at line 33 of file GxEPD2_371.h.

power_off_time

const uint16_t GxEPD2_371::power_off_time = 50

static

Definition at line 31 of file GxEPD2_371.h.

power_on_time

const uint16_t GxEPD2_371::power_on_time = 200

static

Definition at line 30 of file GxEPD2_371.h.

usePartialUpdateWindow

const bool GxEPD2_371::usePartialUpdateWindow = false

static

Definition at line 28 of file GxEPD2_371.h.

WIDTH

const uint16_t GxEPD2_371::WIDTH = 240

static

Definition at line 23 of file GxEPD2_371.h.

---

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

• src/drivers/epd/GxEPD2_371.h
• src/drivers/epd/GxEPD2_371.cpp