Release 612

rei-vilo · Jul 22, 2023 · 3a3c207 · 3a3c207
1 parent 6297776
commit 3a3c207
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 39 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,8 @@ latex/
 xml/
 Doxyfile.dox
 footer.html
+img/
 .github/
 *.ctu-info
 *.dump
+doxygen-awesome-css/
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=PDLS_EXT3_Basic_Touch
-version=6.1.1
+version=6.1.2
 author=Rei Vilo for Pervasive Displays
 maintainer=Rei Vilo
 sentence=Library for Pervasive Displays monochrome e-paper screens with touch and EXT3-1 + EXT3-Touch

diff --git a/src/Screen_EPD_EXT3.cpp b/src/Screen_EPD_EXT3.cpp
@@ -24,6 +24,7 @@
 // Release 607: Improved screens names consistency
 // Release 608: Added screen report
 // Release 609: Added temperature management
+// Release 610: Removed partial update
 //
 
 // Library header

diff --git a/src/Screen_EPD_EXT3.h b/src/Screen_EPD_EXT3.h
@@ -17,8 +17,8 @@
 /// * 3.70"-Touch reference xTP370PGH0x
 ///
 /// @author Rei Vilo
-/// @date 22 May 2023
-/// @version 610
+/// @date 21 Jul 2023
+/// @version 612
 ///
 /// @copyright (c) Rei Vilo, 2010-2023
 /// @copyright Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
@@ -43,23 +43,23 @@
 // Configuration
 #include "hV_Configuration.h"
 
-#if (hV_CONFIGURATION_RELEASE < 600)
-#error Required hV_CONFIGURATION_RELEASE 600
+#if (hV_CONFIGURATION_RELEASE < 611)
+#error Required hV_CONFIGURATION_RELEASE 611
 #endif // hV_CONFIGURATION_RELEASE
 
 #ifndef SCREEN_EPD_EXT3_RELEASE
 ///
 /// @brief Library release number
 ///
-#define SCREEN_EPD_EXT3_RELEASE 610
+#define SCREEN_EPD_EXT3_RELEASE 612
 
 // Other libraries
 #include "SPI.h"
 #include "Wire.h"
 #include "hV_Screen_Buffer.h"
 
-#if (hV_SCREEN_BUFFER_RELEASE < 523)
-#error Required hV_SCREEN_BUFFER_RELEASE 523
+#if (hV_SCREEN_BUFFER_RELEASE < 612)
+#error Required hV_SCREEN_BUFFER_RELEASE 612
 #endif // hV_SCREEN_BUFFER_RELEASE
 
 #if (TOUCH_MODE != USE_TOUCH_YES)

diff --git a/src/hV_Configuration.h b/src/hV_Configuration.h
@@ -19,8 +19,8 @@
 /// * 11. Set storage mode, not implemented
 ///
 /// @author Rei Vilo
-/// @date 21 Jun 2023
-/// @version 611
+/// @date 21 Jul 2023
+/// @version 612
 ///
 /// @copyright (c) Rei Vilo, 2010-2023
 /// @copyright All rights reserved
@@ -56,7 +56,7 @@
 ///
 /// @brief Release
 ///
-#define hV_CONFIGURATION_RELEASE 611
+#define hV_CONFIGURATION_RELEASE 612
 
 ///
 /// @name 1- List of supported Pervasive Displays screens
@@ -128,7 +128,7 @@
 #define eScreen_EPD_EXT3_370_Touch (uint32_t)0x03370C ///< reference xTP370PGH0x, legacy name
 
 /// * Monochrome screens with embedded fast update
-/// @note Global and fast update modes 
+/// @note Global and fast update modes
 /// @see https://www.pervasivedisplays.com/products/?_sft_etc_itc=pu
 ///
 #define eScreen_EPD_EXT3_154_0C_Fast (uint32_t)0x01150C ///< reference xE2154PS0Cx
@@ -150,7 +150,7 @@
 #define eScreen_EPD_EXT3_B98_0B_Fast (uint32_t)0x01B90B ///< reference xE2B98PS0Bx, not tested
 
 /// * Monochrome screens with embedded fast update and wide temperature
-/// @note Global and fast update modes 
+/// @note Global and fast update modes
 /// @see https://www.pervasivedisplays.com/products/?_sft_temperature_range=m15c-to-p60c
 ///
 #define eScreen_EPD_EXT3_154_0C_Wide (uint32_t)0x09150C ///< reference xE2154KS0Cx
@@ -207,20 +207,20 @@
 ///
 struct pins_t
 {
-    ///< EXT3 and EXT3-1 pin 1 Black -> +3.3V
-    ///< EXT3 and EXT3-1 pin 2 Brown -> SPI SCK
+    // ///< EXT3 and EXT3-1 pin 1 Black -> +3.3V
+    // ///< EXT3 and EXT3-1 pin 2 Brown -> SPI SCK
     uint8_t panelBusy; ///< EXT3 and EXT3-1 pin 3 Red
     uint8_t panelDC; ///< EXT3 and EXT3-1 pin 4 Orange
     uint8_t panelReset; ///< EXT3 and EXT3-1 pin 5 Yellow
-    ///< EXT3 and EXT3-1 pin 6 Green -> SPI MISO
-    ///< EXT3 and EXT3-1 pin 7 Blue -> SPI MOSI
+    // ///< EXT3 and EXT3-1 pin 6 Green -> SPI MISO
+    // ///< EXT3 and EXT3-1 pin 7 Blue -> SPI MOSI
     uint8_t flashCS; ///< EXT3 and EXT3-1 pin 8 Violet
     uint8_t panelCS; ///< EXT3 and EXT3-1 pin 9 Grey
-    ///< EXT3 and EXT3-1 pin 10 White -> GROUND
+    // ///< EXT3 and EXT3-1 pin 10 White -> GROUND
     uint8_t panelCSS; ///< EXT3 and EXT3-1 pin 12 Grey2
     uint8_t flashCSS; ///< EXT3 pin 20 or EXT3-1 pin 11 Black2
-    ///< EXT3-Touch pin 1 Brown -> I2C SDA
-    ///< EXT3-Touch pin 2 Black -> I2C SCL
+    // ///< EXT3-Touch pin 1 Brown -> I2C SDA
+    // ///< EXT3-Touch pin 2 Black -> I2C SCL
     uint8_t touchInt; ///< EXT3-Touch pin 3 Red
     uint8_t touchReset; ///< EXT3-Touch pin 4 Orange
     uint8_t panelPower; ///< Optional power circuit
@@ -421,8 +421,8 @@ const pins_t boardFeatherM0M4 =
     .panelCS = 9, ///< EXT3 and EXT3-1 pin 9 Grey -> D9 GPIO9
     .panelCSS = NOT_CONNECTED, ///< EXT3 and EXT3-1 pin 12 Grey2
     .flashCSS = NOT_CONNECTED, ///< EXT3 pin 20 or EXT3-1 pin 11 Black2
-    .touchInt = NOT_CONNECTED, ///< EXT3-Touch pin 3 Red -> D5 GPIO5
-    .touchReset = NOT_CONNECTED, ///< EXT3-Touch pin 4 Orange -> D6 GPIO6
+    .touchInt = 5, ///< EXT3-Touch pin 3 Red -> D5 GPIO5
+    .touchReset = 6, ///< EXT3-Touch pin 4 Orange -> D6 GPIO6
     .panelPower = NOT_CONNECTED, ///< Optional power circuit
     .cardCS = NOT_CONNECTED, ///< Separate SD-card board
     .cardDetect = NOT_CONNECTED, ///< Separate SD-card board

diff --git a/src/hV_Documentation.h b/src/hV_Documentation.h
@@ -41,8 +41,8 @@
 /// Additionally, the **[Wiki](https://docs.pervasivedisplays.com/)** provides a gradual introduction to the e-paper technology and how to use it.
 ///
 /// @author Rei Vilo
-/// @date 21 Jun 2023
-/// @version 611
+/// @date 21 Jul 2023
+/// @version 612
 ///
 /// @copyright (c) Rei Vilo, 2010-2023
 /// @copyright All rights reserved
@@ -65,7 +65,7 @@
 ///
 /// @page Examples Examples
 ///
-/// Examples are under the examples folder.
+/// Examples are under the examples folders.
 ///
 /// * Common
 ///     * Common_Colours
@@ -91,6 +91,14 @@
 /// @image latex Global.jpeg width=10cm
 ///     * Example_Fast_Speed
 /// @image html Fast.jpeg
+/// + Fast
 /// @image latex Fast.jpeg width=10cm
+/// + Black-White-Red-Yellow
+///     * BWRY_Colours
+/// @image html BWRY_Colours.png
+/// @image latex BWRY_Colours.png width=10cm
+///     * BWRY_Palette
+/// @image html BWRY_Palette.png
+/// @image latex BWRY_Palette.png width=10cm
 ///
 
diff --git a/src/hV_Screen_Buffer.cpp b/src/hV_Screen_Buffer.cpp
@@ -25,11 +25,11 @@
 // Code
 hV_Screen_Buffer::hV_Screen_Buffer()
 {
-    _f_fontSize       = 0;
-    _f_fontNumber     = 0;
-    _f_fontSolid      = true;
-    _penSolid       = false;
-    _f_fontSpaceX     = 1;
+    _f_fontSize = 0;
+    _f_fontNumber = 0;
+    _f_fontSolid = true;
+    _penSolid = false;
+    _f_fontSpaceX = 1;
 }
 
 void hV_Screen_Buffer::begin()

diff --git a/src/hV_Screen_Buffer.h b/src/hV_Screen_Buffer.h
@@ -6,8 +6,8 @@
 /// @n Based on highView technology
 ///
 /// @author Rei Vilo
-/// @date 24 Nov 2021
-/// @version 523
+/// @date 21 Jul 2023
+/// @version 612
 ///
 /// @copyright (c) Rei Vilo, 2010-2023
 /// @copyright Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
@@ -29,13 +29,14 @@
 #include "Arduino.h"
 #endif // SDK
 
+// Configuration
+#include "hV_Configuration.h"
+
 #ifndef hV_SCREEN_BUFFER_RELEASE
 ///
 /// @brief Library release number
 ///
-#define hV_SCREEN_BUFFER_RELEASE 523
-
-#include "hV_Configuration.h"
+#define hV_SCREEN_BUFFER_RELEASE 612
 
 // Other libraries
 #include "hV_Colours565.h"

diff --git a/src/hV_Utilities.h b/src/hV_Utilities.h
@@ -6,8 +6,8 @@
 /// @n Based on highView technology
 ///
 /// @author Rei Vilo
-/// @date 22 May 2023
-/// @version 610
+/// @date 21 Jun 2023
+/// @version 611
 ///
 /// @copyright (c) Rei Vilo, 2010-2023
 /// @copyright Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
@@ -33,7 +33,7 @@
 ///
 /// @brief Library release number
 ///
-#define hV_UTILITIES_RELEASE 610
+#define hV_UTILITIES_RELEASE 611
 
 #ifndef min
 #define min(a, b) ((a) < (b) ? (a) : (b))
@@ -43,7 +43,7 @@
 #endif
 
 ///
-/// @name Orientation Orientation constants
+/// @name Orientation constants
 /// @{
 ///
 #define ORIENTATION_PORTRAIT 6 ///< portrait or vertical, higher than large