Rename applyCertificate to applyHttpsCertificate and fix example headers

JosipKuci · JosipKuci · commit 0c5b85ec51d2 · 2025-04-24T11:41:39.000+02:00
diff --git a/examples/Inkplate10/Advanced/WEB_WiFi/Inkplate10_HTTPS_With_Certificate/Inkplate10_HTTPS_With_Certificate.ino b/examples/Inkplate10/Advanced/WEB_WiFi/Inkplate10_HTTPS_With_Certificate/Inkplate10_HTTPS_With_Certificate.ino
@@ -1,7 +1,7 @@
 /*
-   Inkplate10_Download_Files_With_Certificate example for Soldered Inkplate 7
-   For this example you will need a micro USB cable, Inkplate 7, and an available WiFi connection.
-   Select "Soldered Inkplate 7" from Tools -> Board menu.
+   Inkplate10_HTTPS_With_Certificate example for Soldered Inkplate 10
+   For this example you will need a micro USB cable, Inkplate 10, and an available WiFi connection.
+   Select "Soldered Inkplate 10" from Tools -> Board menu.
 
    You can open .bmp files that have color depth of 1 bit (BW bitmap), 4 bit, 8 bit and
    24 bit 
@@ -27,8 +27,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -83,7 +81,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate2/Advanced/WEB_WiFi/Inkplate2_HTTPS_With_Certificate/Inkplate2_HTTPS_With_Certificate.ino b/examples/Inkplate2/Advanced/WEB_WiFi/Inkplate2_HTTPS_With_Certificate/Inkplate2_HTTPS_With_Certificate.ino
@@ -1,5 +1,5 @@
 /*
-   Inkplate2_Download_Files_With_Certificate example for Soldered Inkplate 2
+   Inkplate2_HTTPS_With_Certificate example for Soldered Inkplate 2
    For this example you will need a micro USB cable, Inkplate 2, and an available WiFi connection.
    Select "Soldered Inkplate 2" from Tools -> Board menu.
 
@@ -27,9 +27,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
-
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
 "MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw\n" \
@@ -83,7 +80,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate4/Advanced/WEB_WiFi/Inkplate4_HTTPS_With_Certificate/Inkplate4_HTTPS_With_Certificate.ino b/examples/Inkplate4/Advanced/WEB_WiFi/Inkplate4_HTTPS_With_Certificate/Inkplate4_HTTPS_With_Certificate.ino
@@ -1,7 +1,7 @@
 /*
-   Inkplate4_Download_Files_With_Certificate example for Soldered Inkplate 2
-   For this example you will need a micro USB cable, Inkplate 2, and an available WiFi connection.
-   Select "Soldered Inkplate 2" from Tools -> Board menu.
+   Inkplate4_HTTPS_With_Certificate example for Soldered Inkplate 4
+   For this example you will need a micro USB cable, Inkplate 4, and an available WiFi connection.
+   Select "Soldered Inkplate 4" from Tools -> Board menu.
 
    You can open .bmp files that have color depth of 1 bit (BW bitmap), 4 bit, 8 bit and
    24 bit 
@@ -17,7 +17,7 @@
 
 // Next 3 lines are a precaution, you can ignore those, and the example would also work without them
 #ifndef ARDUINO_INKPLATE4
-#error "Wrong board selection for this example, please select Inkplate 2  in the boards menu."
+#error "Wrong board selection for this example, please select Inkplate 4  in the boards menu."
 #endif
 
 #include "Inkplate.h"            //Include Inkplate library to the sketch
@@ -27,8 +27,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -83,7 +81,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate4TEMPERA/Advanced/WEB_WiFi/Inkplate4TEMPERA_HTTPS_With_Certificate/Inkplate4TEMPERA_HTTPS_With_Certificate.ino b/examples/Inkplate4TEMPERA/Advanced/WEB_WiFi/Inkplate4TEMPERA_HTTPS_With_Certificate/Inkplate4TEMPERA_HTTPS_With_Certificate.ino
@@ -1,5 +1,5 @@
 /*
-   Inkplate4TEMPERA_Download_Files_With_Certificate example for Soldered Inkplate 4TEMPERA
+   Inkplate4TEMPERA_HTTPS_With_Certificate example for Soldered Inkplate 4TEMPERA
    For this example you will need a micro USB cable, Inkplate 4TEMPERA, and an available WiFi connection.
    Select "Soldered Inkplate 4TEMPERA" from Tools -> Board menu.
 
@@ -27,8 +27,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -83,7 +81,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate5/Advanced/WEB_WiFi/Inkplate5_HTTPS_With_Certificate/Inkplate5_HTTPS_With_Certificate.ino b/examples/Inkplate5/Advanced/WEB_WiFi/Inkplate5_HTTPS_With_Certificate/Inkplate5_HTTPS_With_Certificate.ino
@@ -1,5 +1,5 @@
 /*
-   Inkplate5_Download_Files_With_Certificate example for Soldered Inkplate 5
+   Inkplate5_HTTPS_With_Certificate example for Soldered Inkplate 5
    For this example you will need a micro USB cable, Inkplate 5, and an available WiFi connection.
    Select "Soldered Inkplate 5" from Tools -> Board menu.
 
@@ -27,8 +27,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -83,7 +81,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate5V2/Advanced/WEB_WiFi/Inkplate5V2_HTTPS_With_Certificate/Inkplate5V2_HTTPS_With_Certificate.ino b/examples/Inkplate5V2/Advanced/WEB_WiFi/Inkplate5V2_HTTPS_With_Certificate/Inkplate5V2_HTTPS_With_Certificate.ino
@@ -1,5 +1,5 @@
 /*
-   Inkplate6_Download_Files_With_Certificate example for Soldered Inkplate 5V2
+   Inkplate5V2_HTTPS_With_Certificate example for Soldered Inkplate 5V2
    For this example you will need a micro USB cable, Inkplate 5V2, and an available WiFi connection.
    Select "Soldered Inkplate 5V2" from Tools -> Board menu.
 
@@ -27,8 +27,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -83,7 +81,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate6/Advanced/WEB_WiFi/Inkplate6_HTTPS_With_Certificate/Inkplate6_HTTPS_With_Certificate.ino b/examples/Inkplate6/Advanced/WEB_WiFi/Inkplate6_HTTPS_With_Certificate/Inkplate6_HTTPS_With_Certificate.ino
@@ -1,5 +1,5 @@
 /*
-   Inkplate6_Download_Files_With_Certificate example for Soldered Inkplate 6
+   Inkplate6_HTTPS_With_Certificate example for Soldered Inkplate 6
    For this example you will need a micro USB cable, Inkplate 6, and an available WiFi connection.
    Select "Soldered Inkplate 6" from Tools -> Board menu.
    Don't have "Soldered Inkplate 6" option? Follow our tutorial and add it:
@@ -30,8 +30,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -86,7 +84,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate6COLOR/Advanced/WEB_WiFi/Inkplate6COLOR_HTTPS_With_Certificate/Inkplate6COLOR_HTTPS_With_Certificate.ino b/examples/Inkplate6COLOR/Advanced/WEB_WiFi/Inkplate6COLOR_HTTPS_With_Certificate/Inkplate6COLOR_HTTPS_With_Certificate.ino
@@ -1,12 +1,12 @@
 /*
-   Inkplate6COLOR_Download_Files_With_Certificate example for Soldered Inkplate 6 COLOR
-   For this example you will need a micro USB cable, Inkplate 6, and an available WiFi connection.
-   Select "Soldered Inkplate 6" from Tools -> Board menu.
-   Don't have "Soldered Inkplate 6" option? Follow our tutorial and add it:
+   Inkplate6COLOR_HTTPS_With_Certificate example for Soldered Inkplate 6 COLOR
+   For this example you will need a micro USB cable, Inkplate 6COLOR, and an available WiFi connection.
+   Select "Soldered Inkplate 6COLOR" from Tools -> Board menu.
+   Don't have "Soldered Inkplate 6COLOR" option? Follow our tutorial and add it:
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
    You can open .bmp files 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.
+   24 bit.
 
    This example will show you how you can download a .bmp file (picture) from the web securely by providing a 
    certificate for the website that will be validated upon conncection and
@@ -29,8 +29,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -85,7 +83,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate6FLICK/Advanced/WEB_WiFi/Inkplate6FLICK_HTTPS_With_Certificate/Inkplate6FLICK_HTTPS_With_Certificate.ino b/examples/Inkplate6FLICK/Advanced/WEB_WiFi/Inkplate6FLICK_HTTPS_With_Certificate/Inkplate6FLICK_HTTPS_With_Certificate.ino
@@ -1,12 +1,12 @@
 /*
-   Inkplate6FLICK_Download_Files_With_Certificate example for Soldered Inkplate 6FLICK
+   Inkplate6FLICK_HTTPS_With_Certificate example for Soldered Inkplate 6FLICK
    For this example you will need a micro USB cable, Inkplate 6FLICK, and an available WiFi connection.
    Select "Soldered Inkplate 6FLICK" from Tools -> Board menu.
    Don't have "Soldered Inkplate 6FLICK" option? Follow our tutorial and add it:
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
    You can open .bmp files 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.
+   24 bit.
 
    This example will show you how you can download a .bmp file (picture) from the web securely by providing a 
    certificate for the website that will be validated upon conncection and
@@ -29,8 +29,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -85,7 +83,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate6PLUS/Advanced/WEB_WiFi/Inkplate6PLUS_HTTPS_With_Certificate/Inkplate6PLUS_HTTPS_With_Certificate.ino b/examples/Inkplate6PLUS/Advanced/WEB_WiFi/Inkplate6PLUS_HTTPS_With_Certificate/Inkplate6PLUS_HTTPS_With_Certificate.ino
@@ -1,12 +1,12 @@
 /*
-   Inkplate6PLUS_Download_Files_With_Certificate example for Soldered Inkplate 6PLUS
+   Inkplate6PLUS_HTTPS_With_Certificate example for Soldered Inkplate 6PLUS
    For this example you will need a micro USB cable, Inkplate 6PLUS, and an available WiFi connection.
    Select "Soldered Inkplate 6PLUS" from Tools -> Board menu.
    Don't have "Soldered Inkplate 6PLUS" option? Follow our tutorial and add it:
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
    You can open .bmp files 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.
+   24 bit.
 
    This example will show you how you can download a .bmp file (picture) from the web securely by providing a 
    certificate for the website that will be validated upon conncection and
@@ -29,8 +29,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -85,7 +83,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/examples/Inkplate7/Advanced/WEB_WiFi/Inkplate7_HTTPS_With_Certificate/Inkplate7_HTTPS_With_Certificate.ino b/examples/Inkplate7/Advanced/WEB_WiFi/Inkplate7_HTTPS_With_Certificate/Inkplate7_HTTPS_With_Certificate.ino
@@ -1,10 +1,10 @@
 /*
-   Inkplate7_Download_Files_With_Certificate example for Soldered Inkplate 7
+   Inkplate7_HTTPS_With_Certificate example for Soldered Inkplate 7
    For this example you will need a micro USB cable, Inkplate 7, and an available WiFi connection.
    Select "Soldered Inkplate 7" from Tools -> Board menu.
 
    You can open .bmp files 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.
+   24 bit.
 
    This example will show you how you can download a .bmp file (picture) from the web securely by providing a 
    certificate for the website that will be validated upon conncection and
@@ -27,8 +27,6 @@ const char ssid[] = "";    // Your WiFi SSID
 const char *password = ""; // Your WiFi password
 
 //This is the certificate for the website https://varipass.org
-//You can find information on how to get the certificate of a website
-//as well as how to format it here: https://randomnerdtutorials.com/esp32-https-requests/ 
 
 const char* certificate = \
 "-----BEGIN CERTIFICATE-----\n" \
@@ -83,7 +81,7 @@ void setup()
     display.partialUpdate();
 
     //Apply the certificate previously defined
-    display.applyCertificate(certificate);
+    display.applyHttpsCertificate(certificate);
     //Here we will draw the image using a valid certificate. Photo taken by: Roberto Fernandez
     if (!display.drawImage("https://varipass.org/neowise_mono.bmp", 0, 0, false, true))
     {
diff --git a/src/Inkplate.h b/src/Inkplate.h
@@ -108,9 +108,9 @@ class Inkplate : public System, public Graphics
     {
         return NetworkClient::isConnected();
     };
-    void applyCertificate(const char* certificate)
+    void applyHttpsCertificate(const char* certificate)
     {
-        return NetworkClient::applyCertificate(certificate);
+        return NetworkClient::applyHttpsCertificate(certificate);
     };
     // The default parameters for nptServer here are cast to (char*) to keep the compiler happy
     bool getNTPEpoch(time_t *timeEpoch, int timeZone = 0, char *ntpServer = (char *)"pool.ntp.org",
diff --git a/src/include/NetworkClient.cpp b/src/include/NetworkClient.cpp
@@ -623,7 +623,7 @@ void NetworkClient::setFollowRedirects(followRedirects_t f)
  * @returns     None
  *
  */
-void NetworkClient::applyCertificate(const char* certificate)
+void NetworkClient::applyHttpsCertificate(const char* certificate)
 {
     this->certificate=strdup(certificate);
 }
diff --git a/src/include/NetworkClient.h b/src/include/NetworkClient.h
@@ -63,7 +63,7 @@ class NetworkClient
     uint8_t *downloadFile(const char *url, int32_t *defaultLen);
     uint8_t *downloadFileHTTPS(const char *url, int32_t *defaultLen);
     uint8_t *downloadFile(WiFiClient *url, int32_t len);
-    void applyCertificate(const char* certificate);
+    void applyHttpsCertificate(const char* certificate);
 
     // The default parameters for nptServer here are cast to (char*) to keep the compiler happy
     bool getNTPEpoch(time_t *timeEpoch, int timeZone = 0, char *ntpServer = (char *)"pool.ntp.org",
