Parameters¶

The configuration files list the constants for the screens, provide a repository of the configuration of the main controller boards, and set system-wide options for the frame-buffer, the fonts, the type of strings and other features.

Note that the screens and the main controller boards are defined dynamically at run-time, while the other parameters are set statically at build-time.

Run-time parameters¶

Constants for screens¶

The hV_List_Constants header file lists the constants used at run-time, especially those used by the drivers to list the screens they support.

The constants include: the screens sizes, the film types, the driver names, the family groups, the power management options and the frame-buffer sizes.

There is no longer a central list of all the supported screens. Each driver lists the screens it supports.

Legacy release 8

The hV_List_Screens header file provides the extensive list of the supported screens.

The option for the screen update are

Basic edition: normal update;
Evaluation edition: normal and fast update;
Commercial edition: normal and fast update;
Viewer editions: normal and fast update.

Some restrictions apply: see the list for more details.

Boards¶

The hV_List_Boards header file provides the list of the pre-configured main controller boards.

The recommended boards are

Adafruit Feather nRF52840;
Arduino Nano Matter based on Silicon Labs MGM240S;
Espressif ESP32-DevKitC;
Raspberry Pi Pico RP2040.

The other boards are

Boards compatible with those listed as recommended;
Arduino Zero or M0 Pro, and compatible boards;
Raspberry Pi Zero and B;
STM32 Nucleo 64, and compatible boards.

The deprecated boards includes

Particle Photon and RedBear Duo;
Texas Instruments MSP430 and MSP432 LaunchPad, and compatible boards;
Texas Instruments CC1352 LaunchPad and CC1352 LPSTK.

The technical note Define a non-listed board explains how to define a non-listed board.

Build-time options¶

The hV_List_Options header file sets the build-time options.

Warning

Those parameters are fixed for the Basic and pre-compiled Evaluation editions. They can be edited and taken into account for the Commercial and Viewer editions.

Fonts¶

The Fonts include

Basic edition: the Terminal font, with up to 4 variants;
Evaluation, Commercial and Viewer editions: the fixed Mono, and the proportional Serif and Sans Serif, with up to 64 variants.

Fonts are located on

Basic edition: internal MCU Flash;
Evaluation edition: internal MCU Flash;
Commercial edition: internal MCU or external SPI Flash;
Viewer edition: internal memory.

Info

The FONT_MODE setting impacts the Common, Fonts and Screens libraries.

Frame-buffer¶

Frame-buffer is located on

Basic edition: internal MCU SRAM;
Evaluation edition: internal MCU SRAM;
Commercial edition: internal MCU or external SPI SRAM;
Viewer edition: internal memory.

Info

The SRAM_MODE setting impacts the Common, Screens, Files and GUI libraries.

Reference object¶

The reference object is

Basic edition: itself;
Evaluation edition: pure virtual object;
Commercial edition: itself or pure virtual object;
Viewer edition: itself or pure virtual object.

The pure virtual object brings an enhanced compatibility with high level libraries.

Info

The USE_hV_SCREEN setting impacts the Common libraries.

Touch¶

Touch is implemented with the driver Pervasive_Touch_Small for the basic, evaluation and commercial editions.

Basic edition: driver Pervasive_Touch_Small and library PDLS_Basic;
Evaluation edition: driver Pervasive_Touch_Small and library PDLS_Advanced;
Commercial edition: driver Pervasive_Touch_Small and library PDLS_Advanced;
Viewer edition: driver Driver_Viewer_Touch and library PDLS_Viewer_Touch.

Legacy version 8

Touch is implemented with

Basic edition: none, except for PDLS_EXT3_Basic_Touch library;
Evaluation edition: none, except for PDLS_EXT3_Advanced_Touch library;
Commercial edition: option, but required by the PDLS_EXT3_Advanced_Touch library;
Viewer edition: touch, required by the PDLS_EXT3_Viewer_Touch library.

Info

The TOUCH_MODE setting impacts the Common, Screen and GUI libraries.

Haptics¶

Haptic feed-back is implemented by the hV_Haptics_DRV2605L library for the Commercial edition only.

Basic edition: none;
Evaluation edition: none;
Commercial edition: option;
Viewer edition: none.

Info

The HAPTICS_MODE setting impacts the Common and GUI libraries.

GPIO expander¶

The GPIO expander provides a solution when the MCU doesn’t offer enough GPIOs.

Basic edition: none;
Evaluation edition: none;
Commercial edition: option;
Viewer edition: none.

Info

The EXPANDER_MODE setting impacts the Common libraries.

A technical note details how to Use the GPIO expander.

String¶

The string is handled as

Basic edition: a String object from Arduino SDK;
Evaluation edition: a C-standard char array supported by the cstring library;
Commercial edition: a String object provided by the Arduino SDK or a C-standard char array supported by the cstring library;
Viewer edition: a C-standard char array supported by the cstring library.

Info

The STRING_MODE setting impacts the Common, Fonts, Screens, Code, Files, Graphics, GUI and Serial libraries.

Storage¶

Storage options include files saved and read on SD-card, and header files printed on serial console and read from Flash.

Storage is implemented

Basic edition: none;
Evaluation edition: serial console;
Commercial edition: SD-card and serial console;
Viewer edition: Linux or Windows file system and serial console.

Info

The STORAGE_MODE setting impacts the Common and Files libraries.

Debug¶

Debug options print a trace on the serial console for SPI, Wire, panel power, panel OTP memory.

Basic edition: none;
Evaluation edition: all;
Commercial edition: optional;
Viewer edition: optional.

Info

The DEBUG_SPI_SCREEN, DEBUG_WIRE, DEBUG_POWER and DEBUG_OTP settings impact the Screens, Files libraries.

Board¶

The board option allows to select between the EXT3 and EXT4 extension boards.

Basic edition: EXT3 and EXT4;
Evaluation edition: EXT3 only;
Commercial edition: EXT3 and EXT4;
Viewer edition: EXT3 only.

Info

The USE_EXT_BOARD setting impacts the Common and Screens libraries.

Legacy version 8

On the Basic editio, the PDLS_EXT4_Basic_Matter variant requires EXT4.

Basic edition: EXT3 and EXT4, but PDLS_EXT4_Basic_Matter requires EXT4;
Evaluation edition: EXT3 only;
Commercial edition: EXT3 only;
Viewer edition: EXT3 only.