Merge dev into master

Merge pull request #141 from e-radionicacom/dev
- Added Inkplate2 board
- Fixing Inkplate6PLUS compile
- External address of MCP23017 fix
- Inkplate 10 waveform - waveform is stored in ESP32 EEPROM
- Added new examples for waveform on Inkplate 10, modified VCOM factory programming

Author: BornaBiro

.github/workflows/compile.yml

@@ -27,6 +27,10 @@ jobs:
               fqbn: Inkplate_Boards:esp32:Inkplate6COLOR
             additional-sketch-paths: |
               - examples/Inkplate6COLOR
+          - board:
+              fqbn: Inkplate_Boards:esp32:Inkplate2
+            additional-sketch-paths: |
+              - examples/Inkplate2
     steps:
       - name: Checkout
         uses: actions/checkout@v2

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_EEPROM_Usage/Inkplate_EEPROM_Usage.ino

@@ -0,0 +1,93 @@
+/*
+   Inkplate_EEPROM_Usage example for e-radionica.com Inkplate 10
+   For this example, you will need only USB cable and Inkplate 10.
+   Select "Inkplate 10(ESP32)" from Tools -> Board menu.
+   Don't have "Inkplate 10(ESP32)" option? Follow our tutorial and add it:
+   https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/
+
+   This example will show you how to use EEPROM with Inkplate board.
+   It shows how to use basic operations with EEPROM like clearing, writing, and reading.
+   CAUTION! Changing EEPROM size can wipe waveform data.
+   CAUTION! EEPROM addresses from 0 to 75 are used for waveform. DO NOT WRITE OR MODIFY DATA ON THESE ADDRESSES!
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Looking to get support? Write on our forums: http://forum.e-radionica.com/en/
+   13 March 2022 by e-radionica.com
+*/
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATE10
+#error "Wrong board selection for this example, please select Inkplate 10 in the boards menu."
+#endif
+
+#include "EEPROM.h"   // Include ESP32 EEPROM library
+#include "Inkplate.h" // Include Inkplate library to the sketch
+
+#define EEPROM_START_ADDR 76  // Start EEPROM address for user data. Addresses below address 76 are waveform data!
+#define EEPROM_SIZE       128 // How much data to write to EEPROM in this example
+
+Inkplate display(INKPLATE_1BIT); // Create object on Inkplate library and set library to work in monochrome mode
+
+void setup()
+{
+    display.begin(); // Init library (you should call this function ONLY ONCE)
+
+    // Init EEPROM library with 512 of EEPROM size. Do not change this value, it can wipe waveform data!
+    EEPROM.begin(512);
+
+    display.setTextSize(4);                  // Set text size
+    display.println("Clearing EEPROM...\n"); // Print message
+    display.partialUpdate();                 // Use partial updates for refreshing the display
+    clearEEPROM();                           // Clear user EEPROM data
+    delay(500);                              // Wait a little bit...
+
+    display.println("Writing data to EEPROM...\n"); // Print message
+    display.partialUpdate();                        // Use partial updates for refreshing the display
+    writeEEPROM();                                  // Write some data to EEPROM
+    delay(500);                                     // Wait a little bit...
+
+    display.println("Reading data from EEPROM:\n"); // Print message
+    display.partialUpdate();                        // Use partial updates for refreshing the display
+    display.setTextSize(1);                         // Use smaller text so everything can fit on display
+    printEEPROM();                                  // Read data from EEPROM and display it on screen
+    delay(500);                                     // Wait a little bit...
+}
+
+void loop()
+{
+    // Empty...
+}
+
+// Function for clearing EEPROM data (it will NOT clear waveform data)
+void clearEEPROM()
+{
+    for (int i = 0; i < EEPROM_SIZE; i++)
+    {
+        EEPROM.write(i + EEPROM_START_ADDR,
+                     0); // Start writing from address 76 (anything below that address number is waveform data!)
+    }
+    EEPROM.commit();
+}
+
+// Function writes data to EEPROM
+void writeEEPROM()
+{
+    for (int i = 0; i < EEPROM_SIZE; i++)
+    {
+        EEPROM.write(i + EEPROM_START_ADDR,
+                     i); // Start reading from address 76 (anything below that address number is waveform data!)
+    }
+    EEPROM.commit();
+}
+
+// Function reads back previously written data and displays it on screen.
+void printEEPROM()
+{
+    for (int i = 0; i < EEPROM_SIZE; i++)
+    {
+        display.print(EEPROM.read(i + EEPROM_START_ADDR), DEC);
+        if (i != EEPROM_SIZE - 1)
+            display.print(", ");
+    }
+    display.partialUpdate();
+}

examples/Inkplate10/Others/Inkplate_Factory_Programming_VCOM/Inkplate_Factory_Programming_VCOM.ino

@@ -6,7 +6,10 @@
 Inkplate display(INKPLATE_1BIT);
 
 double vcomVoltage;
-int EEPROMaddress = 0;
+
+// EEPROMOffset must be between 0 and 20
+const int EEPROMOffset = 0;
+int EEPROMaddress = sizeof(waveformData) + EEPROMOffset;
 
 // Peripheral mode variables and arrays
 #define BUFFER_SIZE 1000
@@ -19,36 +22,89 @@ const char *testString = {"This is some test string..."};
 // Internal registers of MCP
 uint8_t mcpRegsInt[22];
 
+// All waveforms for Inkplate 10 boards
+uint8_t waveform1[8][9] = {{0, 0, 0, 0, 0, 0, 0, 1, 0}, {0, 0, 0, 2, 2, 2, 1, 1, 0}, {0, 0, 2, 1, 1, 2, 2, 1, 0},
+                           {0, 1, 2, 2, 1, 2, 2, 1, 0}, {0, 0, 2, 1, 2, 2, 2, 1, 0}, {0, 2, 2, 2, 2, 2, 2, 1, 0},
+                           {0, 0, 0, 0, 0, 2, 1, 2, 0}, {0, 0, 0, 2, 2, 2, 2, 2, 0}};
+uint8_t waveform2[8][9] = {{0, 0, 0, 0, 0, 0, 0, 0, 0}, {0, 0, 0, 2, 1, 2, 1, 1, 0}, {0, 0, 0, 2, 2, 1, 2, 1, 0},
+                           {0, 0, 2, 2, 1, 2, 2, 1, 0}, {0, 0, 0, 2, 1, 1, 1, 2, 0}, {0, 0, 2, 2, 2, 1, 1, 2, 0},
+                           {0, 0, 0, 0, 0, 1, 2, 2, 0}, {0, 0, 0, 0, 2, 2, 2, 2, 0}};
+uint8_t waveform3[8][9] = {{0, 3, 3, 3, 3, 3, 3, 3, 0}, {0, 1, 2, 1, 1, 2, 2, 1, 0}, {0, 2, 2, 2, 1, 2, 2, 1, 0},
+                           {0, 0, 2, 2, 2, 2, 2, 1, 0}, {0, 3, 3, 2, 1, 1, 1, 2, 0}, {0, 3, 3, 2, 2, 1, 1, 2, 0},
+                           {0, 2, 1, 2, 1, 2, 1, 2, 0}, {0, 3, 3, 3, 2, 2, 2, 2, 0}};
+uint8_t *waveformList[] = {&waveform1[0][0], &waveform2[0][0], &waveform3[0][0]};
+
+// Calculate number of possible waveforms
+uint8_t waveformListSize = (sizeof(waveformList) / sizeof(uint8_t *));
+
+// Struct for reading waveform from EEPROM memory of ESP32
+struct waveformData waveformEEPROM;
+
+int currentWaveform = 0;
+
 void setup()
 {
-    display.begin();
     Serial.begin(115200);
-    EEPROM.begin(64);
+    display.begin();
+    EEPROM.begin(512);
 
-    vcomVoltage = -1.19;
+    vcomVoltage = -1.3;
 
+    // Check if VCOM and waveform programming is not already done
     if (EEPROM.read(EEPROMaddress) != 170)
     {
         microSDCardTest();
         display.pinModeInternal(MCP23017_INT_ADDR, mcpRegsInt, 6, INPUT_PULLUP);
         writeVCOMToEEPROM(vcomVoltage);
         EEPROM.write(EEPROMaddress, 170);
         EEPROM.commit();
-        display.selectDisplayMode(INKPLATE_1BIT);
+        display.selectDisplayMode(INKPLATE_3BIT);
+
+        // Display all shades of gray on epaper with first waveform
+        showGradient(currentWaveform);
+
+        // Until "Load" key is not pressed, user can select one of the waveforms
+        while (!display.readTouchpad(PAD2))
+        {
+            // Select and show next waveform
+            if (display.readTouchpad(PAD3))
+            {
+                currentWaveform++;
+                if (currentWaveform > waveformListSize - 1)
+                    currentWaveform = 0;
+                showGradient(currentWaveform);
+            }
+
+            // Select and show prev. waveform
+            if (display.readTouchpad(PAD1))
+            {
+                currentWaveform--;
+                if (currentWaveform < 0)
+                    currentWaveform = waveformListSize - 1;
+                showGradient(currentWaveform);
+            }
+        }
+
+        // Load waveform in EEPROM memory of ESP32
+        waveformEEPROM.waveformId = INKPLATE10_WAVEFORM1 + currentWaveform;
+        memcpy(&waveformEEPROM.waveform, waveformList[currentWaveform], sizeof(waveformEEPROM.waveform));
+        waveformEEPROM.checksum = display.calculateChecksum(waveformEEPROM);
+        display.burnWaveformToEEPROM(waveformEEPROM);
     }
     else
     {
-        Serial.println("Vcom already set!");
-        // vcomVoltage = (double)EEPROM.read(EEPROMaddress) / 100;
+        Serial.println("Vcom and waveform already set!");
+        display.einkOn();
+        vcomVoltage = (double)(readReg(0x03) | ((uint16_t)(readReg(0x04 & 1) << 8))) / -100;
+        display.getWaveformFromEEPROM(&waveformEEPROM) ? waveformEEPROM.waveformId : -1;
     }
     memset(commandBuffer, 0, BUFFER_SIZE);
 
-    showSplashScreen();
+    showSplashScreen(waveformEEPROM);
 }
 
 void loop()
 {
-
     if (Serial.available())
     {
         while (Serial.available())
@@ -396,9 +452,9 @@ uint8_t readReg(uint8_t _reg)
     return Wire.read();
 }
 
-void showSplashScreen()
+void showSplashScreen(struct waveformData _w)
 {
-    display.clean(0, 1);
+    display.clearDisplay();
     display.display();
     display.selectDisplayMode(INKPLATE_3BIT);
     display.drawBitmap3Bit(0, 0, demo_image, demo_image_w, demo_image_h);
@@ -407,6 +463,9 @@ void showSplashScreen()
     display.setCursor(10, 10);
     display.print(vcomVoltage, 2);
     display.print("V");
+    display.setCursor(10, 20);
+    display.print("Waveform");
+    display.print(_w.waveformId - 20 + 1, DEC);
     display.display();
 }
 
@@ -559,7 +618,35 @@ void microSDCardTest()
     {
         display.print("FAIL!");
         display.display();
-        while(1);
+        while (1)
+            ;
     }
     display.clearDisplay();
 }
+
+void showGradient(int _selected)
+{
+    int w = display.width() / 8;
+    int h = display.height() - 100;
+
+    display.changeWaveform(waveformList[currentWaveform]);
+
+    display.fillRect(0, 725, 1200, 100, 7);
+
+    display.setTextSize(4);
+    display.setTextColor(0);
+    display.setCursor(420, 743);
+    display.print("Waveform select");
+    display.setCursor(432, 792);
+    display.print("Prev Load Next");
+
+    display.setCursor(800, 743);
+    display.print("1 2 3");
+    display.drawRect((_selected * 6 * 4 * 2) + 800 - 3, 740, (6 * 4) + 2, (8 * 4) + 2, 0);
+
+    for (int i = 0; i < 8; i++)
+    {
+        display.fillRect(i * w, 0, w, h, i);
+    }
+    display.display();
+}