Release 8.0.4

Added power management
rei-vilo · Jul 18, 2024 · 7369cbf · 7369cbf
1 parent 60406a3
commit 7369cbf
Show file tree

Hide file tree

Showing 13 changed files with 296 additions and 124 deletions.
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=PDLS_EXT3_Basic_BWRY
-version=8.0.3
+version=8.0.4
 author=Rei Vilo for Pervasive Displays
 maintainer=Rei Vilo
 sentence=Library for Pervasive Displays iTC red and yellow colour screens and EXT3-1 board

diff --git a/src/Screen_EPD_EXT3.cpp b/src/Screen_EPD_EXT3.cpp
@@ -33,6 +33,7 @@
 // Release 802: Added references to application notes
 // Release 802: Refactored CoG functions
 // Release 803: Added types for string and frame-buffer
+// Release 804: Improved power management
 //
 
 // Library header
@@ -87,7 +88,7 @@ void Screen_EPD_EXT3::COG_SmallQ_getDataOTP()
     }
 
     // GPIO
-    s_reset();
+    // s_reset();
     digitalWrite(b_pin.panelReset, HIGH);
 
     // Check
@@ -417,6 +418,22 @@ void Screen_EPD_EXT3::begin()
             break;
     }
 
+    //
+    // === Touch section
+    //
+
+    //
+    // === End of touch section
+    //
+
+    //
+    // === Large screen section
+    //
+
+    //
+    // === End of Large screen section
+    //
+
     // Configure board
     b_begin(b_pin, FAMILY_SMALL, 50);
 
@@ -492,6 +509,10 @@ void Screen_EPD_EXT3::begin()
 
     memset(s_newImage, 0x00, u_pageColourSize * u_bufferDepth);
 
+    setTemperatureC(25); // 25 Celsius = 77 Fahrenheit
+    b_fsmPowerScreen = FSM_OFF;
+    setPowerProfile(MODE_AUTO, SCOPE_GPIO_ONLY);
+
     // Turn SPI on, initialise GPIOs and set GPIO levels
     // Reset panel and get tables
     resume();
@@ -510,10 +531,6 @@ void Screen_EPD_EXT3::begin()
 
     v_penSolid = false;
     u_invert = false;
-
-    setTemperatureC(25); // 25 Celsius = 77 Fahrenheit
-
-    suspend();
 }
 
 STRING_TYPE Screen_EPD_EXT3::WhoAmI()
@@ -524,30 +541,44 @@ STRING_TYPE Screen_EPD_EXT3::WhoAmI()
     return formatString("iTC %i.%02i\"%s", v_screenDiagonal / 100, v_screenDiagonal % 100, work);
 }
 
-void Screen_EPD_EXT3::suspend()
+void Screen_EPD_EXT3::suspend(uint8_t suspendScope)
 {
-    b_suspend();
-
-    hV_HAL_SPI_end();
+    if (((suspendScope & FSM_GPIO_MASK) == FSM_GPIO_MASK) and (b_pin.panelPower != NOT_CONNECTED))
+    {
+        if ((b_fsmPowerScreen & FSM_GPIO_MASK) == FSM_GPIO_MASK)
+        {
+            b_suspend();
+        }
+    }
 }
 
 void Screen_EPD_EXT3::resume()
 {
-    // Resume GPIO
-    b_resume();
-
-    // Check type and get tables
-    if (u_flagOTP == false)
+    // Target   FSM_ON
+    // Source   FSM_OFF
+    //          FSM_SLEEP
+    if (b_fsmPowerScreen != FSM_ON)
     {
-        hV_HAL_SPI3_begin(); // Define 3-wire SPI pins
-        s_getDataOTP(); // 3-wire SPI read OTP memory
-    }
+        if ((b_fsmPowerScreen & FSM_GPIO_MASK) != FSM_GPIO_MASK)
+        {
+            b_resume(); // GPIO
 
-    // Reset
-    s_reset();
+            s_reset(); // Reset
+
+            b_fsmPowerScreen |= FSM_GPIO_MASK;
+        }
+
+        // Check type and get tables
+        if (u_flagOTP == false)
+        {
+            s_getDataOTP(); // 3-wire SPI read OTP memory
+
+            s_reset(); // Reset
+        }
 
-    // Start SPI
-    hV_HAL_SPI_begin(16000000); // Fast 16 MHz
+        // Start SPI
+        hV_HAL_SPI_begin(16000000); // Fast 16 MHz, with unicity check
+    }
 }
 
 uint8_t Screen_EPD_EXT3::flushMode(uint8_t updateMode)
@@ -585,21 +616,32 @@ void Screen_EPD_EXT3::s_reset()
 
 void Screen_EPD_EXT3::s_getDataOTP()
 {
+    hV_HAL_SPI_end(); // With unicity check
+
+    hV_HAL_SPI3_begin(); // Define 3-wire SPI pins
+
+    // Get data OTP
     COG_SmallQ_getDataOTP(); // 3-wire SPI read OTP memory
 }
 
 void Screen_EPD_EXT3::s_flush(uint8_t updateMode)
 {
-    // Resume GPIO and SPI
-    resume();
+    // Resume
+    if (b_fsmPowerScreen != FSM_ON)
+    {
+        resume();
+    }
 
     COG_SmallQ_initial(); // Initialise
     COG_SmallQ_sendImageData(); // Send image data
     COG_SmallQ_update(); // Update
     COG_SmallQ_powerOff(); // Power off
 
-    // Suspend GPIO and SPI
-    suspend();
+    // Suspend
+    if (u_suspendMode == MODE_AUTO)
+    {
+        suspend(u_suspendScope);
+    }
 }
 
 void Screen_EPD_EXT3::clear(uint16_t colour)
@@ -820,7 +862,7 @@ void Screen_EPD_EXT3::s_setOrientation(uint8_t orientation)
 
 bool Screen_EPD_EXT3::s_orientCoordinates(uint16_t & x, uint16_t & y)
 {
-    bool _flagResult = RESULT_ERROR; // false = success, true = error
+    bool _flagResult = RESULT_ERROR;
     switch (v_orientation)
     {
         case 3: // checked, previously 1

diff --git a/src/Screen_EPD_EXT3.h b/src/Screen_EPD_EXT3.h
@@ -18,8 +18,8 @@
 /// * EPD_417_QS_0A screen 4.17”
 ///
 /// @author Rei Vilo
-/// @date 21 May 2024
-/// @version 803
+/// @date 21 Jul 2024
+/// @version 804
 ///
 /// @copyright (c) Rei Vilo, 2010-2024
 /// @copyright All rights reserved
@@ -81,7 +81,7 @@
 ///
 /// @brief Library release number
 ///
-#define SCREEN_EPD_EXT3_RELEASE 803
+#define SCREEN_EPD_EXT3_RELEASE 804
 
 ///
 /// @brief Library variant
@@ -129,9 +129,11 @@ class Screen_EPD_EXT3 final : public hV_Screen_Buffer, public hV_Utilities_PDLS
 
     ///
     /// @brief Suspend
-    /// @details Turn SPI off and set all GPIOs low
+    /// @param bus include SPI bus, default = SCOPE_GPIO_ONLY, otherwise SCOPE_NONE
+    /// @details Power off and set all GPIOs low
+    /// @note If panelPower is NOT_CONNECTED, SCOPE_GPIO_ONLY defaults to SCOPE_NONE
     ///
-    void suspend();
+    void suspend(uint8_t suspendScope = SCOPE_GPIO_ONLY);
 
     ///
     /// @brief Resume after suspend()