Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Importante
È stata rilasciata una nuova versione del servizio Gemelli digitali di Azure. Alla luce delle funzionalità espanse del nuovo servizio, il servizio Gemelli digitali di Azure originale (descritto in questo set di documentazione) è stato ritirato.
Per visualizzare la documentazione per il nuovo servizio, visitare la documentazione attiva di Azure Digital Twins.
Questo documento fornisce informazioni di riferimento per la libreria client di funzioni definite dall'utente di Gemelli digitali di Azure.
Metodi di supporto
La libreria client definisce i metodi helper per le operazioni di uso comune.
⇒ getSpaceMetadata(id) space
Dato un identificatore di spazio, questa funzione recupera lo spazio dal grafico.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| ID | guid |
Identificatore dello spazio |
getSensorMetadata(id) ⇒ sensor
Dato un identificatore di sensore, questa funzione recupera il sensore dal grafico.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| ID | guid |
Identificatore del sensore |
⇒ getDeviceMetadata(id) device
Dato un identificatore di dispositivo, questa funzione recupera il dispositivo dal grafico.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| ID | guid |
Identificatore del dispositivo |
⇒ getSensorValue(sensorId, dataType) value
Dato un identificatore del sensore e il relativo tipo di dati, questa funzione recupera il valore corrente per tale sensore.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| sensorId | guid |
Identificatore del sensore |
| Datatype | string |
Tipo di dati del sensore |
⇒ getSpaceValue(spaceId, valueName) value
Dato un identificatore di spazio e il nome del valore, questa funzione recupera il valore corrente per tale proprietà space.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| spaceId | guid |
Identificatore dello spazio |
| valueName | string |
Nome della proprietà dello spazio |
getSensorHistoryValues(sensorId, dataType) ⇒ value[]
Dato un identificatore di sensore e il relativo tipo di dati, questa funzione recupera i valori cronologici per tale sensore.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| sensorId | guid |
Identificatore del sensore |
| Datatype | string |
Tipo di dati del sensore |
getSpaceHistoryValues(spaceId, dataType) ⇒ value[]
Dato un identificatore di spazio e il nome del valore, questa funzione recupera i valori cronologici per tale proprietà nello spazio.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| spaceId | guid |
Identificatore dello spazio |
| valueName | string |
Nome della proprietà dello spazio |
⇒ getSpaceChildSpaces(spaceId) space[]
Dato un identificatore di spazio, questa funzione recupera gli spazi figlio per tale spazio padre.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| spaceId | guid |
Identificatore dello spazio |
⇒ getSpaceChildSensors(spaceId) sensor[]
Dato un identificatore di spazio, questa funzione recupera i sensori associati a tale spazio principale.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| spaceId | guid |
Identificatore dello spazio |
getSpaceChildDevices(spaceId) ⇒ device[]
Dato un identificatore di spazio, questa funzione recupera i dispositivi figlio per tale spazio.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| spaceId | guid |
Identificatore dello spazio |
⇒ getDeviceChildSensors(deviceId) sensor[]
Dato un identificatore di dispositivo, questa funzione recupera i sensori figlio per il dispositivo padre.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| deviceId | guid |
Identificatore del dispositivo |
⇒ getSpaceParentSpace(childSpaceId) space
Dato un identificatore di spazio, questa funzione recupera lo spazio padre.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| childSpaceId | guid |
Identificatore dello spazio |
getSensorParentSpace(childSensorId) ⇒ space
Dato un identificatore di sensore, questa funzione recupera lo spazio di origine.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| childSensorId | guid |
Identificatore del sensore |
getDeviceParentSpace(childDeviceId) ⇒ space
Dato un identificatore di dispositivo, questa funzione recupera lo spazio padre.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| childDeviceId | guid |
Identificatore del dispositivo |
⇒ getSensorParentDevice(childSensorId) space
Dato un identificatore di sensore, questa funzione recupera il dispositivo padre.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| childSensorId | guid |
Identificatore del sensore |
getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty
Dato un identificatore di spazio, questa funzione recupera la proprietà e il relativo valore dallo spazio.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| spaceId | guid |
Identificatore dello spazio |
| nomeProprietà | string |
Nome della proprietà dello spazio |
getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty
Dato un identificatore del sensore, questa funzione recupera la proprietà e il relativo valore dal sensore.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| sensorId | guid |
Identificatore del sensore |
| nomeProprietà | string |
Nome della proprietà del sensore |
getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty
Dato un identificatore di dispositivo, questa funzione recupera la proprietà e il relativo valore dal dispositivo.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| deviceId | guid |
Identificatore del dispositivo |
| nomeProprietà | string |
Nome della proprietà del dispositivo |
setSensorValue(sensorId, dataType, value)
Questa funzione imposta un valore sull'oggetto sensore con il tipo di dati specificato.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| sensorId | guid |
Identificatore del sensore |
| Datatype | string |
Tipo di dati del sensore |
| valore | string |
Valore |
setSpaceValue(spaceId, dataType, value)
Questa funzione imposta un valore sull'oggetto space con il tipo di dati specificato.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| spaceId | guid |
Identificatore dello spazio |
| Datatype | string |
Tipo di dati |
| valore | string |
Valore |
log(messaggio)
Questa funzione registra il messaggio seguente all'interno della funzione definita dall'utente.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| Messaggio | string |
Messaggio da registrare |
sendNotification(topologyObjectId, topologyObjectType, payload)
Questa funzione invia una notifica personalizzata da inviare.
Tipo: funzione globale
| Parametro | TIPO | Descrizione |
|---|---|---|
| topologyObjectId | guid |
Identificatore dell'oggetto di Graph. Ad esempio, spazio, sensore e ID dispositivo. |
| topologyObjectType | string |
Esempi sono sensore e dispositivo. |
| carico utile | string |
Il payload JSON da inviare con la notifica. |
Tipi restituiti
I modelli di risposta restituiti dai metodi di supporto per il riferimento del client sono descritti di seguito.
Spazio
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Space",
"friendlyName": "Conference Room",
"typeId": 0,
"parentSpaceId": "00000000-0000-0000-0000-000000000001",
"subtypeId": 0
}
Metodi spaziali
⇒ parent() space
Questa funzione restituisce lo spazio padre dello spazio corrente.
⇒ ChildSensors() sensor[]
Questa funzione restituisce i sensori secondari dello spazio corrente.
⇒ ChildDevices() device[]
Questa funzione restituisce i dispositivi figlio dello spazio corrente.
ExtendedProperty(propertyName) ⇒ extendedProperty
Questa funzione restituisce la proprietà estesa e il relativo valore per lo spazio corrente.
| Parametro | TIPO | Descrizione |
|---|---|---|
| nomeProprietà | string |
Nome della proprietà estesa |
⇒ Value(valueName) value
Questa funzione restituisce il valore dello spazio corrente.
| Parametro | TIPO | Descrizione |
|---|---|---|
| valueName | string |
Nome del valore |
Cronologia(valueName) ⇒ value[]
Questa funzione restituisce i valori cronologici dello spazio corrente.
| Parametro | TIPO | Descrizione |
|---|---|---|
| valueName | string |
Nome del valore |
Notifica(payload)
Questa funzione invia una notifica con il payload specificato.
| Parametro | TIPO | Descrizione |
|---|---|---|
| payload | string |
Payload JSON da includere nella notifica |
Dispositivo
{
"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"
}
Metodi del dispositivo
⇒ parent() space
Questa funzione restituisce lo spazio padre del dispositivo corrente.
⇒ ChildSensors() sensor[]
Questa funzione restituisce i sensori figli del dispositivo corrente.
ExtendedProperty(propertyName) ⇒ extendedProperty
Questa funzione restituisce la proprietà estesa e il relativo valore per il dispositivo corrente.
| Parametro | TIPO | Descrizione |
|---|---|---|
| nomeProprietà | string |
Nome della proprietà estesa |
Notifica(payload)
Questa funzione invia una notifica con il payload specificato.
| Parametro | TIPO | Descrizione |
|---|---|---|
| payload | string |
Payload JSON da includere nella notifica |
Sensore
{
"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
}
Metodi del sensore
⇒ Space() space
Questa funzione restituisce lo spazio padre del sensore corrente.
⇒ device() device
Questa funzione restituisce il dispositivo padre del sensore corrente.
⇒ ExtendedProperty(propertyName) extendedProperty
Questa funzione restituisce la proprietà estesa e il relativo valore per il sensore corrente.
| Parametro | TIPO | Descrizione |
|---|---|---|
| nomeProprietà | string |
Nome della proprietà estesa |
⇒ Value() value
Questa funzione restituisce il valore del sensore corrente.
⇒ History() value[]
Questa funzione restituisce i valori cronologici del sensore corrente.
Notifica(payload)
Questa funzione invia una notifica con il payload specificato.
| Parametro | TIPO | Descrizione |
|---|---|---|
| carico utile | string |
Payload JSON da includere nella notifica |
Valore
{
"dataType": "Temperature",
"value": "70",
"createdTime": ""
}
Proprietà estesa
{
"name": "OccupancyStatus",
"value": "Occupied"
}
Passaggi successivi
Informazioni sulle funzioni definite dall'utente di Gemelli digitali di Azure.
Informazioni su come creare funzioni definite dall'utente.
Informazioni su come eseguire il debug di funzioni definite dall'utente.