Sdílet prostřednictvím

Referenční dokumentace knihovny klienta pro uživatelsky definované funkce

Důležité

Byla vydána nová verze služby Azure Digital Twins. Vzhledem k rozšířeným funkcím nové služby se původní služba Azure Digital Twins (popsaná v této sadě dokumentace) vyřadila z provozu.

Pokud chcete zobrazit dokumentaci k nové službě, navštivte aktivní dokumentaci ke službě Azure Digital Twins.

Tento dokument obsahuje referenční informace pro uživatelsky definovanou klientskou knihovnu funkcí služby Azure Digital Twins.

Pomocné metody

Klientská knihovna definuje pomocné metody pro běžně používané operace.

getSpaceMetadata(id) ⇒ space

Daný identifikátor prostoru způsobí, že tato funkce načte prostor z grafu.

Typ: globální funkce

Parameter Typ Popis
id guid Identifikátor mezery

getSensorMetadata(id) ⇒ sensor

Vzhledem k identifikátoru senzoru tato funkce načte senzor z grafu.

Typ: globální funkce

Parameter Typ Popis
id guid Identifikátor snímače

getDeviceMetadata(id) ⇒ device

Podle identifikátoru zařízení tato funkce načte zařízení z grafu.

Typ: globální funkce

Parameter Typ Popis
id guid Identifikátor zařízení

getSensorValue(sensorId, dataType) ⇒ value

Vzhledem k identifikátoru senzoru a jeho datovému typu tato funkce načte aktuální hodnotu tohoto senzoru.

Typ: globální funkce

Parameter Typ Popis
sensorId guid Identifikátor snímače
dataType string Datový typ senzoru

getSpaceValue(spaceId; valueName) ⇒ value

Vzhledem k identifikátoru prostoru a jménu hodnoty tato funkce načte aktuální hodnotu vlastnosti prostoru.

Druh: globální funkce

Parameter Typ Popis
spaceId guid Identifikátor mezery
valueName string Název vlastnosti prostoru

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

Vzhledem k identifikátoru senzoru a jeho datovému typu tato funkce načte historické hodnoty pro tento senzor.

Typ: globální funkce

Parameter Typ Popis
sensorId guid Identifikátor snímače
dataType string Datový typ senzoru

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

S ohledem na identifikátor prostoru a název dané hodnoty tato funkce načte historické hodnoty této vlastnosti.

Druh: globální funkce

Parameter Typ Popis
spaceId guid Identifikátor mezery
valueName string Název vlastnosti prostoru

getSpaceChildSpaces(spaceId) ⇒ space[]

S ohledem na identifikátor prostoru tato funkce načte podřízené prostory pro tento nadřazený prostor.

Druh: globální funkce

Parameter Typ Popis
spaceId guid Identifikátor mezery

getSpaceChildSensors(spaceId) ⇒ sensor[]

Vzhledem k identifikátoru prostoru tato funkce načte podřízené senzory pro daný nadřazený prostor.

Typ: globální funkce

Parameter Typ Popis
spaceId guid Identifikátor mezery

getSpaceChildDevices(spaceId) ⇒ device[]

Vzhledem k identifikátoru prostoru tato funkce získá podřízená zařízení pro daný nadřazený prostor.

Typ: globální funkce

Parameter Typ Popis
spaceId guid Identifikátor mezery

getDeviceChildSensors(deviceId) ⇒ sensor[]

Na základě identifikátoru zařízení tato funkce získá podřízené senzory pro dané nadřazené zařízení.

Typ: globální funkce

Parameter Typ Popis
id zařízení guid Identifikátor zařízení

getSpaceParentSpace(childSpaceId) ⇒ space

Vzhledem k identifikátoru prostoru tato funkce získá nadřazený prostor.

Typ: globální funkce

Parameter Typ Popis
childSpaceId guid Identifikátor mezery

getSensorParentSpace(childSensorId) ⇒ space

Pomocí identifikátoru senzoru tato funkce načte nadřazený prostor.

Typ: globální funkce

Parameter Typ Popis
childSensorId guid Identifikátor snímače

getDeviceParentSpace(childDeviceId) ⇒ space

Na základě identifikátoru zařízení tato funkce načte rodičovský prostor.

Typ: globální funkce

Parameter Typ Popis
childDeviceId guid Identifikátor zařízení

getSensorParentDevice(childSensorId) ⇒ space

Podle identifikátoru senzoru tato funkce načte jeho nadřazené zařízení.

Druh: globální funkce

Parameter Typ Popis
childSensorId guid Identifikátor snímače

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

Při použití identifikátoru prostoru tato funkce načte vlastnost a její hodnotu z prostoru.

Druh: globální funkce

Parameter Typ Popis
spaceId guid Identifikátor mezery
názevVlastnosti string Název vlastnosti prostoru

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

Tato funkce načte vlastnost a její hodnotu ze senzoru na základě jeho identifikátoru.

Druh: globální funkce

Parameter Typ Popis
sensorId guid Identifikátor snímače
propertyName string Název vlastnosti senzoru

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

Vzhledem k identifikátoru zařízení tato funkce načte vlastnost a její hodnotu ze zařízení.

Typ: globální funkce

Parameter Typ Popis
id zařízení guid Identifikátor zařízení
názevVlastnosti string Název vlastnosti zařízení

setSensorValue(sensorId, dataType, value)

Tato funkce nastaví hodnotu na objektu senzoru s daným datovým typem.

Typ: globální funkce

Parameter Typ Popis
sensorId guid Identifikátor snímače
dataType string Datový typ senzoru
hodnota string Hodnota

setSpaceValue(spaceId, dataType, value)

Tato funkce nastaví hodnotu na objekt prostoru s daným datovým typem.

Typ: globální funkce

Parameter Typ Popis
spaceId guid Identifikátor mezery
dataType string Datový typ
hodnota string Hodnota

log(message)

Tato funkce zaznamená následující zprávu v rámci uživatelem definované funkce.

Typ: globální funkce

Parameter Typ Popis
zpráva string Zpráva, která se má protokolovat

sendNotification(topologyObjectId, topologyObjectType, datová část)

Tato funkce odešle přizpůsobené oznámení k odeslání.

Druh: globální funkcionalita

Parameter Typ Popis
topologyObjectId guid Identifikátor objektu grafu. Příklady jsou mezera, senzor a ID zařízení.
topologyObjectType string Příklady jsou senzory a zařízení.
náklad string Datová část JSON, která se má odeslat s oznámením.

Návratové typy

Modely odpovědí vrácené z pomocných metod klientské reference jsou popsány níže.

Prostor

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

Prostorové metody

Nadřazený() ⇒ space

Tato funkce vrátí nadřazený prostor aktuálního prostoru.

ChildSensors() ⇒ sensor[]

Tato funkce vrátí podřízené senzory aktuálního prostředí.

⇒ ChildDevices() device[]

Tato funkce vrátí zařízení podřízená aktuálnímu prostoru.

ExtendedProperty(propertyName) ⇒ extendedProperty

Tato funkce vrátí rozšířenou vlastnost a její hodnotu pro aktuální prostor.

Parameter Typ Popis
názevVlastnosti string Název rozšířené vlastnosti

Hodnota(valueName) ⇒ value

Tato funkce vrátí hodnotu aktuálního prostoru.

Parameter Typ Popis
valueName string Název hodnoty

Historie(valueName) ⇒ value[]

Tato funkce vrátí historické hodnoty aktuálního prostoru.

Parameter Typ Popis
valueName string Název hodnoty

Upozornit(náklad)

Tato funkce odešle oznámení se zadanou datovou částí.

Parameter Typ Popis
payload string Datová část JSON, která se má zahrnout do oznámení

Zařízení

{
  "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 zařízení

rodič() ⇒ space

Tato funkce vrátí nadřazený prostor aktuálního zařízení.

ChildSensors() ⇒ sensor[]

Tato funkce vrátí podřízené senzory aktuálního zařízení.

ExtendedProperty(propertyName) ⇒ extendedProperty

Tato funkce vrátí rozšířenou vlastnost a její hodnotu pro aktuální zařízení.

Parameter Typ Popis
propertyName string Název rozšířené vlastnosti

Oznam(datová sekce)

Tato funkce odešle oznámení se zadaným obsahem.

Parameter Typ Popis
užitečné zatížení string Datová část JSON, která se má zahrnout do oznámení

Senzor

{
  "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 snímačů

Mezera() ⇒ space

Funkce vrátí prostor nadřazený aktuálnímu senzoru.

⇒ zařízení device

Tato funkce vrátí nadřazené zařízení aktuálního senzoru.

ExtendedProperty(propertyName) ⇒ extendedProperty

Tato funkce vrátí rozšířenou vlastnost a její hodnotu pro aktuální senzor.

Parameter Typ Popis
názevVlastnosti string Název rozšířené vlastnosti

Hodnota() ⇒ value

Tato funkce vrátí hodnotu aktuálního senzoru.

Historie() ⇒ value[]

Tato funkce vrátí historické hodnoty aktuálního senzoru.

Notify(datová část)

Tato funkce odešle oznámení se zadaným obsahem.

Parameter Typ Popis
payload string Datová část JSON, která se má zahrnout do oznámení

Hodnota

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

Rozšířená vlastnost

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

Další kroky

  • Last updated on