Partager via

Informations de référence sur la bibliothèque cliente des fonctions définies par l’utilisateur

  • Article

Important

Une nouvelle version du service Azure Digital Twins a été publiée. En fonction des fonctionnalités étendues du nouveau service, le service Azure Digital Twins d’origine (décrit dans ce jeu de documentation) a été supprimé.

Pour afficher la documentation du nouveau service, consultez la documentation Azure Digital Twins active.

Ce document fournit des informations de référence pour la bibliothèque clients des fonctions définies par l’utilisateur Azure Digital Twins.

Méthodes d’assistance

La bibliothèque cliente définit les méthodes d’assistance pour les opérations couramment utilisées.

getSpaceMetadata(id) ⇒ space

À l’aide d’un identificateur d’espace, cette fonction récupère l’espace à partir du graphe.

Genre : fonction globale

Paramètre Type Description
id guid Identificateur d’espace

getSensorMetadata(id) ⇒ sensor

À l’aide d’un identificateur de capteur, cette fonction récupère le capteur à partir du graphe.

Genre : fonction globale

Paramètre Type Description
id guid Identificateur de capteur

getDeviceMetadata(id) ⇒ device

À l’aide d’un identificateur d’appareil, cette fonction récupère l’appareil à partir du graphe.

Genre : fonction globale

Paramètre Type Description
id guid Identificateur de l’appareil

getSensorValue(sensorId, dataType) ⇒ value

À l’aide d’un identificateur de capteur et de son type de données, cette fonction récupère la valeur actuelle de ce capteur.

Genre : fonction globale

Paramètre Type Description
sensorId guid Identificateur de capteur
dataType string Type de données du capteur

getSpaceValue(spaceId, valueName) ⇒ value

À l’aide d’un identificateur d’espace et du nom de la valeur, cette fonction récupère la valeur actuelle de cette propriété d’espace.

Genre : fonction globale

Paramètre Type Description
spaceId guid Identificateur d’espace
valueName string Nom de la propriété d’espace

de getSensorHistoryValues (sensorId, type de données) value[]

À l’aide d’un identificateur de capteur et de son type de données, cette fonction récupère les valeurs historiques de ce capteur.

Genre : fonction globale

Paramètre Type Description
sensorId guid Identificateur de capteur
dataType string Type de données du capteur

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

À l’aide d’un identificateur d’espace et du nom de la valeur, cette fonction récupère les valeurs historiques de cette propriété de l’espace.

Genre : fonction globale

Paramètre Type Description
spaceId guid Identificateur d’espace
valueName string Nom de la propriété d’espace

getSpaceChildSpaces(spaceId) ⇒ space[]

À l’aide d’un identificateur d’espace, cette fonction récupère les espaces enfants de cet espace parent.

Genre : fonction globale

Paramètre Type Description
spaceId guid Identificateur d’espace

getSpaceChildSensors(spaceId) ⇒ sensor[]

À l’aide d’un identificateur d’espace, cette fonction récupère les capteurs enfants de cet espace parent.

Genre : fonction globale

Paramètre Type Description
spaceId guid Identificateur d’espace

getSpaceChildDevices(spaceId) ⇒ device[]

À l’aide d’un identificateur d’espace, cette fonction récupère les appareils enfants de cet espace parent.

Genre : fonction globale

Paramètre Type Description
spaceId guid Identificateur d’espace

getDeviceChildSensors(deviceId) ⇒ sensor[]

À l’aide d’un identificateur d’appareil, cette fonction récupère les capteurs enfants de cet appareil parent.

Genre : fonction globale

Paramètre Type Description
deviceId guid Identificateur de l’appareil

getSpaceParentSpace(childSpaceId) ⇒ space

À l’aide d’un identificateur d’espace, cette fonction récupère son espace parent.

Genre : fonction globale

Paramètre Type Description
childSpaceId guid Identificateur d’espace

getSensorParentSpace(childSensorId) ⇒ space

À l’aide d’un identificateur de capteur, cette fonction récupère son espace parent.

Genre : fonction globale

Paramètre Type Description
childSensorId guid Identificateur de capteur

getDeviceParentSpace(childDeviceId) ⇒ space

À l’aide d’un identificateur d’appareil, cette fonction récupère son espace parent.

Genre : fonction globale

Paramètre Type Description
childDeviceId guid Identificateur de l’appareil

getSensorParentDevice(childSensorId) ⇒ space

À l’aide d’un identificateur de capteur, cette fonction récupère son appareil parent.

Genre : fonction globale

Paramètre Type Description
childSensorId guid Identificateur de capteur

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

À l’aide d’un identificateur d’espace, cette fonction récupère la propriété et sa valeur à partir de l’espace.

Genre : fonction globale

Paramètre Type Description
spaceId guid Identificateur d’espace
propertyName string Nom de la propriété d’espace

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

À l’aide d’un identificateur de capteur, cette fonction récupère la propriété et sa valeur à partir du capteur.

Genre : fonction globale

Paramètre Type Description
sensorId guid Identificateur de capteur
propertyName string Nom de propriété de capteur

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

À l’aide d’un identificateur d’appareil, cette fonction récupère la propriété et sa valeur à partir de l’appareil.

Genre : fonction globale

Paramètre Type Description
deviceId guid Identificateur de l’appareil
propertyName string Nom de propriété d’appareil

setSensorValue(sensorId, dataType, value)

Cette fonction définit une valeur pour l’objet de capteur avec le type de données indiqué.

Genre : fonction globale

Paramètre Type Description
sensorId guid Identificateur de capteur
dataType string Type de données du capteur
value string Valeur

setSpaceValue(spaceId, dataType, value)

Cette fonction définit une valeur pour l’objet d’espace avec le type de données indiqué.

Genre : fonction globale

Paramètre Type Description
spaceId guid Identificateur d’espace
dataType string Type de données
value string Valeur

log(message)

Cette fonction journalise le message suivant dans la fonction définie par l’utilisateur.

Genre : fonction globale

Paramètre Type Description
message string Message à journaliser

sendNotification(topologyObjectId, topologyObjectType, payload)

Cette fonction envoie une notification personnalisée à distribuer.

Genre : fonction globale

Paramètre Type Description
topologyObjectId guid Identificateur d’objet de graphe. Exemples : espace, capteur et ID d’appareil.
topologyObjectType string Exemples : capteur et appareil.
Charge string Charge utile JSON à envoyer avec la notification.

Types de retour

Les modèles de réponse renvoyés par les méthodes d’assistance de référence du client sont décrits ci-dessous.

Espace

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

Méthodes d’espace

Parent() ⇒ space

Cette fonction retourne l’espace parent de l’espace actuel.

ChildSensors() ⇒ sensor[]

Cette fonction retourne les capteurs enfants de l’espace actuel.

ChildDevices() ⇒ device[]

Cette fonction retourne les appareils enfants de l’espace actuel.

ExtendedProperty(propertyName) ⇒ extendedProperty

Cette fonction retourne la propriété étendue et sa valeur pour l’espace actuel.

Paramètre Type Description
propertyName string Nom de la propriété étendue

Value(valueName) ⇒ value

Cette fonction retourne la valeur de l’espace actuel.

Paramètre Type Description
valueName string Nom de la valeur

History(valueName) ⇒ value[]

Cette fonction retourne les valeurs historiques de l’espace actuel.

Paramètre Type Description
valueName string Nom de la valeur

Notify(payload)

Cette fonction envoie une notification avec la charge utile spécifiée.

Paramètre Type Description
payload string Charge utile JSON à inclure dans la notification

Appareil

{
  "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éthodes d’appareil

Parent() ⇒ space

Cette fonction retourne l’espace parent de l’appareil actuel.

ChildSensors() ⇒ sensor[]

Cette fonction retourne les capteurs enfants de l’appareil actuel.

ExtendedProperty(propertyName) ⇒ extendedProperty

Cette fonction retourne la propriété étendue et sa valeur pour l’appareil actuel.

Paramètre Type Description
propertyName string Nom de la propriété étendue

Notify(payload)

Cette fonction envoie une notification avec la charge utile spécifiée.

Paramètre Type Description
payload string Charge utile JSON à inclure dans la notification

Capteur

{
  "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éthodes de capteur

Space() ⇒ space

Cette fonction retourne l’espace parent du capteur actuel.

Device() ⇒ device

Cette fonction retourne l’appareil parent du capteur actuel.

ExtendedProperty(propertyName) ⇒ extendedProperty

Cette fonction retourne la propriété étendue et sa valeur pour le capteur actuel.

Paramètre Type Description
propertyName string Nom de la propriété étendue

Value() ⇒ value

Cette fonction retourne la valeur du capteur actuel.

History() ⇒ value[]

Cette fonction retourne les valeurs historiques du capteur actuel.

Notify(payload)

Cette fonction envoie une notification avec la charge utile spécifiée.

Paramètre Type Description
payload string Charge utile JSON à inclure dans la notification

Valeur

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

Propriété étendue

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

Étapes suivantes