Mengontrol Relay dan LED melalui perintah Downlink

Pendahuluan

Pada bagian ini, Anda akan menggunakan Shield Workshop Antares pada modul Development Board Lynx-32 Antares. Pada Shield Workshop Antares terdapat sensor suhu dan kelembapan (DHT11), relay, LED dan push button. Pada tutorial ini, Anda akan melakukan kontrol Relay dan LED melalui downlink. Proses pengiriman downlink ini menggunakan software POSTMAN yang melakukan HIT API downlink ke Platform Antares

Gambar Ilustrasi Project

Prasyarat

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

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

1. Shield Workshop Antares

1. Software Postman

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

Instalasi Postman

Langkah Kerja

1. Jalankan Aplikasi Arduino IDE

2. Membuka Contoh Program

Class A

Kode program dapat anda buka pada Arduino IDE melalui File > Examples > Antares LoRaWAN > Lynx32-Simple-Project > Class A > DOWNLINK_RELAY_LED_CLASS_A

Berikut adalah kode program dari contoh DOWNLINK_RELAY_LED_CLASS_A

#include <lorawan.h>
#define RELAY_PIN 25
#define LED_PIN 12

//ABP Credentials
/*
  Notes:
  - select ABP Activation on ANTARES
  - select inherit to generate your keys
  - nwkSKey: 32 digit hex, you can put 16 first digits by first 16 digits your access key and add 16 digits with 0 (ex : abcdef01234567890000000000000000)
  - appSKey: 32 digit hex, put 16 first digits by 0 and put last 16 digits by last 16 digit your access key (ex : 0000000000000000abcdef0123456789)
*/
const char *devAddr = "Lora-Device-Address";      // Replace with the Device Address that you have in the Antares console
const char *nwkSKey = "Network-Session-Key";      // Replace with the Network Session Key that you have in the Antares console
const char *appSKey = "Application-Session-Key";  // Replace with the Application Session Key that you have in the Antares console

const unsigned long interval = 60000;  // 60 s interval to send message
unsigned long previousMillis = 0;      // will store last time message sent
unsigned int counter = 0;              // message counter

char myStr[50];
char outStr[255];
byte recvStatus = 0;
int channel;

const sRFM_pins RFM_pins = {
  .CS = 5,     //LYNX32 to RFM NSS
  .RST = 0,    //LYNX32 to RFM RST
  .DIO0 = 27,  //LYNX32 to RFM DIO0
  .DIO1 = 2,   //LYNX32 to RFM DIO1
};

void setup() {
  // Setup loraid access
  Serial.begin(115200);
  pinMode(RELAY_PIN, OUTPUT);
  pinMode(LED_PIN, OUTPUT);

  digitalWrite(RELAY_PIN, LOW);  // Pastikan relay mati saat awalnya
  digitalWrite(LED_PIN, LOW);    // Matikan LED saat awalnya

  delay(2000);
  if (!lora.init()) {
    Serial.println("RFM95 not detected");
    delay(5000);
    return;
  }

  // Set LoRaWAN Class change CLASS_A or CLASS_C
  lora.setDeviceClass(CLASS_A);

  // Set Data Rate
  lora.setDataRate(SF10BW125);

  // set channel to random
  lora.setChannel(MULTI);

  // Set TxPower to 15 dBi (max)
  lora.setTxPower1(15);

  // Put ABP Key and DevAddress here
  lora.setNwkSKey(nwkSKey);
  lora.setAppSKey(appSKey);
  lora.setDevAddr(devAddr);
}

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

    sprintf(myStr, "Lora Counter-%d", counter);

    Serial.print("Sending : ");
    Serial.println(myStr);

    lora.sendUplink(myStr, strlen(myStr), 0, 5);
    counter++;
    channel = lora.getChannel();
    Serial.print(F("Ch : "));
    Serial.print(channel);
    Serial.println(" ");
  }

  // Check Lora RX
  lora.update();

  recvStatus = lora.readData(outStr);
  if (recvStatus) {
    int counter = 0;

    for (int i = 0; i < recvStatus; i++) {
      if (((outStr[i] >= 32) && (outStr[i] <= 126)) || (outStr[i] == 10) || (outStr[i] == 13))
        counter++;
    }
    if (counter == recvStatus) {
      Serial.print(F("Received String : "));
      for (int i = 0; i < recvStatus; i++) {
        Serial.print(char(outStr[i]));
      }
    } else {
      Serial.print(F("Received Hex : "));
      for (int i = 0; i < recvStatus; i++) {
        Serial.print(outStr[i], HEX);
        Serial.print(" ");
      }
    }
    Serial.println();

    // Check if the received HEX data is "AA11"
    if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x11) {

      digitalWrite(RELAY_PIN, HIGH);
      digitalWrite(LED_PIN, HIGH);
    }
    // Check if the received HEX data is "AA10"
    else if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x10) {
      digitalWrite(RELAY_PIN, HIGH);
      digitalWrite(LED_PIN, LOW);
    }
    // Check if the received HEX data is "AA01"
    else if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x01) {
      digitalWrite(RELAY_PIN, LOW);
      digitalWrite(LED_PIN, HIGH);
    }
    // Check if the received HEX data is "AA00"
    else if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x00) {
      digitalWrite(RELAY_PIN, LOW);
      digitalWrite(LED_PIN, LOW);
    }
  }
}

Class C

Kode program dapat anda buka pada Arduino IDE melalui File > Examples > Antares LoRaWAN > Lynx32-Simple-Project > Class C > DOWNLINK_RELAY_LED_CLASS_C

Berikut adalah kode program dari contoh DOWNLINK_RELAY_LED_CLASS_C

#include <lorawan.h>
#define RELAY_PIN 25
#define LED_PIN 12

//ABP Credentials
/*
  Notes:
  - select ABP Activation on ANTARES
  - select inherit to generate your keys
  - nwkSKey: 32 digit hex, you can put 16 first digits by first 16 digits your access key and add 16 digits with 0 (ex : abcdef01234567890000000000000000)
  - appSKey: 32 digit hex, put 16 first digits by 0 and put last 16 digits by last 16 digit your access key (ex : 0000000000000000abcdef0123456789)
*/
const char *devAddr = "Lora-Device-Address";      // Replace with the Device Address that you have in the Antares console
const char *nwkSKey = "Network-Session-Key";      // Replace with the Network Session Key that you have in the Antares console
const char *appSKey = "Application-Session-Key";  // Replace with the Application Session Key that you have in the Antares console

const unsigned long interval = 60000;  // 60 s interval to send message
unsigned long previousMillis = 0;      // will store last time message sent
unsigned int counter = 0;              // message counter

char myStr[50];
char outStr[255];
byte recvStatus = 0;
int channel;

const sRFM_pins RFM_pins = {
  .CS = 5,     //LYNX32 to RFM NSS
  .RST = 0,    //LYNX32 to RFM RST
  .DIO0 = 27,  //LYNX32 to RFM DIO0
  .DIO1 = 2,   //LYNX32 to RFM DIO1
};

void setup() {
  // Setup loraid access
  Serial.begin(115200);
  pinMode(RELAY_PIN, OUTPUT);
  pinMode(LED_PIN, OUTPUT);

  digitalWrite(RELAY_PIN, LOW);  // Pastikan relay mati saat awalnya
  digitalWrite(LED_PIN, LOW);    // Matikan LED saat awalnya

  delay(2000);
  if (!lora.init()) {
    Serial.println("RFM95 not detected");
    delay(5000);
    return;
  }

  // Set LoRaWAN Class change CLASS_A or CLASS_C
  lora.setDeviceClass(CLASS_C);

  // Set Data Rate
  lora.setDataRate(SF10BW125);

  // set channel to random
  lora.setChannel(MULTI);

  // Set TxPower to 15 dBi (max)
  lora.setTxPower1(15);

  // Put ABP Key and DevAddress here
  lora.setNwkSKey(nwkSKey);
  lora.setAppSKey(appSKey);
  lora.setDevAddr(devAddr);
}

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

    sprintf(myStr, "Lora Counter-%d", counter);

    Serial.print("Sending : ");
    Serial.println(myStr);

    lora.sendUplink(myStr, strlen(myStr), 0, 5);
    counter++;
    channel = lora.getChannel();
    Serial.print(F("Ch : "));
    Serial.print(channel);
    Serial.println(" ");
  }

  // Check Lora RX
  lora.update();

  recvStatus = lora.readData(outStr);
  if (recvStatus) {
    int counter = 0;

    for (int i = 0; i < recvStatus; i++) {
      if (((outStr[i] >= 32) && (outStr[i] <= 126)) || (outStr[i] == 10) || (outStr[i] == 13))
        counter++;
    }
    if (counter == recvStatus) {
      Serial.print(F("Received String : "));
      for (int i = 0; i < recvStatus; i++) {
        Serial.print(char(outStr[i]));
      }
    } else {
      Serial.print(F("Received Hex : "));
      for (int i = 0; i < recvStatus; i++) {
        Serial.print(outStr[i], HEX);
        Serial.print(" ");
      }
    }
    Serial.println();

    // Check if the received HEX data is "AA11"
    if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x11) {

      digitalWrite(RELAY_PIN, HIGH);
      digitalWrite(LED_PIN, HIGH);
    }
    // Check if the received HEX data is "AA10"
    else if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x10) {
      digitalWrite(RELAY_PIN, HIGH);
      digitalWrite(LED_PIN, LOW);
    }
    // Check if the received HEX data is "AA01"
    else if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x01) {
      digitalWrite(RELAY_PIN, LOW);
      digitalWrite(LED_PIN, HIGH);
    }
    // Check if the received HEX data is "AA00"
    else if (recvStatus == 2 && outStr[0] == 0xAA && outStr[1] == 0x00) {
      digitalWrite(RELAY_PIN, LOW);
      digitalWrite(LED_PIN, LOW);
    }
  }
}

3. Set LoRaWAN Parameter di Antares

Pada halaman Device console Antares lakukan Set LoRa dengan menekan button Set LoRa seperti gambar berikut.

Gambar Halaman Console Antares untuk Set LoRa.

Class A

Masukan parameter LoRaWAN dengan Lora Device Class A, Activation Mode ABP, ABP Parameters Inherit seperti pada gambar berikut.

Ketika memilih ABP Parameters Inherit maka parameter LoRa akan digenerate oleh Antares. Dari sisi perangkat, Development Board Lynx32 perlu menyesuaikan parameter LoRa tersebut.

Jangan lupa untuk menyimpan (copy) parameter Network Session Key dan Application Session Key sebelum klik Set LoRa untuk memudahkan proses selanjutnya.

Gambar Form berisi Parameter Set LoRa Class A.

Pastikan akun antares anda memiliki paket LoRa yang aktif.

Class C

Masukan parameter LoRaWAN dengan Lora Device Class C, Activation Mode ABP, ABP Parameters Inherit seperti pada gambar berikut.

Ketika memilih ABP Parameters Inherit maka parameter LoRa akan digenerate oleh Antares. Dari sisi perangkat, Development Board Lynx32 perlu menyesuaikan parameter LoRa tersebut.

Jangan lupa untuk menyimpan (copy) parameter Network Session Key dan Application Session Key sebelum klik Set LoRa untuk memudahkan proses selanjutnya.

Gambar Form berisi Parameter Set LoRa Class C.

Pastikan akun antares anda memiliki paket LoRa yang aktif.

4. Set LoRaWAN Parameter pada Kode Program

Ubah parameter LoRaWAN ABP pada variabel berikut *devAddr , *nwkSkey , dan *appSKey. Sesuaikan dengan parameter di console Antares.

const char *devAddr = "Lora-Device-Address";
const char *nwkSKey = "Network-Session-Key";
const char *appSKey = "Application-Session-Key"

Parameter *devAddr yang telah digenerate oleh Antares dapat dilihat pada halaman device setelah selesai Set LoRa.

Parameter *nwkSKey dan *appSKey didapatkan saat Set LoRa pada langkah sebelumnya.

Gambar Halaman Console Antares Setelah berhasil Set LoRa.

Jika anda lupa menyimpan *nwkSkey dan *appSKey pada langkah sebelumnya maka lihat accesskey pada akun antares anda kemudian ikuti format berikut.

Example Accesskey = "aaaaaaaaaaaaaaaa:bbbbbbbbbbbbbbbb"; //32 digit accesskey

const char *nwkSKey = "aaaaaaaaaaaaaaaa0000000000000000"; //16 digit first accesskey plus 16 digit zero

const char *appSKey = "0000000000000000bbbbbbbbbbbbbbbb"; //16 digit zero plus 16 digit last acesskey

5. Compile dan Upload Program

Hubungkan Development Board Lynx-32 dengan komputer anda dan pastikan Communication Port terbaca.

Pada sistem operasi Windows pengecekan dapat dilakukan melalui Device Manager.

Jika Development Board Lynx-32 anda terbaca maka akan tampil USB-Serial CH340 dengan port menyesuaikan ketersediaan port (pada kasus ini terbaca COM4).

Gambar Device Manager pada Windows.

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

Gambar Menu Tools pada Arduino IDE.

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

Gambar Icon Verify and Upload pada Arduino IDE.

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 and upload. Biasanya digunakan untuk Compile program sekaligus Flash program kedalam target board.

Jika upload program berhasil maka akan terlihat seperti gambar berikut.

Gambar Halaman Arduino IDE Setelah Upload berhasil.

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

Gambar Icon Serial Monitor pada Arduino IDE.

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

Gambar Serial Monitor.

Pastikan serial baud rate sesuai dengan nilai yang terdefinisi di kode program. Jika serial baud rate tidak sama, antara kode program dan serial monitor maka karakter ASCII tidak akan terbaca dengan baik.

6. Setup software POSTMAN

Pada langkah ini anda memerlukan software POSTMAN. Anda dapat menginput end-point, request header, dan request body terlebih dahulu dengan mengikuti format berikut.

End Point

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

Sesuaikan your-application-name dan your-device-name sesuai nama-nama yang terdaftar pada akun Antares anda.

Request Header

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

Sesuaikan your-access-key dengan access key akun Antares anda.

Hasilnya seperti pada gambar berikut.

Gambar setting end-point dan header pada software POSTMAN.

Selanjutnya anda perlu menginput request body untuk dengan mengikuti format berikut.

Request Body

Default Downlink Port

{
      "m2m:cin": {
        "con": "{\"type\":\"downlink\", \"data\":\"your-downlink-data\"}"
    }
}

Default Downlink Port yaitu port 10.

Custom Downlink Port

{
      "m2m:cin": {
        "con": "{\"type\":\"downlink\", \"data\":\"your-downlink-data\", \"fport\":5}"
    }
}

Jika anda menggunakan Custom Downlink Port maka isi field "fport"dengan angka integer selain 0.

Pada software POSTMAN pilih tab Body kemudian pilih raw dan masukan payload sesuai request body yang ingin digunakan seperti gambar berikut.

Gambar isi payload request body pada software POSTMAN.

Sesuaikan isi field "data" sesuai dengan perintah downlink yang ingin anda kirimkan.

7. Mengirim Pesan Downlink

Setelah setup software POSTMAN selesai, saatnya mengirimkan perintah downlink. Pada field "data" diisi dengan hexadecimal sejumlah 4 Input sebagai pesan yang akan dikirim melalui lorawan downlink. Jika sudah selesai mengisi field "data" selanjutnya tekan tombol Send pada software POSTMAN.

Terdapat 4 Input Hexadecimal untuk mengontrol Relay dan LED tercantum pada tabel di bawah ini.

Input Hexadecimal	Relay	LED
AA00	OFF	OFF
AA01	OFF	ON
AA10	ON	OFF
AA11	ON	ON

Gambar isi pesan downlink pada software POSTMAN.

Jika request HTTP melalui software POSTMAN berhasil, pada bagian response software POSTMAN akan muncul pesan seperti gambar berikut.

Gambar response hit API downlink pada software POSTMAN.

8. Periksa Data di Antares

Setelah langkah mengirim pesan downlink pada software POSTMAN berhasil, selanjutnya buka halaman device antares kemudian lihat apakah perintah downlink sudah masuk di Antares.

Gambar data downlink pada halaman device console Antares.

Bentuk data downlink yang diterima oleh antares akan berbentuk JSON seperti format berikut.

{
    "type": "downlink",
    "data": "AA11"
}

Data yang dikirimkan dari POSTMAN berupa "type": "downlink" dan "data". pesan downlink yang diteruskan ke Development Board Lynx-32 ada didalam field "data".

9. Melihat Pesan Downlink

Pesan downlink yang diteruskan dari Antares ke Development Board Lynx-32 dapat dilihat pada Serial Monitor terlihat seperti gambar berikut.

Gambar pesan downlink yang diterima pada Serial Monitor.

Class A

Pada LoRaWAN Class A, pesan downlink akan diterima oleh Lynx-32 setelah Lynx-32 melakukan uplink.

Class C

Pada LoRaWAN Class C, pesan downlink akan diterima oleh Lynx-32 kapan saja.

Pesan downlink yang diterima memberikan perintah Relay dan LED untuk Mati atau Menyala

Gambar Relay LED Menyala