Referenční informace k uživatelské knihovně funkcí definovaných uživatelem

Důležité

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

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

Vzhledem k identifikátoru mezery tato funkce načte mezeru z grafu.

Druh: globální funkce

Parametr	Typ	Description
id	guid	Identifikátor prostoru

getSensorMetadata(id) ⇒ sensor

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

Druh: globální funkce

Parametr	Typ	Description
id	guid	Identifikátor senzoru

getDeviceMetadata(id) ⇒ device

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

Druh: globální funkce

Parametr	Typ	Description
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.

Druh: globální funkce

Parametr	Typ	Description
sensorId	guid	Identifikátor senzoru
dataType	string	Datový typ senzoru

getSpaceValue(spaceId, valueName) ⇒ value

Vzhledem k identifikátoru mezery a názvu hodnoty tato funkce načte aktuální hodnotu této vlastnosti mezery.

Druh: globální funkce

Parametr	Typ	Description
spaceId	guid	Identifikátor prostoru
Název hodnoty	string	Název vlastnosti mezery

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

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

Druh: globální funkce

Parametr	Typ	Description
sensorId	guid	Identifikátor senzoru
dataType	string	Datový typ senzoru

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

Vzhledem k identifikátoru mezery a názvu hodnoty tato funkce načte historické hodnoty této vlastnosti v prostoru.

Druh: globální funkce

Parametr	Typ	Description
spaceId	guid	Identifikátor prostoru
Název hodnoty	string	Název vlastnosti mezery

getSpaceChildSpaces(spaceId) ⇒ space[]

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

Druh: globální funkce

Parametr	Typ	Description
spaceId	guid	Identifikátor prostoru

getSpaceChildSensors(spaceId) ⇒ sensor[]

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

Druh: globální funkce

Parametr	Typ	Description
spaceId	guid	Identifikátor prostoru

getSpaceChildDevices(spaceId) ⇒ device[]

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

Druh: globální funkce

Parametr	Typ	Description
spaceId	guid	Identifikátor prostoru

getDeviceChildSensors(deviceId) ⇒ sensor[]

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

Druh: globální funkce

Parametr	Typ	Description
Deviceid	guid	Identifikátor zařízení

getSpaceParentSpace(childSpaceId) ⇒ space

Vzhledem k identifikátoru mezery tato funkce načte nadřazený prostor.

Druh: globální funkce

Parametr	Typ	Description
childSpaceId	guid	Identifikátor mezery

getSensorParentSpace(childSensorId) ⇒ space

Vzhledem k identifikátoru senzoru tato funkce načte nadřazený prostor.

Druh: globální funkce

Parametr	Typ	Description
childSensorId	guid	Identifikátor senzoru

getDeviceParentSpace(childDeviceId) ⇒ space

Vzhledem k identifikátoru zařízení tato funkce načte nadřazený prostor.

Druh: globální funkce

Parametr	Typ	Description
childDeviceId	guid	Identifikátor zařízení

getSensorParentDevice(childSensorId) ⇒ space

Vzhledem k identifikátoru senzoru tato funkce načte své nadřazené zařízení.

Druh: globální funkce

Parametr	Typ	Description
childSensorId	guid	Identifikátor senzoru

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

Vzhledem k identifikátoru mezery tato funkce načte vlastnost a její hodnotu z prostoru.

Druh: globální funkce

Parametr	Typ	Description
spaceId	guid	Identifikátor mezery
Propertyname	string	Název vlastnosti mezery

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

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

Druh: globální funkce

Parametr	Typ	Description
sensorId	guid	Identifikátor senzoru
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í.

Druh: globální funkce

Parametr	Typ	Description
Deviceid	guid	Identifikátor zařízení
Propertyname	string	Název vlastnosti zařízení

setSensorValue(sensorId, dataType, value)

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

Druh: globální funkce

Parametr	Typ	Description
sensorId	guid	Identifikátor senzoru
dataType	string	Datový typ senzoru
value	string	Hodnota

setSpaceValue(spaceId, dataType, value)

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

Druh: globální funkce

Parametr	Typ	Description
spaceId	guid	Identifikátor mezery
dataType	string	Datový typ
value	string	Hodnota

log(message)

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

Druh: globální funkce

Parametr	Typ	Description
message	string	Zpráva, která se má protokolovat

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

Tato funkce odešle vlastní oznámení, která se mají odeslat.

Druh: globální funkce

Parametr	Typ	Description
topologyObjectId	guid	Graph identifikátor objektu. Příklady jsou mezera, senzor a ID zařízení.
topologyObjectType	string	Příklady jsou senzory a zařízení.
payload	string	Datová část JSON, která se má odeslat s oznámením.

Návratové typy

Modely odpovědí vrácené z pomocných metod referenčního klienta jsou popsány níže.

Místo

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

Metody mezerníku

Parent() ⇒ space

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

Podřízené ⇒ sensor[]

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

ChildDevices() ⇒ device[]

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

ExtendedProperty(propertyName) ⇒ extendedProperty

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

Parametr	Typ	Description
Propertyname	string	Název rozšířené vlastnosti

Hodnota(valueName) ⇒ value

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

Parametr	Typ	Description
Název hodnoty	string	Název hodnoty

⇒ historie(valueName) value[]

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

Parametr	Typ	Description
Název hodnoty	string	Název hodnoty

Notify(payload)

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

Parametr	Typ	Description
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í

Parent() ⇒ space

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

Podřízené ⇒ 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í.

Parametr	Typ	Description
Propertyname	string	Název rozšířené vlastnosti

Notify(payload)

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

Parametr	Typ	Description
payload	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čů

Mezerník() ⇒ space

Tato funkce vrátí nadřazený prostor aktuálního 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.

Parametr	Typ	Description
Propertyname	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(payload)

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

Parametr	Typ	Description
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

• Seznamte se s uživatelem definovanými funkcemi Azure Digital Twins.

• Naučte se vytvářet uživatelem definované funkce.

• Zjistěte , jak ladit uživatelem definované funkce.