Added Quotables examples

Author: gogi640

examples/Inkplate10/Projects/Quotables_Example/Fonts/exmouth_32pt7b.h

@@ -0,0 +1,217 @@
+/*
+    Network.cpp
+    Inkplate 6 Arduino library
+    David Zovko, Borna Biro, Denis Vajak, Zvonimir Haramustek @ e-radionica.com
+    September 24, 2020
+    https://github.com/e-radionicacom/Inkplate-6-Arduino-library
+
+    For support, please reach over forums: forum.e-radionica.com/en
+    For more info about the product, please check: www.inkplate.io
+
+    This code is released under the GNU Lesser General Public License v3.0: https://www.gnu.org/licenses/lgpl-3.0.en.html
+    Please review the LICENSE file included with this example.
+    If you have any questions about licensing, please contact [email protected]
+    Distributed as-is; no warranty is given.
+*/
+
+#include "Network.h"
+
+#include <HTTPClient.h>
+#include <WiFi.h>
+#include <WiFiClientSecure.h>
+
+#include "Inkplate.h"
+
+// Must be installed for this example to work
+#include <ArduinoJson.h>
+
+// external parameters from our main file
+extern char ssid[];
+extern char pass[];
+
+// Get our Inkplate object from main file to draw debug info on
+extern Inkplate display;
+
+// Static Json from ArduinoJson library
+StaticJsonDocument<30000> doc;
+
+void Network::begin()
+{
+    // Initiating wifi, like in BasicHttpClient example
+    WiFi.mode(WIFI_STA);
+    WiFi.begin(ssid, pass);
+
+    int cnt = 0;
+    Serial.print(F("Waiting for WiFi to connect..."));
+    while ((WiFi.status() != WL_CONNECTED))
+    {
+        Serial.print(F("."));
+        delay(1000);
+        ++cnt;
+
+        if (cnt == 20)
+        {
+            Serial.println("Can't connect to WIFI, restarting");
+            delay(100);
+            ESP.restart();
+        }
+    }
+    Serial.println(F(" connected"));
+
+    // Find internet time
+    setTime();
+}
+
+// Gets time from ntp server
+void Network::getTime(char *timeStr)
+{
+    // Get seconds since 1.1.1970.
+    time_t nowSecs = time(nullptr);
+
+    // Used to store time
+    struct tm timeinfo;
+    gmtime_r(&nowSecs, &timeinfo);
+
+    // Copies time string into timeStr
+    strncpy(timeStr, asctime(&timeinfo) + 4, 12);
+
+    // Setting time string timezone
+    int hr = 10 * timeStr[7] + timeStr[8] + timeZone;
+
+    // Better defined modulo, in case timezone makes hours to go below 0
+    hr = (hr % 24 + 24) % 24;
+
+    // Adding time to '0' char makes it into whatever time char, for both digits
+    timeStr[7] = hr / 10 + '0';
+    timeStr[8] = hr % 10 + '0';
+}
+
+bool Network::getData(char* text, char* auth)
+{
+    bool f = 0;
+
+    // If not connected to wifi reconnect wifi
+    if (WiFi.status() != WL_CONNECTED)
+    {
+        WiFi.reconnect();
+
+        delay(5000);
+
+        int cnt = 0;
+        Serial.println(F("Waiting for WiFi to reconnect..."));
+        while ((WiFi.status() != WL_CONNECTED))
+        {
+            // Prints a dot every second that wifi isn't connected
+            Serial.print(F("."));
+            delay(1000);
+            ++cnt;
+
+            if (cnt == 7)
+            {
+                Serial.println("Can't connect to WIFI, restart initiated.");
+                delay(100);
+                ESP.restart();
+            }
+        }
+    }
+
+    // Wake up if sleeping and save inital state
+    bool sleep = WiFi.getSleep();
+    WiFi.setSleep(false);
+
+    // Http object used to make get request
+    HTTPClient http;
+
+    http.getStream().setTimeout(10);
+    http.getStream().flush();
+
+    // Initiate http
+    char link[] = "https://api.quotable.io/random";
+    http.begin(link);
+
+    // Actually do request
+    int httpCode = http.GET();
+    if (httpCode == 200)
+    {
+        while (http.getStream().available() && http.getStream().peek() != '{')
+            (void)http.getStream().read();
+
+        // Try parsing JSON object
+        DeserializationError error = deserializeJson(doc, http.getStream());
+
+        if (error)
+        {
+            Serial.print(F("deserializeJson() failed: "));
+            Serial.println(error.c_str());
+            f = 1;
+        }
+        else
+        {
+            // Set all data got from internet using formatTemp and formatWind defined above
+            // This part relies heavily on ArduinoJson library
+
+            Serial.println("Success");
+
+            const char *buff1 = doc["content"];
+
+            strcpy(text, buff1);
+
+            const char *buff2 = doc["author"];
+
+            strcpy(auth, buff2);
+
+            // Save our data to data pointer from main file
+            f = 0;
+        }
+    }
+    else if (httpCode == 404)
+    {
+        // Coin id not found
+        display.clearDisplay();
+        display.setCursor(50, 230);
+        display.setTextSize(2);
+        display.println(F("Info has not been found!"));
+        display.display();
+        while (1)
+            ;
+    }
+    else
+    {
+        f = 1;
+    }
+
+    // Clear document and end http
+    doc.clear();
+    http.end();
+
+    // Return to initial state
+    WiFi.setSleep(sleep);
+
+    return !f;
+}
+
+// Function for initial time setting ovet the ntp server
+void Network::setTime()
+{
+    // Used for setting correct time
+    configTime(0, 0, "pool.ntp.org", "time.nist.gov");
+
+    Serial.print(F("Waiting for NTP time sync: "));
+    time_t nowSecs = time(nullptr);
+    while (nowSecs < 8 * 3600 * 2)
+    {
+        delay(500);
+        Serial.print(F("."));
+        yield();
+        nowSecs = time(nullptr);
+    }
+
+    Serial.println();
+
+    // Used to store time info
+    struct tm timeinfo;
+    gmtime_r(&nowSecs, &timeinfo);
+
+    Serial.print(F("Current time: "));
+    Serial.print(asctime(&timeinfo));
+}

examples/Inkplate10/Projects/Quotables_Example/Fonts/exmouth_40pt7b.h

@@ -0,0 +1,56 @@
+/*
+  Network.h
+  Inkplate 6 Arduino library
+  David Zovko, Borna Biro, Denis Vajak, Zvonimir Haramustek @ e-radionica.com
+  September 24, 2020
+  https://github.com/e-radionicacom/Inkplate-6-Arduino-library
+
+  For support, please reach over forums: forum.e-radionica.com/en
+  For more info about the product, please check: www.inkplate.io
+
+  This code is released under the GNU Lesser General Public License v3.0: https://www.gnu.org/licenses/lgpl-3.0.en.html
+  Please review the LICENSE file included with this example.
+  If you have any questions about licensing, please contact [email protected]
+  Distributed as-is; no warranty is given.
+*/
+
+#include "Arduino.h"
+
+#include <HTTPClient.h>
+#include <WiFi.h>
+#include <WiFiClientSecure.h>
+
+// To get timeZone from main file
+extern int timeZone;
+
+// Wifi ssid and password
+extern char ssid[];
+extern char pass[];
+
+struct channelInfo
+{
+  char name[64];
+  uint32_t subscribers;
+  uint32_t total_views;
+  uint16_t video_count;
+};
+
+#ifndef NETWORK_H
+#define NETWORK_H
+
+// All functions defined in Network.cpp
+
+class Network
+{
+  public:
+    // Functions we can access in main file
+    void begin();
+    void getTime(char *timeStr);
+    bool getData(char* text, char* auth);
+
+  private:
+    // Functions called from within our class
+    void setTime();
+};
+
+#endif

examples/Inkplate10/Projects/Quotables_Example/Network.cpp

@@ -0,0 +1,120 @@
+/*
+    Quotables example for Soldered Inkplate 10
+    For this example you will need only USB cable and Inkplate 10.
+    Select "Inkplate 2(ESP32)" from Tools -> Board menu.
+    Don't have "Inkplate 2(ESP32)" option? Follow our tutorial and add it:
+    https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/
+
+    This example shows you how to use simple API call without API key. Response
+    from server is in JSON format, so that will be shown too how it is used. What happens
+    here is basically ESP32 connects to WiFi and sends API call and server returns HTML
+    document containing one quote and some information about it, then using library ArduinoJSON
+    we extract only quote from JSON data and show it on Inkplate 10. After displaying quote
+    ESP32 goes to sleep and wakes up every 300 seconds to show new quote(you can change time interval).
+
+    IMPORTANT:
+    Make sure to change wifi credentials below
+    Also have ArduinoJSON installed in your Arduino libraries, download here: https://arduinojson.org/
+    You can deserialize JSON data easily using JSON assistant https://arduinojson.org/v6/assistant/
+
+    Want to learn more about Inkplate? Visit www.inkplate.io
+    Looking to get support? Write on our forums: http://forum.e-radionica.com/en/
+    7 April 2022 by Soldered
+*/
+
+// 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
+
+//---------- CHANGE HERE  -------------:
+
+// Put in your ssid and password
+char ssid[] = "";
+char pass[] = "";
+
+//----------------------------------
+
+// Include Inkplate library to the sketch
+#include "Inkplate.h"
+
+// Include fonts used
+#include "Fonts/exmouth_40pt7b.h"
+
+// Our networking functions, declared in Network.cpp
+#include "Network.h"
+
+// create object with all networking functions
+Network network;
+
+// create display object
+Inkplate display(INKPLATE_1BIT);
+
+// Delay between API calls in seconds, 300 seconds is 5 minutes
+#define DELAY_S 300
+
+// Our functions declared below setup and loop
+void drawAll();
+
+char quote[128]; // Buffer to store quote
+char author[64];
+
+void setup()
+{
+    // Begin serial communitcation, sed for debugging
+    Serial.begin(115200);
+
+    // Initial display settings
+    display.begin();
+    display.setTextWrap(false); // Set text wrapping to true
+    display.setTextColor(BLACK);
+
+    // Our begin function
+    network.begin();
+
+    while (!network.getData(quote, author))
+    {
+        Serial.println("Retrying retriving data!");
+        delay(1000);
+    }
+
+    // Our main drawing function
+    drawAll();
+    // Full refresh
+    display.display();
+
+    // Go to sleep before checking again
+    // This is set in microseconds, so it needs to be
+    // multiplied by million to get seconds
+    esp_sleep_enable_timer_wakeup(1000000 * DELAY_S);
+    (void)esp_deep_sleep_start();
+}
+
+void loop()
+{
+    // Never here
+}
+
+// Our main drawing function
+void drawAll()
+{
+    uint8_t rows = strlen(quote) / 60, row = 0;
+    display.setFont(&exmouth_40pt7b); // Set custom font
+    display.setTextSize(1);
+    display.setTextColor(BLACK); //Set text color to black
+    display.setCursor(60, display.height() / 2 - 30 * rows); //Place text in the middle
+    uint16_t cnt = 0;
+    while (quote[cnt] != '\0')
+    {
+        if (display.getCursorX() > display.width() - 80)
+        {
+            row++;
+            display.setCursor(60, display.height() / 2 - 30 * rows + row * 60);
+        }
+        display.print(quote[cnt]);
+        cnt++;
+    }
+    display.setCursor(display.width() - 32 * strlen(author), display.height() - 30); // Set cursor to fit author name in lower right corner
+    display.print("-");
+    display.println(author); // Print author
+}