Get Data displayed on OLED

In this project, you will display data from Antares IoT Platform on OLED using ESP8266 module. In this Antares Shield Workshop, there are temperature, humidity (DHT11), relay, LED, and push button sensors. You will send a message in the form of data displayed on the OLED display. The process of sending this data uses POSTMAN Software to send data to the Antares IoT Platform.

Picture of WEMOSD1R2 with OLED Display

Prerequisites

The materials required follow the General Prerequisites on the previous page. If you have not prepared the requirements on that page, then you can visit the following page.

General Prerequisites ESP8266 Wi-Fi

The additional materials specific to this project are as follows.

1. Shield Workshop Antares

2. I2C-based 0.96inch 128x64 pixel SSD1036 OLED module

   

   SSD1036 0.96inch OLED Module Picture
3. Antares ESP HTTP Library. This documentation uses the Antares ESP HTTP library version 1.4.0.

If you have not installed Antares ESP HTTP 1.4.0, please follow these steps.

Antares Wi-Fi HTTP

1. OLED display library. This documentation uses Adafruit_SSD1306 by Adafruit version 2.5.7.

If you have not installed the Adafruit SSD1306 by Adafruit library version 2.5.7. you can follow the steps in the following link.

Adafruit SSD1306

1. Software Postman

If you have not installed POSTMAN Software, you can follow the steps in the following link.

Postman Installation

Follow These Steps

1. Launch the Arduino IDE application

2. Opening Sample Programme

You can open the programme code in the Arduino IDE via File > Example > Antares ESP HTTP > ESP8266-Simple-Project > GET_DATA_OLED.

Here is the programme code of the GET_DATA_OLED example.

#include <AntaresESPHTTP.h>     // Include the AntaresESP8266HTTP library for connecting to the Antares platform
#include <Adafruit_SSD1306.h>  // Include the OLED library

#define ACCESSKEY "YOUR-ACCESS-KEY"    // Replace with your Antares account access key
#define WIFISSID "YOUR-WIFI-SSID"      // Replace with your Wi-Fi SSID
#define PASSWORD "YOUR-WIFI-PASSWORD"  // Replace with your Wi-Fi password

#define projectName "YOUR-APPLICATION-NAME"  // Replace with the Antares application name that was created
#define deviceName "YOUR-DEVICE-NAME"        // Replace with the Antares device name that was created

const unsigned long interval = 10000;  // 10 s interval to send message
unsigned long previousMillis = 0;      // will store last time message sent

AntaresESPHTTP antares(ACCESSKEY);

#define SCREEN_WIDTH 128
#define SCREEN_HEIGHT 64
#define OLED_RESET -1  // Change this if your OLED module has a different reset pin

Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, OLED_RESET);  // Create an OLED display object

void setup() {
  Serial.begin(115200);
  antares.setDebug(true);
  antares.wifiConnection(WIFISSID, PASSWORD);

  // Initialize the OLED display
  if (!display.begin(SSD1306_SWITCHCAPVCC, 0x3C)) {
    Serial.println(F("SSD1306 allocation failed"));
    for (;;)
      ;
  }

  // Clear the buffer and display the initial message
  display.clearDisplay();
  display.setTextSize(1);
  display.setTextColor(SSD1306_WHITE);
  display.setCursor(0, 0);
  display.println("Hallo Test");
  display.display();
  delay(2000);  // Display the message for 2 seconds
}

void loop() {
  if (millis() - previousMillis > interval) {
    previousMillis = millis();

    // Get the latest data from your Antares device
    antares.get(projectName, deviceName);

    // Check if we're actually getting data
    if (antares.getSuccess()) {
      String test = antares.getString("Test");

      // Update the OLED display
      Serial.println("Received : " + test);
      display.clearDisplay();
      display.setTextSize(1);
      display.setTextColor(SSD1306_WHITE);
      display.setCursor(0, 0);
      display.println("Received:" + test);
      display.display();
    }
  }
}

3. Set WiFi Credential and Antares Credential in Program Code

Change the HTTP Protocol parameters in the following variables *ACCESSKEY, *WIFISSID, *PASSWORD, *projectName, and *deviceName. Adjust to the parameters in the Antares console.

#define ACCESSKEY "your-access-key" // Replace with your Antares account access key
#define WIFISSID "your-wifi-ssid" // Replace with your Wi-Fi SSID
#define PASSWORD "your-wifi-password" // Replace with your Wi-Fi password

#define projectName "your-project-name"   // Antares project name
#define deviceName "your-project-name"   // Name of the device

The *Access key parameter is obtained from your Antares account page.

Access Key Location on Antares Account Page

The WIFISSID parameter is obtained from the name of the Wifi / Hotspot that is currently being used by you. for example in the image below.

The WiFi SSID being used.

The *PASSWORD parameter is obtained from the WiFi password you are currently using.

The parameters *projectName and *deviceName are obtained from the Application Name and Device Name that have been created in the Antares account.

Application Name Display

Device Name Display

4. Compile and Upload Program

Connect the ESP8266 WEMOS D1R2 with your computer and make sure the Communication Port is read.

On Windows operating systems, checking can be done via Device Manager. If your ESP8266 WEMOS D1R2 is read, the USB-Serial CH340 appears with the port adjusting the port availability (in this case it reads COM4).

Device Manager image on Windows.

Set up the ESP8266 WEMOS D1R2 board by clicking Tools > Board > esp8266 in the Arduino IDE, then make sure the one used is LOLIN (WEMOS) D1 R2 & mini. Select the port according to the communication port that is read (in this case COM4). The result will look like the following picture.

Image of Tools Menu on Arduino IDE

After all the setup is complete, upload the programme by pressing the arrow icon as shown below. Wait for the compile and upload process to finish.

Image of the Verify and Upload icons in the Arduino IDE.

The Tick icon on the Arduino IDE is just the verify process. Usually used to Compile the programme to find out whether there are errors or not. The Arrow icon on the Arduino IDE is the verify and upload process. Usually used to Compile the programme as well as Flash the programme to the target board.

If the programme upload is successful, it will look like the following image.

Arduino IDE page image after successful upload.

After uploading the programme, you can view the serial monitor to debug the programme. The serial monitor icon is shown in the following image.

Image of the Serial Monitor Icon in the Arduino IDE.

Set the serial baud rate to 115200 and select BothNL & CR. The result will look like the following image.

Make sure the serial baud rate matches the value defined in the programme code. If the serial baud rate is not the same between the programme code and the serial monitor, the ASCII characters will not be read properly.

5. Setup Software POSTMAN

In this step you need POSTMAN software, you can input the end-point, request header and request body first by following the following format.

End Point

Method	POST
URL	https://platform.antares.id:8443/~/antares-cse/antares-id/your-application-name/your-device-name

Customise your-application-name and your-device-name to the names registered to your Antares account.

Request Header

Key	Value
X-M2M-Origin	your-access-key
Content-Type	application/json;ty=4
Accept	application/json

Customise your-access-key with your Antares account access key.

The result will be as shown below.

Image of end-point and header settings in POSTMAN software.

Next, you need to input the request body by following the following format.

Request Body

{
  "m2m:cin": {
    "con": "{\"key1\":\"integer-value\", \"key2\":\"string-value\", \"keyN\":\"valueN\"}"
  }
}

In the POSTMAN software, select the Body tab then select raw and enter the payload according to the request body you want to use as shown below.

Image of the contents of the payload request body in POSTMAN software.

Customise the contents of the "con" field according to the "key" and "value" you want to send.

6. Sending POSTMAN Messages to the Antares Server

After the POSTMAN software setup is complete, it's time to send the POST command. The "Test" field is filled with the string "Hello 123" as the message to be sent via HTTP protocol to the Antares server.

{
  "m2m:cin": {
    "con": "{\"Test\":\"Hallo 123\"}"
  }
}

If you have finished filling in the "Test" field, then press the Send button on the POSTMAN software. Looks like the following picture.

Image of the message content in POSTMAN software.

If the HTTP request through POSTMAN software is successful, the POSTMAN software response section will appear as shown below

Image of API hit response in POSTMAN software.

7. Check Data in Antares

After uploading the programme successfully, then open the device antares page and see if the data has been successfully sent.

Data received by ESP8266 with HTTP protocol in the form of Test variablet.

8. Output program

Get data from the Antares IoT Platform and display it on the OLED display after connecting to Wi-Fi is shown in the figure below:

Get Data results displayed on OLED