Mengontrol Relay dan LED Melalui Perintah Retrieve

Pendahuluan

Pada project ini, Anda akan menggunakan Shield Workshop Antares pada modul Development Board Lynx-32. Pada Shield Workshop Antares ini terdapat sensor suhu, kelembapan (DHT11), relay, LED, dan push button. Anda akan melakukan publish data menggunakan MQTTX yang berisi perintah untuk mengontrol LED dan relay. Kemudian Development Board Lynx-32 melakukan Subscribe Data ke Antares IoT Platform yang berisi dua opsi perintah, yaitu apabila masukan Relay bernilai 1 maka relay akan menyala; masukan Relay bernilai 0 maka relay akan mati; LED bernilai 1 maka LED akan menyala; masukan LED bernilai 0 maka LED akan mati.

Gambar Ilustrasi Project

Prasyarat

Material yang dibutuhkan mengikuti Prasyarat Umum pada laman sebelumnya. Jika Anda belum menyiapkan kebutuhan pada laman tersebut, maka Anda dapat mengunjungi laman berikut.

Prasyarat Umum ESP32 Wi-Fi

Adapun tambahan material yang spesifik untuk project ini adalah sebagai berikut.

  1. Shield Workshop Antares

  2. Library Antares ESP HTTP. Pada dokumentasi ini menggunakan library Antares ESP MQTT versi 1.0.

Jika anda belum menginstall Antares ESP MQTT versi 1.0 dapat mengikuti langkah berikut.

Antares Wi-Fi MQTT

  1. Software MQTTX

Jika Anda belum menginstall Software MQTTX dapat mengikuti langkah pada link berikut.

Instalasi MQTTX

Langkah Kerja

1. Jalankan Aplikasi Arduino IDE

2. Membuka Contoh Program

Kode program dapat Anda buka pada Arduino IDE melalui File > Examples > Antares ESP HTTP > Lynx32-Simple-Project > RETRIEVE_DATA_RELAY_LED.

Berikut adalah kode program contoh RETRIEVE_DATA_RELAY_LED.

// Include necessary libraries
#include <AntaresESPMQTT.h> // Include the ESP32 HTTP library
#include <Adafruit_SSD1306.h> // Include the OLED library

// Replace these with your own credentials
#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

#define relayPin 25
#define ledPin 12

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

AntaresESPMQTT antares(ACCESSKEY);

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());

  String relayValue = antares.getString("Relay"); // Change data field to "Relay"
  String ledValue = antares.getString("LED");     // Add reading for "LED" data field
  // Control relay based on received data
  if (relayValue == "1") {
  digitalWrite(relayPin, HIGH);
  } 
  else if (relayValue == "0") {
  digitalWrite(relayPin, LOW);
  }

  // Control LED based on received data
  if (ledValue == "1") {
  digitalWrite(ledPin, HIGH);
  } 
  else if (ledValue == "0") {
  digitalWrite(ledPin, LOW);
  }

  Serial.println("Received data - Relay: " + relayValue + " | LED: " + ledValue);
  
}

void setup() {
    Serial.begin(115200); // Initialize serial communication
    antares.setDebug(true); // Enable debugging for Antares
    antares.wifiConnection(WIFISSID, PASSWORD); // Connect to WiFi
    antares.setMqttServer();
    antares.setCallback(callback);
    pinMode(relayPin, OUTPUT); // Set relayPin as an output
    pinMode(ledPin, OUTPUT); // Set ledPin as an output
}

void loop() {
 /*
    Check if we're still connected to the MQTT broker/server.
    If disconnected, the device will try to reconnect.
   */
  antares.checkMqttConnection();
}

3. Set Credential WiFi dan Credential Antares pada Kode Program

Ubah parameter Protokol HTTP pada variabel berikut *ACCESSKEY, *WIFISSID, *PASSWORD, *projectName, dan *deviceName. Sesuaikan dengan parameter di console Antares.

#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

Parameter *Access key didapat dari laman akun Antares Anda.

Letak Access Key di Laman Akun Antares

Parameter WIFISSID didapat dari nama Wifi/Hotspot yang sedang digunakan oleh Anda. contohnya pada gambar di bawah ini.

WIFISSID

Parameter *PASSWORD didapat dari password WiFi yang sedang anda gunakan.

Parameter *projectName dan *deviceName didapat dari Application Name dan Device Name yang sudah dibuat dalam akun Antares.

Tampilan Application Name
Tampilan Device Name

4. Compile dan Upload Program

Hubungkan Lynx-32 dengan komputer Anda dan pastikan Communication Port terbaca.

Pada sistem operasi Windows pengecekan dapat dilakukan melalui Device Manager. Jika Lynx-32 Anda terbaca maka tampil USB-Serial CH340 dengan port menyesuaikan ketersediaan port (pada kasus ini terbaca COM4).

Tampilan Device Manager

Atur board ESP32 dengan klik Tools > Board > esp32 pada Arduino IDE, kemudian pastikan yang digunakan adalah ESP32 Dev Module. Pilih port sesuai communication port yang terbaca (dalam kasus ini COM4). Hasilnya akan terlihat seperti gambar berikut.

Tampilan Spesifikasi Board dan Port yang Digunakan

Setelah semua setup selesai, lakukan upload program dengan menekan icon panah seperti gambar berikut. Tunggu hingga selesai proses compile dan upload

Ikon Compile untuk Centang dan Ikon Upload untuk Tanda Panah

Icon Centang pada Arduino IDE hanyalah proses verify. Biasanya digunakan untuk Compile program untuk mengetahui apakah terdapat error atau tidak.

Icon panah pada Arduino IDE adalah proses verify dan upload. Biasanya digunakan untuk Compile program sekaligus Flash Program pada target board.

Jika upload program berhasil maka akan terlihat seperti gambar berikut.

Setelah selesai upload program, Anda dapat melihat serial monitor untuk melakukan debug program. Icon serial monitor terlihat pada gambar berikut.

Ikon Serial Monitor

Atur serial baud rate menjadi 115200 dan pilih BothNL & CR. Hasilnya akan terlihat seperti gambar berikut.

Tampilan Serial Monitor

5. Setup Software MQTTX

Buka Aplikasi MQTTX, lalu pilih New Connection

Membuat New Connection

Agar dapat terconfigurasi antara MQTTX dengan broker Antares, sesuaikan Name, Host dan Port seperti yang ditunjukan di bawah ini, setelah itu klik Connect

Antares MQTT Broker Configuration

Jika sudah terkoneksi maka terdapat notifikasi seperti gambar berikut

Antares Broker MQTTX Connected

Masukan Topic dan Payload pada kolom di MQTTX.

Laman Topic dan Payload pada MQTTX
Field
Value

Topic

/oneM2M/req/your-access-key/antares-cse/json

Payload

{
      "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
      }
    }

Sesuaikan your-access-key, nama-aplikasi-anda, dan nama-device-anda sesuai nama-nama yang terdaftar pada akun Antares Anda. Isikan pula "Field" data dan "Nilai" data pada "con" sesuai yang Anda inginkan.

Pada software MQTTX masukan Topic dan Payload yang ingin digunakan. Kemudian klik Publish untuk mengirimkan pesan dari MQTTX ke server Antares.

Publish untuk mengirim pesan ke server Antares

6. Mengirim Pesan MQTTX ke Server Antares

Setelah setup software MQTTX selesai, saatnya mengirimkan perintah PUBLISH. Pada field "Relay" diisi dengan string "1" atau "0" sebagai pesan perintah untuk Relay yang akan dikirim melalui protokol MQTT ke server Antares. Pada field "LED" diisi dengan string "1" untuk LED ON atau "0" untuk LED OFF sebagai pesan perintah untuk LED yang akan dikirim melalui protokol MQTT ke server Antares.

{
      "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": "{\"Relay\":\"1\",\"LED\":\"1\"}"
          }
        },
        "ty": 4
      }
    }

Jika sudah selesai mengisi field "test" selanjutnya tekan tombol PUBLISH pada software MQTTX yang terletak di sebelah kanan kolom pengisian Topic, seperti pada gambar berikut.

Gambar isi Payload MQTTX

Jika sudah publish maka laman MQTTX akan terdapat Message seperti berikut.

Notifikasi Message Published

7. Periksa Data di Antares

Setelah upload program berhasil, selanjutnya buka halaman device antares kemudian lihat apakah data sudah berhasil dikirim.

Gambar Halaman Console Antares Ketika Data Berhasil Diterima.

Data yang diterima oleh LYNX-32 dengan protokol MQTT berupa variabel Relay dan LED.

8. Melihat Pesan Retrieve

Retrieve data dari Antares IoT Platform dan ditampilkan pada display OLED setelah terhubung ke Wi-Fi tertampil pada gambar dibawah ini:

Last updated