Biblioteca de clientes com funções definidas pelo usuário
Importante
Uma nova versão do serviço dos Gêmeos Digitais do Azure foi lançada. À luz das funcionalidades expandidas do novo serviço, o serviço original dos Gêmeos Digitais do Azure (descrito neste conjunto de documentação) foi desativado.
Para exibir a documentação do novo serviço, visite a Documentação ativa dos Gêmeos Digitais do Azure.
Este documento fornece informações de referência para a biblioteca de clientes de funções definidas pelo usuário dos Gêmeos Digitais do Azure.
Métodos auxiliares
A biblioteca de clientes define os métodos auxiliares para as operações mais usadas.
getSpaceMetadata(id) ⇒ space
Dado um identificador de espaço, essa função recupera o espaço do grafo.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| id | guid |
Identificador de espaço |
getSensorMetadata(id) ⇒ sensor
Dado um identificador de sensor, essa função recupera o sensor do grafo.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| id | guid |
Identificador de sensor |
getDeviceMetadata(id) ⇒ device
Dado um identificador de dispositivo, essa função recupera o dispositivo do grafo.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| id | guid |
Identificador de dispositivo |
getSensorValue(sensorId, dataType) ⇒ value
Dado um identificador de sensor e o tipo de dados, essa função recupera o valor atual para esse sensor.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| sensorId | guid |
Identificador de sensor |
| dataType | string |
Tipo de dados de sensor |
getSpaceValue(spaceId, valueName) ⇒ value
Dado um identificador de espaço e o nome do valor, essa função recupera o valor atual para essa propriedade de espaço.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| spaceId | guid |
Identificador de espaço |
| valueName | string |
Nome da propriedade de espaço |
getSensorHistoryValues(sensorId, dataType) ⇒ value[]
Dado um identificador de sensor e o tipo de dados, essa função recupera os valores históricos desse sensor.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| sensorId | guid |
Identificador de sensor |
| dataType | string |
Tipo de dados de sensor |
getSpaceHistoryValues(spaceId, dataType) ⇒ value[]
Dado um identificador de espaço e o nome do valor, essa função recupera os valores históricos dessa propriedade no espaço.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| spaceId | guid |
Identificador de espaço |
| valueName | string |
Nome da propriedade de espaço |
getSpaceChildSpaces(spaceId) ⇒ space[]
Dado um identificador de espaço, essa função recupera os espaços filhos para esse espaço pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| spaceId | guid |
Identificador de espaço |
getSpaceChildSensors(spaceId) ⇒ sensor[]
Dado um identificador de espaço, essa função recupera os sensores filhos para esse espaço pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| spaceId | guid |
Identificador de espaço |
getSpaceChildDevices(spaceId) ⇒ device[]
Dado um identificador de espaço, essa função recupera os dispositivos filhos para esse espaço pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| spaceId | guid |
Identificador de espaço |
getDeviceChildSensors(deviceId) ⇒ sensor[]
Dado um identificador de dispositivo, essa função recupera os sensores filhos desse dispositivo pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| deviceId | guid |
Identificador de dispositivo |
getSpaceParentSpace(childSpaceId) ⇒ space
Dado um identificador de espaço, essa função recupera o espaço pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| childSpaceId | guid |
Identificador de espaço |
getSensorParentSpace(childSensorId) ⇒ space
Dado um identificador de sensor, essa função recupera o espaço pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| childSensorId | guid |
Identificador de sensor |
getDeviceParentSpace(childDeviceId) ⇒ space
Dado um identificador de dispositivo, essa função recupera o espaço pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| childDeviceId | guid |
Identificador de dispositivo |
getSensorParentDevice(childSensorId) ⇒ space
Dado um identificador de sensor, essa função recupera o dispositivo pai.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| childSensorId | guid |
Identificador de sensor |
getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty
Dado um identificador de espaço, essa função recupera a propriedade e o valor do espaço.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| spaceId | guid |
Identificador de espaço |
| propertyName | string |
Nome da propriedade de espaço |
getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty
Dado um identificador de sensor, esta função recupera a propriedade e o valor do sensor.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| sensorId | guid |
Identificador de sensor |
| propertyName | string |
Nome da propriedade do sensor |
getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty
Dado um identificador de dispositivo, essa função recupera a propriedade e o valor do dispositivo.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| deviceId | guid |
Identificador de dispositivo |
| propertyName | string |
Nome da propriedade do dispositivo |
setSensorValue(sensorId, dataType, value)
Essa função define um valor no objeto sensor com o tipo de dados dado.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| sensorId | guid |
Identificador de sensor |
| dataType | string |
Tipo de dados de sensor |
| value | string |
Valor |
setSpaceValue(spaceId, dataType, value)
Essa função define um valor no objeto de espaço com o tipo de dados fornecido.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| spaceId | guid |
Identificador de espaço |
| dataType | string |
Tipo de dados |
| value | string |
Valor |
log(message)
Essa função registra a seguinte mensagem dentro da função definida pelo usuário.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| message | string |
Mensagem a ser registrada em log |
sendNotification(topologyObjectId, topologyObjectType, payload)
Essa função envia uma notificação personalizada a ser despachada.
Tipo: função global
| Parâmetro | Type | Descrição |
|---|---|---|
| topologyObjectId | guid |
Identificador de objeto do grafo. Exemplos são espaço, sensor e ID do dispositivo. |
| topologyObjectType | string |
Exemplos são sensor e dispositivo. |
| Carga | string |
A carga útil JSON a ser enviada com a notificação. |
Tipos de retorno
Os modelos de resposta retornados de métodos auxiliares de referência do cliente são descritos abaixo.
Space
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Space",
"friendlyName": "Conference Room",
"typeId": 0,
"parentSpaceId": "00000000-0000-0000-0000-000000000001",
"subtypeId": 0
}
Métodos de espaço
Parent() ⇒ space
Essa função retorna o espaço pai do espaço atual.
ChildSensors() ⇒ sensor[]
Essa função retorna os sensores filhos do espaço atual.
ChildDevices() ⇒ device[]
Essa função retorna os dispositivos filhos do espaço atual.
ExtendedProperty(propertyName) ⇒ extendedProperty
Essa função retorna a propriedade estendida e o valor para o espaço atual.
| Parâmetro | Type | Descrição |
|---|---|---|
| propertyName | string |
Nome da propriedade estendida |
Value(valueName) ⇒ value
Essa função retorna o valor do espaço atual.
| Parâmetro | Type | Descrição |
|---|---|---|
| valueName | string |
Nome do valor |
History(valueName) ⇒ value[]
Essa função retorna os valores históricos do espaço atual.
| Parâmetro | Type | Descrição |
|---|---|---|
| valueName | string |
Nome do valor |
Notify(payload)
Essa função envia uma notificação com a carga especificada.
| Parâmetro | Type | Descrição |
|---|---|---|
| payload | string |
payload JSON a ser incluído na notificação |
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 do dispositivo
Parent() ⇒ space
Essa função retorna o espaço pai do dispositivo atual.
ChildSensors() ⇒ sensor[]
Essa função retorna os sensores filhos do dispositivo atual.
ExtendedProperty(propertyName) ⇒ extendedProperty
Essa função retorna a propriedade estendida e o valor para o dispositivo atual.
| Parâmetro | Type | Descrição |
|---|---|---|
| propertyName | string |
Nome da propriedade estendida |
Notify(payload)
Essa função envia uma notificação com a carga especificada.
| Parâmetro | Type | Descrição |
|---|---|---|
| payload | string |
payload JSON a ser incluído na notificação |
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 do sensor
Space() ⇒ space
Essa função retorna o espaço pai do sensor atual.
Device() ⇒ device
Essa função retorna o dispositivo pai do sensor atual.
ExtendedProperty(propertyName) ⇒ extendedProperty
Essa função retorna a propriedade estendida e o valor para o sensor atual.
| Parâmetro | Type | Descrição |
|---|---|---|
| propertyName | string |
Nome da propriedade estendida |
Value() ⇒ value
Essa função retorna o valor do sensor atual.
History() ⇒ value[]
Esta função retorna os valores históricos do sensor atual.
Notify(payload)
Essa função envia uma notificação com a carga especificada.
| Parâmetro | Type | Descrição |
|---|---|---|
| payload | string |
payload JSON a ser incluído na notificação |
Valor
{
"dataType": "Temperature",
"value": "70",
"createdTime": ""
}
Propriedade estendida
{
"name": "OccupancyStatus",
"value": "Occupied"
}
Próximas etapas
Aprenda sobre as funções definidas pelo usuário em Gêmeos Digitais do Azure.