Link IoT Edge：SDK untuk Node.js

Untuk kode sumber SDK untuk Node.js, kunjungi Open-source SDK untuk Node.js.

Instalasi dan penggunaan

1. Jalankan perintah berikut untuk menginstal SDK:

   npm install linkedge-thing-access-sdk

2. Setelah SDK terinstal, Anda dapat mengembangkan driver berdasarkan antarmuka SDK.
   Penting Jika Anda menjalankan driver secara langsung setelah pengembangan selesai, akan terjadi error. Anda harus men-deploy driver ke gateway melalui Konsol Platform IoT sebelum menjalankannya. Untuk informasi lebih lanjut tentang cara men-deploy driver ke gateway, lihat Pengembangan Driver.

   Berikut adalah contoh penggunaan SDK untuk mengembangkan driver:

   const {
     Config,
     ThingAccessClient
   } = require('linkedge-thing-access-sdk');
   
   const callbacks = {
     setProperties: function (properties) {
       // Setel properti ke physical thing dan kembalikan hasilnya.
       // Kembalikan objek yang merepresentasikan hasil atau promise wrapper dari objek tersebut.
       return {
         code: 0,
         message: 'success',
       };
     },
     getProperties: function (keys) {
       // Ambil properti dari physical thing dan kembalikan hasilnya.
       // Kembalikan objek yang merepresentasikan hasil atau promise wrapper dari objek tersebut.
       return {
         code: 0,
         message: 'success',
         params: {
           key1: 'value1',
           key2: 'value2',
         }
       };
     },
     callService: function (name, args) {
       // Panggil layanan pada physical thing dan kembalikan hasilnya.
       // Kembalikan objek yang merepresentasikan hasil atau promise wrapper dari objek tersebut.
       return new Promise((resolve) => {
         resolve({
           code: 0,
           message: 'success',
         });
       });
     }
   };
   Config.get()
     .then(config => {
       const thingInfos = config.getThingInfos();
       thingInfos.forEach(thingInfo => {
         const client = new ThingAccessClient(thingInfo, callbacks);
         client.registerAndOnline()
           .then(() => {
             return new Promise(() => {
               setInterval(() => {
                 client.reportEvent('high_temperature', { temperature: 41 });
                 client.reportProperties({ 'temperature': 41 });
               }, 2000);
             });
           })
           .catch(err => {
             console.log(err);
             client.cleanup();
           });
           .catch(err => {
             console.log(err);
           });
       });
     });

Konstanta

Config

Informasi terkait konfigurasi driver.

• static get()

  Mengembalikan objek konfigurasi driver global, yang dihasilkan oleh sistem saat perangkat dikaitkan dengan driver.

  Catatan Perbedaan antara fungsi Config.get() dan fungsi getConfig() adalah bahwa getConfig() mengembalikan string konfigurasi, sedangkan Config.get() mengembalikan objek konfigurasi.
  Respons:

  Promise<Config>

• static registerChangedCallback(callback)

  Fungsi callback yang digunakan untuk menangani perubahan konfigurasi.

  Tabel 1. Parameter permintaan

  Parameter	Tipe	Deskripsi
  callback	Function	Fungsi callback yang dipanggil ketika terjadi perubahan konfigurasi.

• static unregisterChangedCallback(callback)

  Fungsi callback yang digunakan untuk mengembalikan perubahan konfigurasi.

  Tabel 2. Parameter permintaan

  Parameter	Tipe	Deskripsi
  callback	Function	Fungsi callback yang dipanggil ketika terjadi perubahan konfigurasi.

• Config(string)

  Membuat objek Config baru berdasarkan string konfigurasi.

  Tabel 3. Parameter permintaan

  Parameter	Tipe	Deskripsi
  string	String	String konfigurasi JSON.

• getThingInfos()

  Mengembalikan semua informasi terkait perangkat.

  Respons:

  ThingInfo[]

• getDriverInfo()

  Mengembalikan informasi driver.

  Respons:

  Object

ThingInfo

Fungsi ini digunakan untuk mengidentifikasi informasi perangkat yang terhubung ke Link IoT Edge. Setelah perangkat terhubung ke Link IoT Edge, informasi seperti ProductKey, DeviceName, dan konfigurasi kustom perangkat dapat diakses melalui fungsi ini.

Membuat objek ThingInfo baru.

ThingAccessClient

Klien yang memungkinkan perangkat terhubung ke Platform IoT. Anda dapat menggunakan klien ini untuk melaporkan properti dan event, serta mengirim perintah dari cloud ke perangkat.

• ThingAccessClient(config, callbacks)

  Konstruktor yang diinisialisasi dengan parameter config dan callbacks.

  Tabel 5. Parameter permintaan

  Parameter	Tipe	Deskripsi
  config	Object	Metadata yang digunakan untuk mengonfigurasi klien. Format: { "productKey": "Your Product Key", "deviceName": "Your Device Name" }
  callbacks	Object	Objek fungsi callback. Format: callbacks: { setProperties: function(properties) {}, getProperties: function(keys) {}, callService: function(name, args) {} } Untuk parameter callback penyetelan properti perangkat, lihat bagian callbacks.setProperties. Untuk parameter callback pengambilan properti perangkat, lihat bagian callbacks.getProperties. Untuk parameter callback pemanggilan layanan perangkat, lihat bagian callbacks.callService.

• callbacks.setProperties(properties)

  Fungsi callback untuk menyetel properti perangkat.

  Tabel 6. Parameter permintaan

  Parameter	Tipe	Deskripsi
  properties	Object	Objek properti. Format nilai properti sebagai berikut: { "key1": "value1", "key2": "value2" }

  Respons:

  {
    "code": 0,
    "message": "string",
    "params": {}
  }

  Tabel 7. Parameter Respons

  Parameter	Type	Deskripsi
  code	Number	Kode status. 0: menunjukkan panggilan berhasil. Nilai bukan nol: menunjukkan panggilan gagal dan mengembalikan error yang sesuai dengan nilai tersebut.
  message	String	Opsional. Informasi deskripsi status.
  params	Object	Opsional. Parameter ini dapat digunakan untuk mengembalikan hasil konfigurasi tiap properti. Parameter ini berisi nilai aktual properti.

• callbacks.getProperties(keys)

  Fungsi callback yang digunakan untuk mendapatkan properti perangkat tertentu.

  Tabel 8. Parameter permintaan

  Parameter	Tipe	Deskripsi
  keys	String[]	Nama properti. Formatnya sebagai berikut: ['key1', 'key2']

  Respons:

  {
    "code": 0,
    "message": "string",
    "params": {}
  }

  Tabel 9. Parameter Respons

  Parameter	Tipe	Deskripsi
  code	Number	Kode status. 0: menunjukkan panggilan berhasil. Nilai bukan nol: menunjukkan panggilan gagal dan mengembalikan error yang sesuai dengan nilai tersebut.
  message	String	Opsional. Informasi deskripsi status.
  params	Object	Opsional. Parameter ini dapat digunakan untuk mengembalikan nilai properti yang diminta jika permintaan berhasil.

• callbacks.callService(name, args)

  Fungsi callback untuk memanggil layanan perangkat.

  Tabel 10. Parameter permintaan

  Parameter	Type	Deskripsi
  name	String	Nama layanan perangkat.
  args	Object	Daftar parameter input layanan. Formatnya sebagai berikut: { "key1": "value1", "key2": "value2" }

  Tabel 11. Parameter Respons

  Parameter	Tipe	Deskripsi
  code	Number	Kode status. 0: menunjukkan panggilan berhasil. Nilai bukan nol: menunjukkan panggilan gagal dan mengembalikan error yang sesuai dengan nilai tersebut.
  message	String	Opsional. Informasi deskripsi status.
  params	Object	Opsional. Parameter ini dapat digunakan untuk mengembalikan informasi tambahan saat layanan dipanggil.

• registerAndOnline()

  Mendaftarkan perangkat ke gateway dan memberi tahu gateway untuk menghubungkan perangkat ke Platform IoT. Perangkat harus didaftarkan dan dihubungkan ke Platform IoT sebelum dapat menerima perintah atau mengirim data ke Platform IoT.

  Respons:

  Promise<Void>

• online()

  Memberi tahu gateway bahwa perangkat sedang online. Fungsi ini digunakan ketika perangkat yang sebelumnya offline kembali online.

  Respons:

  Promise<Void>

• offline()

  Memberi tahu gateway bahwa perangkat sedang offline.

  Respons:

  Promise<Void>

• reportEvent(eventName, args)

  Melaporkan event perangkat ke Platform IoT.

  Tabel 12. Parameter permintaan

  Parameter	Type	Deskripsi
  eventName	String	Nama event, yang sama dengan nama event yang Anda tentukan dalam definisi produk.
  args	Object	Kunci dan nilai dalam event. Formatnya sebagai berikut: { "key1": "value1", "key2": "value2" }

• reportProperties(properties)

  Melaporkan properti perangkat ke Platform IoT.

  Tabel 13. Parameter permintaan

  Parameter	Tipe	Deskripsi
  properties	Object	Kunci dan nilai dalam properti. Formatnya sebagai berikut: { "key1": "value1", "key2": "value2" }

• getTsl()

  Mengembalikan string TSL perangkat. Format datanya sama seperti di Platform IoT.

  Respons:

  Promise<Void>

• getTslExtInfo()

  Mengembalikan informasi ekstensi TSL.

  Respons:

  Promise<String>

• cleanup()

  Membersihkan sumber daya. Gunakan fungsi ini untuk melepaskan sumber daya yang digunakan.

  Respons:

  Promise<Void>

• unregister()

  Menghapus perangkat dari gateway. Gunakan fungsi ini dengan hati-hati.

  Respons:

  Promise<Void>

getConfig()

Promise<String>

destroy()

Menghapus semua sumber daya yang digunakan oleh SDK. Panggil fungsi destroy() ketika Anda tidak lagi menggunakan SDK.

Promise<Void>