# Retrieve Data displayed on OLED Display

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 messages in the form of data displayed on the OLED display. The process of sending this data uses **MQTTX Software** to send data to the **Antares IoT Platform**. 

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/KJljnyCgxyT72xoLvyL2/ESP8266_OLED_Hello_Antares-removebg-preview%20(1).png" alt=""><figcaption><p>Image of WEMOS D1R2 Displaying Data on OLED</p></figcaption></figure>

## 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.

{% content-ref url="../../general-prerequisites-esp8266-wi-fi" %}
[general-prerequisites-esp8266-wi-fi](https://docs.antares.id/en/code-and-library-examples/esp8266-wi-fi/general-prerequisites-esp8266-wi-fi)
{% endcontent-ref %}

The additional materials specific to this project are as follows.

1. Shield Workshop Antares
2. I2C-based 0.96inch 128x64 pixel SSD1036 OLED module

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/4nvkfbCCoHzkon3YxGnp/WhatsApp%20Image%202023-09-06%20at%2014.39.49.jpeg" alt="" width="345"><figcaption><p>SSD1036 0.96inch OLED Module Image</p></figcaption></figure>

3. OLED display library. This documentation uses **Adafruit\_SSD1306 by Adafruit version 2.5.7.**

{% hint style="info" %}
If you have not installed the **Adafruit SSD1306 by Adafruit library version 2.5.7.** you can follow the steps in the following link.
{% endhint %}

4. MQTTX Software

{% hint style="info" %}
If you have not installed the **MQTTX Software**, you can follow the steps in the following link.

[mqttx-installation](https://docs.antares.id/en/getting-started/software-installation/mqttx-installation "mention")
{% endhint %}

## Follow These Steps

### **1.** Launch the Arduino IDE application

### **2.** Opening Sample Programme&#x20;

{% hint style="info" %}
You can open the programme code in the Arduino IDE via **File > Example > Antares ESP MQTT > ESP8266-Simple-Project > RETRIEVE\_DATA\_OLED.**&#x20;
{% endhint %}

Below is the programme code of the  **RETRIEVE\_DATA\_OLED** example.&#x20;

```cpp
#include <AntaresESPMQTT.h>    // Import the AntaresESPMQTT library for communication with Antares
#include <Adafruit_SSD1306.h>  // Import the Adafruit_SSD1306 library for controlling the OLED display

#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

AntaresESPMQTT antares(ACCESSKEY);  // Initialize the AntaresESPMQTT object with the access key

#define SCREEN_WIDTH 128  // OLED display width
#define SCREEN_HEIGHT 64  // OLED display height
#define OLED_RESET -1     // OLED display reset pin

String testData;       // Store received mqtt data
String lastData = "";  // Store last received mqtt data

Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, OLED_RESET);  // Initialize the display object

void callback(char topic[], byte payload[], unsigned int length) {
  antares.get(topic, payload, length);

  Serial.println("New Message!");
  Serial.println("Topic: " + antares.getTopic());
  Serial.println("Payload: " + antares.getPayload());

  testData = antares.getString("Test");
  Serial.println("Received: " + testData);
  if (testData != "null") {
    if (lastData != testData) {
      lastData = testData;
      display.clearDisplay();
      display.setTextSize(1);
      display.setTextColor(SSD1306_WHITE);
      display.setCursor(0, 0);
      display.println("Received: " + testData);
      display.display();
    }
  }
}

void setup() {
  Serial.begin(115200);                        // Start serial communication at baud rate 115200
  antares.setDebug(true);                      // Enable debug mode for Antares
  antares.wifiConnection(WIFISSID, PASSWORD);  // Connect to Wi-Fi using SSID and password
  antares.setMqttServer();                     // Set up the Antares MQTT server
  antares.setCallback(callback);               // Set the callback function for MQTT messages

  if (!display.begin(SSD1306_SWITCHCAPVCC, 0x3C)) {  // Initialize the OLED display
    Serial.println(F("SSD1306 allocation failed"));  // Display a message if OLED initialization fails
    for (;;)
      ;  // Halt the program
  }

  display.clearDisplay();                  // Clear the OLED display
  display.setTextSize(1);                  // Set text size
  display.setTextColor(SSD1306_WHITE);     // Set text color
  display.setCursor(0, 0);                 // Set text cursor position
  display.println("Waiting for data...");  // Display initial message
  display.display();                       // Show the message on the display
}

void loop() {
  antares.checkMqttConnection();  // Check MQTT connection to Antares
}
```

### **3.** Set WiFi Credential and Antares Credential in Program Code&#x20;

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

```arduino
#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
```

{% hint style="info" %}
The **\*Access key** parameter is obtained from your Antares account page.
{% endhint %}

<figure><img src="https://3873791589-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cujmJ5QHdJaAjH815aZ%2Fuploads%2FLvXLl7xJ502ghZfDuP5h%2Fimage.png?alt=media&#x26;token=079c00f9-6a90-4a63-9924-abb28b3e8c88" alt=""><figcaption><p>Access Key Location on Antares Account Page</p></figcaption></figure>

{% hint style="info" %}
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.
{% endhint %}

<div align="center" data-full-width="true"><figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/qV0pFUlJymLc245XVc1V/Wifi%20SSID.jpeg" alt="" width="375"><figcaption><p>The WiFi SSID being used.</p></figcaption></figure></div>

{% hint style="info" %}
The **\*PASSWORD** parameter is obtained from the **WiFi password** you are currently using.
{% endhint %}

{% hint style="info" %}
The parameters **\*projectName** and **\*deviceName** are obtained from the **Application Name** and **Device Name** that have been created in the Antares account.
{% endhint %}

<figure><img src="https://3873791589-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cujmJ5QHdJaAjH815aZ%2Fuploads%2FpRtQglxdEizsrBlByVM7%2Fimage.png?alt=media&#x26;token=581f1467-fd48-4cd3-8d93-6ef06f178a59" alt=""><figcaption><p>Application Name Display</p></figcaption></figure>

<figure><img src="https://3873791589-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cujmJ5QHdJaAjH815aZ%2Fuploads%2FOSeZx0LW7g22ETy963rd%2Fimage.png?alt=media&#x26;token=90770975-95b4-4153-a1f4-0b27f1568f4f" alt=""><figcaption><p>Device Name Display</p></figcaption></figure>

### **4. Compile and Upload Program**

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

{% hint style="info" %}
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**).
{% endhint %}

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/NTFRdir7Md7yxzR69Zfj/Device%20Manager.jpeg" alt=""><figcaption><p>Device Manager image on Windows.</p></figcaption></figure>

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.

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/2bugJSC71Klee6w0pR77/Board%20LOLIN%20WEMOS%20D1R2.jpeg" alt="" width="563"><figcaption><p>Image of Tools Menu on Arduino IDE</p></figcaption></figure>

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.

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/ZdWAMMyPkVmRct79i1eP/Logo%20Upload%20dan%20Verify.jpeg" alt=""><figcaption><p>Image of the Verify and Upload icons in the Arduino IDE.</p></figcaption></figure>

{% hint style="info" %}
**The Tick icon** on the Arduino IDE is just the verify process. Usually used to C**ompile** 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.
{% endhint %}

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

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/avlqOJQLSlDQ3PJMJLue/Done%20Uploading.jpeg" alt=""><figcaption><p>Arduino IDE page image after successful upload.</p></figcaption></figure>

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

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/YzosK6UEdsP3jxAN0mPc/Logo%20SeRial%20Retrieve%20Last%20Data.jpeg" alt=""><figcaption><p>Image of the Serial Monitor Icon in the Arduino IDE.</p></figcaption></figure>

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

{% hint style="danger" %}
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.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/fJzquA6yA3kPVgXYjzAi/Serial%20Monitor%20Retrieve_OLED_MQTT.jpg" alt=""><figcaption><p>Serial Monitor Image</p></figcaption></figure>

### **5. Setup MQTTX Software**

Open the MQTTX App, then select New Connection

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/YhCjAORMVZf4VQWdF4vn/New%20Connection%20MQTTX.jpg" alt=""><figcaption><p>Creating a New Connection</p></figcaption></figure>

In order to configure MQTTX with Antares broker, adjust the Name, Host and Port as shown below, then click Connect.

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/EXE8NIa3niFv00Eb021l/Configuration%20MQTTX.jpg" alt=""><figcaption><p>Antares MQTT Broker Configuration</p></figcaption></figure>

If it is connected, there is a notification as shown below

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/S6OC8fKJiawWXj3b2kH5/Connected%20MQTTX.jpg" alt=""><figcaption><p>Antares Broker MQTTX Connected</p></figcaption></figure>

To publish to the Antares server, enter **Topic** and **Payload** in the fields in MQTTX.

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/ijJakj7oisLBj79GRmu7/Topic%20dan%20Payload%20MQTTX.jpg" alt=""><figcaption><p>Topic and Payload pages in MQTTX</p></figcaption></figure>

<table><thead><tr><th width="111">Field</th><th>Value</th></tr></thead><tbody><tr><td><strong>Topic</strong></td><td><mark style="color:red;"><code>/oneM2M/req/your-access-key/antares-cse/json</code></mark></td></tr><tr><td><strong>Payload</strong></td><td><pre class="language-json"><code class="lang-json">{
      "m2m:rqp": {
        "fr": "your-access-key",
        "to": "/antares-cse/antares-id/nama-aplikasi-anda/nama-device-anda",
        "op": 1,
        "rqi": 123456,
        "pc": {
          "m2m:cin": {
            "cnf": "message",
            "con": "{\"your-first-data\":\"the-integer-value\",\"your-second-data\":\"the-string-data\"}"
          }
        },
        "ty": 4
      }
    }
</code></pre></td></tr></tbody></table>

{% hint style="info" %}
Customise <mark style="color:red;">your-access-key</mark>, <mark style="color:red;">your-application-name</mark>, and <mark style="color:red;">your-device-name</mark> to the names registered to your Antares account. Fill in the "Field" data and "Value" data in "con" as you wish.
{% endhint %}

In the MQTTX software, enter the Topic and Payload that you want to use. Then click Publish to send the message from MQTTX to the Antares server.

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/TTo26XPxgPJKkqdgwrFH/Publish%20to%20Antares%20MQTTX.jpg" alt=""><figcaption><p>Publish to send the message to Antares server</p></figcaption></figure>

### **6.** Sending MQTTX Messages to Antares Server

After the MQTTX software setup is complete, it's time to send the PUBLISH command. The "Test" field is filled with the string "Hello Antares" as the message that will be sent via the MQTT protocol to the Antares server.

```json
{
      "m2m:rqp": {
        "fr": "your-access-key",
        "to": "/antares-cse/antares-id/nama-aplikasi-anda/nama-device-anda",
        "op": 1,
        "rqi": 123456,
        "pc": {
          "m2m:cin": {
            "cnf": "message",
            "con": "{\"Test\":\"Hallo Antares\"}"
          }
        },
        "ty": 4
      }
    }
```

If you have finished filling in the "Test" field, then press the **Publish** button on the MQTTX software, as shown below.

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/YwP48cjNE6hQdeoKLnuN/Payload%20Hello%20Antares%20MQTTX.jpg" alt=""><figcaption><p>Image of MQTTX Payload content</p></figcaption></figure>

If it has been published, the MQTTX page will have a message like the following.

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/LkSeOjFkywKLq3b3ZKIz/Published%20MQTTX.jpg" alt=""><figcaption><p>Notification Message Published</p></figcaption></figure>

### **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.

<figure><img src="https://3873791589-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cujmJ5QHdJaAjH815aZ%2Fuploads%2Fb70eL5zSYFzukpyL3oT2%2Fimage.png?alt=media&#x26;token=4be75e1e-d353-4749-a6b2-4642bd5843eb" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3873791589-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cujmJ5QHdJaAjH815aZ%2Fuploads%2FzihfmbKQb3rGhOH3JSej%2Fimage.png?alt=media&#x26;token=40bf42b1-d09e-494c-89fa-746aca46595d" alt=""><figcaption><p>Image of the Antares Console Page When Data is Successfully Received.</p></figcaption></figure>

{% hint style="info" %}
The data received by **ESP8266** with MQTT protocol is in the form of Test variable.
{% endhint %}

### **8. Output program**&#x20;

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:

<figure><img src="https://content.gitbook.com/content/7cujmJ5QHdJaAjH815aZ/blobs/oozvQLVAGo5eFjpzn0b5/ESP8266_OLED_Hello_Antares-removebg-preview.png" alt=""><figcaption><p>MQTTX Data Retrieve Results displayed on OLED</p></figcaption></figure>