Paperd.Ink Library 0.0.5
Library for interacting with Paperd.Ink devices.
Loading...
Searching...
No Matches
GxEPD2_154_M09 Class Reference

#include <GxEPD2_154_M09.h>

Inheritance diagram for GxEPD2_154_M09:
GxEPD2_EPD

Public Member Functions

 GxEPD2_154_M09 (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 writeScreenBufferAgain (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 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 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 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 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 = 200
 
static const uint16_t HEIGHT = 200
 
static const GxEPD2::Panel panel = GxEPD2::GDEW0154M09
 
static const bool hasColor = false
 
static const bool hasPartialUpdate = true
 
static const bool hasFastPartialUpdate = true
 
static const uint16_t power_on_time = 250
 
static const uint16_t power_off_time = 100
 
static const uint16_t full_refresh_time = 1000
 
static const uint16_t partial_refresh_time = 400
 

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_154_M09.h.

Constructor & Destructor Documentation

◆ GxEPD2_154_M09()

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

Definition at line 16 of file GxEPD2_154_M09.cpp.

16 :
17 GxEPD2_EPD(cs, dc, rst, busy, LOW, 10000000, WIDTH, HEIGHT, panel, hasColor, hasPartialUpdate, hasFastPartialUpdate)
18{
19}
static const GxEPD2::Panel panel
static const bool hasColor
static const bool hasFastPartialUpdate
static const uint16_t WIDTH
static const bool hasPartialUpdate
static const uint16_t HEIGHT
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)

Member Function Documentation

◆ clearScreen()

void GxEPD2_154_M09::clearScreen ( uint8_t value = 0xFF)
virtual

Implements GxEPD2_EPD.

Definition at line 21 of file GxEPD2_154_M09.cpp.

22{
23 writeScreenBuffer(value);
24 refresh(true);
26}
void writeScreenBuffer(uint8_t value=0xFF)
void writeScreenBufferAgain(uint8_t value=0xFF)
void refresh(bool partial_update_mode=false)

◆ drawImage() [1/2]

void GxEPD2_154_M09::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 214 of file GxEPD2_154_M09.cpp.

215{
216 if (black)
217 {
218 drawImage(black, x, y, w, h, invert, mirror_y, pgm);
219 }
220}
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)

◆ drawImage() [2/2]

void GxEPD2_154_M09::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 199 of file GxEPD2_154_M09.cpp.

200{
201 writeImage(bitmap, x, y, w, h, invert, mirror_y, pgm);
202 refresh(x, y, w, h);
203 writeImageAgain(bitmap, x, y, w, h, invert, mirror_y, pgm);
204}
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 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)

◆ drawImagePart() [1/2]

void GxEPD2_154_M09::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 222 of file GxEPD2_154_M09.cpp.

224{
225 if (black)
226 {
227 drawImagePart(black, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
228 }
229}
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)

◆ drawImagePart() [2/2]

void GxEPD2_154_M09::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 206 of file GxEPD2_154_M09.cpp.

208{
209 writeImagePart(bitmap, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
210 refresh(x, y, w, h);
211 writeImagePartAgain(bitmap, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
212}
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 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)

◆ drawNative()

void GxEPD2_154_M09::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 231 of file GxEPD2_154_M09.cpp.

232{
233 if (data1)
234 {
235 drawImage(data1, x, y, w, h, invert, mirror_y, pgm);
236 }
237}

◆ hibernate()

void GxEPD2_154_M09::hibernate ( )
virtual

Implements GxEPD2_EPD.

Definition at line 277 of file GxEPD2_154_M09.cpp.

278{
279 _PowerOff();
280 if (_rst >= 0)
281 {
282 _writeCommand(0x07); // deep sleep
283 _writeData(0xA5); // check code
284 _hibernating = true;
285 }
286}
void _writeCommand(uint8_t c)
void _writeData(uint8_t d)
int16_t _rst
Definition GxEPD2_EPD.h:112
bool _hibernating
Definition GxEPD2_EPD.h:118

◆ powerOff()

void GxEPD2_154_M09::powerOff ( void )
virtual

Implements GxEPD2_EPD.

Definition at line 272 of file GxEPD2_154_M09.cpp.

273{
274 _PowerOff();
275}

◆ refresh() [1/2]

void GxEPD2_154_M09::refresh ( bool partial_update_mode = false)
virtual

Implements GxEPD2_EPD.

Definition at line 239 of file GxEPD2_154_M09.cpp.

240{
241 if (partial_update_mode) refresh(0, 0, WIDTH, HEIGHT);
242 else
243 {
244 if (_using_partial_mode) _Init_Full();
245 _Update_Full();
246 _initial_refresh = false; // initial full update done
247 }
248}
bool _using_partial_mode
Definition GxEPD2_EPD.h:118
bool _initial_refresh
Definition GxEPD2_EPD.h:117

◆ refresh() [2/2]

void GxEPD2_154_M09::refresh ( int16_t x,
int16_t y,
int16_t w,
int16_t h )
virtual

Implements GxEPD2_EPD.

Definition at line 250 of file GxEPD2_154_M09.cpp.

251{
252 if (_initial_refresh) return refresh(false); // initial update needs be full update
253 // intersection with screen
254 int16_t w1 = x < 0 ? w + x : w; // reduce
255 int16_t h1 = y < 0 ? h + y : h; // reduce
256 int16_t x1 = x < 0 ? 0 : x; // limit
257 int16_t y1 = y < 0 ? 0 : y; // limit
258 w1 = x1 + w1 < int16_t(WIDTH) ? w1 : int16_t(WIDTH) - x1; // limit
259 h1 = y1 + h1 < int16_t(HEIGHT) ? h1 : int16_t(HEIGHT) - y1; // limit
260 if ((w1 <= 0) || (h1 <= 0)) return;
261 // make x1, w1 multiple of 8
262 w1 += x1 % 8;
263 if (w1 % 8 > 0) w1 += 8 - w1 % 8;
264 x1 -= x1 % 8;
265 if (!_using_partial_mode) _Init_Part();
266 _writeCommand(0x91); // partial in
267 _setPartialRamArea(x1, y1, w1, h1);
268 _Update_Part();
269 _writeCommand(0x92); // partial out
270}

◆ writeImage() [1/2]

void GxEPD2_154_M09::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 174 of file GxEPD2_154_M09.cpp.

175{
176 if (black)
177 {
178 writeImage(black, x, y, w, h, invert, mirror_y, pgm);
179 }
180}

◆ writeImage() [2/2]

void GxEPD2_154_M09::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_154_M09.cpp.

52{
53 _writeImage(0x13, bitmap, x, y, w, h, invert, mirror_y, pgm);
54}

◆ writeImageAgain()

void GxEPD2_154_M09::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 )
virtual

Reimplemented from GxEPD2_EPD.

Definition at line 56 of file GxEPD2_154_M09.cpp.

57{
58 _writeImage(0x10, bitmap, x, y, w, h, invert, mirror_y, pgm);
59}

◆ writeImagePart() [1/2]

void GxEPD2_154_M09::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 182 of file GxEPD2_154_M09.cpp.

184{
185 if (black)
186 {
187 writeImagePart(black, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
188 }
189}

◆ writeImagePart() [2/2]

void GxEPD2_154_M09::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 108 of file GxEPD2_154_M09.cpp.

110{
111 _writeImagePart(0x13, bitmap, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
112}

◆ writeImagePartAgain()

void GxEPD2_154_M09::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 )
virtual

Reimplemented from GxEPD2_EPD.

Definition at line 114 of file GxEPD2_154_M09.cpp.

116{
117 _writeImagePart(0x10, bitmap, x_part, y_part, w_bitmap, h_bitmap, x, y, w, h, invert, mirror_y, pgm);
118}

◆ writeNative()

void GxEPD2_154_M09::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 191 of file GxEPD2_154_M09.cpp.

192{
193 if (data1)
194 {
195 writeImage(data1, x, y, w, h, invert, mirror_y, pgm);
196 }
197}

◆ writeScreenBuffer()

void GxEPD2_154_M09::writeScreenBuffer ( uint8_t value = 0xFF)
virtual

Implements GxEPD2_EPD.

Definition at line 28 of file GxEPD2_154_M09.cpp.

29{
30 _initial_write = false; // initial full screen buffer clean done
31 if (!_using_partial_mode) _Init_Part();
32 _writeScreenBuffer(0x13, value); // set current
33 if (_initial_refresh) _writeScreenBuffer(0x26, value); // set previous
34}
bool _initial_write
Definition GxEPD2_EPD.h:117

◆ writeScreenBufferAgain()

void GxEPD2_154_M09::writeScreenBufferAgain ( uint8_t value = 0xFF)
virtual

Reimplemented from GxEPD2_EPD.

Definition at line 36 of file GxEPD2_154_M09.cpp.

37{
38 if (!_using_partial_mode) _Init_Part();
39 _writeScreenBuffer(0x10, value); // set previous
40}

Member Data Documentation

◆ full_refresh_time

const uint16_t GxEPD2_154_M09::full_refresh_time = 1000
static

Definition at line 31 of file GxEPD2_154_M09.h.

◆ hasColor

const bool GxEPD2_154_M09::hasColor = false
static

Definition at line 26 of file GxEPD2_154_M09.h.

◆ hasFastPartialUpdate

const bool GxEPD2_154_M09::hasFastPartialUpdate = true
static

Definition at line 28 of file GxEPD2_154_M09.h.

◆ hasPartialUpdate

const bool GxEPD2_154_M09::hasPartialUpdate = true
static

Definition at line 27 of file GxEPD2_154_M09.h.

◆ HEIGHT

const uint16_t GxEPD2_154_M09::HEIGHT = 200
static

Definition at line 24 of file GxEPD2_154_M09.h.

◆ panel

const GxEPD2::Panel GxEPD2_154_M09::panel = GxEPD2::GDEW0154M09
static

Definition at line 25 of file GxEPD2_154_M09.h.

◆ partial_refresh_time

const uint16_t GxEPD2_154_M09::partial_refresh_time = 400
static

Definition at line 32 of file GxEPD2_154_M09.h.

◆ power_off_time

const uint16_t GxEPD2_154_M09::power_off_time = 100
static

Definition at line 30 of file GxEPD2_154_M09.h.

◆ power_on_time

const uint16_t GxEPD2_154_M09::power_on_time = 250
static

Definition at line 29 of file GxEPD2_154_M09.h.

◆ WIDTH

const uint16_t GxEPD2_154_M09::WIDTH = 200
static

Definition at line 23 of file GxEPD2_154_M09.h.


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