GET & POST Requests
Now that Inkplate is connected to the internet, you will likely want to send and receive data on it from sensors, messages, and your custom APIs, etc. This page contains examples on how to send and receive data on Inkplate via the internet:
GET request
Using client.GET() will enable you to easily download and handle data on Inkplate however you want. Here is an example on how to GET an HTML file and print it on Inkplate:
#include "Inkplate.h" //Include Inkplate library to the sketch
#include <HTTPClient.h> //Include HTTP library to this sketch
#include <WiFi.h> //Include ESP32 WiFi library to our sketch
#define ssid "" // Name of the WiFi network (SSID) that you want to connect Inkplate to
#define pass "" // Password of that WiFi network
Inkplate display(INKPLATE_1BIT); // Create an object on Inkplate library and also set library into 1 Bit mode (BW)
void setup()
{
display.begin(); // Init Inkplate library (you should call this function ONLY ONCE)
display.clearDisplay(); // Clear frame buffer of display
display.display(); // Put clear image on display
display.setTextSize(2); // Set text scaling to two (text will be two times bigger)
display.setCursor(0, 0); // Set print position
display.setTextColor(BLACK, WHITE); // Set text color to black and background color to white
display.println("Scanning for WiFi networks..."); // Write text
display.display(); // Send everything to display (refresh display)
int n = WiFi.scanNetworks(); // Start searching WiFi networks and put the number of found WiFi networks in variable
// n
if (n == 0)
{ // If you did not find any network, show the message and stop the program.
display.print("No WiFi networks found!");
display.partialUpdate();
while (true)
;
}
else
{
if (n > 10)
n = 10; // If you did find, print name (SSID), encryption and signal strength of first 10 networks
for (int i = 0; i < n; i++)
{
display.print(WiFi.SSID(i));
display.print((WiFi.encryptionType(i) == WIFI_AUTH_OPEN) ? 'O' : '*');
display.print('\n');
display.print(WiFi.RSSI(i), DEC);
}
display.partialUpdate(); //(Partial) refresh thescreen
}
display.clearDisplay(); // Clear everything in frame buffer
display.setCursor(0, 0); // Set print cursor to new position
display.print("Connecting to "); // Print the name of WiFi network
display.print(ssid);
WiFi.begin(ssid, pass); // Try to connect to WiFi network
while (WiFi.status() != WL_CONNECTED)
{
delay(1000); // While it is connecting to network, display dot every second, just to know that Inkplate is
// alive.
display.print('.');
display.partialUpdate();
}
display.print("connected"); // If it's connected, notify user
display.partialUpdate();
HTTPClient http;
if (http.begin("http://example.com/index.html"))
{ // Now try to connect to some web page (in this example www.example.com. And yes, this is a valid Web page :))
if (http.GET() > 0)
{ // If connection was successful, try to read content of the Web page and display it on screen
String htmlText;
htmlText = http.getString();
display.setTextSize(1); // Set smaller text size, so everything can fit on screen
display.clearDisplay();
display.setCursor(0, 0);
display.print(htmlText);
display.display();
}
}
}
void loop()
{
// Nothing
}
WiFi.begin()
This function attempts to connect to WiFi
Returns type: wl_status_t
Returns value: Returns wl_status_t enum value
Function parameters:
| Type | Name | Description |
|---|---|---|
const char* | ssid | Network SSID. |
const char* | passphrase | Optional, depends on WiFi network security certificate |
http.begin()
This function attempts to open an HTTP communication to a given URL
Returns type: bool
Returns value: Returns true if communication is successful, otherwise returns false.
Function parameters:
| Type | Name | Description |
|---|---|---|
String | url | URL of the specified website |
http.GET()
This function handles GET requests.
Returns type: int
Returns value: Returns the size of available data
POST request
To send data from Inkplate to a web server, you can use the same built-in WiFiClient class. Let's use ThingSpeak.com, which is a great resource for testing POST and GET requests. By visiting the site, you get a unique URL to which you can send a POST request from Inkplate, and the data will then be visible on the site:
// Include needed libraries
#include "Inkplate.h"
#include "WiFi.h"
// Create objects from included libraries
Inkplate display(INKPLATE_1BIT);
WiFiClient client;
// Here you can change the interval of sending POST requests (minimum 15 seconds with a free license)
#define POSTING_INTERVAL_IN_SESCS 20
// Enter your WiFi credentials
const char *ssid = "";
const char *pass = "";
// ThingSpeak settings
char *server = "api.thingspeak.com";
String writeAPIKey = ""; // Enter your Write API Key
// Variable that holds last connection time
unsigned long lastConnectionTime = 0;
void setup()
{
// Init serial communication
Serial.begin(115200);
// Init Inkplate library (you should call this function ONLY ONCE)
display.begin();
// Clear frame buffer of display
display.clearDisplay();
// Set text color and size
display.setTextColor(BLACK, WHITE);
display.setTextSize(6);
// Display a message
display.printf("HTTP POST request example\n\n");
display.printf("Open Serial Monitor at \n115200 baud rate to see \nwhat's happening");
display.display();
// Connect to the WiFi network
WiFi.mode(WIFI_MODE_STA);
WiFi.begin(ssid, pass);
Serial.print("Connecting to Wifi ");
while (WiFi.status() != WL_CONNECTED)
{
delay(500);
Serial.print(".");
}
Serial.println();
Serial.print("Connected to WiFi network with IP Address: ");
Serial.println(WiFi.localIP());
}
void loop()
{
// Every POSTING_INTERVAL_IN_SESCS seconds make the POST request
if ((unsigned long)(millis() - lastConnectionTime) > POSTING_INTERVAL_IN_SESCS * 1000LL)
{
// Clear frame buffer of display
display.clearDisplay();
// Connect the WiFi client to the server via port 80
if (!client.connect(server, 80))
{
// If it fails, print a message, remember time, stop the client and reset the loop
Serial.println("Connection failed");
lastConnectionTime = millis();
client.stop();
return;
}
else
{
// If you have any sensor or something else, here you have to put data to send instead of a random number
int field1Data = random(40);
// Create data string to send to ThingSpeak
String data = "field1=" + String(field1Data); // shows how to include additional field data in http post
// POST data to ThingSpeak
if (client.connect(server, 80))
{
client.println("POST /update HTTP/1.1");
client.println("Host: api.thingspeak.com");
client.println("Connection: close");
client.println("User-Agent: ESP32WiFi/1.1");
client.println("X-THINGSPEAKAPIKEY: " + writeAPIKey);
client.println("Content-Type: application/x-www-form-urlencoded");
client.print("Content-Length: ");
client.print(data.length());
client.print("\n\n");
client.print(data);
Serial.print("The POST request is done: ");
Serial.println(data);
lastConnectionTime = millis();
delay(250);
}
}
client.stop();
}
}
WiFi.mode()
This function sets the MCU WiFi chip as STA or AP.
Returns type: bool
Function parameters:
| Type | Name | Description |
|---|---|---|
wifi_mode_t | mode | WiFi mode value, can be either WIFI_MODE_STA or WIFI_MODE_AP |
WiFi.begin()
This function attempts to connect to WiFi
Returns type: wl_status_t
Returns value: Returns wl_status_t enum value
Function parameters:
| Type | Name | Description |
|---|---|---|
const char* | ssid | Network SSID. |
const char* | passphrase | Optional, depends on WiFi network security certificate |
http.begin()
This function attempts to open an HTTP communication to a given URL
Returns type: bool
Returns value: Returns true if communication is successful, otherwise returns false.
Function parameters:
| Type | Name | Description |
|---|---|---|
String | url | URL of the specified website |
Full example
To see more details, check out our full examples:
Inkplate6FLICK_HTTP_Request.ino
Inkplate 6FLICK WiFi GET request example from the Inkplate library
Inkplate6FLICK_HTTP_POST_Request.ino
Inkplate 6FLICK WiFi POST request example from the Inkplate library