Pervasive Displays Library Suite - Basic edition 8.0.8
Library for Pervasive Displays e-paper screens and EXT3 extension board
Loading...
Searching...
No Matches
Screen_EPD_EXT3_Fast Class Referencefinal

Class for Pervasive Displays iTC monochrome touch screens with embedded fast update. More...

#include <Screen_EPD_EXT3.h>

Inheritance diagram for Screen_EPD_EXT3_Fast:
Collaboration diagram for Screen_EPD_EXT3_Fast:

Public Member Functions

 Screen_EPD_EXT3_Fast (uint32_t eScreen_EPD_EXT3, pins_t board)
 Constructor with default pins.
 
void begin ()
 Initialisation.
 
void suspend (uint8_t suspendScope=0x01)
 Suspend.
 
void resume ()
 Resume after suspend()
 
virtual String WhoAmI ()
 Who Am I.
 
void clear (uint16_t colour=myColours.white)
 Clear the screen.
 
void flush ()
 Update the display, global update.
 
void regenerate (uint8_t mode=0x02)
 Regenerate the panel.
 
uint8_t flushMode (uint8_t updateMode=0x02)
 Update the display.
 
- Public Member Functions inherited from hV_Screen_Buffer
 hV_Screen_Buffer ()
 Constructor.
 
virtual void setOrientation (uint8_t orientation)
 Set orientation.
 
uint8_t getOrientation ()
 Get orientation.
 
virtual uint16_t screenSizeX ()
 Screen size, x-axis of logical screen.
 
virtual uint16_t screenSizeY ()
 Screen size, y-axis of logical screen.
 
virtual uint16_t screenDiagonal ()
 Screen size, diagonal.
 
virtual uint8_t screenColourBits ()
 Screen colour depth.
 
virtual void circle (uint16_t x0, uint16_t y0, uint16_t radius, uint16_t colour)
 Draw circle.
 
virtual void line (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t colour)
 Draw line, rectangle coordinates.
 
virtual void dLine (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t colour)
 Draw line, vector coordinates.
 
virtual void setPenSolid (bool flag=true)
 Set pen opaque.
 
virtual void triangle (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t x3, uint16_t y3, uint16_t colour)
 Draw triangle, rectangle coordinates.
 
virtual void rectangle (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t colour)
 Draw rectangle, rectangle coordinates.
 
virtual void dRectangle (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t colour)
 Draw rectangle, vector coordinates.
 
virtual void point (uint16_t x1, uint16_t y1, uint16_t colour)
 Draw pixel.
 
virtual void selectFont (uint8_t font)
 Select font number.
 
virtual uint8_t getFont ()
 Get font number.
 
virtual uint8_t addFont (font_s fontName)
 Add a font.
 
virtual void setFontSolid (bool flag=true)
 Set transparent or opaque text.
 
virtual void setFontSpaceX (uint8_t number=1)
 Set additional spaces between two characters, horizontal axis.
 
virtual void setFontSpaceY (uint8_t number=1)
 Set additional spaces between two characters, vertical axis.
 
virtual uint16_t characterSizeX (uint8_t character=0x00)
 Character size, x-axis.
 
virtual uint16_t characterSizeY ()
 Character size, y-axis.
 
virtual uint16_t stringSizeX (String text)
 String size, x-axis.
 
virtual uint8_t stringLengthToFitX (String text, uint16_t pixels)
 Number of characters to fit a size, x-axis.
 
virtual uint8_t fontMax ()
 Number of fonts.
 
virtual void gText (uint16_t x0, uint16_t y0, String text, uint16_t textColour=myColours.black, uint16_t backColour=myColours.white)
 Draw ASCII Text (pixel coordinates) with selection of size.
 
virtual void gTextLarge (uint16_t x0, uint16_t y0, String text, uint16_t textColour=myColours.black, uint16_t backColour=myColours.white)
 Draw ASCII Text (pixel coordinates) with selection of size.
 
bool isTouch ()
 Is touch available?
 
bool isTouchEvent ()
 Are touch events available?
 
bool getTouch (uint16_t &x, uint16_t &y, uint16_t &z, uint16_t &t)
 Poll touch.
 
void clearTouch ()
 Clear touch.
 
bool getTouchInterrupt ()
 Check touch interrupt.
 
void calibrateTouch ()
 Calibrate the touch.
 
- Public Member Functions inherited from hV_Utilities_PDLS
void setTemperatureC (int8_t temperatureC=25)
 Set temperature in Celsius.
 
void setTemperatureF (int16_t temperatureF=77)
 Set temperature in Fahrenheit.
 
uint8_t checkTemperatureMode (uint8_t updateMode)
 Check the mode against the temperature.
 
void setPowerProfile (uint8_t mode=0x00, uint8_t scope=0x01)
 Set the power profile.
 
void invert (bool flag)
 Invert screen.
 
uint8_t screenColours ()
 Get number of colours.
 
virtual String screenNumber ()
 Screen number.
 
void debugVariant (uint8_t contextFilm)
 Recommend variant for film.
 
- Public Member Functions inherited from hV_Board
 hV_Board ()
 Constructor.
 
void setPanelPowerPin (uint8_t panelPowerPin=(uint8_t) 0xff)
 Set panelPower pin.
 
pins_t getBoardPins ()
 Get the pins of the board.
 

Detailed Description

Class for Pervasive Displays iTC monochrome touch screens with embedded fast update.

Screen controllers

  • LCD: proprietary, SPI
  • touch: proprietary, I2C
  • fonts: no external Flash
Note
All commands work on the frame-buffer, to be displayed on screen with flush()

Constructor & Destructor Documentation

◆ Screen_EPD_EXT3_Fast()

Screen_EPD_EXT3_Fast::Screen_EPD_EXT3_Fast ( uint32_t eScreen_EPD_EXT3,
pins_t board )

Constructor with default pins.

Parameters
eScreen_EPD_EXT3size and model of the e-screen
boardboard configuration
Note
Frame-buffer generated by the class
To be used with begin() with no parameter

Member Function Documentation

◆ begin()

void Screen_EPD_EXT3_Fast::begin ( )
virtual

Initialisation.

Note
Frame-buffer generated internally, not suitable for FRAM
Warning
begin() initialises SPI and I2C

Reimplemented from hV_Screen_Buffer.

◆ clear()

void Screen_EPD_EXT3_Fast::clear ( uint16_t colour = myColours.white)
virtual

Clear the screen.

Parameters
colourdefault = white
Note
Clear next frame-buffer

Reimplemented from hV_Screen_Buffer.

◆ flush()

void Screen_EPD_EXT3_Fast::flush ( )
virtual

Update the display, global update.

Note
  1. Send the frame-buffer to the screen
  2. Refresh the screen
  3. Copy next frame-buffer into old frame-buffer

Implements hV_Screen_Buffer.

◆ flushMode()

uint8_t Screen_EPD_EXT3_Fast::flushMode ( uint8_t updateMode = 0x02)

Update the display.

Display next frame-buffer on screen and copy next frame-buffer into old frame-buffer

Parameters
updateModeexpected update mode, default = UPDATE_FAST
Returns
uint8_t recommended mode
Note
Mode checked with checkTemperatureMode()

◆ regenerate()

void Screen_EPD_EXT3_Fast::regenerate ( uint8_t mode = 0x02)

Regenerate the panel.

White-to-black-to-white cycle to reduce ghosting

Parameters
modedefault = UPDATE_FAST = fast mode

◆ resume()

void Screen_EPD_EXT3_Fast::resume ( )

Resume after suspend()

Turn SPI on and set all GPIOs levels

◆ suspend()

void Screen_EPD_EXT3_Fast::suspend ( uint8_t suspendScope = 0x01)

Suspend.

Parameters
suspendScopedefault = POWER_SCOPE_GPIO_ONLY, otherwise POWER_SCOPE_NONE

Power off and set all GPIOs low

Note
If panelPower is NOT_CONNECTED, POWER_SCOPE_GPIO_ONLY defaults to POWER_SCOPE_NONE

◆ WhoAmI()

String Screen_EPD_EXT3_Fast::WhoAmI ( )
virtual

Who Am I.

Returns
Who Am I string

Implements hV_Screen_Buffer.


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