IoT Platform:Cihaz özellikleri, olayları ve hizmetler

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dize. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

version

String

Protokol sürüm numarası. Tek geçerli değer 1.0'dır.

method

String

İstek yöntemi. Örneğin: thing.event.property.post.

params

Object

Bildirilecek özellik verisi. Bu örnekte, cihaz Power (güç kaynağı) ve WF (çalışma akımı) özelliklerini, her biri bir değer ve isteğe bağlı bir zaman damgası ile birlikte bildirir.

Yalnızca özellik değerlerini geçiriyorsanız, time ve value alanlarını yüklemeniz gerekmez. Aşağıda params parametresine bir örnek verilmiştir:

"params": {
    "Power": "on",
    "WF": 23.6
}

Özel bir modül özelliği ise, tanımlayıcı biçimi ${moduleIdentifier}:${propertyIdentifier} (iki nokta üst üste işaretiyle ayrılmış) şeklindedir. Örneğin:

"test:Power": {
        "value": "on",
        "time": 1524448722000
    }

time

Long

Özelliğin bildirildiği UTC milisaniye cinsinden UNIX zaman damgası.

İsteğe bağlıdır. Mesaj sıralamanın önemli olduğu durumlarda bir zaman damgası ekleyin.

• time dahil edilirse, IoT Platform bunu özellik bildirim zamanı olarak kullanır.

• time atlanırsa, IoT Platform bildirim zamanını otomatik olarak oluşturur.

value

Object

Bildirilen özellik değeri.

time dahil etmezseniz, value öğesini atlayabilir ve parametre değerini doğrudan bildirebilirsiniz.

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dize. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

code

Integer

Sonuç durum kodu. Cihaz tarafı genel kodlar.

data

Object

İstek başarılı olursa boş bir nesne döndürülür.

message

String

Yanıt mesajı. İstek başarılı olursa success döndürülür.

method

String

Yanıta karşılık gelen istek yöntemi. Bu, istek parametrelerindeki method ile aynıdır.

version

String

Protokol sürüm numarası. Bu, istek parametrelerindeki version ile aynıdır.

Veri biçimi (mobil hedefli)

İstek ve yanıt konuları

Geçiş/özel

• İstek konusu: /sys/${productKey}/${deviceName}/thing/model/down_raw

• Yanıt konusu: /sys/${productKey}/${deviceName}/thing/model/down_raw_reply

Alink JSON

• İstek konusu: /sys/${productKey}/${deviceName}/thing/service/property/set

• Yanıt konusu: /sys/${productKey}/${deviceName}/thing/service/property/set_reply

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dize. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

version

String

Protokol sürüm numarası. Tek geçerli değer 1.0'dır.

params

Object

Özellik ayarlama parametreleri. Örnekte özellik şu şekilde ayarlanır: { "temperature": "30.5" }.

Özel bir modül özelliği ise, tanımlayıcı biçimi ${moduleIdentifier}:${propertyIdentifier} (iki nokta üst üste işaretiyle ayrılmış) şeklindedir, örneğin { "test:temperature": "30.5" }.

method

String

İstek yöntemi. Örneğin: thing.service.property.set.

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dize. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

code

Integer

Sonuç durum kodu. Cihaz tarafı genel kodlar.

data

Object

İstek başarılı olursa boş bir nesne döndürülür.

Parametre

Tür

Açıklama

id

String

Mesaj Kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dizedir. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

version

String

Protokol sürüm numarası. Tek geçerli değer 1.0'dır.

method

String

İstek yöntemi.

• Varsayılan modül

  Değer thing.event.${tsl.event.identifier}.post şeklindedir.

• Özel modül

  Değer thing.event.${tsl.functionBlockId}:${tsl.event.identifier}.post şeklindedir.

params

Object

Bildirim yapılan olayın çıkış parametreleri.

value

Object

Olayın çıkış parametrelerinin bilgileri. Örnek, Power ve WF (çalışma akımı) olmak üzere iki parametre için bilgi göstermektedir.

{
    "Power": "on",
    "WF": "2"
}

time

Long

Olayın UTC milisaniye cinsinden bildirildiği UNIX zaman damgası.

Bu isteğe bağlı bir alandır. İş senaryonuzun gerektirdiğine göre zaman damgası ekleyip eklememeye karar verin. Mesajlar sık geliyorsa ve mesaj sırasını zaman damgasına göre belirlemeniz gerekiyorsa zaman damgası eklemenizi öneririz.

• time dahil ederseniz IoT Platform belirtilen zamanı olay bildirim zamanı olarak kaydeder.

• time dahil etmezseniz IoT Platform olay bildirim zamanını otomatik olarak oluşturur ve kaydeder.

Parametre

Tür

Açıklama

id

String

Mesaj Kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dizedir. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

code

Integer

Sonuç durum kodu. Cihaz tarafı genel kodları.

data

Object

İstek başarılı olursa boş bir nesne döndürülür.

Giden veri biçimi

İstek ve yanıt konuları

Aktarım/özel

• İstek konusu: /sys/${productKey}/${deviceName}/thing/model/down_raw

• Yanıt konusu: /sys/${productKey}/${deviceName}/thing/model/down_raw_reply

Alink JSON

• Varsayılan modül

  • İstek konusu: /sys/${productKey}/${deviceName}/thing/service/${tsl.service.identifier}

  • Yanıt konusu: /sys/${productKey}/${deviceName}/thing/service/${tsl.service.identifier}_reply

• Özel modül

  • İstek konusu: /sys/${productKey}/${deviceName}/thing/service/${tsl.functionBlockId}:${tsl.service.identifier}

  • Yanıt konusu: /sys/${productKey}/${deviceName}/thing/service/${tsl.functionBlockId}:${tsl.service.identifier}_reply

Parametre

Tür

Açıklama

id

String

Mesaj Kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dizedir. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

version

String

Protokol sürüm numarası. Tek geçerli değer 1.0'dır.

params

Object

Hizmet çağrısı parametreleri. Hizmet tanımlayıcısını ve hizmet değerini içerir. Örnek, Power ve WF (çalışma akımı) olmak üzere iki parametre göstermektedir.

{
    "Power": "on",
    "WF": "2"
}

method

String

İstek yöntemi.

• Varsayılan modül

  Değer thing.service.${tsl.service.identifier} şeklindedir.

• Özel modül

  Değer thing.service.${tsl.functionBlockId}:${tsl.service.identifier} şeklindedir.

Parametre

Tür

Açıklama

id

String

Mesaj Kimliği. 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dizedir. Her mesaj kimliği geçerli cihaz için benzersiz olmalıdır.

code

Integer

Sonuç durum kodu. Cihaz tarafı genel kodları.

data

Object

Yanıt bilgisi.

data parametresinin değeri TSL modeli tanımına bağlıdır. Hizmet bir sonuç döndürmezse data değeri boştur. Hizmet bir sonuç döndürürse döndürülen veri hizmet tanımına kesinlikle uyar.

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip sayısal bir dizedir. Her mesaj kimliği, mevcut cihaz için benzersiz olmalıdır.

version

String

Protokol sürüm numarası. Tek geçerli değer 1.0'dır.

params

Object

İstek parametreleri.

properties

Object

Özellikler. Özellik tanımlayıcısını, özellik değerini (value) ve özelliğin oluşturulduğu zamanı (time) içerir.

time parametresi isteğe bağlıdır. İş senaryonıza göre zaman damgası ekleyip eklememeye karar verin. Mesajlar sık geliyorsa ve mesaj sırasını zaman damgasına göre belirlemeniz gerekiyorsa zaman damgası eklemenizi öneririz.

Örnekte, cihaz Power ve WF (çalışma akımı) olmak üzere iki özellik için bilgi raporlar.

Özel modül özelliği ise tanımlayıcı biçimi ${moduleIdentifier}:${propertyIdentifier} şeklindedir (iki nokta üst üste ile ayrılmış). Örnek:

"test:Power": {
        "value": "on",
        "time": 1524448722000
    }

events

Object

Olaylar. Olay tanımlayıcısını, olay çıktı parametrelerini (value) ve olayın oluşturulduğu zamanı (time) içerir.

time parametresi isteğe bağlıdır. İş senaryonıza göre zaman damgası ekleyip eklememeye karar verin. Mesajlar sık geliyorsa ve mesaj sırasını zaman damgasına göre belirlemeniz gerekiyorsa zaman damgası eklemenizi öneririz.

Örnekte, alarmEvent1 ve alarmEvent2 adlı iki olay, karşılık gelen param1 ve param2 parametreleriyle birlikte raporlanır.

Özel modül olayı ise tanımlayıcı biçimi ${moduleIdentifier}:${eventIdentifier} şeklindedir (iki nokta üst üste ile ayrılmış). Örnek:

"test:alarmEvent1": {
        "value": {
            "param1": "on",
            "param2": "2"
        },
        "time": 1524448722000
    }

subDevices

Object

Alt cihaz bilgileri.

productKey

String

Alt cihazın ürününe ait ProductKey değeri.

deviceName

String

Alt cihazın adı.

method

String

İstek parametresi. Değer: thing.event.property.pack.post.

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip sayısal bir dizedir. Her mesaj kimliği, mevcut cihaz için benzersiz olmalıdır.

code

Integer

Yanıt kodu. 200 değeri başarıyı gösterir.

data

Object

İstek başarılı olursa boş bir nesne döndürülür.

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip sayısal bir dizedir. Her mesaj kimliği, mevcut cihaz için benzersiz olmalıdır.

version

String

Protokol sürüm numarası. Tek geçerli değer 1.0'dır.

method

String

İstek yöntemi. Statik bir alandır. Değer: thing.event.property.history.post.

params

Object

İstek parametreleri.

identity

String

Verinin ait olduğu cihazın sertifika bilgileri. productKey ve deviceName parametrelerini içerir.

properties

Object

Özellikler. Özellik tanımlayıcısını, özellik değerini (value) ve özelliğin oluşturulduğu zamanı (time) içerir.

Örnekte, cihaz Power ve WF (çalışma akımı) olmak üzere iki özellik için geçmiş bilgileri raporlar.

Özel modül özelliği ise tanımlayıcı biçimi ${moduleIdentifier}:${propertyIdentifier} şeklindedir (iki nokta üst üste ile ayrılmış). Örnek:

"test:Power": {
        "value": "on",
        "time": 1524448722000
    }

events

Object

Olaylar. Olay tanımlayıcısını, olay çıktı parametrelerini (value) ve olayın oluşturulduğu zamanı (time) içerir.

Örnekte, alarmEvent için geçmiş bilgiler, karşılık gelen Power ve WF (çalışma akımı) parametreleriyle birlikte raporlanır.

Özel modül olayı ise tanımlayıcı biçimi ${moduleIdentifier}:${eventIdentifier} şeklindedir (iki nokta üst üste ile ayrılmış). Örnek:

"test:alarmEvent": {
        "value": {
            "Power": "on", 
            "WF": "2"
        }, 
        "time": 1524448722000
    }

Parametre

Tür

Açıklama

id

String

Mesaj kimliği. 0 ile 4294967295 arasında bir değere sahip sayısal bir dizedir. Her mesaj kimliği, mevcut cihaz için benzersiz olmalıdır.

code

Integer

Sonuç durum kodu. Cihaz tarafı genel kodları.

data

Object

İstek başarılı olursa boş bir nesne döndürülür.

Parameter

Type

Description

id

String

Mesaj kimliği (ID). 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dizedir. Her mesaj ID'si, mevcut cihaz için benzersiz olmalıdır.

version

String

Protokol sürüm numarası. Geçerli tek değer 1.0'dır.

method

String

İstek yöntemi. Bu statik bir alandır. Değer: thing.event.property.batch.post.

params

Object

İstek parametreleri.

properties

Object

Özellikler. Özellik tanımlayıcısını, özellik değerini (value) ve özelliğin oluşturulduğu zamanı (time) içerir.

Örnekte, cihaz Power ve WF (çalışma akımı) olmak üzere iki özellik için toplu iş bilgilerini bildirir.

Bu bir özel modül özelliği ise tanımlayıcı formatı ${moduleIdentifier}:${propertyIdentifier} şeklindedir (iki nokta üst üste ile ayrılmış). Örneğin:

"test:Power": {
        "value": "on",
        "time": 1524448722000
    }

events

Object

Olaylar. Olay tanımlayıcısını, olay çıktı parametrelerini (value) ve olayın oluşturulduğu zamanı (time) içerir.

Örnekte, alarmEvent için ilgili Power ve WF (çalışma akımı) parametreleriyle birlikte toplu iş bilgileri bildirilir.

Bu bir özel modül olayı ise tanımlayıcı formatı ${moduleIdentifier}:${eventIdentifier} şeklindedir (iki nokta üst üste ile ayrılmış). Örneğin:

"test:alarmEvent": {
        "value": {
            "Power": "on", 
            "WF": "2"
        }, 
        "time": 1524448722000
    }

Parameter

Type

Description

id

String

Mesaj kimliği (ID). 0 ile 4294967295 arasında bir değere sahip rakamlardan oluşan bir dizedir. Her mesaj ID'si, mevcut cihaz için benzersiz olmalıdır.

code

Integer

Sonuç durum kodu. Cihaz tarafı genel kodları.

data

Object

İstek başarılı olursa boş bir nesne döndürülür.