Corrected some examples for inkplate5

Author: KarloLeksic

examples/Inkplate5/Advanced/Communications/Inkplate5_Bluetooth_Peripheral_Mode/Inkplate5_Bluetooth_Peripheral_Mode.ino

@@ -40,14 +40,12 @@ char commandBuffer[BUFFER_SIZE + 1];
 
 void setup()
 {
-    Serial.begin(115200);   // Init serial communication for debugging
     display.begin();        // Init Inkplate library (you should call this function ONLY ONCE)
     display.setTextSize(4); // Scale text to be 4 times bigger then original (5x7 px)
 
     // Init BT communication
     if (!SerialBT.begin("Inkplate5"))
     {
-        Serial.println("An error occurred initializing Bluetooth");
         display.println("An error occurred initializing Bluetooth");
     }
     else
@@ -69,11 +67,10 @@ void loop()
             commandBuffer[i] = commandBuffer[i + 1];
         }
         commandBuffer[BUFFER_SIZE - 1] = SerialBT.read();
-        Serial.print(commandBuffer[BUFFER_SIZE - 1]);
     }
 
     // Function in peripheral.h
-    run(commandBuffer, BUFFER_SIZE);
+    run(commandBuffer, BUFFER_SIZE, &display, &SerialBT);
 
     // Wait a bit
     delay(50);

examples/Inkplate5/Advanced/Communications/Inkplate5_Bluetooth_Peripheral_Mode/Peripheral.h

@@ -5,6 +5,12 @@
    Don't have "Soldered Inkplate5" option? Follow our tutorial and add it:
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
+   This example shows how to use a second SPI for any breakout that uses SPI communication. 
+   It's important to specify pins inside SPI.begin() or else the example won't work. 
+   This example will show you how you can read an RFID tag ID with the MFRC522 breakout 
+   and print it on the Inkplate screen. When you approximate a card to the reader, 
+   if everything is connected properly, on the Inkplate screen will be displayed the card type and ID.
+
    For this example you have to install Soldered MFRC522 library:
    https://github.com/SolderedElectronics/Soldered-MFRC522-RFID-Reader-Arduino-Library
 
@@ -18,9 +24,7 @@
    SCK  - IO14
    SDA  - IO15
 
-   This example will show you how you can read a tag ID and print it on the Inkplate screen.
-
-   NOTE: you have to cut JP3 and connect the other 2 contacts in order to work!
+   IMPORTANT: you have to cut JP3 and connect/solder the other 2 contacts in order to work!
 
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
@@ -48,7 +52,7 @@ MFRC522 rfid(SS_PIN, RST_PIN);
 // Create an object on Inkplate library and also set library into 1-bit mode (BW)
 Inkplate display(INKPLATE_1BIT);
 
-// Font scale for the text on the screen. The scale of 1 is 7px height
+// Font scale for the text on the screen. The scale of 1 is 7px in height and 5 pixels in width
 #define BIG_TEXT_SCALE   4
 #define SMALL_TEXT_SCALE 3
 
@@ -58,6 +62,8 @@ void setup()
     display.begin();
 
     // Init SPI bus
+    // IMPORTANT: you have to specify pins!
+    // The pins are: SPI.begin(SCK, MISO, MOSI, SS);
     SPI.begin(14, 12, 13, 15);
 
     // Init MFRC522
@@ -82,10 +88,10 @@ void loop()
     // If the new tag is available
     if (rfid.PICC_IsNewCardPresent())
     {
-        // If the NUID has been read
+        // If the ID has been read
         if (rfid.PICC_ReadCardSerial())
         {
-            // Check if the content fits on the screen expecting 2 line of the text
+            // Check if the content fits on the screen expecting 2 lines of the text
             if (display.getCursorY() + 2 * SMALL_TEXT_SCALE * 7 > E_INK_HEIGHT)
             {
                 // Clear the frame buffer of the display and set cursor to the beginning of the screen

examples/Inkplate5/Advanced/Communications/Inkplate5_Second_SPI/Inkplate5_Second_SPI.ino

@@ -49,7 +49,6 @@ void setup()
     display.partialUpdate();                        // Use partial updates for refreshing the display
     display.setTextSize(2);                         // 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()
@@ -60,6 +59,7 @@ void loop()
 // Function for clearing EEPROM data
 void clearEEPROM()
 {
+    // Go through each address and clear it (write 0)
     for (int i = 0; i < EEPROM_SIZE; i++)
     {
         EEPROM.write(i, 0);
@@ -70,19 +70,24 @@ void clearEEPROM()
 // Function writes data to EEPROM
 void writeEEPROM()
 {
+    // Go through each address and write current index
     for (int i = 0; i < EEPROM_SIZE; i++)
     {
         EEPROM.write(i, i);
     }
     EEPROM.commit();
 }
 
-// Function reads back previously written data and displays it on screen.
+// Function reads back previously written data and displays it on screen
 void printEEPROM()
 {
+    // Go through each address and read a value from it
     for (int i = 0; i < EEPROM_SIZE; i++)
     {
+        // Print read value in decimal 
         display.print(EEPROM.read(i), DEC);
+
+        // Print a comma after each number except the last one
         if (i != EEPROM_SIZE - 1)
             display.print(", ");
     }

examples/Inkplate5/Advanced/Other/Inkplate5_EEPROM_Usage/Inkplate5_EEPROM_Usage.ino

@@ -1,17 +1,16 @@
 /*
    Inkplate5_SD_Pictures example for Soldered Inkplate 5
-   For this example you will need a USB-C cable, Inkplate5 and a SD card loaded with
-   images that can be found inside folder of this example.
+   For this example you will need a USB-C cable, Inkplate5 and a SD card 
+   loaded with images that can be found inside folder of this example.
    Select "Soldered Inkplate5" from Tools -> Board menu.
    Don't have "Soldered Inkplate5" option? Follow our tutorial and add it:
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
-   You can open .bmp, .jpeg or .png files (but there are some limitations by the library) that have
-   color depth of 1 bit (BW bitmap), 4 bit, 8 bit and 24 bit AND have resoluton smaller than 800x600
-   or otherwise it won't fit on screen. Format your SD card in standard FAT fileformat.
-
-   This example will show you how you can read .bmp and .jpeg files (pictures) from SD card and
-   display that image on e-paper display.
+   This example will show you how you can read .bmp and .jpeg files (pictures) from an SD card and
+   display that image on the e-paper display. You can open .bmp, .jpeg or .png files (but there are 
+   some limitations by the library) that have color depth of 1 bit (BW bitmap), 4 bit, 8 bit and 
+   24 bit AND have resoluton smaller than 960x540 or otherwise it won't fit on screen. Format your
+   SD card in standard FAT fileformat.
 
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
@@ -49,7 +48,7 @@ void setup()
             // If is something failed (wrong filename or wrong bitmap format), write error message on the screen.
             // REMEMBER! You can only use Windows Bitmap file with color depth of 1, 4, 8 or 24 bits with no
             // compression! You can turn of dithering for somewhat faster image load by changing the last 1 to 0, or
-            // removing the 1 argument completely
+            // removing the parameter completely
             display.println("Image open error");
         }
         display.display();
@@ -70,10 +69,10 @@ void setup()
 
         // Now draw a JPEG
         display.clearDisplay();
-        if (!display.drawImage("pyramid.jpg", 100, 0, true, false))
+        if (!display.drawImage("pyramid.jpg", 100, 0, true))
         {
             // If is something failed (wrong filename or wrong format), write error message on the screen.
-            // You can turn off dithering for somewhat faster image load by changing the fifth parameter to false, or
+            // You can turn off dithering for somewhat faster image load by changing the fourth parameter to false, or
             // removing the parameter completely
             display.println("Image open error");
         }

examples/Inkplate5/Advanced/SD/Inkplate5_SD_Pictures/Inkplate5_SD_Pictures.ino

@@ -6,10 +6,10 @@
    Don't have "Soldered Inkplate5" option? Follow our tutorial and add it:
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
-   You can open your own .txt file, but in order to this example works properly it should
-   not have more than 500 chars and you should name it text.txt
-
-   This example will show you how to open .txt files and display the content of that file on Inkplate epaper display.
+   This example will show you how to open .txt files, limit the number of characters
+   to read, and display the content of that file on the Inkplate e-paper display.
+   You can open any other .txt file, just make sure that if there are more than 500 chars,
+   increase the MAX_LENGTH to your needs. You can also change the file name.
 
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
@@ -25,6 +25,12 @@
 Inkplate display(INKPLATE_1BIT); // Create an object on Inkplate library and also set library into 1 Bit mode (BW)
 SdFile file;                     // Create SdFile object used for accessing files on SD card
 
+// Define how many characters will be read from the .txt file. Change if you want to read larger files
+#define MAX_LENGTH 500
+
+// Here is the specified name of the file
+const char fileName[] = "/text.txt";
+
 void setup()
 {
     display.begin();        // Init Inkplate library (you should call this function ONLY ONCE)
@@ -38,9 +44,11 @@ void setup()
         display.println("SD Card ok! Reading data...");
         display.partialUpdate();
 
-        // Try to load text with max lenght of 200 chars.
-        if (!file.open("/text.txt", O_RDONLY))
-        { // If it fails to open, send error message to display and put sd card in sleep mode, otherwise read the file.
+        // Try to load text with a max length of 500 chars. You can change this by changing MAX_LENGTH define
+        if (!file.open(fileName, O_RDONLY))
+        {
+            // If it fails to open, send error message to display and put sd card in sleep mode, otherwise read the
+            // file.
             display.println("File open error");
             display.display();
             display.sdCardSleep();
@@ -49,24 +57,24 @@ void setup()
         {
             display.clearDisplay();    // Clear everything that is stored in frame buffer of epaper
             display.setCursor(0, 0);   // Set print position at the begining of the screen
-            char text[501];            // Array where data from SD card is stored (max 500 chars here)
+            char text[MAX_LENGTH + 1]; // An array where data from an SD card is stored (max 500 chars here plus one for
+                                       // the null terminating char)
             int len = file.fileSize(); // Read how big is file that we are opening
-            if (len > 500)
-                len = 500;         // If it's more than 500 bytes (500 chars), limit to max 500 bytes
-            file.read(text, len);  // Read data from file and save it in text array
-            text[len] = 0;         // Put null terminating char at the and of data
+            if (len > MAX_LENGTH)
+                len = MAX_LENGTH;  // If it's more than 500 bytes (500 chars), limit to max 500 bytes
+            file.read(text, len);  // Read 500 chars from the file and save it in the text array
+            text[len] = 0;         // Put the null terminating char at the end of data
             display.print(text);   // Print data/text
-            display.sdCardSleep(); // Put sd card in sleep mode
+            display.sdCardSleep(); // Put the SD card in sleep mode
             display.display();     // Do a full refresh of display
         }
     }
     else
-    { // If card init was not successful, display error on screen and stop the program (using infinite loop)
+    {
+        // If card init was not successful, display error on screen and stop the program (using infinite loop)
         display.println("SD Card error!");
         display.partialUpdate();
         display.sdCardSleep();
-        while (true)
-            ;
     }
 }
 

examples/Inkplate5/Advanced/SD/Inkplate5_SD_TXT_Read/Inkplate5_SD_TXT_Read.ino

@@ -5,7 +5,16 @@
    Don't have "Soldered Inkplate5" option? Follow our tutorial and add it:
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
-   This example will show you how to write in .txt file.
+   This example shows how you can use Inkplate 5 to write in a .txt file. 
+   The file name is specified below and you can change it. Just make sure that 
+   you specified the .txt extension or otherwise it will create a file that you
+   can't open. You can also change the content that will be written in the file
+   by changing the array called dataToWrite. 
+
+   If you don't change anything, after uploading the example the Inkplate will 
+   create a file named test.txt and write "Hello! This is the file writing example 
+   for Inkplate 5." into the file. It will also add a new line at the end, so if 
+   you run the example again, it will write once again the same string in the next line.
 
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
@@ -21,7 +30,8 @@
 Inkplate display(INKPLATE_1BIT); // Create an object on Inkplate library and also set library into 1 Bit mode (BW)
 SdFile file;                     // Create SdFile object used for accessing files on SD card
 
-char *fileName = "test.txt"; // The name of a file with the extension.
+// The name of a file with the extension
+char *fileName = "test.txt"; 
 
 // The text you want to write in the file
 char *dataToWrite = "Hello! This is the file writing example for Inkplate 5.\n"; // "\n" represents a new line
@@ -33,16 +43,17 @@ void setup()
     display.display();      // Put clear image on display
     display.setTextSize(3); // Set text to be 3 times bigger than original (5x7 px)
 
-    // Init SD card. Display if SD card is init propery or not.
+    // Init SD card. Display if SD card is init propery or not
     if (display.sdCardInit())
     {
+        // Print a message on the display
         display.println("SD Card ok!");
         display.partialUpdate();
 
         // Try to create text.txt file.
         if (!file.open(fileName, FILE_WRITE))
         {
-            // If it fails to create, send an error message to display, otherwise write to file.
+            // If it fails to create, send an error message to display, otherwise write to file
             display.println("Error while creating the file!");
             display.partialUpdate();
             display.sdCardSleep();
@@ -60,13 +71,14 @@ void setup()
     }
     else
     {
-        // If card init was not successful, display error on screen, put sd card in sleep mode, and stop the program
-        // (using infinite loop)
+        // If card init was not successful, display an error on the screen, and put the 
+        // SD card in sleep mode (turn off the MOSFET that turns off the power for SD).
+        // It is desirable to stop the program after the SD card fails, but there is no 
+        // next part in this example, only an empty loop().You can do it, for example, 
+        // by calling while(1); at the end of this code block, after sdCardSleep();
         display.println("SD Card error!");
         display.partialUpdate();
         display.sdCardSleep();
-        while (true)
-            ;
     }
 }
 

examples/Inkplate5/Advanced/SD/Inkplate5_SD_TXT_Write/Inkplate5_SD_TXT_Write.ino

@@ -36,7 +36,7 @@ const char *pass = "";
 const char *apiUrl = "https://jsonplaceholder.typicode.com/posts";
 
 // Specify the delay time between 2 POST requests in milliseconds
-#define DELAY_BETWEEN_REQUESTS 10000
+#define DELAY_BETWEEN_REQUESTS 10000 // Here is 10 seconds
 
 // Create objects from included libraries
 WiFiClientSecure client;
@@ -48,7 +48,7 @@ void setup()
     // Init serial communication
     Serial.begin(115200);
 
-    // Init the display
+    // Init library (you should call this function ONLY ONCE)
     display.begin();
 
     // Clear the display and print message
@@ -87,15 +87,20 @@ void loop()
     http.addHeader("Content-Type", "application/json");
 
     // Create a JSON document for serializing data
-    const size_t CAPACITY = JSON_OBJECT_SIZE(1);
+    const size_t CAPACITY = JSON_OBJECT_SIZE(2);
     StaticJsonDocument<CAPACITY> doc;
 
     // Convert the JSON document to a JSON object in order to add data
     JsonObject object = doc.to<JsonObject>();
 
     // Add data in the JSON object
+    // Add some title
     object["title"] = "Hello Inkplate";
 
+    // Add some random number from 0 to 100
+    // In the same way, you can add some sensor readings or something similar
+    object["sensor_reading"] = random(100);
+
     // Serialize the JSON object with your data to a JSON document for sending
     char jsonOutput[128];
     serializeJson(doc, jsonOutput);

examples/Inkplate5/Advanced/WEB_WiFi/Inkplate5_HTTPS_POST_Request/Inkplate5_HTTPS_POST_Request.ino

@@ -8,7 +8,12 @@
     This example will show you how you can use Inkplate 5 to display API data,
     e.g. Openweather public weather API. It shows the forecast weather for 4 days 
     at 15 o'clock (3 PM). If it's passed 3 PM, the first rectangle shows the 
-    forecast weather for tomorrow at 3 PM.
+    forecast weather for tomorrow at 3 PM. What happens here is basically ESP32 
+    connects to WiFi and sends an API call and the server returns data in JSON 
+    format containing data about weather, then using the library ArduinoJson we 
+    extract only temperature per day from JSON data and show it on Inkplate 5. 
+    After displaying the weather, ESP32 goes to sleep and wakes up every DELAY_MS 
+    milliseconds to show new weather (you can change the time interval).
 
     IMPORTANT:
     Make sure to change your desired city and wifi credentials below.

examples/Inkplate5/Projects/Inkplate5_Daily_Weather_Station/Inkplate5_Daily_Weather_Station.ino

@@ -7,7 +7,12 @@
 
    This example will show you how you can use Inkplate 5 to display API data,
    e.g. OpenWeather public weather API for real time data. It shows the forecast
-   weather for 4 hours.
+   weather for 4 hours. What happens here is basically ESP32 connects to WiFi and 
+   sends an API call and the server returns data in JSON format containing data 
+   about weather, then using the library ArduinoJson we extract only temperature 
+   per hour from JSON data and show it on Inkplate 5. After displaying the weather,
+   ESP32 goes to sleep and wakes up every DELAY_MS milliseconds to show new weather
+   (you can change the time interval).
 
    IMPORTANT:
    Make sure to change your desired city and wifi credentials below.