Compartilhar via

Referência da biblioteca cliente de 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 acessar a documentação do novo serviço, consulte a Documentação Ativa do Azure Digital Twins .

Este documento fornece informações de referência para a biblioteca de cliente das funções definidas pelo usuário do Azure Digital Twins.

Métodos auxiliares

A biblioteca de clientes define métodos auxiliares para operações comumente 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 Tipo 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 Tipo Descrição
ID guid Identificador do sensor

getDeviceMetadata(id) ⇒ device

Dado um identificador de dispositivo, essa função recupera o dispositivo do grafo.

Tipo: função global

Parâmetro Tipo Descrição
ID guid Identificador de dispositivo

getSensorValue(sensorId, dataType) ⇒ value

Dado um identificador de sensor e seu tipo de dados, essa função recupera o valor atual desse sensor.

Tipo: função global

Parâmetro Tipo Descrição
sensorId guid Identificador do sensor
Datatype string Tipo de dados do sensor

getSpaceValue(spaceId, valueName) ⇒ value

Dado um identificador de espaço e o nome do valor, esta função recupera o valor atual para essa propriedade de espaço.

Tipo: função global

Parâmetro Tipo Descrição
spaceId guid Identificador de espaço
valueName string Nome da propriedade espaço

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

Dado um identificador de sensor e seu tipo de dados, essa função recupera os valores históricos desse sensor.

Tipo: função global

Parâmetro Tipo Descrição
sensorId guid Identificador do sensor
Datatype string Tipo de dados do 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 Tipo Descrição
spaceId guid Identificador de espaço
valueName string Nome da propriedade do espaço

getSpaceChildSpaces(spaceId) ⇒ space[]

Dado um identificador de espaço, essa função recupera os espaços filhos associados ao espaço pai correspondente.

Tipo: função global

Parâmetro Tipo 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 o espaço pai.

Tipo: função global

Parâmetro Tipo Descrição
spaceId guid Identificador de espaço

getSpaceChildDevices(spaceId) ⇒ device[]

Dado um identificador de espaço, essa função recupera os dispositivos associados a esse espaço pai.

Tipo: função global

Parâmetro Tipo Descrição
spaceId guid Identificador de espaço

getDeviceChildSensors(deviceId) ⇒ sensor[]

Dado um identificador de dispositivo, essa função recupera os sensores filho para esse dispositivo pai.

Tipo: função global

Parâmetro Tipo Descrição
deviceId guid Identificador de dispositivo

getSpaceParentSpace(childSpaceId) ⇒ space

Dado um identificador de espaço, essa função recupera seu espaço de origem.

Tipo: função global

Parâmetro Tipo Descrição
childSpaceId guid Identificador de espaço

getSensorParentSpace(childSensorId) ⇒ space

Dado um identificador de sensor, essa função recupera seu espaço pai.

Tipo: função global

Parâmetro Tipo Descrição
childSensorId guid Identificador do sensor

getDeviceParentSpace(childDeviceId) ⇒ space

Dado um identificador de dispositivo, essa função recupera o espaço pai.

Tipo: função global

Parâmetro Tipo Descrição
childDeviceId guid Identificador de dispositivo

getSensorParentDevice(childSensorId) ⇒ space

Dado um identificador de sensor, essa função recupera seu dispositivo pai.

Tipo: função global

Parâmetro Tipo Descrição
childSensorId guid Identificador do sensor

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

Dado um identificador de espaço, essa função recupera a propriedade e seu valor do espaço.

Tipo: função global

Parâmetro Tipo Descrição
spaceId guid Identificador de espaço
nomeDaPropriedade string Nome da propriedade espacial

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

Dado um identificador de sensor, essa função recupera a propriedade e seu valor do sensor.

Tipo: função global

Parâmetro Tipo Descrição
sensorId guid Identificador do sensor
nomeDaPropriedade string Nome da propriedade do sensor

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

Dado um identificador de dispositivo, essa função recupera a propriedade e seu valor do dispositivo.

Tipo: função global

Parâmetro Tipo Descrição
deviceId guid Identificador de dispositivo
nomeDaPropriedade string Nome da propriedade do dispositivo

setSensorValue(sensorId, dataType, value)

Essa função define um valor no objeto do sensor com o tipo de dados fornecido.

Tipo: função global

Parâmetro Tipo Descrição
sensorId guid Identificador do sensor
Datatype string Tipo de dados do sensor
o valor 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 Tipo Descrição
spaceId guid Identificador de espaço
Datatype string Tipo de dados
o valor string Valor

log(mensagem)

Essa função registra a mensagem a seguir dentro da função definida pelo usuário.

Tipo: função global

Parâmetro Tipo Descrição
Mensagem string Mensagem a ser registrada

sendNotification(topologyObjectId, topologyObjectType, payload)

Essa função envia uma notificação personalizada para ser expedida.

Tipo: função global

Parâmetro Tipo Descrição
topologyObjectId guid Identificador de objeto do Graph. Exemplos são espaço, sensor e ID do dispositivo.
topologyObjectType string Exemplos são sensor e dispositivo.
carga útil string O conteúdo JSON a ser enviado com a notificação.

Tipos de retorno

Os modelos de resposta retornados dos métodos auxiliares de referência do cliente são descritos abaixo.

Espaço

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

Métodos espaciais

Parent() ⇒ space

Essa função retorna o espaço pai do espaço em questão.

ChildSensors() ⇒ sensor[]

Essa função retorna os sensores filho do espaço atual.

ChildDevices() ⇒ device[]

Essa função retorna os dispositivos filho do espaço atual.

ExtendedProperty(propertyName) ⇒ extendedProperty

Essa função retorna a propriedade estendida e seu valor para o espaço atual.

Parâmetro Tipo Descrição
nomeDaPropriedade string Nome da propriedade estendida

Value(valueName) ⇒ value

Essa função retorna o valor do espaço atual.

Parâmetro Tipo Descrição
valueName string Nome do valor

History(valueName) ⇒ value[]

Essa função retorna os valores históricos do espaço atual.

Parâmetro Tipo Descrição
valueName string Nome do valor

Notificar(carga útil)

Essa função envia uma notificação com a carga útil especificada.

Parâmetro Tipo Descrição
carga útil string Conteúdo 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 de dispositivo

Parent() ⇒ space

Essa função retorna o espaço pai do dispositivo atual.

ChildSensors() ⇒ sensor[]

Essa função retorna os sensores filho do dispositivo atual.

ExtendedProperty(propertyName) ⇒ extendedProperty

Essa função retorna a propriedade estendida e seu valor para o dispositivo atual.

Parâmetro Tipo Descrição
nomeDaPropriedade string Nome da propriedade estendida

Notificar(carga útil)

Essa função envia uma notificação com a carga útil especificada.

Parâmetro Tipo Descrição
carga útil string Conteúdo 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 de sensor

Espaço() ⇒ space

Essa função retorna o espaço pai do sensor em operação.

Dispositivo() ⇒ device

Essa função retorna o dispositivo pai do sensor atual.

ExtendedProperty(propertyName) ⇒ extendedProperty

Essa função retorna a propriedade estendida e seu valor para o sensor atual.

Parâmetro Tipo Descrição
nomeDaPropriedade string Nome da propriedade estendida

Value() ⇒ value

Essa função retorna o valor do sensor atual.

Histórico() ⇒ value[]

Essa função retorna os valores históricos do sensor atual.

Notificar(carga útil)

Essa função envia uma notificação com o payload especificado.

Parâmetro Tipo Descrição
carga útil string Conteúdo JSON a ser incluído na notificação

Valor

{
  "dataType": "Temperature",
  "value": "70",
  "createdTime": ""
}

Propriedade estendida

{
  "name": "OccupancyStatus",
  "value": "Occupied"
}

Próximas etapas

  • Last updated on