hV_Utilities_PDLS Class Reference

Class for Pervasive Displays e-paper displays. More...

#include <hV_Utilities_PDLS.h>

Inheritance diagram for hV_Utilities_PDLS:

Collaboration diagram for hV_Utilities_PDLS:

Public Member Functions
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 e-paper displays.

Shared common functions and variables

Member Function Documentation

checkTemperatureMode()

uint8_t hV_Utilities_PDLS::checkTemperatureMode

(

uint8_t

updateMode

)

Check the mode against the temperature.

Parameters

updateMode

expected update mode

Returns

uint8_t recommended mode

Note

If required, defaulting to UPDATE_GLOBAL or UPDATE_NONE

Warning

Default temperature is 25 °C, otherwise set by setTemperatureC() or setTemperatureF()

debugVariant()

void hV_Utilities_PDLS::debugVariant

(

uint8_t

contextFilm

)

Recommend variant for film.

Parameters

uint8_t

Context film

Note

exit() called after

invert()

void hV_Utilities_PDLS::invert

(

bool

flag

)

Invert screen.

Invert black and white colours

Parameters

flag	true to invert, false for normal screen

screenColours()

uint8_t hV_Utilities_PDLS::screenColours

(

)

Get number of colours.

Returns

uint8_t number of colours

• 2 = monochrome
• 3 = black-white-red or black-white-yellow
• 4 = black-white-red-yellow

screenNumber()

String hV_Utilities_PDLS::screenNumber ( )

virtual

Screen number.

Returns

Screen number as string

setPowerProfile()

void hV_Utilities_PDLS::setPowerProfile	(	uint8_t	mode = 0x00,
		uint8_t	scope = 0x01 )

Set the power profile.

Parameters

mode	default = POWER_MODE_AUTO, otherwise POWER_MODE_MANUAL
scope	default = POWER_SCOPE_GPIO_ONLY, otherwise POWER_SCOPE_NONE

Note

If panelPower is NOT_CONNECTED, (POWER_MODE_AUTO, POWER_SCOPE_GPIO_ONLY) defaults to (POWER_MODE_MANUAL, POWER_SCOPE_NONE)

setTemperatureC()

void hV_Utilities_PDLS::setTemperatureC

(

int8_t

temperatureC = 25

)

Set temperature in Celsius.

Set the temperature for update

Parameters

temperatureC

temperature in °C, default = 25 °C

Note

Refer to data-sheets for authorised operating temperatures

setTemperatureF()

void hV_Utilities_PDLS::setTemperatureF

(

int16_t

temperatureF = 77

)

Set temperature in Fahrenheit.

Set the temperature for update

Parameters

temperatureF

temperature in °F, default = 77 °F = 25 °C

Note

Refer to data-sheets for authorised operating temperatures

---

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

• hV_Utilities_PDLS.h
• hV_Utilities_PDLS.cpp