Referencia de la biblioteca cliente de funciones definidas por el usuario
Importante
Se ha publicado una nueva versión del servicio Azure Digital Twins. A la luz de las funcionalidades ampliadas del nuevo servicio, se ha retirado el servicio Azure Digital Twins original (descrito en este conjunto de documentación).
Para ver la documentación del nuevo servicio, visite la documentación activa de Azure Digital Twins.
En este documento se proporciona información de referencia para la biblioteca cliente de funciones definidas por el usuario de Azure Digital Twins.
Métodos auxiliares
La biblioteca cliente define los métodos auxiliares para las operaciones utilizadas con frecuencia.
getSpaceMetadata(id) ⇒ space
Dado un identificador de espacio, esta función recupera el espacio del grafo.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | guid |
Identificador del espacio |
getSensorMetadata(id) ⇒ sensor
Dado un identificador de sensor, esta función recupera el sensor del grafo.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | guid |
Identificador del sensor |
getDeviceMetadata(id) ⇒ device
Dado un identificador de dispositivo, esta función recupera el dispositivo del grafo.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | guid |
Identificador de dispositivo |
getSensorValue(sensorId, dataType) ⇒ value
Dado un identificador de sensor y su tipo de datos, esta función recupera el valor actual de ese sensor.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| sensorId | guid |
Identificador del sensor |
| dataType | string |
Tipo de datos del sensor |
getSpaceValue(spaceId, valueName) ⇒ value
Dado un identificador de espacio y el nombre del valor, esta función recupera el valor actual de esa propiedad de espacio.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| spaceId | guid |
Identificador del espacio |
| valueName | string |
Nombre de la propiedad de espacio |
getSensorHistoryValues(sensorId, dataType) ⇒ value[]
Dado un identificador de sensor y su tipo de datos, esta función recupera el historial de valores de ese sensor.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| sensorId | guid |
Identificador del sensor |
| dataType | string |
Tipo de datos del sensor |
getSpaceHistoryValues(spaceId, dataType) ⇒ value[]
Dado un identificador de espacio y el nombre del valor, esta función recupera el historial de valores de esa propiedad de espacio.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| spaceId | guid |
Identificador del espacio |
| valueName | string |
Nombre de la propiedad de espacio |
getSpaceChildSpaces(spaceId) ⇒ space[]
Dado un identificador de espacio, esta función recupera los espacios secundarios de ese espacio primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| spaceId | guid |
Identificador del espacio |
getSpaceChildSensors(spaceId) ⇒ sensor[]
Dado un identificador de espacio, esta función recupera los sensores secundarios de ese espacio primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| spaceId | guid |
Identificador del espacio |
getSpaceChildDevices(spaceId) ⇒ device[]
Dado un identificador de espacio, esta función recupera los dispositivos secundarios de ese espacio primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| spaceId | guid |
Identificador del espacio |
getDeviceChildSensors(deviceId) ⇒ sensor[]
Dado un identificador de espacio, esta función recupera los sensores secundarios de ese dispositivo primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| deviceId | guid |
Identificador de dispositivo |
getSpaceParentSpace(childSpaceId) ⇒ space
Dado un identificador de espacio, esta función recupera su espacio primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| childSpaceId | guid |
Identificador del espacio |
getSensorParentSpace(childSensorId) ⇒ space
Dado un identificador de sensor, esta función recupera su espacio primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| childSensorId | guid |
Identificador del sensor |
getDeviceParentSpace(childDeviceId) ⇒ space
Dado un identificador de dispositivo, esta función recupera su espacio primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| childDeviceId | guid |
Identificador de dispositivo |
getSensorParentSpace(childSensorId) ⇒ space
Dado un identificador de sensor, esta función recupera su dispositivo primario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| childSensorId | guid |
Identificador del sensor |
getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty
Dado un identificador de espacio, esta función recupera la propiedad y su valor desde el espacio.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| spaceId | guid |
Identificador del espacio |
| propertyName | string |
Nombre de la propiedad de espacio |
getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty
Dado un identificador de sensor, esta función recupera la propiedad y su valor desde el sensor.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| sensorId | guid |
Identificador del sensor |
| propertyName | string |
Nombre de la propiedad del sensor |
getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty
Dado un identificador de dispositivo, esta función recupera la propiedad y su valor desde el espacio.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| deviceId | guid |
Identificador de dispositivo |
| propertyName | string |
Nombre de la propiedad del dispositivo |
setSensorValue(sensorId, dataType, value)
Esta función establece un valor en el objeto de sensor con el tipo de datos indicado.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| sensorId | guid |
Identificador del sensor |
| dataType | string |
Tipo de datos del sensor |
| value | string |
Valor |
setSpaceValue(spaceId, dataType, value)
Esta función establece un valor en el objeto de espacio con el tipo de datos indicado.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| spaceId | guid |
Identificador del espacio |
| dataType | string |
Tipo de datos |
| value | string |
Valor |
log(Message)
Esta función registra el mensaje siguiente dentro de la función definida por el usuario.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| message | string |
Mensaje que se va a registrar |
sendNotification(topologyObjectId, topologyObjectType, payload)
Esta función envía una notificación personalizada para que se distribuya.
Tipo: función global
| Parámetro | Tipo | Descripción |
|---|---|---|
| topologyObjectId | guid |
Identificador de objeto gráfico. Algunos ejemplos son el espacio, el sensor y el identificador de dispositivo. |
| topologyObjectType | string |
Algunos ejemplos son el sensor y el dispositivo. |
| Carga útil | string |
La carga útil de JSON que se envía con la notificación. |
Tipos de valores devueltos
Debajo se describen los modelos de respuesta devueltos por métodos auxiliares de referencia de cliente.
Space
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Space",
"friendlyName": "Conference Room",
"typeId": 0,
"parentSpaceId": "00000000-0000-0000-0000-000000000001",
"subtypeId": 0
}
Métodos del espacio
Parent() ⇒ space
Esta función devuelve el espacio primario del espacio actual.
ChildSensors() ⇒ sensor[]
Esta función devuelve los sensores secundarios del espacio actual.
ChildDevices() ⇒ device[]
Esta función devuelve los dispositivos secundarios del espacio actual.
ExtendedProperty(propertyName) ⇒ extendedProperty
Esta función devuelve la propiedad extendida y su valor para el espacio actual.
| Parámetro | Tipo | Descripción |
|---|---|---|
| propertyName | string |
Nombre de la propiedad extendida |
Value(valueName) ⇒ value
Esta función devuelve el valor del espacio actual.
| Parámetro | Tipo | Descripción |
|---|---|---|
| valueName | string |
Nombre del valor |
History(valueName) ⇒ value[]
Esta función devuelve los valores históricos del espacio actual.
| Parámetro | Tipo | Descripción |
|---|---|---|
| valueName | string |
Nombre del valor |
Notify(Payload)
Esta función envía una notificación con la carga útil especificada.
| Parámetro | Tipo | Descripción |
|---|---|---|
| payload | string |
la carga útil de JSON que se incluye en la notificación |
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"
}
Métodos de dispositivo
Parent() ⇒ space
Esta función devuelve el espacio primario del dispositivo actual.
ChildSensors() ⇒ sensor[]
Esta función devuelve los sensores secundarios del dispositivo actual.
ExtendedProperty(propertyName) ⇒ extendedProperty
Esta función devuelve la propiedad extendida y su valor para el dispositivo actual.
| Parámetro | Tipo | Descripción |
|---|---|---|
| propertyName | string |
Nombre de la propiedad extendida |
Notify(Payload)
Esta función envía una notificación con la carga útil especificada.
| Parámetro | Tipo | Descripción |
|---|---|---|
| payload | string |
la carga útil de JSON que se incluye en la notificación |
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
}
Métodos del sensor
Space() ⇒ space
Esta función devuelve el espacio primario del sensor actual.
Device() ⇒ device
Esta función devuelve el dispositivo primario del sensor actual.
ExtendedProperty(propertyName) ⇒ extendedProperty
Esta función devuelve la propiedad extendida y su valor para el sensor actual.
| Parámetro | Tipo | Descripción |
|---|---|---|
| propertyName | string |
Nombre de la propiedad extendida |
Value() ⇒ value
Esta función devuelve el valor del sensor actual.
History() ⇒ value[]
Esta función devuelve los valores históricos del sensor actual.
Notify(Payload)
Esta función envía una notificación con la carga útil especificada.
| Parámetro | Tipo | Descripción |
|---|---|---|
| payload | string |
la carga útil de JSON que se incluye en la notificación |
Valor
{
"dataType": "Temperature",
"value": "70",
"createdTime": ""
}
Propiedad extendida
{
"name": "OccupancyStatus",
"value": "Occupied"
}
Pasos siguientes
Obtenga más información sobre las funciones definidas por el usuario de Azure Digital Twins.
Obtenga información sobre la creación de funciones definidas por el usuario.
Obtenga información sobre la depuración de funciones definidas por el usuario.