Pervasive Displays Library Suite - Basic edition  5.2.4
Library for Pervasive Displays e-paper screens and EXT3 extension board
Screen_EPD_EXT3 Class Referencefinal

Class for Pervasive Displays iTC monochome and colour screens. More...

#include <Screen_EPD_EXT3.h>

Inheritance diagram for Screen_EPD_EXT3:
Collaboration diagram for Screen_EPD_EXT3:

Public Member Functions

 Screen_EPD_EXT3 (eScreen_EPD_EXT3_t eScreen_EPD_EXT3, pins_t board)
 Constructor with default pins. More...
 
void begin ()
 Initialisation. More...
 
String WhoAmI ()
 Who Am I. More...
 
void clear (uint16_t colour=myColours.white)
 Clear the screen. More...
 
void invert (bool flag)
 Invert screen. More...
 
void flush ()
 Update the display, global update. More...
 
void point (uint16_t x1, uint16_t y1, uint16_t colour)
 Draw pixel. More...
 
uint16_t readPixel (uint16_t x1, uint16_t y1)
 Read pixel colour. More...
 
uint8_t getRefreshTime ()
 Screen refresh time for the BWR screens. More...
 
- Public Member Functions inherited from hV_Screen_Buffer
 hV_Screen_Buffer ()
 Constructor.
 
virtual void setOrientation (uint8_t orientation)
 Set orientation. More...
 
uint8_t getOrientation ()
 Get orientation. More...
 
virtual uint16_t screenSizeX ()
 Screen size, x-axis. More...
 
virtual uint16_t screenSizeY ()
 Screen size, y-axis. More...
 
virtual uint16_t screenDiagonal ()
 Screen size, diagonal. More...
 
virtual uint8_t screenColourBits ()
 Screen colour depth. More...
 
virtual void circle (uint16_t x0, uint16_t y0, uint16_t radius, uint16_t colour)
 Draw circle. More...
 
virtual void line (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t colour)
 Draw line, rectangle coordinates. More...
 
virtual void dLine (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t colour)
 Draw line, vector coordinates. More...
 
virtual void setPenSolid (bool flag=true)
 Set pen opaque. More...
 
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. More...
 
virtual void rectangle (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t colour)
 Draw rectangle, rectangle coordinates. More...
 
virtual void dRectangle (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t colour)
 Draw rectangle, vector coordinates. More...
 
virtual void selectFont (uint8_t font)
 Select font number. More...
 
virtual uint8_t getFont ()
 Get font number. More...
 
virtual uint8_t addFont (font_s fontName)
 Add a font. More...
 
virtual void setFontSolid (bool flag=true)
 Set transparent or opaque text. More...
 
virtual void setFontSpaceX (uint8_t number=1)
 Set additional spaces between two characters, horizontal axis. More...
 
virtual void setFontSpaceY (uint8_t number=1)
 Set additional spaces between two characters, vertical axis. More...
 
virtual uint16_t characterSizeX (uint8_t character=0x00)
 Character size, x-axis. More...
 
virtual uint16_t characterSizeY ()
 Character size, y-axis. More...
 
virtual uint16_t stringSizeX (String text)
 String size, x-axis. More...
 
virtual uint8_t stringLengthToFitX (String text, uint16_t pixels)
 Number of characters to fit a size, x-axis. More...
 
virtual uint8_t fontMax ()
 Number of fonts. More...
 
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. More...
 

Additional Inherited Members

- Protected Member Functions inherited from hV_Font_Terminal
void _f_begin ()
 Initialisation.
 
void _f_selectFont (uint8_t font)
 Select font. More...
 
uint8_t _f_addFont (font_s fontName)
 Use a font. More...
 
void _f_setFontSolid (bool flag=true)
 Set transparent or opaque text. More...
 
void _f_setFontSpaceX (uint8_t number=1)
 Set additional pixels between two characters, horizontal axis. More...
 
void _f_setFontSpaceY (uint8_t number=1)
 Set additional pixels between two characters, vertical axis. More...
 
uint16_t _f_characterSizeX (uint8_t character=0x00)
 Character size, x-axis. More...
 
uint16_t _f_characterSizeY ()
 Character size, y-axis. More...
 
uint16_t _f_stringSizeX (String text)
 String size, x-axis. More...
 
uint8_t _f_stringLengthToFitX (String text, uint16_t pixels)
 Number of characters to fit a size, x-axis. More...
 
uint8_t _f_fontMax ()
 Number of fonts. More...
 
uint8_t _f_getFontKind ()
 Get selected font details. More...
 
uint8_t _f_getFontMaxWidth ()
 Get selected font details. More...
 
uint8_t _f_getCharacter (uint8_t character, uint16_t index)
 Get definition for line of character. More...
 
- Protected Attributes inherited from hV_Font_Terminal
font_s _f_font
 font
 
uint8_t _f_fontNumber
 number of fonts available, 0.._fontNumber-1
 
uint8_t _f_fontSize
 actual font selected
 
uint8_t _f_fontSpaceX
 pixels between two characters, horizontal axis
 
uint8_t _f_fontSpaceY
 pixels between two characters, vertical axis
 
bool _f_fontSolid
 font
 

Detailed Description

Class for Pervasive Displays iTC monochome and colour screens.

Screen controllers

  • LCD: propietary, SPI
  • touch: no touch
  • fonts: no fonts


All commands work on the frame-buffer, to be displayed on screen with flush()

Constructor & Destructor Documentation

◆ Screen_EPD_EXT3()

Screen_EPD_EXT3::Screen_EPD_EXT3 ( eScreen_EPD_EXT3_t  eScreen_EPD_EXT3,
pins_t  board 
)

Constructor with default pins.

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

Member Function Documentation

◆ begin()

void Screen_EPD_EXT3::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::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::flush ( )
virtual

Update the display, global update.

Note
Send the frame-buffer to the screen and refresh the screen

Implements hV_Screen_Buffer.

◆ getRefreshTime()

uint8_t Screen_EPD_EXT3::getRefreshTime ( )

Screen refresh time for the BWR screens.

Returns
Estimated refresh time in seconds

◆ invert()

void Screen_EPD_EXT3::invert ( bool  flag)

Invert screen.

Parameters
flagtrue to invert, false for normal screen

◆ point()

void Screen_EPD_EXT3::point ( uint16_t  x1,
uint16_t  y1,
uint16_t  colour 
)
virtual

Draw pixel.

Parameters
x1point coordinate, x-axis
y1point coordinate, y-axis
colour16-bit colour


More: Coordinate, Colour

Reimplemented from hV_Screen_Buffer.

◆ readPixel()

uint16_t Screen_EPD_EXT3::readPixel ( uint16_t  x1,
uint16_t  y1 
)

Read pixel colour.

Parameters
x1point coordinate, x-axis
y1point coordinate, y-axis
Returns
16-bit colour, bits 15-11 red, bits 10-5 green, bits 4-0 blue


More: Coordinate, Colour

◆ WhoAmI()

String Screen_EPD_EXT3::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: