Serial_Buffer Class Reference

Screen printed as header file on Serial console. More...

#include <hV_Serial_Buffer.h>

Inheritance diagram for Serial_Buffer:

Collaboration diagram for Serial_Buffer:

Public Member Functions
	Serial_Buffer (Screen_EPD *screen)
	Constructor object.
uint8_t	saveScreen (STRING_CONST_TYPE name)
	Screen saved as image header file to SD-card.
uint8_t	readScreen (const uint8_t *buffer)
	Read an image from a header file.
Public Member Functions inherited from Serial_System
	Serial_System ()
	Constructor object.
uint8_t	beginFileSystem (uint8_t pinCS=NOT_CONNECTED, uint8_t port=0, int8_t pinDetect=-1, int level=LOW)
	File system and SD-card initialisation.
uint8_t	endFileSystem ()
	Close file system.
uint8_t	setFolder (STRING_CONST_TYPE name)
	Set the folder for files.
uint8_t	suspendFileSystem ()
	Suspend file system.
uint8_t	resumeFileSystem ()
	Resume file system after suspend.
uint8_t	saveScreen (STRING_CONST_TYPE name, uint8_t multiplier=1)
	Screen printed to serial console.
uint8_t	saveWindow (STRING_CONST_TYPE name, uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint8_t multiplier=1)
	Partial window printed to serial console.
uint8_t	readScreen (STRING_CONST_TYPE name, uint8_t multiplier=1)
	Load and display header file.

Detailed Description

Screen printed as header file on Serial console.

Note

For all screens, monochrome and colour, 16 bits per pixel

Header file to be included in project

Constructor & Destructor Documentation

Serial_Buffer()

Serial_Buffer::Serial_Buffer

(

Screen_EPD *

screen

)

Constructor object.

Parameters

screen

&screen to link Serial_Buffer to

Member Function Documentation

readScreen()

uint8_t Serial_Buffer::readScreen

(

const uint8_t *

buffer

)

Read an image from a header file.

Frame-buffer updated, flush() required

Note

Image compiled as header file at build-time

Parameters

image

image_s image

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

Warning

Use flush() to refresh the panel

saveScreen()

uint8_t Serial_Buffer::saveScreen

(

STRING_CONST_TYPE

name

)

Screen saved as image header file to SD-card.

Parameters

name	file name, only letters and numbers

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

---

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

• hV_Serial_Buffer.h