IoT Platform：Tambahkan fitur TSL

Catatan penggunaan

• Anda harus mengonfigurasi fitur TSL dalam modul. Jumlah total modul default dan jumlah modul kustom di setiap produk tidak boleh melebihi 20.

• Jika sebuah produk telah diterbitkan, Anda tidak dapat memodifikasi model TSL produk tersebut. Untuk memodifikasi model TSL, Anda harus menarik kembali penerbitan produk yang memiliki model TSL terdefinisi.

• Anda dapat memodifikasi versi historis dari model TSL untuk menghasilkan versi baru.

• IoT Platform dapat menyimpan 10 versi terbaru dari model TSL. Versi sebelumnya akan ditimpa.

• Setelah Anda memodifikasi model TSL, Anda harus menerbitkan model TSL agar pembaruan berlaku.

Untuk informasi lebih lanjut, lihat Batasan.

Prosedur

1. Masuk ke Konsol IoT Platform.

2. Di sudut kiri atas Konsol IoT Platform, pilih wilayah tempat IoT Platform diaktifkan.

3. Pada tab All environment halaman Overview, temukan instance yang ingin Anda kelola dan klik ID atau nama instance tersebut.

4. Di panel navigasi sisi kiri, pilih Devices > Products. Dalam daftar produk, temukan produk yang ingin Anda kelola dan klik View di kolom Aksi.

5. Pada halaman detail produk, klik tab Define Feature, klik Edit Draft, lalu klik Default Module atau Add Module.

6. Opsional. Jika Anda ingin menambahkan modul, konfigurasikan parameter yang diperlukan, dan klik OK. Lalu, klik nama modul yang telah ditambahkan. Tabel berikut menjelaskan parameter-parameter tersebut.

   Parameter	Deskripsi
   Nama Modul	Nama harus terdiri dari 4 hingga 30 karakter, dan dapat berisi huruf, angka, serta garis bawah (_).
   Pengenal Modul	ID modul. ID harus unik dalam satu produk. ID harus terdiri dari 1 hingga 30 karakter dan dapat berisi huruf, angka, serta garis bawah (_).
   Deskripsi Modul	Deskripsi modul. Deskripsi harus terdiri dari 1 hingga 4096 karakter.

7. Opsional. Pilih versi dari daftar drop-down Riwayat Versi, dan klik Kembalikan. Kemudian, Anda dapat memodifikasi model TSL berdasarkan versi historis.

8. Tambahkan fitur kustom.

   Klik Add Self-defined Feature. Kemudian, Anda dapat menambahkan properti, layanan, atau peristiwa ke produk tersebut.

   • Tambahkan properti: Di kotak dialog Add Self-defined Feature, pilih Properties di bidang Jenis Fitur. Konfigurasikan parameter dan klik OK.

     Tabel berikut menjelaskan parameter-parameter tersebut.

     Parameter	Deskripsi
     Nama Fitur	Nama properti. Contoh: konsumsi daya. Nama harus unik dalam satu produk. Nama harus terdiri dari 1 hingga 30 karakter, dan dapat berisi huruf, angka, tanda hubung (-), garis bawah (_), garis miring (/), dan titik (.). Nama harus dimulai dengan huruf atau angka.
     Pengenal	ID properti. ID harus unik dalam satu produk. ID ditunjukkan oleh nilai parameter identifier dalam format JSON Alink. Perangkat menggunakan ID sebagai kunci untuk melaporkan data properti. IoT Platform memeriksa ID untuk menentukan apakah akan menerima data tersebut. ID harus terdiri dari 1 hingga 50 karakter, dan dapat berisi huruf, angka, serta garis bawah (_). Contoh: PowerConsumption. Catatan Anda tidak dapat menetapkan parameter ini ke salah satu kata cadangan berikut: set, get, post, property, event, time, dan value.
     Tipe data	int32: bilangan bulat 32-bit. Anda harus menentukan rentang nilai, ukuran langkah, dan unit. float: bilangan floating-point presisi tunggal. Anda harus menentukan rentang nilai, ukuran langkah, dan unit. double: bilangan floating-point presisi ganda. Anda harus menentukan rentang nilai, ukuran langkah, dan unit. enum: enumerasi. Anda harus menentukan nilai dan deskripsi untuk item Enum. Contoh: 1-mode pemanasan dan 2-mode pendinginan. bool: Boolean. Anda harus menggunakan 0 atau 1 untuk mendefinisikan nilai Boolean. Contoh: 0 menunjukkan mati dan 1 menunjukkan hidup. text: string. Anda harus menentukan panjang string. String harus terdiri dari 1 hingga 10.240 byte. date: timestamp. Timestamp UTC dalam format string. Unit: milidetik. struct: objek JSON. Anda harus mendefinisikan struct JSON dan menambahkan parameter JSON ke struct. Misalnya, Anda dapat mendefinisikan warna lampu sebagai struct yang terdiri dari parameter berikut: Merah, Hijau, dan Biru. Struct bersarang tidak didukung. array: array. Anda harus menentukan tipe data dan jumlah elemen dalam array. Nilai valid untuk tipe elemen: int32, float, double, text, dan struct. Elemen dalam array harus memiliki tipe yang sama. Nilai valid untuk jumlah elemen: 1 hingga 512. Catatan Parameter ini tidak diperlukan jika parameter Protokol Koneksi Gateway produk diatur ke Modbus.
     Rentang nilai	Jika parameter Tipe Data diatur ke int32, float, atau double, tentukan rentang nilai untuk properti tersebut.
     Langkah	Ukuran langkah minimum yang dapat diubah untuk nilai properti. Jika parameter Tipe Data diatur ke int32, float, atau double, Anda dapat menentukan ukuran langkah berdasarkan kebutuhan bisnis Anda. Contohnya, Anda ingin menambahkan properti suhu ke produk termometer. Anda dapat mengatur parameter Tipe Data ke int32, parameter Langkah ke 2, parameter Unit ke °C, dan parameter Rentang Nilai ke 0 hingga 100. Dalam hal ini, setiap kali suhu berubah sebesar 2°C, perangkat produk termometer melaporkan nilai suhu, seperti 0°C, 2°C, 4°C, 6°C, atau 8°C.
     Satuan harga instans.	Anda dapat memilih Tidak Ada atau nilai lain berdasarkan skenario bisnis Anda.
     Tipe Baca/Tulis	Baca/Tulis: Permintaan GET dan SET didukung. Hanya-Baca: Hanya permintaan GET yang didukung. Catatan Parameter ini tidak diperlukan jika parameter Protokol Koneksi Gateway produk diatur ke Modbus.
     Deskripsi	Deskripsi fitur. Deskripsi tidak boleh melebihi 100 karakter.
     Informasi Tambahan	Informasi tambahan menentukan pemetaan antara protokol koneksi dan model TSL standar perangkat. Setelah Anda mengonfigurasi pengaturan tambahan dalam model TSL, Anda dapat melihat pengaturan tersebut di tab Informasi Ekstensi TSL model TSL di konsol IoT Platform. Jika parameter Gateway Connection Protocol dari gateway sub-device diatur ke Custom, OPC UA, atau Modbus, Anda harus menentukan informasi tambahan. Jika parameter Gateway Connection Protocol diatur ke Custom, tentukan deskripsi dalam format JSON untuk konfigurasi kustom. Deskripsi harus terdiri dari 1 hingga 1.024 karakter. Jika parameter Gateway Connection Protocol diatur ke OPC UA, masukkan nama node. Setiap nama node yang Anda tentukan untuk properti harus unik. Jika parameter Gateway Connection Protocol diatur ke Modbus, konfigurasikan parameter berikut: Tipe Operasi: Anda dapat mengatur parameter ini ke salah satu nilai berikut. Input Diskrit (hanya-baca, 0x02) Status Koil (hanya-baca, 0x01) Status Koil (baca dan tulis, 0x01-baca, 0x05-tulis) Status Koil (baca dan tulis, 0x01-baca, 0x0F-tulis) Status Koil (hanya-tulis, 0x05) Status Koil (hanya-tulis, 0x0F) Register Penahan (hanya-baca, 0x03) Register Penahan (baca dan tulis, 0x03-baca, 0x06-tulis) Register Penahan (baca dan tulis, 0x03-baca, 0x10-tulis) Register Penahan (hanya-tulis, 0x06) Register Penahan (hanya-baca, 0x10) Register Input (hanya-baca, 0x04) Alamat Register: Anda harus menentukan nilai heksadesimal yang dimulai dengan 0x. Nilai valid: 0x0 hingga 0xFFFF. Contoh: 0xFE. Tipe Data Asli: Beberapa tipe data didukung. Nilai valid: int16, uint16, int32, uint32, int64, uint64, float, double, string, bool, dan bits. Posisi Bit: Anda harus mengonfigurasi parameter ini jika parameter Tipe Data Asli diatur ke bits. Pilih posisi bit tempat data disimpan. Rentang Nilai: Rentang nilai diperoleh setelah data asli diproses menggunakan faktor skala tertentu. Data yang melebihi rentang nilai akan dibuang. IoT Platform mendefinisikan rentang nilai default untuk jenis operasi berikut: Status Koil: 0 hingga 1 Input Diskrit: 0 hingga 1 Register Penahan: -2147483648 hingga 2147483647 Register Input: -2147483648 hingga 2147483647 Tukar Byte Tinggi dan Rendah di Register: menentukan apakah akan menukar 8 bit pertama dan 8 bit terakhir dari integer 16-bit di register. Nilai valid: true: Sistem menukar 8 bit pertama dan 8 bit terakhir. false: Sistem tidak menukar 8 bit pertama dan 8 bit terakhir. Tukar Urutan Bit Register: menentukan apakah akan menukar 16 bit pertama dan 16 bit terakhir dari integer 32-bit asli. Nilai valid: true: Sistem menukar 16 bit pertama dan 16 bit terakhir. false: Sistem tidak menukar 16 bit pertama dan 16 bit terakhir. Faktor Skala: menentukan bilangan bulat atau bilangan floating-point. Nilai default: 1. Nilai tidak boleh 0 atau negatif. Laporan Data: Anda dapat memilih Pada Waktu Tertentu atau Laporkan Perubahan.

   • Tambahkan layanan: Di kotak dialog Add Self-defined Feature, pilih Services di bidang Jenis Fitur. Konfigurasikan parameter dan klik OK.

     Catatan

     Jika parameter Protokol Koneksi Gateway diatur ke Modbus, Anda tidak dapat menambahkan layanan.

     Tabel berikut menjelaskan parameter-parameter tersebut.

     Parameter	Deskripsi
     Nama Fitur	Nama layanan. Nama harus terdiri dari 1 hingga 30 karakter, dan dapat berisi huruf, angka, tanda hubung (-), garis bawah (_), garis miring (/), dan titik (.). Harus dimulai dengan huruf atau angka.
     Pengenal	ID layanan. ID harus unik dalam satu produk. ID ditunjukkan oleh nilai parameter identifier yang ditentukan untuk layanan dalam format JSON Alink. ID harus terdiri dari 1 hingga 50 karakter, dan dapat berisi huruf, angka, serta garis bawah (_). Catatan Anda tidak dapat menetapkan parameter ini ke salah satu kata cadangan berikut: set, get, post, property, event, time, dan value.
     Metode Pemanggilan	Asinkron: IoT Platform mengembalikan hasil setelah layanan dipanggil. IoT Platform tidak menunggu respons dari perangkat. Sinkron: IoT Platform menunggu respons dari perangkat. Jika tidak ada respons yang dikembalikan, pemanggilan layanan habis waktu.
     Parameter Masukan	Opsional. Parameter masukan layanan. Di kotak dialog yang muncul, klik + Add Parameter untuk menambahkan parameter masukan. Jika parameter Protokol Koneksi Gateway diatur ke OPC UA, Anda harus mengonfigurasi indeks parameter untuk menentukan urutan parameter. Catatan Anda tidak dapat menetapkan parameter ini ke salah satu kata cadangan berikut: set, get, post, property, event, time, dan value. Anda dapat menggunakan properti sebagai parameter masukan atau mengonfigurasi parameter masukan kustom. Misalnya, saat Anda mendefinisikan layanan Penyiraman Otomatis, Anda dapat menggunakan properti yang telah didefinisikan sebelumnya Interval Penyiraman dan Jumlah Penyiraman sebagai parameter masukan. Saat IoT Platform memanggil layanan Penyiraman Otomatis, perangkat penyiram mulai menyiram berdasarkan interval penyiraman dan jumlah yang ditentukan. Anda dapat menambahkan hingga 20 parameter masukan untuk setiap layanan.
     Parameter Keluaran	Opsional. Parameter keluaran layanan. Di kotak dialog yang muncul, klik + Add Parameter untuk menambahkan parameter keluaran. Jika parameter Protokol Koneksi Gateway diatur ke OPC UA, Anda harus mengonfigurasi indeks parameter untuk menentukan urutan parameter. Catatan Anda tidak dapat menetapkan parameter ini ke salah satu kata cadangan berikut: set, get, post, property, event, time, dan value. Anda dapat menggunakan properti sebagai parameter keluaran atau mengonfigurasi parameter keluaran kustom. Misalnya, saat Anda mendefinisikan layanan Penyiraman Otomatis, Anda dapat menggunakan properti yang telah didefinisikan sebelumnya Kelembaban Tanah sebagai parameter keluaran. Saat IoT Platform memanggil layanan Penyiraman Otomatis, data yang terkait dengan kelembaban tanah dikembalikan. Anda dapat menambahkan hingga 20 parameter keluaran untuk setiap layanan.
     Informasi Tambahan	Informasi tambahan menentukan pemetaan antara protokol koneksi dan model TSL standar perangkat. Setelah Anda mengonfigurasi pengaturan tambahan dalam model TSL, Anda dapat melihat pengaturan ini di tab Informasi Ekstensi TSL model TSL di konsol IoT Platform. Jika parameter Gateway Connection Protocol dari gateway sub-device diatur ke Custom atau OPC UA, Anda harus menentukan informasi tambahan. Jika parameter Gateway Connection Protocol diatur ke Custom, tentukan deskripsi dalam format JSON untuk konfigurasi kustom. Deskripsi harus terdiri dari 1 hingga 1.024 karakter. Jika parameter Gateway Connection Protocol diatur ke OPC UA, masukkan nama node. Setiap nama node yang Anda tentukan untuk layanan harus unik.
     Deskripsi	Deskripsi layanan. Deskripsi harus terdiri dari 1 hingga 100 karakter.

   • Tambahkan peristiwa: Di kotak dialog Add Self-defined Feature, pilih Events di bidang Jenis Fitur. Konfigurasikan parameter dan klik OK.

     Catatan

     Jika parameter Protokol Koneksi Gateway diatur ke Modbus, Anda tidak dapat menambahkan peristiwa.

     Tabel berikut menjelaskan parameter-parameter tersebut.

     Parameter	Deskripsi
     Nama Fitur	Nama peristiwa. Nama harus terdiri dari 1 hingga 30 karakter, dan dapat berisi huruf, angka, tanda hubung (-), garis bawah (_), garis miring (/), dan titik (.). Harus dimulai dengan huruf atau angka.
     Pengenal	ID peristiwa. ID harus unik dalam satu produk. ID ditunjukkan oleh nilai parameter identifier dalam format JSON Alink. Perangkat menggunakan ID sebagai kunci untuk melaporkan data peristiwa. Contoh: ErrorCode. ID harus terdiri dari 1 hingga 50 karakter, dan dapat berisi huruf, angka, serta garis bawah (_). Catatan Anda tidak dapat menetapkan parameter ini ke salah satu kata cadangan berikut: set, get, post, property, event, time, dan value.
     Tipe peristiwa.	Anda dapat melakukan pemrosesan logika atau analisis untuk peristiwa dari tipe yang berbeda. Info: Perangkat melaporkan notifikasi umum, seperti notifikasi penyelesaian tugas. Peringatan: Perangkat melaporkan keadaan darurat atau pengecualian yang terjadi saat perangkat beroperasi. Peristiwa jenis ini diberi prioritas tinggi. Error: Perangkat melaporkan keadaan darurat atau pengecualian yang terjadi saat perangkat beroperasi. Peristiwa jenis ini diberi prioritas tinggi.
     Parameter Keluaran	Parameter keluaran peristiwa. Di kotak dialog yang muncul, klik + Add Parameter untuk menambahkan parameter keluaran. Anda dapat menggunakan properti sebagai parameter keluaran atau mengonfigurasi parameter keluaran kustom. Misalnya, Anda dapat menggunakan properti yang telah didefinisikan sebelumnya Tegangan sebagai parameter keluaran. Jika perangkat melaporkan kesalahan terkait tegangan, tegangan perangkat juga dilaporkan untuk pemecahan masalah. Jika parameter Protokol Koneksi Gateway diatur ke OPC UA, Anda harus mengonfigurasi indeks parameter untuk menentukan urutan parameter. Catatan Anda tidak dapat menetapkan parameter ini ke salah satu kata cadangan berikut: set, get, post, property, event, time, dan value. Anda dapat mendefinisikan hingga 50 parameter keluaran untuk sebuah peristiwa.
     Informasi Tambahan	Informasi tambahan menentukan pemetaan antara protokol koneksi dan model TSL standar perangkat. Setelah Anda mengonfigurasi pengaturan tambahan dalam model TSL, Anda dapat melihat pengaturan ini di tab Informasi Ekstensi TSL model TSL di konsol IoT Platform. Jika parameter Gateway Connection Protocol dari gateway sub-device diatur ke Custom atau OPC UA, Anda harus menentukan informasi tambahan. Jika parameter Gateway Connection Protocol diatur ke Custom, tentukan deskripsi dalam format JSON untuk konfigurasi kustom. Deskripsi harus terdiri dari 1 hingga 1.024 karakter. Jika parameter Gateway Connection Protocol diatur ke OPC UA, masukkan nama node. Setiap nama node yang Anda tentukan untuk peristiwa harus unik.
     Deskripsi	Deskripsi peristiwa. Deskripsi harus terdiri dari 1 hingga 100 karakter.

Publikasikan model TSL

1. Pilih Define Feature > Edit Draft. Di sudut kiri bawah halaman yang muncul, klik Release online. Kotak dialog Release model online? muncul.

2. Opsional. Klik +Tambah catatan pasca, dan masukkan nomor versi dan catatan.

   Parameter	Deskripsi
   Nomor Versi	Nomor versi model TSL. Anda dapat mengelola model TSL berdasarkan nomor versi. Nomor versi harus terdiri dari 1 hingga 16 karakter, dan dapat berisi huruf, angka, serta titik (.).
   Catatan	Deskripsi model TSL. Deskripsi dapat berisi huruf, angka, dan karakter khusus. Deskripsi harus terdiri dari 1 hingga 100 karakter.

3. Jika versi online tersedia, Anda harus memeriksa perbedaan antara versi saat ini yang ingin Anda rilis dan versi online.

   Klik View Differences. Di panel View Differences, Anda dapat melihat perbedaan antara versi. Setelah Anda mengonfirmasi pengaturan, klik Confirm. Di kotak dialog Release model online?, kotak centang secara otomatis dipilih.

   Jika Anda tidak ingin melihat perbedaan antara versi, pilih "Pastikan bahwa Anda telah memverifikasi perbedaan antara versi saat ini dan versi online."

4. Klik OK untuk mempublikasikan model TSL.

Hasil eksekusi

Setelah Anda mempublikasikan model TSL, Anda dapat melihat model yang telah dipublikasikan di Konsol IoT Platform. Anda dapat melakukan operasi berikut di tab Define Feature halaman Product Details:

• Klik TSL Model untuk melihat model TSL dalam format JSON.

Operasi API terkait

Apa yang harus dilakukan selanjutnya

Secara default, data TSL yang dikirimkan oleh perangkat suatu produk secara otomatis ditulis ke ruang penyimpanan data panas. Anda dapat menghentikan layanan penyimpanan data panas untuk beberapa atau semua model TSL berdasarkan kebutuhan bisnis Anda.