Release 9.2.0

Author: rei-vilo

.github/workflows/stale.yml

@@ -7,7 +7,7 @@ name: Mark stale issues and pull requests
 
 on:
   schedule:
-  - cron: '31 4 * * *'
+  - cron: '28 0 * * *'
 
 jobs:
   stale:

README.md

@@ -1,12 +1,12 @@
 # Pervasive Displays Library Suite - Basic edition
 
-[![Release](https://img.shields.io/github/v/release/rei-vilo/PDLS_Basic)](https://github.com/rei-vilo/PDLS_Basic/releases) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9f09780839f7479285cb931ffe4954d7)](https://app.codacy.com/gh/rei-vilo/PDLS_Basic/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) ![Arduino lint](https://github.com/rei-vilo/PDLS_Basic/actions/workflows/main.yml/badge.svg) [![GitHub issues](https://img.shields.io/github/issues/rei-vilo/PDLS_Basic)](https://github.com/rei-vilo/PDLS_Basic/issues)
+[![Release](https://img.shields.io/github/v/release/rei-vilo/PDLS_Basic)](https://github.com/rei-vilo/PDLS_Basic/releases) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9f09780839f7479285cb931ffe4954d7)](https://app.codacy.com/gh/rei-vilo/PDLS_Basic/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) ![Arduino lint](https://github.com/rei-vilo/PDLS_Basic/actions/workflows/main.yml/badge.svg) [![GitHub issues](https://img.shields.io/github/issues/pervasivedisplays/PDLS_Basic)](https://github.com/rei-vilo/PDLS_Basic/issues)
 
-[![](https://img.shields.io/badge/-Technical_Wiki-blue)](https://docs.pervasivedisplays.com/) [![](https://img.shields.io/badge/-User_Guide-blue)](https://pdls.pervasivedisplays.com/userguide/index.html) [![](https://img.shields.io/badge/-Reference_Manual-blue)](https://pdls.pervasivedisplays.com/reference/html/index.html)
+[![](https://img.shields.io/badge/-Knowledge_Base-orange)](https://docs.pervasivedisplays.com/knowledge/)
 
 The Pervasive Displays Library Suite is specifically designed for the [Pervasive Displays](https://www.pervasivedisplays.com) e-paper screens, extension boards and evaluation kits.
 
-![](https://pdls.pervasivedisplays.com/userguide/img/Logo_PDI_text_320.png)
+![](img/Logo_PDI_text_320.png)
 
 Release 9 inaugurates a new structure based on drivers developed by Pervasive Displays.
 
@@ -45,13 +45,14 @@ The Pervasive Displays Library Suite provides a high-level interface to drive th
 
 ## Documentation
 
-* [Pervasive Displays Technical Wiki](https://docs.pervasivedisplays.com/) 
-* [User guide](https://pdls.pervasivedisplays.com/userguide/index.html) with commented examples
-* [Reference manual](https://pdls.pervasivedisplays.com/reference/html/index.html) 
+* [Knowledge Base](https://docs.pervasivedisplays.com/knwoledge/)
 
 ## Support
 
-* Please refer to the [PDLS_Basic](https://github.com/rei-vilo/PDLS_Basic/issues) repository for reporting issues and contributing pull requests.
+* Please refer to the [Support](https://docs.pervasivedisplays.com/knowledge/
+Volume5/) page with FAQ, technical notes and reference designs.
+
+* Report issues at the [PDLS_Basic](https://github.com/pervasivedisplays/PDLS_Basic/issues) repository.
 
 ## Installation
 

examples/EXT4/EXT4_WhoAmI/EXT4_WhoAmI.ino

@@ -53,9 +53,14 @@
 // Define structures and classes
 
 // Define variables and constants
+// Board
 pins_t myBoard = boardArduinoNanoMatter;
 // pins_t myBoard = boardSiLabsBG24Explorer;
+
+// Driver
 Pervasive_Wide_Small myDriver(eScreen_EPD_290_KS_0F, myBoard);
+
+// Screen
 Screen_EPD myScreen(&myDriver);
 
 uint8_t fontSmall, fontMedium, fontLarge, fontVery;

img/Logo_PDI_text_320.png

@@ -1,10 +1,10 @@
 name=PDLS_Basic
-version=9.1.2
+version=9.2.0
 author=Rei Vilo
 maintainer=Rei Vilo
 sentence=Library for Pervasive Displays iTC screens, extension boards and development kits
 paragraph=Graphics and text primitives, normal and fast update
 category=Display
-url=https://pdls.pervasivedisplays.com/userguide/
+url=https://docs.pervasivedisplays.com/knowledge/
 architectures=*
 depends=PDLS_Common,Pervasive_Wide_Large,Pervasive_Wide_Medium,Pervasive_Wide_Small,Pervasive_BWRY_Small,Pervasive_Touch_Small

library.properties

@@ -6,8 +6,8 @@
 /// @n Based on highView technology
 ///
 /// @author Rei Vilo
-/// @date 21 Jul 2025
-/// @version 911
+/// @date 21 Aug 2025
+/// @version 920
 ///
 /// @copyright (c) Rei Vilo, 2010-2025
 /// @copyright All rights reserved
@@ -35,15 +35,19 @@
 // SDK and configuration
 #include "PDLS_Common.h"
 
-#if (PDLS_COMMON_RELEASE < 902)
-#error Required PDLS_COMMON_RELEASE 902
+#if (PDLS_COMMON_RELEASE < 920)
+#error Required PDLS_COMMON_RELEASE 920
 #endif // PDLS_COMMON_RELEASE
 
+#ifndef EDITION_BASIC
+#error Required Basic edition of PDLS_Common
+#endif // EDITION_BASIC
+
 #ifndef PDLS_BASIC_RELEASE
 ///
 /// @brief Library release number
 ///
-#define PDLS_BASIC_RELEASE 911
+#define PDLS_BASIC_RELEASE 920
 
 #include "Screen_EPD.h"
 

src/PDLS_Basic.h

@@ -42,6 +42,7 @@
 // Release 905: Added support for Wide large screens
 // Release 910: Added check on vector coordinates
 // Release 912: Added temperature functions to driver 
+// Release 920: Added check on edition
 //
 
 // Library header
@@ -220,7 +221,7 @@ void Screen_EPD::begin()
 
             hV_HAL_Serial_crlf();
             hV_HAL_log(LEVEL_CRITICAL, "Screen %i-%cS-0%c is not supported", u_codeSize, u_codeFilm, u_codeDriver);
-            hV_HAL_exit(0x01);
+            hV_HAL_exit(RESULT_ERROR);
             break;
     } // u_codeSize
     v_screenDiagonal = u_codeSize;
@@ -232,7 +233,7 @@ void Screen_EPD::begin()
     if (((u_codeSize == SIZE_969) or (u_codeSize == SIZE_1198)) and (s_driver->b_pin.panelCSS == NOT_CONNECTED))
     {
         hV_HAL_log(LEVEL_CRITICAL, "Required pin panelCSS is NOT_CONNECTED");
-        hV_HAL_exit(0x01);
+        hV_HAL_exit(RESULT_ERROR);
     }
     //
     // === End of Large screen section
@@ -332,7 +333,7 @@ void Screen_EPD::begin()
     {
         hV_HAL_Serial_crlf();
         hV_HAL_log(LEVEL_CRITICAL, "Screen %i-%cS-0%c does not have touch", u_codeSize, u_codeFilm, u_codeDriver);
-        hV_HAL_exit(0x01);
+        hV_HAL_exit(RESULT_ERROR);;
     }
 
     switch (SCREEN_SIZE(s_driver->u_eScreen_EPD))

src/Screen_EPD.cpp

@@ -7,7 +7,7 @@
 ///
 /// @author Rei Vilo
 /// @date 21 Aug 2025
-/// @version 912
+/// @version 920
 ///
 /// @copyright (c) Rei Vilo, 2010-2025
 /// @copyright All rights reserved
@@ -35,8 +35,8 @@
 // SDK and configuration
 #include "PDLS_Common.h"
 
-#if (PDLS_COMMON_RELEASE < 902)
-#error Required PDLS_COMMON_RELEASE 902
+#if (PDLS_COMMON_RELEASE < 920)
+#error Required PDLS_COMMON_RELEASE 920
 #endif // PDLS_COMMON_RELEASE
 
 // Other libraries

src/Screen_EPD.h

@@ -5,18 +5,41 @@
 /// @details Project Pervasive Displays Library Suite - Basic edition
 /// @n Based on highView technology
 ///
-/// @mainpage Pervasive Displays Library Suite - Basic edition
+/// @mainpage Software Reference Manual
 ///
-/// @details The Pervasive Displays Library Suite is specifically designed for the [Pervasive Displays](https://www.pervasivedisplays.com/) e-paper screens, extension boards and development kits.
+/// @details The software includes the **drivers** and the **Pervasive Displays Library Suite - Basic edition**.
+///
+/// They are specifically designed for the [Pervasive Displays](https://www.pervasivedisplays.com/) e-paper screens, extension boards and development kits.
 ///
 /// @image html Logo-PDI-text-320.jpeg
 /// @image latex Logo-PDI-text-320.pdf width=10cm
 ///
-/// It provides a high-level interface to drive the e-paper screens with normal and fast update, supports capacitive touch and haptic feed-back.
+/// ## Drivers
+///
+/// The driver library manages the panel and the board. It sends the content of a C-array image to the screen and refreshes the panel. It is based on the film and the size of the screen.
+///
+/// * @ref Pervasive_BWRY_Small
+/// * @ref Pervasive_Wide_Small
+/// * @ref Pervasive_Wide_Medium
+/// * @ref Pervasive_Wide_Large
+/// * @ref Pervasive_Touch_Small
+///
+/// The drivers are available at the [Pervasive Displays GitHub page](https://github.com/PervasiveDisplays).
+///
+/// ## Pervasive Displays Library Suite - Basic edition
+///
+/// The Pervasive Displays Library Suite provides the text and graphics functions and the fonts to generate the image to be displayed through the driver.
+///
+/// * @ref Screen_EPD, derived from
+/// * @ref hV_Screen_Buffer
 ///
 /// Release 9 inaugurates a new structure based on drivers developed by Pervasive Displays.
 ///
-/// The library supports the screens through drivers
+/// PDLS Basic edition is available at the [Pervasive Displays GitHub page](https://github.com/PervasiveDisplays).
+///
+/// ## Scope
+///
+/// The software supports the screens
 ///
 /// * iTC monochrome [with wide temperature and embedded fast update](https://www.pervasivedisplays.com/products/?_sft_etc_itc=pu&_sft_temperature_range=m15c-to-p60c&_sft_product_colour=black-white) (film `K`),
 /// * iTC monochrome [with touch](https://www.pervasivedisplays.com/products/?_sft_etc_itc=tp),
@@ -34,38 +57,11 @@
 /// * [EPD Pico Kit Touch (EPDK-271-Touch)](https://www.pervasivedisplays.com/product/touch-expansion-board-ext3-touch/#tab-3), which includes an EXT3.1 extension board, an EXT3-Touch expansion board, and a 2.71"-Touch monochrome panel with embedded fast update, and
 /// * [E-Paper Development Kit for Matter (EPDK-Matter)](https://www.pervasivedisplays.com/product/epdk-matter/#tab-3), which bundles an Arduino Nano Matter, an EXT4 board and a 2.90" high-definition monochrome panel with embedded fast update and wide temperature.
 ///
-/// Legacy release 8 supports the screens
-///
-/// * iTC monochrome [with normal update](https://www.pervasivedisplays.com/products/?_sft_product_colour=black-white) (film `C`),
-/// * iTC monochrome [with embedded fast update](https://www.pervasivedisplays.com/products/?_sft_etc_itc=pu&_sft_product_colour=black-white) (film `P`), and
-/// * iTC colour [black-white-red](https://www.pervasivedisplays.com/products/?_sft_product_colour=black-white-red) (film `J`).
-///
-/// @b Drivers
-///
-/// PDLS relies on drivers developed and maintained by Pervasive Displays.
-/// * Pervasive_BWRY_Small
-/// * Pervasive_Wide_Small
-/// * Pervasive_Wide_Medium
-/// * Pervasive_Wide_Large
-/// * Pervasive_Touch_Small
-///
-/// The drivers are available at the [Pervasive Displays GitHub page](https://github.com/PervasiveDisplays).
-///
-/// Drivers © Pervasive Displays, 2021-2025
-///
-/// @b Documentation
-///
-/// The documentation includes two documents:
-///
-/// * This **Reference manual** lists all the objects and functions, with details for their parameters and returned results.
-///
-/// * The [User guide](https://pdls.pervasivedisplays.com/userguide/index.html) focuses on how to use the different libraries, with commented examples.
-///
-/// Additionally, the **[Pervasive Displays Technical Wiki](https://docs.pervasivedisplays.com/)** provides a gradual introduction to the e-paper technology and how to use it.
+/// ## Copyright, licence and disclaimer
 ///
 /// @author Rei Vilo
 /// @date 21 Aug 2025
-/// @version 912
+/// @version 920
 ///
 /// @copyright @n © Pervasive Displays Inc., 2021-2025, under licence by Rei Vilo
 /// @copyright All rights reserved
@@ -92,7 +88,7 @@
 /// * **Documentation**
 /// @n All rights reserved
 ///
-/// @b Disclaimer
+/// ## Disclaimer
 ///
 /// The software, including the related documentation, is provided to you "as is," and we make no express or implied warranties whatsoever with respect to its functionality, operability, or use, including, without limitation, any implied warranties of merchantability, fitness for a particular purpose, or infringement. We expressly disclaim any liability whatsoever for any direct, indirect, consequential, incidental or special damages, including, without limitation, lost revenues, lost profits, losses resulting from business interruption or loss of data, regardless of the form of action or legal theory under which the liability may be asserted, even if advised of the possibility or likelihood of such damages.
 ///
@@ -110,10 +106,20 @@
 /// * `PDLS_EXT4_Advanced_Wide` is replaced by `PDLS_Advanced` with the drivers `Pervasive_Wide_Small` or `Pervasive_Wide_Medium`, and
 /// * `PDLS_EXT4_Advanced_Touch` is replaced by `PDLS_Advanced` with the driver `Pervasive_Touch_Small`.
 ///
-/// @note The technical note [Migrate from release 8 to release 9](https://pdls.pervasivedisplays.com/userguide/Volume5/Chapter1/Part6/Section22/) provides more information.
+/// @note The technical note [Migrate from release 8 to release 9](https://docs.pervasivedisplays.com/knowledge/Software/Volume5/Chapter1/Part6/Section22.html) provides more information.
 ///
 /// The drivers are available at the [Pervasive Displays](https://github.com/PervasiveDisplays) GitHub repository.
 ///
+/// @page Release8 Legacy release 8
+///
+/// Legacy release 8 supports the following screens, boards and kits.
+///
+/// Library | Supported screens, boards and kits
+/// ---- | ----
+/// [PDLS_EXT3_Basic_Global](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global) | iTC monochrome screens [with normal update](https://www.pervasivedisplays.com/products/?_sft_product_colour=black-white) (film `C`)<br>iTC colour screens [black-white-red](https://www.pervasivedisplays.com/products/?_sft_product_colour=black-white-red) (film `J`);
+/// [PDLS_EXT3_Basic_Fast](https://github.com/rei-vilo/PDLS_EXT3_Basic_Fast) | iTC monochrome screens [with embedded fast update](https://www.pervasivedisplays.com/products/?_sft_etc_itc=pu&_sft_product_colour=black-white) (film `P`);
+/// [PDLS_EXT4_Basic_Matter](https://github.com/rei-vilo/PDLS_EXT4_Basic_Matter) | [EPDK-Matter](https://www.pervasivedisplays.com/product/epdk-matter/) and<br>[EXT4 Extension Board](https://www.pervasivedisplays.com/product/epd-extension-kit-gen-4-ext4/) and<br>iTC monochrome screens [with wide temperature and embedded fast update](https://www.pervasivedisplays.com/products-e-ink-display/?_sft_etc_itc=pu&_sft_temperature_range=m15c-to-p60c&_sft_product_colour=black-white) (film `K`).
+///
 /// @page Examples Examples
 ///
 /// Examples are under the examples folders.