FICHE TECHNIQUE MS Définition de l API Web Service

Transcription

1 FICHE TECHNIQUE MS Définition de l API Web Service Fiche Technique Référence MS Edition 10/2013

2 API Web Services ELOG - Page 2 REVISIONS Rédacteur Vérificateur Approbateur 30/07/13 06/08/13 XBA-09 FLA-09 EDITION Nombre REFERENCES OBJET DE LA MISE A JOUR de pages Page Chapitre Création à partir de doc[1] Ajout d un paragraphe d introduction à ELOG de présentation technique Renommage de termes techniques et fonctionnels. Suppression de pages avec des web services non présents ou non utilisés dans ELOG

3 API Web Services ELOG - Page 3 Contenu 1. Documents (Bibliographie) Documents de référence AVANT PROPOS Qu est-ce que ELOG Entrées / Sorties sur ELOG Données accessibles dans ELOG Mapping Web Services / Exigences Fonctionnelles Généralité sur l architecture Avertissements Web-Services disponibles Tableau des web services disponibles Définition des ressources Ports de communication : Ports RS Configuration du port Ethernet (port C) Entrées TOR Description Consultation de la liste des ETOR Consultation d une ETOR Consultation de la liste des variables d une ETOR Consultation / Mise à Jour unitaire de la configuration de la variable des ETORS Sortie TOR Description Gestion de la liste des Sorties TOR Création / Consultation / Mise à Jour / Suppression unitaire d une sortie TOR Drivers Consultation de la liste des drivers Création / modification / Consultation / Suppression d un Driver Gestion des variables d un driver Gestion des variables Composite d un driver Points de Mesure Consultation des Points de Mesure Configuration d un Point de Mesure Télé relève des données instantanées et enregistrées d un Point de Mesure Télé relève des valeurs des variables simples d un Point de Mesure Télé relève des valeurs des variables composées d un Point de Mesure Système : Heure du système Moteur de télé-relèves Statistiques Numéro de série Langue des pages web embarquées Adresse MAC...61

4 API Web Services ELOG - Page Firmware Reboot elog Versions logicielles Consultation / Modification état sortie TOR Consultation firmware / Chargement firmware / Rechargement firmware...67

5 API Web Services ELOG - Page 5 1. Documents (Bibliographie) 1.1. Documents de référence Référence Statut Auteurs [1] N03652_DCS_S1_09 - Web Service REST Document Interne FLA

6 API Web Services ELOG - Page 6 2. AVANT PROPOS Les informations contenues dans cette Fiche Technique sont uniquement destinées aux programmeurs désirant exploiter les informations et données en temps réel et enregistrées par «ELOG web-box data logger» via les web services. Avec pour objectif une exploitation par un logiciel tiers, connecté sur réseau Ethernet et via le protocole HTTP.

7 API Web Services ELOG - Page 7 3. Qu est-ce que ELOG ELOG est une unité de centralisation, de collecte, d enregistrement automatique et de supervision de données issues d équipements communicants multifonction et multimarque (compteurs d énergie, centrales de mesure électriques, convertisseurs, capteurs, sondes, automates...) ELOG est équipé de nombreux moyens de communication pour l acquisition des données et l exploitation. 5 Entrées TOR mode impulsions : o pour la relève des index de compteurs à sortie impulsion (eau, gaz, électricité ). 1 port de communication Ethernet pour plusieurs utilisations : o mode maitre Modbus : lecture en temps réel et enregistrement périodique des valeurs de variables issues d équipements multi-fonctions et multi-marques communicants aux protocoles Modbus RS485, ModbusTCP et Modbus encapsulé TCP. o serveur web : configuration du produit ELOG et consultation en temps réel des valeurs des variables des équipements Modbus/TCP, à partir de pages web embarquées ; o réseau Ethernet : intégration dans un réseau Ethernet global pour une exploitation à distance et multi-produits ELOG via le protocole HTTP, par le biais de web Services (supervision avec E. Online, Télé-relève et affichage par tableur ). 2 ports de communication numérique maîtres de type RS485 : o mode maitre Modbus RTU : lecture en temps réel et enregistrement périodique des valeurs de variables issues d équipements multi-fonctions et multi-marques communicants au protocole Modbus RTU. 1 interface de communication optique : connectivité réservée à la maintenance constructeur.

8 API Web Services ELOG - Page 8 4. Entrées / Sorties sur ELOG

9 API Web Services ELOG - Page 9 5. Données accessibles dans ELOG 2 TYPES de DONNÉES : o INDEX : cumul d une grandeur sur la durée (ex : index de compteur) o ANALOGIQUE : valeur moyenne, instantanée, (ex : température extérieure) MODES D ACCÈS AUX DONNÉES : o en temps réel sur les variables mesurées par les équipements distants (4000 variables) o en télé-relève sur les données enregistrées (sur 50 variables) PÉRIODICITÉ des ENREGISTREMENTS programmée à la création du Point de Mesure : o INDEX : toutes les 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30 et 60 minutes o ANALOGIQUE : toutes les 5, 6, 10, 12, 15, 20, 30, 60, 120, 180, 240, 300, 360, 600, 720, 900, 1200, 1800 ou 3600 secondes o Nombre de variables en mode enregistrement : 50 PROFONDEUR MÉMOIRE : o 3 mois sur les données pour les périodicités 1 minute o 3 jours sur les données pour les périodicités < 1 minute

10 API Web Services ELOG - Page Mapping Web Services / Exigences Fonctionnelles 6.1. Généralité sur l architecture Ce paragraphe regroupe les services web RESTful de Elog. Il a pour but de spécifier les requêtes et les réponses de tous les services web implémentés dans Elog web server. Conventions : indique une requête envoyée par le client pour Elog (corps de la requête) indique une réponse envoyée par Elog pour le client (corps de la requête) l'uri de base pour accéder aux services web est les données sont échangées au format JSON le type string à une taille MAX de 50 caractères si non précisée. les services web utilisent les méthodes HTTP suivantes : : pour récupérer une ressource : pour créer une ressource : pour modifier une ressource DELETE : pour supprimer une ressource De plus, les codes de statut suivants sont possiblement retournés : OK (OK) (Created) (Non content) Code erreur (bad Request) (Unauthorised) (forbidden) (Not found) (Method Not Allowed) (Not Acceptable) (Timeout) (Conflict) (Internal Server Error)

11 API Web Services ELOG - Page Avertissements Dans ce document, une URI peut être composée d un ou plusieurs paramètres placés entre guillemets (ex : ID_device, ID_variable, years ). Ces paramètres doivent être remplacés par un nombre entier décimal pouvant aller de 0 à Ex : ID_device /values/variables/ ID_variable /raw/ année peut devenir

12 API Web Services ELOG - Page Web-Services disponibles Les différents web-services disponibles dans ELOG sont : o Lire / Modifier l heure système o Lire les paramètres système (firmaware, n de série, version, ) o Lire / Modifier les paramètres de communication des ports RS485 A et B o Lire / Modifier les paramètres de communication du port Ethernet o Lire / Modifier les paramètres des 5 entrées T.O.R impulsion o Lire / Modifier les paramètres de la sortie T.O.R o Lire / Créer / Modifier / Supprimer un driver o Lire / Créer / Modifier / Supprimer une variable simple d un driver o Lire / Créer / Modifier / Supprimer une variable composite d un driver o Lire / Créer / Modifier / Supprimer les paramètres d un Point de Mesure o Lire la valeur en temps réel d une variable simple ou composée d un Point de Mesure o Lire / Supprimer les données enregistrées sur une variable simple ou composée

13 8. Tableau des web services disponibles Paramètres Système Heure Produit API Web Services ELOG - Page 13 Heure UTC Produit Heure locale Produit : Obtenir l heure UTC du système et le timezone : Configurer l heure UTC du système et le timezone : Obtenir l heure locale du système Ports de communication Ports RS485 A et B Port Ethernet Liste des entrées TOR Consulter une entrée TOR Liste des variables d'une entrée TOR Configurati on de la variable d'une entrée TOR : Obtenir la configuration du port A ou B : Configurer le port A ou B : Obtenir la configuration du port C : Configurer le port C Entrées TOR impulsions : Obtenir la liste des ETOR configurables ID_din : Consulter une ETOR ID_din /variables : Obtenir la liste de variables d une ETOR ID_din /variables/1 : Obtenir la configuration de la variable 1 de l ETOR : Met à jour la configuration de la variable 1 de l ETOR Sortie TOR : Obtenir la liste des sorties TOR : Obtenir la configuration d une sortie TOR : Met à jour la configuration de la sortie TOR : Obtenir l état de la sortie TOR 1

14 API Web Services ELOG - Page 14 : Modifier l état de la sortie TOR 1 Driver / Variables simples Driver : Obtenir la liste des drivers DELETE : Suppression de tous les drivers ID_driver : Obtenir la description du driver : Créer un driver : Modifier un driver DELETE : Supprimer un driver et ses variables simples et composées Variables Simples ID_driver /variables : Obtenir la liste des variables simples du driver DELETE : Suppression de toutes les variables simples du driver ID_driver /variables/ ID_variable : Obtenir la description d une variable simple : Créer une variable simple : Modifier une variable simple DELETE : Suppression d'une variable simple Variables Composées ID_driver /composites : Obtenir la liste des variables composées du driver DELETE : Suppression de toutes les variables composées du driver ID_driver /composites/ ID_composite : Obtenir la description d une variable composée du driver : Créer une variable composée : Modifier une variable composée DELETE : Suppression de la variable composée Points de Mesure : Obtenir la liste des Points de Mesure DELETE : Suppression de tous les Points de Mesure ID_device : Obtenir la description d un Point de Mesure DELETE : Suppression d un Point de Mesure ID_device /conf : Obtenir la configuration d un Point de Mesure : Créer un Point de Mesure : Modifier la configuration d un Point de Mesure Moteur de Télé-relève : Obtenir l état (actif ou inactif) du moteur de télé-relèves : Modifier l état (actif ou inactif) du moteur de télé-relèves

15 API Web Services ELOG - Page 15 : Obtenir les statistiques Statistiques Numéro de série : Obtenir les numéros de série Langues : Obtenir la langue des pages web embarquées : Modifier la langue des pages web embarquées Adresse MAC : Obtenir l adresse MAC Firmware : Consulter le firmware : Charger le firmware : Recharger le firmware : Recharger le firmware : Consultation reboot : Effectuer un reboot de Elog : Obtenir la version logicielle : Effectuer un reboot de Elog Reboot ELOG Versions logicielles Exploitation des données instantanées et enregistrées Points de Mesure Variables simples et composées Liste des types de données accessibles pour une ID_device /values : Obtenir le lien des variables simples et composées d un Point de Mesure DELETE : Suppression de tous les enregistrements de toutes les variables simples et composées du Point de Mesure) ID_device /values : Obtenir la liste des variables simples du Point de Mesure ID_device /values/variables/ ID_variable

16 API Web Services ELOG - Page 16 variable simple Acccès aux données enregistrées sur une variable simple : Obtenir un lien pour chaque type de donnée d une variable simple du Point de Mesure ID_device /values/variables/ ID_variable /raw : Obtenir un lien pour chaque année avec des enregistrements d une variable simple du Point de Mesure DELETE : Supprimer tous les enregistrements d une variable simple du Point de Mesure ID_device /values/variables/ ID_variable /raw/ année' : Obtenir un lien pour chaque mois d une année avec des enregistrements d une variable simple du Point de Mesure ID_device /values/variables/ ID_variable /raw/ année'/ mois : Obtenir un lien pour chaque jour d un mois avec des enregistrements d une variable simple du Point de Mesure DELETE : Suppression de tous les enregistrements du mois du Point de Mesure ID_device /values/variables/ ID_variable /raw/ année'/ mois / jour : Obtenir un lien pour chaque heure d une journée avec des enregistrements d une variable simple du Point de Mesure DELETE : Suppression de tous les enregistrements de la journée du Point de Mesure ID_device /values/variables/ ID_variable /raw/ année / mois / jour / heure / : Obtenir un lien vers la liste des pages contenant les enregistrements d une variable simple d un Point de Mesure. DELETE : Suppression de tous les enregistrements de la journée du Point de Mesure ID_device /values/variables/ ID_variable /raw/ année / mois / jour / heure /p ages : Obtenir la liste des pages contenant les enregistrements d une variable simple d un Point de Mesure sur 1 heure ID_device /values/variables/ ID_variable /raw/ année / mois / jour / heure /p ages/ ID_page : Obtenir la liste des enregistrements horodatés d une page d une variable simple d un Point de Mesure Acccès aux données instantanée s sur une variable simple Acccès aux données enregistrées sur une variable composée ID_device /values/variables/ ID_variable /instant : Obtenir la valeur instantanée d une variable simple d un Point de Mesure ID_device /values/variables/ ID_composite /raw : Obtenir un lien pour chaque année avec des enregistrements d une variable simple du Point de Mesure DELETE : Supprimer tous les enregistrements d une variable simple du Point de Mesure ID_device /values/variables/ ID_composite /raw/ année' : Obtenir un lien pour chaque mois d une année avec des enregistrements d une variable simple du Point de Mesure ID_device /values/variables/ ID_composite /raw/ année'/ mois : Obtenir un lien pour chaque jour d un mois avec des enregistrements d une variable simple du Point de Mesure DELETE : Suppression de tous les enregistrements du mois du Point de Mesure

17 API Web Services ELOG - Page 17 ID_device /values/variables/ ID_composite /raw/ année'/ mois / jour : Obtenir un lien pour chaque heure d une journée avec des enregistrements d une variable simple du Point de Mesure DELETE : Suppression de tous les enregistrements de la journée du Point de Mesure ID_device /values/variables/ ID_composite /raw/ année / mois / jour / heure / : Obtenir un lien vers la liste des pages contenant les enregistrements d une variable simple d un Point de Mesure. DELETE : Suppression de tous les enregistrements de la journée du Point de Mesure ID_device /values/variables/ ID_composite /raw/ année / mois / jour / heure /pages : Obtenir la liste des pages contenant les enregistrements d une variable simple d un Point de Mesure sur 1 heure ID_device /values/variables/ ID_composite /raw/ année / mois / jour / heure /pages/ ID_page : Obtenir la liste des enregistrements horodatés d une page d une variable simple d un Point de Mesure

18 API Web Services ELOG - Page Définition des ressources 9.1. Ports de communication : Cet ensemble de Web services permet de configurer un port RS 485 : - Définition du Mode : Maître ou Esclave - Paramétrage du port : Selon son Mode Ports RS Configuration du Port A Le port A est un port RS485. Il utilise l ensemble des Web Service pour la configuration d un port RS Configuration du Port B Le port B est un port RS485. Il utilise l ensemble des Web Service pour la configuration d un port RS 485

19 API Web Services ELOG - Page Implémentation Ressource Port A : Ressource Port B : Obtenir la configuration du port Status OK : 200 Status KO : 404, modem : {booléen} [SI modem = true ALORS] - modem_params : - hayes : {string} (Commande d init du modem) - hang_up : {entier} (valeur en ms) - mode : {entier (0,1)} (Maître, Esclave) - speed : {entier (300,600,1200,2400,4800,9600,19200,38400,115200)} - stop_bits : {entier (1,2)} - parity : {entier (0,1,2)} (sans, odd, even) - timeout : {entier} (valeur en ms [0 ;120000]) - transmission_delay : {entier} (temps minimum entre 2 télérelèves. valeur en ms [0 ; 1000]) Configurer le port DELETE - modem : {booléen} [SI modem = true ALORS] - modem_params : - hayes : {string} (Commande d init du modem) - hang_up : {entier} (valeur en ms) - mode : {entier (0,1)} (Maître, Esclave) - speed : {entier (300,600,1200,2400,4800,9600,19200,38400,115200)} - stop_bits : {entier (1,2)} - parity : {entier (0,1,2)} (sans, odd, even) - timeout : {entier} (valeur en ms [0 ;120000]) - transmission_delay : {entier} (temps minimum entre 2 télérelèves. valeur en ms [0 ; 1000]) Status OK : 200 Status KO : 400, 403, 404, 500

20 API Web Services ELOG - Page Configuration du port Ethernet (port C) Description Cet ensemble de Web service permet de configurer le port Ethernet Implémentation Ressource : Obtenir la configuration du port Status OK : 200 Status KO : 404, hostname : {string} - type : {entier (0,1)} (dhcp, static) [SI type = 1] - ip : {string (X.X.X.X)} (X entre 0 et 255) - netmask : {string (X.X.X.X)} (X entre 0 et 255) - gateway : {string (X.X.X.X)} (X entre 0 et 255) (option) - dns : {string (X.X.X.X)} (X entre 0 et 255) (option) - ntp : {string} (option) - smtp : {string}(option) - timeout : {entier} (valeur en ms [0;5000]) Configurer le port DELETE - hostname : {string} - type : {entier (0,1)} (dhcp, static) [SI type = 1] - ip : {string (X.X.X.X)} (X entre 0 et 255) - netmask : {string (X.X.X.X)} (X entre 0 et 255) - gateway : {string (X.X.X.X)} (X entre 0 et 255) (option) - dns : {string (X.X.X.X)} (X entre 0 et 255) (option) - ntp : {string} (option) - smtp : {string} (option) - timeout : {entier} (valeur en ms [0;5000]) Status OK : 200 Status KO : 400, 403, 404, 500

21 API Web Services ELOG - Page Entrées TOR Description Gestion de ETOR 1 Cet ensemble de Web service permet de gérer l entrée TOR Gestion de ETOR 2 Cet ensemble de Web service permet de gérer l entrée TOR Gestion de ETOR 3 Cet ensemble de Web service permet de gérer l entrée TOR Gestion de ETOR 4 Cet ensemble de Web service permet de gérer l entrée TOR Gestion de ETOR 5 Cet ensemble de Web service permet de gérer l entrée TOR5

22 Consultation de la liste des ETOR API Web Services ELOG - Page 22 Ressource ETOR : Obtenir la liste des ETOR configurables Status OK : {200} Status KO : {404, 500} - dins : {tableau de strings} (tableau d URI des entrées TOR) ex : dins : { /rest/dins/1, /rest/dins/2, /rest/dins/3, /rest/dins/4, /rest/dins/5 } Status KO : {405} DELETE Status KO : {405} Status KO : {405}

23 Consultation d une ETOR API Web Services ELOG - Page 23 Ressource ETOR : ID_din Consulter une ETOR Status OK : {200} Status KO : {404, 500} - variables : {string} URI de la liste des variables de l ETOR ex : variables : /rest/dins/ ID_din /variables Status KO : {405} DELETE Status KO : {405} Status KO : {405}

24 API Web Services ELOG - Page Consultation de la liste des variables d une ETOR Ressource ETOR : ID_din /variables Obtenir la liste de variables d une ETOR Status OK : {200} Status KO : {404, 500} - variables : {tableau de strings} tableau d URI de la variable de l ETOR ex : variables : { /rest/dins/ ID_din /variables/1 } Status KO : {405} DELETE Status KO : {405} Status KO : {405}

25 API Web Services ELOG - Page Consultation / Mise à Jour unitaire de la configuration de la variable des ETORS Ressource : ID_din /variables/1 Obtenir la configuration de la variable 1 de l ETOR Status OK : {200} Status KO : {404, 500} - label : {string} - mode : {entier (0)} (comptage) - unit : {string} (unité de l index) - authorize_history : - {boolean (true)} - curve_unit : {string} (unité de la courbe de charge) - {boolean (false)} - pulse_weight : {entier}(poids de l impulsion en 1/10000 e de l unité) - used_by_device : {booléen} Status KO : {405} Met à jour la configuration de la variable 1 de l ETOR - label : {string} - mode : {entier (0)} (comptage) - unit : {string} (unité de l index) - authorize_history : - {boolean (true)} - curve_unit : {string} (unité de la courbe de charge) - {boolean (false)} - index_value : {entier non signé} (en 1/10000 e de l unité) (option) - pulse_weight : {entier non signé}(poids de l impulsion en 1/10000 e de l unité) DELETE /!\ le web service ne permet pas de changer : - mode Status OK : {200} Status KO : {400, 403, 404, 500} Status KO : {405}

26 API Web Services ELOG - Page Sortie TOR Description Cet ensemble de web service permet de gérer la sortir TOR Gestion de la liste des Sorties TOR Malgré le fait qu il n y ait qu une seule et unique STOR, la gestion est sous forme de liste Ressource : Obtenir la liste des sorties TOR Status OK : {200} Status KO : {404, 500} - douts : {tableau de strings} (tableau d URI des sorties TOR) DELETE Status KO : {405}

27 API Web Services ELOG - Page Création / Consultation / Mise à Jour / Suppression unitaire d une sortie TOR Ressource : Obtenir la configuration d une sortie TOR Status OK : {200} Status KO : {404, 500} - label : {string} - mode : {entier (0, 1)} (inactif, alarme) - initial_state : {entier (0,1)}(NO,NF) Met à jour la configuration de la sortie TOR DELETE - label : {string} - mode : {entier (0, 1)} (inactif, alarme) - initial_state : {entier (0,1)}(NO,NF) Status OK : {200} Status KO : {400, 403, 404, 500}

28 API Web Services ELOG - Page Drivers Consultation de la liste des drivers Ressource : Obtenir la liste des drivers Status OK : {200} Status KO : {404, 500} - drivers : {tableau de strings} (tableau d URI des drivers) DELETE Suppression de tous les drivers Status OK : {204} Status KO : {404, 500}

29 API Web Services ELOG - Page Création / modification / Consultation / Suppression d un Driver Ressource : ID_driver Obtenir la description du driver Status OK : {200} Status KO : {404, 500} - label : {string} (libellé du driver) - version : {entier} (version du driver) - protocol : {entier (0)} (modbus) - variables : {tableau de strings} (tableau d URI des variables) - composites : {tableau de strings}(tableau d URI des variables composites) - used_by_device : {booléen} Créer un driver - label : {string} (libellé du driver) - version : {entier} (version du driver de 0 à 100) - protocol : {entier (0)} (modbus) Status OK : {201} Status KO : {400, 403, 500} Modifier un driver - label : {string} (libellé du driver) - version : {entier : {0..100}} (version du driver) - protocol : {entier (0)} (modbus) Status OK : {200} Status KO : {400, 403, 404, 500} DELETE Supprimer un driver (et ses variables/composites en cascade) Status OK : {204} Status KO : {403, 404, 500}

30 Gestion des variables d un driver API Web Services ELOG - Page Consultation de la liste des variables d un driver Ressource : ID_driver /variables Obtenir la liste des variables Status OK : {200} Status KO : {404, 500} - variables : {tableau de strings} (tableau d URI des variables) DELETE Suppression de toutes les variables Status OK : {204} Status KO : {404, 500}

31 API Web Services ELOG - Page Consultation / Création / Modification / Suppression d une variable Ressource : ID_driver /variables/ ID_variable Obtenir la description d une variable Status OK : {200} Status KO : {404, 500} - label : {string} - variable_type : { entier (0,1)} (index,ana) - unit : {string} - value_type : {entier (0,1,2,3,4,5,6)} (int16, uint16, int32, uint32, int64, uint64, float32) - byte_order : {entier (0,1,2,3)} 0 : : (big endian) 2 : (little endian) 3 : mask : {string} (0x )(valeur dépendant de la nature) - gain : {float} (gain sur la valeur lue [ ; ]) - offset : {float} (offset sur la valeur lue [ ; ]) - visibilty : {boolean} (variable visible ou non dans le mapping) - authorize_history : {boolean} false : pas de courbe, valeur par défaut true : génération de la courbe de mesure [SI authorize_history = true ALORS] - curve_unit : {string} - protocol : {entier (0)} (modbus) [SI protocol = 0 ALORS] - protocol_params : - address : {string} (représentation HEXA (0x...) (0 à FFFF) - read_function : {entier} (numéro de fonction pour lecture) - write_function : {entier} (numéro de fonction pour écriture) Créer une variable

32 API Web Services ELOG - Page 32 - label : {string} - variable_type : { entier (0,1)} (index,ana) - unit : {string} - value_type : {entier (0,1,2,3,4,5,6)} (int16, uint16, int32, uint32, int64, uint64, float32) - byte_order : {entier (0,1,2,3)} 0 : : (big endian) 2 : (little endian) 3 : mask : {string} (0x )(valeur dépendant de la nature) - gain : {float} (gain sur la valeur lue [ ; ]) - offset : {float} (offset sur la valeur lue [ ; ]) - visibilty : {boolean} (variable visible ou non dans le mapping) - authorize_history : {boolean} false : pas de courbe, valeur par défaut true : génération de la courbe de mesure [SI authorize_history = true ALORS] - curve_unit : {string} - protocol : {entier (0)} (modbus) [SI protocol = 0 ALORS] - protocol_params : - address : {string} (représentation HEXA (0x...) (0 à FFFF) - read_function : {entier} (numéro de fonction pour lecture) - write_function : {entier} (numéro de fonction pour écriture) Status OK : {201} Status KO : {400, 403, 500} Modifier une variable

33 API Web Services ELOG - Page 33 - label : {string} - variable_type : { entier (0,1)} (index,ana) - unit : {string} - value_type : {entier (0,1,2,3,4,5,6)} (int16, uint16, int32, uint32, int64, uint64, float32) - byte_order : {entier (0,1,2,3)} 0 : : (big endian) 2 : (little endian) 3 : mask : {string} (0x )(valeur dépendant de la nature) - gain : {float} (gain sur la valeur lue [ ; ]) - offset : {float} (offset sur la valeur lue [ ; ]) - visibilty : {boolean} (variable visible ou non dans le mapping) - authorize_history : {boolean} false : pas de courbe, valeur par défaut true : génération de la courbe de mesure [SI authorize_history = true ALORS] - curve_unit : {string} - protocol : {entier (0)} (modbus) [SI protocol = 0 ALORS] - protocol_params : - address : {string} (représentation HEXA (0x...) (0 à FFFF) - read_function : {entier} (numéro de fonction pour lecture) - write_function : {entier} (numéro de fonction pour écriture) /!\ le web service ne permet pas de changer : - variable_type Status OK : {200} Status KO : {400, 403, 404, 500} DELETE Suppression de la variable Status OK : {204} Status KO : {403, 404, 500}

34 API Web Services ELOG - Page Gestion des variables Composite d un driver Une variable composite est un calcul effectué entre 2 variables de mapping avec un opérateur. Il n y a donc pas de télé relève d une variable composite. Une limite de 10 variables composites maximum est imposée Consultation de la liste des variables composites d un driver Ressource : ID_driver /composites Obtenir la liste des variables composites Status OK : {200} Status KO : {404, 500} - composites : {tableau de strings} (tableau d URI des composites) DELETE Suppression de toutes les variables composites Status OK : {204} Status KO : {404, 500}

35 API Web Services ELOG - Page Création / Consultation / modification / Suppression d une variable composite Ressource : ID_driver /composites/ ID_composite Obtenir la description d une variable composite Status OK : {200} Status KO : {404, 500} - label : {string} - composite_type : { entier (0,1)} (index,ana) - unit : {string} - operand1 : {string} (URI de la variable 1) - operator : {entier (0,1,2,3)} (+,-,*,/) - operand2 : {string} (URI de la variable 2) - authorize_history : {boolean} false : pas de courbe, valeur par défaut true : génération de la courbe de mesure [SI authorize_history = true ALORS] - curve_unit : {string} Créer une variable composite - label : {string} - composite_type : { entier (0,1)} (index,ana) - unit : {string} - operand1 : {string} (URI de la variable 1) - operator : {entier (0,1,2,3)} (+,-,*,/) - operand2 : {string} (URI de la variable 2) - authorize_history : {boolean} false : pas de courbe, valeur par défaut true : génération de la courbe de mesure [SI authorize_history = true ALORS] - curve_unit : {string} Status OK : {201} Status KO : {400, 403, 500} Modifier une variable composite

36 API Web Services ELOG - Page 36 - label : {string} - composite_type : { entier (0,1)} (index,ana) - unit : {string} - operand1 : {string} (URI de la variable 1) - operator : {entier (0,1,2,3)} (+,-,*,/) - operand2 : {string} (URI de la variable 2) - authorize_history : {boolean} false : pas de courbe, valeur par défaut true : génération de la courbe de mesure [SI authorize_history = true ALORS] - curve_unit : {string} /!\ le web service ne permet pas de changer : - composite_type Status OK : {200} Status KO : {400, 403, 404, 500} DELETE Suppression de la variable composite Status OK : {204} Status KO : {404, 500}

37 API Web Services ELOG - Page Points de Mesure Consultation des Points de Mesure Consultation de la liste des Points de Mesure Ressource : Obtenir la liste des Points de Mesure Status OK : {200} Status KO : {404, 500} - devices : {tableau de strings} (tableau d URI des Points de Mesure) DELETE Suppression de tous les Points de Mesure Status OK : {204} Status KO : {404, 500}

38 Consultation d un Point de Mesure API Web Services ELOG - Page 38 Ressource : ID_device Obtenir la description d un Point de Mesure Status OK : {200} Status KO : {404, 500} - conf : {string} (URI de la configuration du Point de Mesure) - values : {string} (URI des valeurs du Point de Mesure. Si aucune valeur, paramètre null) - thresholds : {string} (URI des seuils du Point de Mesure. Si aucun seuil, paramètre null) DELETE Suppression d un Point de Mesure Status OK : {204} Status KO : {404, 500}

39 Configuration d un Point de Mesure Cet ensemble de web service gère la configuration d un Point de Mesure : - Son driver - Sa place hiérarchique dans l installation - Son port com associée (et la configuration nécessaire) API Web Services ELOG - Page 39 NB Création / modification / suppression d un Point de Mesure Dans le cas d un Point de Mesure sur ETOR, on ne précise pas de driver associé car l Elog créé automatiquement une variable. Elle est de fait de type Index (unit32) dans le cas d une ETOR configurée en mode «comptage». Ressource : ID_device /conf Obtenir la configuration d un Point de Mesure

40 API Web Services ELOG - Page 40 Status OK : {200} Status KO : {404, 500} - label : {string} (nom du Point de Mesure) - calendar : {string} URI du profil d alarme (option) - level1 : {string} - level2 : {string} - level3 : {string} - level4 : {string} - category : {string} - enable_index_history : {boolean} (pour ETOR ou variable/composite distante de type index) - enable_analog_history : {boolean} (pour variable/composite distante de type analogique) - type : {entier} 0 : local (ETOR par ex) 1 : distant (via port A, B, C ou D) - type_params : [SI type = 0 ALORS] - din : {string} URI ETOR associée [SI enable_index_history = true ALORS] - periodicity (diviseur de 60, en min) [SI type = 1 ALORS] - driver : {string} URI du driver [SI enable_index_history = true ALORS] - index_curve_params : - periodicity (diviseur de 60, en min) [SI enable_analog_history = true ALORS] - analog_curve_params : - periodicity (diviseur de 3600, en s) - com_params : - port : {string} (A,B,C) - port_params : [SI port = A OU port = B ALORS] - protocol : {entier (0,1)} (RTU, ASCII) - protocol_params : - slave_address : {entier (1-255)} [SI port = C ALORS] - protocol : {entier (0,1)} (modbus/tcp, modbus encapsulé) - protocol_params : - ip : {string (X.X.X.X)} (X entre 0 et 255) - listening_port : {entier ( )} - slave_address : {entier (1-255)} Créer la configuration d un Point de Mesure

41 API Web Services ELOG - Page 41 - label : {string} (nom du Point de Mesure) - calendar : {string} URI du profil d alarme (option) - level1 : {string} - level2 : {string} - level3 : {string} - level4 : {string} - category : {string} - enable_index_history : {boolean} (pour ETOR ou variable/composite distante de type index) - enable_analog_history : {boolean} (pour variable/composite distante de type analogique) - type : {entier} 0 : local (ETOR par ex) 1 : distant (via port A, B, C ou D) - type_params : [SI type = 0 ALORS] - din : {string} URI ETOR associée [SI enable_index_history = true ALORS] - periodicity (diviseur de 60, en min) [SI type = 1 ALORS] - driver : {string} URI du driver [SI enable_index_history = true ALORS] - index_curve_params : - periodicity (diviseur de 60, en min) [SI enable_analog_history = true ALORS] - analog_curve_params : - periodicity (diviseur de 3600, en s) - com_params : - port : {string} (A,B,C) - port_params : [SI port = A OU port = B ALORS] - protocol : {entier (0,1)} (RTU, ASCII) - protocol_params : - slave_address : {entier (1-255)} [SI port = C ALORS] - protocol : {entier (0,1)} (modbus/tcp, modbus encapsulé) - protocol_params : - ip : {string (X.X.X.X)} (X entre 0 et 255) - listening_port : {entier ( )} - slave_address : {entier (1-255)} Status OK : {201} Status KO : {400, 403, 500} Modifier la configuration d un Point de Mesure

42 API Web Services ELOG - Page 42 - label : {string} (nom du Point de Mesure) - calendar : {string} URI du profil d alarme (option) - level1 : {string} - level2 : {string} - level3 : {string} - level4 : {string} - category : {string} - enable_index_history : {boolean} (pour ETOR ou variable/composite distante de type index) - enable_analog_history : {boolean} (pour variable/composite distante de type analogique) - type : {entier} 0 : local (ETOR par ex) 1 : distant (via port A, B, C ou D) - type_params : [SI type = 0 ALORS] - din : {string} URI ETOR associée [SI enable_index_history = true ALORS] - periodicity (diviseur de 60, en min) [SI type = 1 ALORS] - driver : {string} URI du driver [SI enable_index_history = true ALORS] - index_curve_params : - periodicity (diviseur de 60, en min) [SI enable_analog_history = true ALORS] - analog_curve_params : - periodicity (diviseur de 3600, en s) - com_params : - port : {string} (A,B,C) - port_params : [SI port = A OU port = B ALORS] - protocol : {entier (0,1)} (RTU, ASCII) - protocol_params : - slave_address : {entier (1-255)} [SI port = C ALORS] - protocol : {entier (0,1)} (modbus/tcp, modbus encapsulé) - protocol_params : - ip : {string (X.X.X.X)} (X entre 0 et 255) - listening_port : {entier ( )} - slave_address : {entier (1-255)} DELETE Status OK : {200} Status KO : {400, 403, 404, 500}

43 API Web Services ELOG - Page 43 NB : La création d un Point de Mesure entraine également la création des ressources suivantes : - ID_device /values - ID_device /values/variables/ ID_variable ID_device /values/variables/ ID_variable /raw ID_device /values/variables/ ID_variable /history ID_device /values/variables/ ID_variable /instant - ID_device /values/composites/ ID_composite ID_device /values/composites/ ID_ composite /raw ID_device /values/composites/ ID_ composite /history ID_device /values/composites/ ID_ composite /instant

44 API Web Services ELOG - Page Télé relève des données instantanées et enregistrées d un Point de Mesure Type et suppression des données d un Point de Mesure Ressource : ID_device /values Obtenir le lien des variables simples et composées d un Point de Mesure Status OK : {200} Status KO : {404} - variables : /rest/devices/ ID_device /values/variables - composites : /rest/devices/ ID_device /values/composites (Si aucune variable composée, paramètre null) DELETE Suppression de tous les enregistrements de toutes les variables simples et composées du Point de Mesure) Status OK : {204} Status KO : {404, 500}

45 API Web Services ELOG - Page Télé relève des valeurs des variables simples d un Point de Mesure Permet d obtenir les différentes valeurs pour chacune des variables simples d un Point de Mesure (selon son driver) Liste des variables simples d un Point de Mesure Ressource : ID_device /values/variables Obtenir la liste des variables simples du Point de Mesure Status OK : {200} Status KO : {404, 500} - variables : {tableau de strings} (tableau d URI des variables simples) ex : - variables : { /rest/devices/ ID_device /values/variables/ ID_variable, /rest/devices/ ID_device /values/variables/ ID_variable } DELETE

46 Type de donnée d une variable simple API Web Services ELOG - Page 46 Ressource : ID_device /values/variables/ ID_variable Obtenir un lien pour chaque type de donnée d une variable simple du Point de Mesure Status OK : {200} Status KO : {404} - raw : {string} (URI des enregistrements d une variable simple) - history : {string} (URI de l historique d une variable simple) - instant : {string} (URI de la valeur instantanée d une variable simple) ex : - raw : /rest/devices/ ID_device /values/variables/ ID_variable /raw - history : /rest/devices/ ID_device /values/variables/ ID_variable /histo ry - instant : /rest/devices/ ID_device /values/variables/ ID_variable /insta nt DELETE

47 API Web Services ELOG - Page Liste des années avec des enregistrements sur une variable simple Ressource : ID_device /values/variables/ ID_variable /raw Obtenir un lien pour chaque année avec des enregistrements d une variable simple du Point de Mesure Status OK : {200} Status KO : {404} - years : {tableau de strings} (tableau d URI des enregistrements d une variable simple. 1 URI par année) - years : { /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2011 } DELETE Supprimer tous les enregistrements d une variable simple du Point de Mesure Status OK : {204} Status KO : {404, 500}

48 Liste des mois d une année avec des enregistrements sur une variable simple API Web Services ELOG - Page 48 Ressource : ID_device /values/variables/ ID_variable /raw/ année' Obtenir un lien pour chaque mois d une année avec des enregistrements d une variable simple du Point de Mesure Status OK : {200} Status KO : {404} - months : {tableau de strings} (tableau d URI des enregistrements d une variable simple sur 1 année. 1 URI par mois) ex : - months : { /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /1, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /2, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /3, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /4, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /5, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /6, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /7, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /8, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /9, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /10, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /11, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /12} DELETE

49 API Web Services ELOG - Page Liste des jours d un mois avec des enregistrements sur une variable simple Ressource : ID_device /values/variables/ ID_variable /raw/ année'/ mois Obtenir un lien pour chaque jour d un mois avec des enregistrements d une variable simple du Point de Mesure Status OK : {200} Status KO : {404} - days : {tableau de strings} (tableau d URI des enregistrements d une variable simple sur 1 mois. 1URI/jour) ex : - days : { /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/1, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/2, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/3, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/5, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/6, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/7, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/8, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/9, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/10, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/11, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/12, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/13, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/14, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/15, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/16, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/17, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/18, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/19, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/20, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/21, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/22, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/23, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/24, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/25, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/26, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/27, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/28, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/29, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/30, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/31}

50 API Web Services ELOG - Page 50 DELETE Suppression de tous les enregistrements du mois du Point de Mesure Status OK : {204} Status KO : {404, 500} Liste des heures d un jour avec des enregistrements sur une variable simple Ressource : ID_device /values/variables/ ID_variable /raw/ année'/ mois / jour Obtenir un lien pour chaque heure d une journée avec des enregistrements d une variable simple du Point de Mesure Status OK : {200} Status KO : {404} - hours : {tableau de strings} (tableau d URI des enregistrements d une variable simple sur 1 journée. 1URI/heure) ex : - hours : { /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/0, (entre 0h00 et 1h00) /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/1, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/2, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/3, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/4, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/5, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/6, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/7, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/8, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/9, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/10, (entre 10h00 et 11h00) /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/11, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/12, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/13, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/14, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/15, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/16, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/17, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/18, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/19, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/20, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/21, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/22, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010/3/4/23} (entre 23h00 et 24h00)

51 API Web Services ELOG - Page 51 DELETE Suppression de tous les enregistrements de la journée du Point de Mesure Status OK : {204} Status KO : {404, 500} Lien vers la liste des pages contenant les enregistrements d une variable simple d un Point de Mesure Ressource : ID_device /values/variables/ ID_variable /raw/ année / mois / jour / heure / Obtenir un lien vers la liste des pages contenant les enregistrements d une variable simple d un Point de Mesure. Status OK : {200} Status KO : {404} - pages : {string} URI des pages contenant les enregistrements d une variable simple sur 1 heure. ex : - pages : { /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /3/4/0/pages DELETE

52 API Web Services ELOG - Page Liste des pages contenant les enregistrements d une variable simple d un Point de Mesure sur 1 heure Ressource : ID_device /values/variables/ ID_variable /raw/ année / mois / jour / heure /pages Obtenir la liste des pages contenant les enregistrements d une variable simple d un Point de Mesure sur 1 heure Status OK : {200} Status KO : {404} - pages : {tableau de strings} (tableau d URI des pages contenant les enregistrements d une variable simple sur 1 heure. 1URI/page) ex : - pages : { /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /3/4/0/pages/0, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /3/4/0/pages/1, /rest/devices/ ID_device /values/variables/ ID_variable /raw/2010 /3/4/0/pages/2 } DELETE

53 API Web Services ELOG - Page Liste des enregistrements horodatés d une page d une variable simple d un Point de Mesure Ressource : ID_device /values/variables/ ID_variable /raw/ année / mois / jour / heure /pages/ ID_page Obtenir la liste des enregistrements horodatés d une page d une variable simple d un Point de Mesure Status OK : {200} Status KO : {404} - data : {tableau d objets} (tableau d objets contenant les enregistrements) Objet : - time : {entier} (timestamp UNIX en heure locale) - value : {float32} valeur de l enregistrement Ex : - data : { { time : , value : 20}, { time : , value : 40}, { time : , value : 60}, { time : , value : 80}, { time : , value : 100}, { time : , value : 120} } DELETE

54 API Web Services ELOG - Page Télé relève des valeurs instantanées d une variable simple d un Point de Mesure Ressource : ID_device /values/variables/ ID_variable /instant Obtenir la valeur instantanée d une variable simple d un Point de Mesure Status OK : {200} Status KO : {404, 409} - time : {entier} (timestamp UNIX en heure locale) - value : (float32) (valeur) - unit : (string) (unité de la valeur) DELETE Télé relève des valeurs des variables composées d un Point de Mesure Permet d obtenir les différentes valeurs pour chacune des composites d un Point de Mesure (selon son driver). Identique au chapitre à l exception des ressources qui doivent être adaptées comme l exemple cidessous : ID_device /values/variables/ ID_variable devient ID_device /values/composites/ ID_composite