Nilai properti perangkat yang diinginkan - IoT Platform

Untuk mengontrol perangkat, Anda dapat memanggil operasi SetDeviceDesiredProperty di IoT Platform untuk menetapkan nilai properti yang diinginkan pada perangkat. Setelah menetapkan nilai properti yang diinginkan di IoT Platform, nilai tersebut diperbarui secara real-time jika perangkat sedang online. Jika perangkat offline, nilai properti yang diinginkan disimpan sementara di IoT Platform. Ketika perangkat kembali online, perangkat akan mendapatkan nilai properti yang diinginkan dan memperbarui nilai properti yang ada. Topik ini menjelaskan format pesan terkait nilai properti perangkat yang diinginkan.

Catatan Untuk informasi lebih lanjut tentang cara memanggil operasi SetDeviceDesiredProperty di IoT Platform untuk menetapkan nilai properti yang diinginkan pada perangkat, lihat SetDeviceDesiredProperty.

Mendapatkan nilai properti yang diinginkan

Topik-topik berikut digunakan ketika perangkat mengirimkan permintaan ke IoT Platform dan IoT Platform mengirimkan respons ke perangkat:

Perangkat mengirimkan permintaan untuk mendapatkan nilai properti yang diinginkan dari IoT Platform.

Topik permintaan: /sys/${productKey}/${deviceName}/thing/property/desired/get
Topik respons: /sys/${productKey}/${deviceName}/thing/property/desired/get_reply

Contoh permintaan dalam format JSON Alink:

{
    "id" : "123",
    "version":"1.0",
    "sys":{
      "ack":0
  },
    "params" : [
        "power",
        "temperature"
    ],
    "method":"thing.property.desired.get"
}

Contoh respons dalam format JSON Alink:

{
    "id":"123",
    "code":200,
    "data":{
        "power": {
            "value": "on",
            "version": 2
        }
    }
}

Tabel 1. Parameter Permintaan
Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: 0 hingga 4294967295. Setiap ID pesan harus unik untuk perangkat.
version	String	Versi protokol. Nilai valid: 1.0.
sys	Object	Parameter untuk fitur tambahan. Nilainya berisi bidang-bidang untuk setiap fitur. Catatan Jika tidak ada fitur tambahan yang dikonfigurasikan saat menggunakan SDK perangkat untuk mengembangkan fitur perangkat, parameter ini tidak tersedia. Fitur tambahan menggunakan konfigurasi default.
ack	Integer	Bidang fitur tambahan dalam parameter sys. Bidang ini menentukan apakah IoT Platform mengembalikan data respons untuk permintaan pendaftaran. Nilai valid: 1: IoT Platform mengembalikan data respons. 0: IoT Platform tidak mengembalikan data respons. Penting Untuk informasi lebih lanjut tentang parameter ini, lihat Contoh penggunaan model TSL. Jika fitur tidak dikonfigurasikan, parameter ini tidak tersedia. Secara default, IoT Platform mengembalikan data respons untuk permintaan pendaftaran.
params	List	Daftar pengenal properti yang ingin Anda dapatkan nilainya yang diinginkan. Dalam contoh ini, pengenal properti berikut terdaftar: `[ "power", "temperature" ]` Pengenal properti modul kustom berada dalam format `Pengenal Modul:Pengenal Properti`. Contoh: `[ "test:power", "test:temperature" ]`
method	String	Metode permintaan. Nilai valid: `thing.property.desired.get`.

Tabel 2. Parameter Respons
Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: 0 hingga 4294967295. Setiap ID pesan harus unik untuk perangkat.
code	Integer	Kode status HTTP dalam respons. Untuk informasi lebih lanjut, lihat Kode umum pada perangkat.
data	Object	Informasi nilai yang diinginkan yang dikembalikan. Dalam contoh ini, informasi nilai yang diinginkan tentang properti daya dikembalikan. Informasi tersebut mencakup value dan version dari properti. `{ "power": { "value": "on", "version": 2 } }` Pengenal properti modul kustom berada dalam format `Pengenal Modul:Pengenal Properti`. Contoh: `{ "test:power": { "value": "on", "version": 2 } }` Catatan Jika tidak ada nilai yang diinginkan yang ditetapkan untuk properti di IoT Platform atau nilai yang diinginkan telah dihapus, data yang dikembalikan tidak akan berisi pengenal properti ini. Dalam contoh ini, properti suhu tidak memiliki nilai yang diinginkan. Oleh karena itu, data yang dikembalikan tidak berisi pengenal properti ini. Untuk informasi lebih lanjut tentang parameter dalam data, lihat tabel berikut.

Tabel 3. Data
Parameter	Tipe	Deskripsi
key	String	Pengenal properti, seperti daya dalam contoh ini.
value	Object	Nilai yang diinginkan.
version	Integer	Versi saat ini dari nilai yang diinginkan. Catatan Saat Anda menetapkan nilai properti yang diinginkan untuk pertama kalinya, versinya adalah 1. Kemudian, versi bertambah 1 setiap kali Anda menetapkan nilai yang diinginkan.

Hapus nilai properti yang diinginkan

Topik-topik berikut digunakan ketika perangkat mengirimkan permintaan ke IoT Platform dan IoT Platform mengirimkan respons ke perangkat:

Perangkat mengirimkan permintaan untuk menghapus nilai properti yang diinginkan yang disimpan sementara di IoT Platform.

Topik permintaan: /sys/${productKey}/${deviceName}/thing/property/desired/delete
Topik respons: /sys/${productKey}/${deviceName}/thing/property/desired/delete_reply

Contoh permintaan dalam format JSON Alink:

{
    "id": "123",
    "version": "1.0",
    "sys":{
      "ack":0
  },
    "params": {
        "power": {
            "version": 1
        },
        "temperature": { }
    },
    "method":"thing.property.desired.delete"  
}

Contoh respons dalam format JSON Alink:

{
    "id": "123",
    "code": 200,
    "data": { }
}

Tabel 4. Parameter Permintaan
Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: 0 hingga 4294967295. Setiap ID pesan harus unik untuk perangkat.
version	String	Versi protokol. Nilai valid: 1.0.
sys	Object	Parameter untuk fitur tambahan. Nilainya berisi bidang-bidang untuk setiap fitur. Catatan Jika tidak ada fitur tambahan yang dikonfigurasikan saat menggunakan SDK perangkat untuk mengembangkan fitur perangkat, parameter ini tidak tersedia. Fitur tambahan menggunakan konfigurasi default.
ack	Integer	Bidang fitur tambahan dalam parameter sys. Bidang ini menentukan apakah IoT Platform mengembalikan data respons untuk permintaan pendaftaran. Nilai valid: 1: IoT Platform mengembalikan data respons. 0: IoT Platform tidak mengembalikan data respons. Penting Untuk informasi lebih lanjut tentang parameter ini, lihat Contoh penggunaan model TSL. Jika fitur tidak dikonfigurasikan, parameter ini tidak tersedia. Secara default, IoT Platform mengembalikan data respons untuk permintaan pendaftaran.
params	Object	Daftar properti yang ingin Anda hapus nilainya yang diinginkan. Properti diidentifikasi oleh pengenal dan version. Contoh: `{ "power": { "version": 1 }, "temperature": { } }` Pengenal properti modul kustom berada dalam format `Pengenal Modul:Pengenal Properti`. Contoh: `{ "test:power": { "version": 1 }, "test:temperature": { } }` Untuk informasi lebih lanjut tentang parameter dalam params, lihat tabel berikut.
method	String	Metode permintaan. Nilai valid: `thing.property.desired.delete`.

Tabel 5. Params
Parameter	Tipe	Deskripsi
key	String	Pengenal properti. Dalam contoh ini, pengenal properti berikut terdaftar: power dan temperature.
version	Integer	Versi nilai yang diinginkan yang akan dihapus. Catatan Anda bisa mendapatkan nilai parameter version dari topik `/sys/${productKey}/${deviceName}/thing/property/desired/get`. Jika Anda menetapkan parameter version menjadi 2, IoT Platform hanya akan menghapus nilai yang diinginkan jika versi saat ini adalah 2. Jika versi saat ini dari nilai yang diinginkan adalah 3 di IoT Platform, permintaan penghapusan ini akan diabaikan. Jika parameter version tidak ditentukan dalam permintaan, IoT Platform tidak akan memverifikasi versi, tetapi langsung menghapus nilai yang diinginkan.

Tabel 6. Parameter Respons
Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: 0 hingga 4294967295. Setiap ID pesan harus unik untuk perangkat.
code	Integer	Kode status HTTP dalam respons. Untuk informasi lebih lanjut, lihat Kode umum pada perangkat.
data	Object	Data yang dikembalikan. Dalam respons terhadap permintaan untuk menghapus nilai properti yang diinginkan, tidak ada data yang dikembalikan.

IoT Platform：Nilai properti perangkat yang diinginkan

Mendapatkan nilai properti yang diinginkan

Hapus nilai properti yang diinginkan

Referensi