hV_CodeQR.h File Reference

QR-code library for Pervasive Displays iTC monochrome and colour screens. More...

#include "PDLS_Common.h"
#include "hV_Screen_Virtual.h"

Include dependency graph for hV_CodeQR.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	hV_CODEQR_RELEASE   902
	Release.
Options
See also https://github.com/ricmoo/QRCode#what-is-version-error-correction-and-mode
#define	QR_MODE   MODE_ALPHANUMERIC
	recommended
#define	QR_ECC   ECC_MEDIUM
	error correction
#define	QR_VERSION   4
#define	QR_MAX_LENGTH   90

Functions
bool	codeQR (hV_Screen_Virtual *screen, uint16_t x0, uint16_t y0, String text, uint8_t multiplier=2, uint16_t frontColour=myColours.black, uint16_t backColour=myColours.white)
	Generate and display a QR-code.
uint16_t	getSizeCodeQR (uint8_t multiplier=2)
	Get the QR-code square size.

Detailed Description

QR-code library for Pervasive Displays iTC monochrome and colour screens.

Project Pervasive Displays Library Suite
Based on highView technology

Author

Rei Vilo

Date

21 Jan 2025

Version

902

Copyright

(c) Rei Vilo, 2010-2025

All rights reserved

For exclusive use with Pervasive Displays screens

• Evaluation edition: for professionals or organisations, evaluation only, no commercial usage
• Commercial edition: for professionals or organisations, commercial usage

Warning

This library requires the external QRcode library.

* https://www.arduino.cc/reference/en/libraries/qrcode/

* https://github.com/ricmoo/QRCode

Macro Definition Documentation

QR_MAX_LENGTH

#define QR_MAX_LENGTH   90

See also

https://github.com/ricmoo/QRCode#data-capacities

QR_VERSION

#define QR_VERSION   4

version

Function Documentation

codeQR()

bool codeQR	(	hV_Screen_Virtual *	screen,
		uint16_t	x0,
		uint16_t	y0,
		String	text,
		uint8_t	multiplier = 2,
		uint16_t	frontColour = myColours.black,
		uint16_t	backColour = myColours.white )

Generate and display a QR-code.

Parameters

screen	&screen to display the QR-code on
x0	top-left x coordinate
y0	top-left y coordinate
text	text to convert, string or char array
multiplier	size of each dot, default = 2 recommended
frontColour	16-bit colour, default = black
backColour	16-bit colour, default = white

Returns

RESULT_SUCCESS = success, otherwise RESULT_ERROR = overflow

Note

Text maximum length is set by TABLES_DEFINED in QRframes.h

• 11 for 1.1 = 19 characters in 21x21 square
• 12 for 1.2 = 34 characters in 25x25 square
• 16 for 1.6 = 68 characters in 41x41 square

QR-code square size = (41 + 2) * multiplier

getSizeCodeQR()

uint16_t getSizeCodeQR

(

uint8_t

multiplier = 2

)

Get the QR-code square size.

Parameters

multiplier

size of each dot, default = 2 recommended

Returns

size, in pixels