API Tutoriel 3 : création d'une heatmap dynamique

Prérequis

Objectifs

Nous avons un objectif dans ce tutoriel :

  • mettre à jour en temps réel une donnée de confort ou de qualité de l'aire sur une salle et visualiser les modifications en temps réel

Mettre a jour, en temps réel, une valeur de température, de présence...

Requêtes utiles

GET api/v1/context/list

GET api/v1/context/{dynamic_id}/tree

GET api/v1/node/{dynamic_id}/control_endpoint_list

POST api/v1/endpoint/{dynamic_id}/update (value)

Démarche

Nous avons vu dans les exemples précédent comment récupérer les données sur des contextes déjà identifiés. Nous montrons dans ce tuto comment accéder à n'importe quelle arborescence de données pré-paramétré dans le jumeau numérique Spinalcore. Deux étapes sont nécessaires :

  • identifiez-vous sur le serveur d'API (sur les versions "sandbox" cette étape n'est pas nécessaire pour tester l'API)

  • récupérez la liste des contextes (arborescences) auxquelles vous avez accès dans le jumeau numérique

GET "http://adresse_de_votre_serveur/api/v1/context/list"

  • sélectionnez la "dynamic_id" du contexte de groupe de pièce particulier que vous avez paramétré lors de la phase d'intégration des heatmap et récupérez l'arborescence complète associé :

GET "http://adresse_de_votre_serveur/api/v1/context/{dynamic_id}/tree"

Vous avez maintenant la liste des pièces sur lesquels des heatmap ont été paramétrées. Ces pièces ont donc des "points de contrôle" et des "séries temporelles "associés. Nous pouvons modifier la valeur de ce point de contrôle (équivalent à un point de mesure IoT)

  • recherchez votre pièce dans l'arborescence, récupérez sa "dynamic_id" puis appelez la requête de récupération des points de contrôle sur cette pièce

GET "http://adresse_de_votre_serveur/api/v1/node/{dynamic_id}/control_endpoint_list"

  • Vous pouvez ensuite modifier la valeur de ce point IoT avec l'API suivante :

POST "http://adresse_de_votre_serveur/api/v1/endpoint/{dynamic_id}/update " la valeur numérique est passée en paramètre de la méthode POST.

Résultat

Sur le Studio Spinalcore, activez la heatmap sur le groupe de pièce construit. La modification de la valeur du point de contrôle (température, présence...) entraine la mise à jour en temps réel de la couleur associée à la pièce, comme sur l'illustration précédente.