Clientbibliotheksreferenz für benutzerdefinierte Funktionen
Wichtig
Eine neue Version des Azure Digital Twins-Diensts wurde veröffentlicht. Angesichts der erweiterten Funktionen des neuen Diensts wurde der ursprüngliche Azure Digital Twins-Dienst (in diesem Dokumentationssatz beschrieben) eingestellt.
Um die Dokumentation für den neuen Dienst anzuzeigen, besuchen Sie die aktive Azure Digital Twins-Dokumentation.
Das Dokument enthält Referenzinformationen für die Clientbibliothek mit benutzerdefinierten Funktionen in Azure Digital Twins.
Hilfsmethoden
Die Clientbibliothek definiert Hilfsmethoden für häufig verwendete Vorgänge.
getSpaceMetadata(id) ⇒ space
Bei angegebenem Raumbezeichner ruft diese Funktion den Raum aus dem Graphen ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| id | guid |
Raumbezeichner |
getSensorMetadata(id) ⇒ sensor
Bei angegebenem Sensorbezeichner ruft diese Funktion den Sensor aus dem Graphen ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| id | guid |
Sensorbezeichner |
getDeviceMetadata(id) ⇒ device
Bei angegebenem Gerätebezeichner ruft diese Funktion das Gerät aus dem Graphen ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| id | guid |
Gerätebezeichner |
getSensorValue(sensorId, dataType) ⇒ value
Nach Angabe eines Sensorbezeichners und dessen Datentyps ruft diese Funktion den aktuellen Wert dieses Sensors ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| sensorId | guid |
Sensorbezeichner |
| dataType | string |
Sensordatentyp |
getSpaceValue(spaceId, valueName) ⇒ value
Nach Angabe eines Raumbezeichners und des Wertnamens ruft diese Funktion den aktuellen Wert für diese Raumeigenschaft ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| spaceId | guid |
Raumbezeichner |
| valueName | string |
Name der Raumeigenschaft |
getSensorHistoryValues(sensorId, dataType) ⇒ value[]
Nach Angabe eines Sensorbezeichners und dessen Datentyps ruft diese Funktion die früheren Werte dieses Sensors ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| sensorId | guid |
Sensorbezeichner |
| dataType | string |
Sensordatentyp |
getSpaceHistoryValues(spaceId, dataType) ⇒ value[]
Nach Angabe eines Raumbezeichners und des Wertnamens ruft diese Funktion die früheren Werte dieser Raumeigenschaft ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| spaceId | guid |
Raumbezeichner |
| valueName | string |
Name der Raumeigenschaft |
getSpaceChildSpaces(spaceId) ⇒ space[]
Nach Angabe eines Raumbezeichners ruft diese Funktion die untergeordneten Räume dieses übergeordneten Raums ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| spaceId | guid |
Raumbezeichner |
getSpaceChildSensors(spaceId) ⇒ sensor[]
Nach Angabe eines Raumbezeichners ruft diese Funktion die untergeordneten Sensoren dieses übergeordneten Raums ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| spaceId | guid |
Raumbezeichner |
getSpaceChildDevices(spaceId) ⇒ device[]
Nach Angabe eines Raumbezeichners ruft diese Funktion die untergeordneten Geräte dieses übergeordneten Raums ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| spaceId | guid |
Raumbezeichner |
getDeviceChildSensors(deviceId) ⇒ sensor[]
Nach Angabe eines Gerätebezeichners ruft diese Funktion die untergeordneten Sensoren dieses übergeordneten Geräts ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| deviceId | guid |
Gerätebezeichner |
getSpaceParentSpace(childSpaceId) ⇒ space
Nach Angabe eines Raumbezeichners ruft diese Funktion den übergeordneten Raum ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| childSpaceId | guid |
Raumbezeichner |
getSensorParentSpace(childSensorId) ⇒ space
Nach Angabe eines Sensorbezeichners ruft diese Funktion den übergeordneten Raum ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| childSensorId | guid |
Sensorbezeichner |
getDeviceParentSpace(childDeviceId) ⇒ space
Nach Angabe eines Gerätebezeichners ruft diese Funktion den übergeordneten Raum ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| childDeviceId | guid |
Gerätebezeichner |
getSensorParentDevice(childSensorId) ⇒ space
Nach Angabe eines Sensorbezeichners ruft diese Funktion das übergeordnete Gerät ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| childSensorId | guid |
Sensorbezeichner |
getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty
Nach Angabe eines Raumbezeichners ruft diese Funktion die Eigenschaft und deren Wert aus dem Raum ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| spaceId | guid |
Raumbezeichner |
| propertyName | string |
Name der Raumeigenschaft |
getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty
Nach Angabe eines Sensorbezeichners ruft diese Funktion die Eigenschaft und deren Wert vom Sensor ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| sensorId | guid |
Sensorbezeichner |
| propertyName | string |
Name der Sensoreigenschaft |
getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty
Nach Angabe eines Gerätebezeichners ruft diese Funktion die Eigenschaft und deren Wert vom Gerät ab.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| deviceId | guid |
Gerätebezeichner |
| propertyName | string |
Name der Geräteeigenschaft |
setSensorValue(sensorId, dataType, value)
Diese Funktion legt den Wert des Sensorobjekts mit dem angegebenen Datentyp fest.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| sensorId | guid |
Sensorbezeichner |
| dataType | string |
Sensordatentyp |
| value | string |
Wert |
setSpaceValue(spaceId, dataType, value)
Diese Funktion legt den Wert des Raumobjekts mit dem angegebenen Datentyp fest.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| spaceId | guid |
Raumbezeichner |
| dataType | string |
Datentyp |
| value | string |
Wert |
log(message)
Diese Funktion protokolliert die folgende Meldung in der benutzerdefinierten Funktion.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| Nachricht | string |
Die zu protokollierende Meldung |
sendNotification(topologyObjectId, topologyObjectType, payload)
Diese Funktion sendet eine benutzerdefinierte Benachrichtigung, die erledigt werden soll.
Art: globale Funktion
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| topologyObjectId | guid |
Bezeichner des Graphobjekts. Beispiele: Raum-, Sensor- und Geräte-ID. |
| topologyObjectType | string |
Beispiele: Sensor und Gerät. |
| Nutzlast | string |
Die JSON-Nutzlast, die mit der Benachrichtigung gesendet werden soll. |
Rückgabetypen
Die Antwortmodelle, die von Clientreferenz-Hilfsmethoden zurückgegeben werden, sind nachfolgend beschrieben.
LeerZchn
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Space",
"friendlyName": "Conference Room",
"typeId": 0,
"parentSpaceId": "00000000-0000-0000-0000-000000000001",
"subtypeId": 0
}
Raummethoden
Parent() ⇒ space
Diese Funktion gibt den übergeordneten Raum des aktuellen Raums zurück.
ChildSensors() ⇒ sensor[]
Diese Funktion gibt die untergeordneten Sensoren des aktuellen Raums zurück.
ChildDevices() ⇒ device[]
Diese Funktion gibt die untergeordneten Geräte des aktuellen Raums zurück.
ExtendedProperty(propertyName) ⇒ extendedProperty
Diese Funktion gibt die erweiterte Eigenschaft und deren Wert für den aktuellen Raum zurück.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| propertyName | string |
Name der erweiterten Eigenschaft |
Value(valueName) ⇒ value
Diese Funktion gibt den Wert des aktuellen Raums zurück.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| valueName | string |
Name des Werts |
History(valueName) ⇒ value[]
Diese Funktion gibt die früheren Werte des aktuellen Raums zurück.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| valueName | string |
Name des Werts |
Notify(payload)
Diese Funktion sendet eine Benachrichtigung mit der angegebenen Nutzlast.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| payload | string |
JSON-Nutzlast, die in die Benachrichtigung eingefügt werden soll |
Sicherungsmedium
{
"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"
}
Gerätemethoden
Parent() ⇒ space
Diese Funktion gibt den übergeordneten Raum des aktuellen Geräts zurück.
ChildSensors() ⇒ sensor[]
Diese Funktion gibt die untergeordneten Sensoren des aktuellen Geräts zurück.
ExtendedProperty(propertyName) ⇒ extendedProperty
Diese Funktion gibt die erweiterte Eigenschaft und deren Wert für das aktuelle Gerät zurück.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| propertyName | string |
Name der erweiterten Eigenschaft |
Notify(payload)
Diese Funktion sendet eine Benachrichtigung mit der angegebenen Nutzlast.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| payload | string |
JSON-Nutzlast, die in die Benachrichtigung eingefügt werden soll |
Sensor
{
"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
}
Sensormethoden
Space() ⇒ space
Diese Funktion gibt den übergeordneten Raum des aktuellen Sensors zurück.
Device() ⇒ device
Diese Funktion gibt das übergeordnete Gerät des aktuellen Sensors zurück.
ExtendedProperty(propertyName) ⇒ extendedProperty
Diese Funktion gibt die erweiterte Eigenschaft und deren Wert für den aktuellen Sensor zurück.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| propertyName | string |
Name der erweiterten Eigenschaft |
Value() ⇒ value
Diese Funktion gibt den Wert des aktuellen Sensors zurück.
History() ⇒ value[]
Diese Funktion gibt die früheren Werte des aktuellen Sensors zurück.
Notify(payload)
Diese Funktion sendet eine Benachrichtigung mit der angegebenen Nutzlast.
| Parameter | type | BESCHREIBUNG |
|---|---|---|
| payload | string |
JSON-Nutzlast, die in die Benachrichtigung eingefügt werden soll |
Wert
{
"dataType": "Temperature",
"value": "70",
"createdTime": ""
}
Erweiterte Eigenschaft
{
"name": "OccupancyStatus",
"value": "Occupied"
}
Nächste Schritte
Informationen zu Benutzerdefinierten Funktionen in Azure Digital Twins.
Informationen zum Erstellen von benutzerdefinierten Funktionen.
Informationen zum Debuggen von benutzerdefinierten Funktionen.