Inkplate10_News version 0.2

Author: luxzap7

examples/Inkplate10/Projects/InkPlate10_News/InkPlate10_News.ino

@@ -1,74 +1,233 @@
 /*
-InkPlate_News for Soldered Inkplate 10
+    Inkplate10_News_API example for Soldered Inkplate 10
+    For this example you will need only USB cable and Inkplate 10.
+    Select "e-radionica Inkplate10" or "Soldered Inkplate10" from Tools -> Board menu.
+    Don't have "e-radionica Inkplate10" or "Soldered Inkplate10" option? Follow our tutorial and add it:
+    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
-This project fetches and displays news headlines using a news API.
+    This example will show you how you can use Inkplate 10 to display API data.
+    Here we use News API to get headline news and short description and display
+    them on the Inkplate screen. For this you will need an API key which you can obtain
+    here: https://newsapi.org/
 
-Setup:
-1. Enter your WiFi credentials.
-2. Get an API key from https://newsapi.org/ or another news provider.
+    IMPORTANT:
+    Make sure to change your timezone and wifi credentials below
+    Also have ArduinoJSON installed in your Arduino libraries, download here: https://arduinojson.org/
+
+    Want to learn more about Inkplate? Visit www.inkplate.io
+    Looking to get support? Write on our forums: https://forum.soldered.com/
+    28 July 2020 by Soldered
 */
 
-#include "src/includes.h" // Include necessary libraries and dependencies
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#if !defined(ARDUINO_INKPLATE10) && !defined(ARDUINO_INKPLATE10V2)
+#error "Wrong board selection for this example, please select e-radionica Inkplate10 or Soldered Inkplate10 in the boards menu."
+#endif
+
+//---------- CHANGE HERE  -------------:
+
+// Adjust your time zone, 2 means UTC+2
+int timeZone = 2;
+
+// Put in your ssid and password
+char ssid[] = "Soldered-testingPurposes";
+char pass[] = "Testing443";
+char api_key_news[] = "10fb57f24c784ee7be7a9cc419b775cc"; //You can obtain one here: https://newsapi.org/
+// Also, declare the function to check if the API key is valid
+bool checkIfAPIKeyIsValid(char *APIKEY);
+
+//----------------------------------
+
+// Include Inkplate library to the sketch
+#include "Inkplate.h"
 
-// --- WiFi Configuration ---
-const char *ssid = "Soldered-testingPurposes";
-const char *password = "Testing443";
+// Our networking functions, declared in Network.cpp
+#include "Network.h"
+#include "Inter12pt7b.h"
+#include "GT_Pressura16pt7b.h"
 
-// --- News API Configuration ---
-String apiKey = "10fb57f24c784ee7be7a9cc419b775cc";
-String newsEndpoint = "https://newsapi.org/v2/top-headlines?country=us&apiKey=" + apiKey;
 
-// --- Device and Data Objects ---
-Inkplate inkplate(INKPLATE_3BIT);
+// create object with all networking functions
 Network network;
-Gui gui(inkplate);
 
-// --- Deep Sleep Configuration ---
-#define uS_TO_S_FACTOR 1000000
-#define TIME_TO_SLEEP 600 // Sleep for 10 minutes
+// create display object
+Inkplate display(INKPLATE_1BIT);
+
+// Delay between API calls in miliseconds (first 60 represents minutes so you can change to your need)
+#define DELAY_MS (uint32_t)60 * 60 * 1000
+#define DELAY_WIFI_RETRY_SECONDS 10
+#define DELAY_API_RETRY_SECONDS 10
+
+// Variable for counting partial refreshes
+RTC_DATA_ATTR unsigned refreshes = 0;
+
+// Constant to determine when to full update
+const int fullRefresh = 20;
 
 void setup()
 {
+    // Begin serial communitcation, sed for debugging
     Serial.begin(115200);
-    inkplate.begin();
-    inkplate.clearDisplay();
-    inkplate.setRotation(1);
+    // Initial display settings
+    display.begin();
+    display.setTextWrap(false);
+
+    // Connect Inkplate to the WiFi network
+    // Try connecting to a WiFi network.
+    // Parameters are network SSID, password, timeout in seconds and whether to print to serial.
+    // If the Inkplate isn't able to connect to a network stop further code execution and print an error message.
+    if (!display.connectWiFi(ssid, pass, WIFI_TIMEOUT, true))
+    {
+        //Can't connect to netowrk
+        // Clear display for the error message
+        display.clearDisplay();
+        // Set the font size;
+        display.setTextSize(3);
+        // Set the cursor positions and print the text.
+        display.setCursor((display.width() / 2) - 200, display.height() / 2);
+        display.print(F("Unable to connect to "));
+        display.println(F(ssid));
+        display.setCursor((display.width() / 2) - 200, (display.height() / 2) + 30);
+        display.println(F("Please check SSID and PASS!"));
+        // Display the error message on the Inkplate and go to deep sleep
+        display.display();
+        esp_sleep_enable_timer_wakeup(1000L * DELAY_WIFI_RETRY_SECONDS);
+        (void)esp_deep_sleep_start();
+    }
+
+    if(!checkIfAPIKeyIsValid(api_key_news))
+    {
+        display.clearDisplay();
+        display.setTextSize(3);
+        display.setCursor((display.width() / 2) - 200, display.height() / 2);
+        display.print(F("Your API key is invalid or incorrect."));
+        display.setCursor((display.width() / 2) - 200, (display.height() / 2) + 30);
+        display.println(F("Please check your API key."));
+        display.display();
+        esp_sleep_enable_timer_wakeup(1000L * DELAY_API_RETRY_SECONDS);
+        (void)esp_deep_sleep_start();
+    }
+
+    setTime();
+
+    struct news *entities;
+
+    entities = network.getData();
+    drawNews(entities);
+
+    display.display();
+
+    ++refreshes;
+
+    // Go to sleep before checking again
+    esp_sleep_enable_timer_wakeup(1000 * DELAY_MS);
+    (void)esp_deep_sleep_start();
+}
+
+void drawNews(struct news *entities)
+{
+    display.setRotation(3);
+
+    // Add title "World News"
+    display.setFont(&GT_Pressura16pt7b); // Use a bold font for the title
+    display.setTextSize(2); // Set text size for the title
+    int textWidth = strlen("World News") * 12; // Approximate width (12 pixels per character for GT_Pressura16pt7b)
+    int centerX = (display.width() - textWidth) / 2; // Center the title horizontally
+    display.setCursor(centerX-100, 55); // Set the cursor to the calculated position
+    display.print("World News");
+    
+    // Add a dividing line below the title
+    for (int lineY = 60; lineY < 65; lineY++) { // 5-pixel thick line
+        display.drawLine(0, lineY, display.width(), lineY, BLACK);
+    }
+
+    display.setTextSize(1); // Set text size for the news items
+    // Start rendering news items below the title
+  
+    // Start rendering news items below the title
+    int startY = 100; // Starting Y position below the title
+    int boxHeight = 135; // Height of each news box
+    int boxSpacing = 20; // Spacing between boxes
+    int leftMargin = 20; // Left margin for the text
+    int rightMargin = 20; // Right margin for the text  
+    int maxBoxes = (display.height() - startY) / (boxHeight + boxSpacing); // Calculate how many boxes fit on the screen
 
-    // Attempt to connect to WiFi
-    const unsigned long timeout = 30000;
-    unsigned long startTime = millis();
-    bool connected = false;
+    const int MAX_NEWS_ITEMS = 7;
 
-    while (!connected && (millis() - startTime) < timeout)
+    // Loop through the news items and display each in a box
+    for (int i = 0; i < maxBoxes && i < MAX_NEWS_ITEMS && entities[i].title != NULL && entities[i].description != NULL; i++)
     {
-        connected = inkplate.connectWiFi(ssid, password, 10, true);
+        // Calculate the position of the current box
+        int y0 = startY + i * (boxHeight + boxSpacing);
+        int y1 = y0 + boxHeight;
+
+        // Draw the title in the box
+        display.drawTextBox(leftMargin, y0, display.width() - rightMargin, y0 + 80, entities[i].title, 1, &GT_Pressura16pt7b, 30, false, 18);
+
+        // Draw the description in the box
+        display.drawTextBox(leftMargin, y0 + 57, display.width() - rightMargin, y1+100, entities[i].description, 1, &Inter12pt7b, 30, false, 16);
     }
+}
 
-    // If WiFi failed, display error message
-    if (!connected)
+// Function for getting time from NTP server
+void setTime()
+{
+    // Structure used to hold time information
+    struct tm timeInfo;
+    time_t nowSec;
+    // Fetch current time in epoch format and store it
+    display.getNTPEpoch(&nowSec);
+    // This loop ensures that the NTP time fetched is valid and beyond a certain threshold
+    while (nowSec < 8 * 3600 * 2)
     {
-        gui.wifiError();
+        delay(500);
+        yield();
+        nowSec = time(nullptr);
+    }
+    gmtime_r(&nowSec, &timeInfo);
+    Serial.print(F("Current time: "));
+    Serial.print(asctime(&timeInfo));
+}
+
+bool checkIfAPIKeyIsValid(char *APIKEY)
+{
+    bool failed = false;
+    // Create the buffer for holding the API response, make it large enough just in case
+    char *data;
+    data = (char *)ps_malloc(50000LL);
+
+    // Http object used to make GET request
+    HTTPClient http;
+    http.getStream().setTimeout(10);
+    http.getStream().flush();
+    http.getStream().setNoDelay(true);
+
+    // Combine the base URL and the API key to do a test call
+    char *baseURL = "https://newsapi.org/v2/top-headlines?country=us&apiKey=";
+    char apiTestURL[200];
+    sprintf(apiTestURL, "%s%s", baseURL, APIKEY);
+
+    http.begin(apiTestURL);
+    delay(300);
+
+    int httpCode = http.GET();
+
+    if(httpCode != 200)
+    {
+        Serial.println("Your API key is invalid or incorrect.");
+        failed = true;
     }
     else
     {
-        // Fetch and display news
-        String newsData = network.fetchData(newsEndpoint);
-        if (newsData.length() > 0)
-        {
-            gui.showNews(newsData); // Custom function to display news
-        }
-        else
-        {
-            gui.showError("Failed to fetch news.");
-        }
+        Serial.println("API key OK.");
     }
+    http.end();
+    free(data);
 
-    // Enter deep sleep
-    esp_sleep_enable_timer_wakeup(TIME_TO_SLEEP * uS_TO_S_FACTOR);
-    esp_deep_sleep_start();
+    return !failed;
 }
 
 void loop()
 {
-    // Empty, main logic is in setup
-}
+    // Never here
+}