Udostępnij za pośrednictwem

Dokumentacja biblioteki klienta funkcji zdefiniowanych przez użytkownika

  • Artykuł

Ważne

Wydano nową wersję usługi Azure Digital Twins. W świetle rozszerzonych możliwości nowej usługi oryginalna usługa Azure Digital Twins (opisana w tym zestawie dokumentacji) została wycofana.

Aby wyświetlić dokumentację nowej usługi, odwiedź aktywną dokumentację usługi Azure Digital Twins.

Ten dokument zawiera informacje referencyjne dotyczące biblioteki klienta funkcji zdefiniowanych przez użytkownika usługi Azure Digital Twins.

Metody pomocnika

Biblioteka klienta definiuje metody pomocnicze dla często używanych operacji.

⇒ getSpaceMetadata(id) space

Mając identyfikator spacji, ta funkcja pobiera przestrzeń z grafu.

Rodzaj: funkcja globalna

Parametr Typ Opis
id guid Identyfikator przestrzeni

getSensorMetadata(id) ⇒ sensor

Mając identyfikator czujnika, ta funkcja pobiera czujnik z grafu.

Rodzaj: funkcja globalna

Parametr Typ Opis
id guid Identyfikator czujnika

getDeviceMetadata(id) ⇒ device

Mając identyfikator urządzenia, ta funkcja pobiera urządzenie z grafu.

Rodzaj: funkcja globalna

Parametr Typ Opis
id guid Identyfikator urządzenia

getSensorValue(sensorId, dataType) ⇒ value

Biorąc pod uwagę identyfikator czujnika i jego typ danych, ta funkcja pobiera bieżącą wartość dla tego czujnika.

Rodzaj: funkcja globalna

Parametr Typ Opis
sensorId guid Identyfikator czujnika
dataType string Typ danych czujnika

getSpaceValue(spaceId, valueName) ⇒ value

Mając identyfikator spacji i nazwę wartości, ta funkcja pobiera bieżącą wartość dla tej właściwości spacji.

Rodzaj: funkcja globalna

Parametr Typ Opis
spaceId guid Identyfikator przestrzeni
valueName string Nazwa właściwości spacji

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

Biorąc pod uwagę identyfikator czujnika i jego typ danych, ta funkcja pobiera wartości historyczne dla tego czujnika.

Rodzaj: funkcja globalna

Parametr Typ Opis
sensorId guid Identyfikator czujnika
dataType string Typ danych czujnika

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

Mając identyfikator spacji i nazwę wartości, ta funkcja pobiera wartości historyczne dla tej właściwości w przestrzeni.

Rodzaj: funkcja globalna

Parametr Typ Opis
spaceId guid Identyfikator przestrzeni
valueName string Nazwa właściwości spacji

getSpaceChildSpaces(spaceId) ⇒ space[]

Mając identyfikator spacji, ta funkcja pobiera spacje podrzędne dla tej przestrzeni nadrzędnej.

Rodzaj: funkcja globalna

Parametr Typ Opis
spaceId guid Identyfikator przestrzeni

getSpaceChildSensors(spaceId) ⇒ sensor[]

Mając identyfikator spacji, ta funkcja pobiera czujniki podrzędne dla tej przestrzeni nadrzędnej.

Rodzaj: funkcja globalna

Parametr Typ Opis
spaceId guid Identyfikator przestrzeni

getSpaceChildDevices(spaceId) ⇒ device[]

Mając identyfikator spacji, ta funkcja pobiera urządzenia podrzędne dla tej przestrzeni nadrzędnej.

Rodzaj: funkcja globalna

Parametr Typ Opis
spaceId guid Identyfikator przestrzeni

getDeviceChildSensors(deviceId) ⇒ sensor[]

Mając identyfikator urządzenia, ta funkcja pobiera czujniki podrzędne dla tego urządzenia nadrzędnego.

Rodzaj: funkcja globalna

Parametr Typ Opis
Deviceid guid Identyfikator urządzenia

getSpaceParentSpace(childSpaceId) ⇒ space

Mając identyfikator spacji, ta funkcja pobiera przestrzeń nadrzędną.

Rodzaj: funkcja globalna

Parametr Typ Opis
childSpaceId guid Identyfikator przestrzeni

getSensorParentSpace(childSensorId) ⇒ space

Mając identyfikator czujnika, ta funkcja pobiera przestrzeń nadrzędną.

Rodzaj: funkcja globalna

Parametr Typ Opis
childSensorId guid Identyfikator czujnika

getDeviceParentSpace(childDeviceId) ⇒ space

Mając identyfikator urządzenia, ta funkcja pobiera przestrzeń nadrzędną.

Rodzaj: funkcja globalna

Parametr Typ Opis
childDeviceId guid Identyfikator urządzenia

getSensorParentDevice(childSensorId) ⇒ space

Mając identyfikator czujnika, ta funkcja pobiera urządzenie nadrzędne.

Rodzaj: funkcja globalna

Parametr Typ Opis
childSensorId guid Identyfikator czujnika

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

Mając identyfikator spacji, ta funkcja pobiera właściwość i jej wartość z przestrzeni.

Rodzaj: funkcja globalna

Parametr Typ Opis
spaceId guid Identyfikator przestrzeni
Propertyname string Nazwa właściwości spacji

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

Mając identyfikator czujnika, ta funkcja pobiera właściwość i jej wartość z czujnika.

Rodzaj: funkcja globalna

Parametr Typ Opis
sensorId guid Identyfikator czujnika
Propertyname string Nazwa właściwości czujnika

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

Mając identyfikator urządzenia, ta funkcja pobiera właściwość i jej wartość z urządzenia.

Rodzaj: funkcja globalna

Parametr Typ Opis
Deviceid guid Identyfikator urządzenia
Propertyname string Nazwa właściwości urządzenia

setSensorValue(sensorId, dataType, value)

Ta funkcja ustawia wartość na obiekcie czujnika z danym typem danych.

Rodzaj: funkcja globalna

Parametr Typ Opis
sensorId guid Identyfikator czujnika
dataType string Typ danych czujnika
wartość string Wartość

setSpaceValue(spaceId, dataType, value)

Ta funkcja ustawia wartość obiektu spacji z danym typem danych.

Rodzaj: funkcja globalna

Parametr Typ Opis
spaceId guid Identyfikator przestrzeni
dataType string Typ danych
wartość string Wartość

log(message)

Ta funkcja rejestruje następujący komunikat w funkcji zdefiniowanej przez użytkownika.

Rodzaj: funkcja globalna

Parametr Typ Opis
message string Komunikat do zarejestrowania

sendNotification(topologyObjectId, topologyObjectType, payload)

Ta funkcja wysyła powiadomienie niestandardowe do wysłania.

Rodzaj: funkcja globalna

Parametr Typ Opis
topologyObjectId guid Graph identyfikator obiektu. Przykłady to spacja, czujnik i identyfikator urządzenia.
topologyObjectType string Przykłady to czujnik i urządzenie.
payload string Ładunek JSON do wysłania za pomocą powiadomienia.

Typy zwracane

Modele odpowiedzi zwracane z metod pomocnika odwołania klienta zostały opisane poniżej.

Miejsce

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

Metody spacji

⇒ parent() space

Ta funkcja zwraca przestrzeń nadrzędną bieżącej przestrzeni.

ChildSensors() ⇒ sensor[]

Ta funkcja zwraca czujniki podrzędne bieżącej przestrzeni.

ChildDevices() ⇒ device[]

Ta funkcja zwraca urządzenia podrzędne bieżącego miejsca.

ExtendedProperty(propertyName) ⇒ extendedProperty

Ta funkcja zwraca właściwość extended i jej wartość dla bieżącego miejsca.

Parametr Typ Opis
Propertyname string Nazwa właściwości rozszerzonej

⇒ value(valueName) value

Ta funkcja zwraca wartość bieżącego miejsca.

Parametr Typ Opis
valueName string Nazwa wartości

⇒ History(valueName) value[]

Ta funkcja zwraca historyczne wartości bieżącej przestrzeni.

Parametr Typ Opis
valueName string Nazwa wartości

Notify(ładunek)

Ta funkcja wysyła powiadomienie z określonym ładunkiem.

Parametr Typ Opis
payload string Ładunek JSON do uwzględnienia w powiadomieniu

Urządzenie

{
  "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"
}

Metody urządzenia

⇒ parent() space

Ta funkcja zwraca przestrzeń nadrzędną bieżącego urządzenia.

ChildSensors() ⇒ sensor[]

Ta funkcja zwraca czujniki podrzędne bieżącego urządzenia.

ExtendedProperty(propertyName) ⇒ extendedProperty

Ta funkcja zwraca właściwość extended i jej wartość dla bieżącego urządzenia.

Parametr Typ Opis
Propertyname string Nazwa właściwości rozszerzonej

Notify(ładunek)

Ta funkcja wysyła powiadomienie z określonym ładunkiem.

Parametr Typ Opis
payload string Ładunek JSON do uwzględnienia w powiadomieniu

Czujnik

{
  "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  
}

Metody czujników

Spacja() ⇒ space

Ta funkcja zwraca przestrzeń nadrzędną bieżącego czujnika.

Device() ⇒ device

Ta funkcja zwraca urządzenie nadrzędne bieżącego czujnika.

ExtendedProperty(propertyName) ⇒ extendedProperty

Ta funkcja zwraca właściwość extended i jej wartość dla bieżącego czujnika.

Parametr Typ Opis
Propertyname string Nazwa właściwości rozszerzonej

⇒ value() value

Ta funkcja zwraca wartość bieżącego czujnika.

Historia() ⇒ value[]

Ta funkcja zwraca historyczne wartości bieżącego czujnika.

Notify(ładunek)

Ta funkcja wysyła powiadomienie z określonym ładunkiem.

Parametr Typ Opis
payload string Ładunek JSON do uwzględnienia w powiadomieniu

Wartość

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

Właściwość rozszerzona

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

Następne kroki