Kullanıcı tanımlı işlevler istemci kitaplığı başvurusu

Önemli

Azure Digital Twins hizmetinin yeni bir sürümü yayınlandı. Yeni hizmetin genişletilmiş özellikleri ışığında özgün Azure Digital Twins hizmeti (bu belge kümesinde açıklanmıştır) kullanımdan kaldırılmıştır.

Yeni hizmetin belgelerini görüntülemek için etkin Azure Digital Twins Belgeleri'ni ziyaret edin.

Bu belge, Azure Digital Twins kullanıcı tanımlı işlevler istemci kitaplığı için başvuru bilgileri sağlar.

Yardımcı yöntemler

İstemci kitaplığı, yaygın olarak kullanılan işlemler için yardımcı yöntemleri tanımlar.

getSpaceMetadata(id) ⇒ space

Bir boşluk tanımlayıcısı verüldüğünde, bu işlev graftan alanı alır.

Tür: genel işlev

Parametre	Tür	Description
id	guid	Boşluk tanımlayıcısı

getSensorMetadata(id) ⇒ sensor

Bir algılayıcı tanımlayıcısı verüldüğünde, bu işlev algılayıcıyı grafikten alır.

Tür: genel işlev

Parametre	Tür	Description
id	guid	Algılayıcı tanımlayıcısı

getDeviceMetadata(id) ⇒ device

Bir cihaz tanımlayıcısı verüldüğünde, bu işlev cihazı grafikten alır.

Tür: genel işlev

Parametre	Tür	Description
id	guid	Cihaz tanımlayıcısı

getSensorValue(sensorId, dataType) ⇒ value

Bir algılayıcı tanımlayıcısı ve veri türü göz önünde bulundurulduğunda, bu işlev bu algılayıcı için geçerli değeri alır.

Tür: genel işlev

Parametre	Tür	Description
sensorId	guid	Algılayıcı tanımlayıcısı
dataType	string	Algılayıcı veri türü

getSpaceValue(spaceId, valueName) ⇒ value

Bir boşluk tanımlayıcısı ve değer adı verüldüğünde, bu işlev bu boşluk özelliği için geçerli değeri alır.

Tür: genel işlev

Parametre	Tür	Description
spaceId	guid	Boşluk tanımlayıcısı
valueName	string	Boşluk özelliği adı

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

Bir algılayıcı tanımlayıcısı ve veri türü göz önünde bulundurulduğunda, bu işlev bu algılayıcının geçmiş değerlerini alır.

Tür: genel işlev

Parametre	Tür	Description
sensorId	guid	Algılayıcı tanımlayıcısı
dataType	string	Algılayıcı veri türü

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

Bir boşluk tanımlayıcısı ve değer adı verüldüğünde, bu işlev alanda söz konusu özelliğin geçmiş değerlerini alır.

Tür: genel işlev

Parametre	Tür	Description
spaceId	guid	Boşluk tanımlayıcısı
valueName	string	Boşluk özelliği adı

getSpaceChildSpaces(spaceId) ⇒ space[]

Bir boşluk tanımlayıcısı verüldüğünde, bu işlev bu üst alanın alt boşluklarını alır.

Tür: genel işlev

Parametre	Tür	Description
spaceId	guid	Boşluk tanımlayıcısı

getSpaceChildSensors(spaceId) ⇒ sensor[]

Bir alan tanımlayıcısı verüldüğünde, bu işlev söz konusu üst alan için alt algılayıcıları alır.

Tür: genel işlev

Parametre	Tür	Description
spaceId	guid	Boşluk tanımlayıcısı

getSpaceChildDevices(spaceId) ⇒ device[]

Alan tanımlayıcısı verüldüğünde, bu işlev bu üst alan için alt cihazları alır.

Tür: genel işlev

Parametre	Tür	Description
spaceId	guid	Boşluk tanımlayıcısı

getDeviceChildSensors(deviceId) ⇒ sensor[]

Cihaz tanımlayıcısı verüldüğünde, bu işlev söz konusu üst cihaz için alt algılayıcıları alır.

Tür: genel işlev

Parametre	Tür	Description
Deviceıd	guid	Cihaz tanımlayıcısı

getSpaceParentSpace(childSpaceId) ⇒ space

Bir boşluk tanımlayıcısı verüldüğünde, bu işlev üst alanını alır.

Tür: genel işlev

Parametre	Tür	Description
childSpaceId	guid	Boşluk tanımlayıcısı

getSensorParentSpace(childSensorId) ⇒ space

Bir algılayıcı tanımlayıcısı verüldüğünde, bu işlev üst alanını alır.

Tür: genel işlev

Parametre	Tür	Description
childSensorId	guid	Algılayıcı tanımlayıcısı

getDeviceParentSpace(childDeviceId) ⇒ space

Bir cihaz tanımlayıcısı verüldüğünde, bu işlev üst alanını alır.

Tür: genel işlev

Parametre	Tür	Description
childDeviceId	guid	Cihaz tanımlayıcısı

getSensorParentDevice(childSensorId) ⇒ space

Bir algılayıcı tanımlayıcısı verüldüğünde, bu işlev üst cihazını alır.

Tür: genel işlev

Parametre	Tür	Description
childSensorId	guid	Algılayıcı tanımlayıcısı

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

Bir boşluk tanımlayıcısı verüldüğünde, bu işlev özelliği ve değerini boşluktan alır.

Tür: genel işlev

Parametre	Tür	Description
spaceId	guid	Boşluk tanımlayıcısı
Propertyname	string	Boşluk özelliği adı

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

Bir algılayıcı tanımlayıcısı verüldüğünde, bu işlev özelliği ve değerini algılayıcıdan alır.

Tür: genel işlev

Parametre	Tür	Description
sensorId	guid	Algılayıcı tanımlayıcısı
Propertyname	string	Algılayıcı özellik adı

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

Bir cihaz tanımlayıcısı verüldüğünde, bu işlev özelliği ve değerini cihazdan alır.

Tür: genel işlev

Parametre	Tür	Description
Deviceıd	guid	Cihaz tanımlayıcısı
Propertyname	string	Cihaz özellik adı

setSensorValue(sensorId, dataType, value)

Bu işlev, belirtilen veri türüne sahip algılayıcı nesnesinde bir değer ayarlar.

Tür: genel işlev

Parametre	Tür	Description
sensorId	guid	Algılayıcı tanımlayıcısı
dataType	string	Algılayıcı veri türü
değer	string	Değer

setSpaceValue(spaceId, dataType, value)

Bu işlev, verilen veri türüne sahip boşluk nesnesinde bir değer ayarlar.

Tür: genel işlev

Parametre	Tür	Description
spaceId	guid	Boşluk tanımlayıcısı
dataType	string	Veri türü
değer	string	Değer

log(ileti)

Bu işlev, kullanıcı tanımlı işlev içinde aşağıdaki iletiyi günlüğe kaydeder.

Tür: genel işlev

Parametre	Tür	Description
ileti	string	Günlüğe kaydedilecek ileti

sendNotification(topologyObjectId, topologyObjectType, payload)

Bu işlev, gönderilmesi için özel bir bildirim gönderir.

Tür: genel işlev

Parametre	Tür	Description
topologyObjectId	guid	nesne tanımlayıcısı Graph. Örnek olarak alan, algılayıcı ve cihaz kimliği verilebilir.
topologyObjectType	string	Algılayıcı ve cihaz örnekleridir.
yük	string	Bildirimle birlikte gönderilecek JSON yükü.

Dönüş türleri

İstemci başvurusu yardımcı yöntemlerinden döndürülen yanıt modelleri aşağıda açıklanmıştır.

Alan

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Space",
  "friendlyName": "Conference Room",
  "typeId": 0,
  "parentSpaceId": "00000000-0000-0000-0000-000000000001",
  "subtypeId": 0
}

Boşluk yöntemleri

Parent() ⇒ space

Bu işlev geçerli boşluğun üst alanını döndürür.

ChildSensors() ⇒ sensor[]

Bu işlev, geçerli alanın alt algılayıcılarını döndürür.

ChildDevices() ⇒ device[]

Bu işlev geçerli alanın alt cihazlarını döndürür.

ExtendedProperty(propertyName) ⇒ extendedProperty

Bu işlev genişletilmiş özelliği ve geçerli alan için değerini döndürür.

Parametre	Tür	Description
Propertyname	string	Genişletilmiş özelliğin adı

Value(valueName) ⇒ value

Bu işlev geçerli alanın değerini döndürür.

Parametre	Tür	Description
valueName	string	Değerin adı

History(valueName) ⇒ value[]

Bu işlev geçerli boşluğun geçmiş değerlerini döndürür.

Parametre	Tür	Description
valueName	string	Değerin adı

Notify(payload)

Bu işlev, belirtilen yükü içeren bir bildirim gönderir.

Parametre	Tür	Description
yük	string	Bildirime eklenecek JSON yükü

Cihaz

{
  "id": "00000000-0000-0000-0000-000000000002",
  "name": "Device",
  "friendlyName": "Temperature Sensing Device",
  "description": "This device contains a sensor that captures temperature readings.",
  "type": "None",
  "subtype": "None",
  "typeId": 0,
  "subtypeId": 0,
  "hardwareId": "ABC123",
  "gatewayId": "ABC",
  "spaceId": "00000000-0000-0000-0000-000000000000"
}

Cihaz yöntemleri

Parent() ⇒ space

Bu işlev geçerli cihazın üst alanını döndürür.

ChildSensors() ⇒ sensor[]

Bu işlev, geçerli cihazın alt algılayıcılarını döndürür.

ExtendedProperty(propertyName) ⇒ extendedProperty

Bu işlev genişletilmiş özelliği ve geçerli cihaz için değerini döndürür.

Parametre	Tür	Description
Propertyname	string	Genişletilmiş özelliğin adı

Notify(payload)

Bu işlev, belirtilen yükü içeren bir bildirim gönderir.

Parametre	Tür	Description
yük	string	Bildirime eklenecek JSON yükü

Algılayıcı

{
  "id": "00000000-0000-0000-0000-000000000003",
  "port": "30",
  "pollRate": 3600,
  "dataType": "Temperature",
  "dataSubtype": "None",
  "type": "Classic",
  "portType": "None",
  "dataUnitType": "FahrenheitTemperature",
  "spaceId": "00000000-0000-0000-0000-000000000000",
  "deviceId": "00000000-0000-0000-0000-000000000001",
  "portTypeId": 0,
  "dataUnitTypeId": 0,
  "dataTypeId": 0,
  "dataSubtypeId": 0,
  "typeId": 0  
}

Algılayıcı yöntemleri

Space() ⇒ space

Bu işlev geçerli sensörün üst alanını döndürür.

Device() ⇒ device

Bu işlev geçerli sensörün üst cihazını döndürür.

ExtendedProperty(propertyName) ⇒ extendedProperty

Bu işlev genişletilmiş özelliği ve geçerli algılayıcının değerini döndürür.

Parametre	Tür	Description
Propertyname	string	Genişletilmiş özelliğin adı

Value() ⇒ value

Bu işlev geçerli sensörün değerini döndürür.

History() ⇒ value[]

Bu işlev geçerli sensörün geçmiş değerlerini döndürür.

Notify(payload)

Bu işlev, belirtilen yükü içeren bir bildirim gönderir.

Parametre	Tür	Description
yük	string	Bildirime eklenecek JSON yükü

Değer

{
  "dataType": "Temperature",
  "value": "70",
  "createdTime": ""
}

Genişletilmiş özellik

{
  "name": "OccupancyStatus",
  "value": "Occupied"
}

Sonraki adımlar

• Azure Digital Twins kullanıcı tanımlı işlevleri hakkında bilgi edinin.

• Kullanıcı tanımlı işlevler oluşturmayı öğrenin.

• Kullanıcı tanımlı işlevlerde hata ayıklamayı öğrenin.