Manuel du produit Vorne XL API

Présentation

L'API XL est une interface basée sur REST qui vous permet d'intégrer directement XL à d'autres systèmes et applications, ainsi que d'échanger des informations avec les appareils XL. L'API XL est disponible sur les appareils XL équipés de la version 2.0 ou ultérieure du logiciel.

L'API XL est particulièrement utile pour les grandes entreprises disposant de services informatiques bien dotés en personnel et souhaitant exercer un contrôle total sur l'intégration. Les entreprises souhaitant utiliser l'API doivent prévoir de faire appel aux services d'un développeur logiciel expérimenté.

Pour les entreprises qui ne disposent pas de ces ressources, nous recommandons de faire appel aux partenaires d’intégration Vorne XL. Nos partenaires d’intégration XL proposent une combinaison de produits logiciels et de services clés en main (souvent développés à l’aide de connexions API) et vous aideront à intégrer étroitement XL à vos systèmes existants, afin que vous n’ayez pas à consacrer de ressources à la maintenance d’une connexion API.

L’API XL peut être utilisée pour transmettre des informations aux appareils XL. Voici cinq utilisations courantes de cette fonctionnalité :

Transmettre les paramètres de pièce et de tâche à XL (et lancer un nouveau cycle de production).
Transmettre un nom d’équipe et la taille de l’équipe à XL (et attribuer ces paramètres à l’équipe de travail en cours).
Transmettre une commande à XL pour le forcer à passer à un autre état de production et indiquer le motif associé (par exemple : « Non planifié » > « Pas de production »).
Envoyer un message unique sur le tableau d’affichage à LED pendant 30 secondes maximum (par exemple : « Bravo à toute l’équipe ! »).

L’API XL peut également être utilisée pour extraire des informations de XL en vue de leur utilisation dans un autre système (généralement en les enregistrant dans une base de données). Voici trois utilisations courantes de cette fonctionnalité :

Extraire toutes les données et tous les paramètres de XL (à des fins de sauvegarde de l’appareil).
Extraire toutes les métriques associées à un canal de données (par exemple : heure, équipe, jour de production, mois, pièce) vers une base de données SQL pour les utiliser avec une plateforme de reporting tierce.
Extraire l’état de production XL actuellement actif et la raison correspondante (pour déclencher un événement dans un système GMAO ou ERP).

En savoir plus

Pour savoir si l’API XL est adaptée à votre application et pour obtenir une copie de la documentation de l’API XL, veuillez contacter le support Vorne :

E-mail : support@vorne.com
Téléphone : +1.630.875.3600

Mises à jour

À mesure que nous continuons à développer et à ajouter des fonctionnalités à XL, l'API XL est susceptible d'évoluer.

Les modifications suivantes ont été apportées à l'API :

Version	Points de terminaison	Explication
2.21	Tableau d'affichage > Image graphique HDMI	Ajout d'un nouveau point de terminaison permettant de renvoyer une image PNG de la sortie HDMI actuelle du XL HD.
2.20	État du processus > Motifs	Mise à jour du point de terminaison pour renvoyer une liste des raisons d'état des processus actifs.
2.20	Processus de fabrication > Facteur de comptage des performances	Ajout d’un nouveau point de terminaison pour mettre à jour le nombre prévu par cycle et le nombre utilisé par cycle.
2.20	Tableau de bord > Champs API	Ajout d'un nouveau point de terminaison permettant d'obtenir et de configurer jusqu'à douze champs personnalisés pour le tableau de bord.
2.19	Processus de fabrication > Démarrer un poste	Ajout d'un nouveau point de terminaison permettant de démarrer manuellement les quarts de travail (avec une équipe en option).
2.18.2	Temps réel > Schéma des données en temps réel Temps réel > Données en temps réel	Points de terminaison « Temps réel » entièrement remaniés avec des modifications majeures visant à rendre la structure hiérarchique, à remplacer les tableaux par des objets composés de paires clé/valeur et à ajouter l'état des broches d'entrée.
2.18.2	Temps réel > Schéma des données en temps réel Temps réel > Données en temps réel	Ajout de nouveaux points de terminaison permettant d'obtenir les valeurs actuelles pour toutes les catégories, les identifiants d'événements, les métriques et (en option) les métriques dérivées.
2.18	État du processus > Identifier le dernier état du processus	Ajout d’un nouveau point de terminaison permettant d’obtenir des informations sur l’événement le plus récent pour chaque type d’état de processus.
2.18	Processus de fabrication > Marquer un cycle de production avec un ID de tâche	Ajout d’un nouveau point de terminaison POST permettant d’associer un ID de tâche à une pièce en cours de fabrication.
2.17.1	Tableau > [Tous les points de terminaison] Canal > [Tous les points de terminaison]	Supprimé : Métrique : ordinal_shift_event_id Canal : ordinal_shift
2.17	Tableau > [Tous les points de terminaison] Canal > [Tous les points de terminaison]	Ajouté : Dimension : ordinal_shift Métrique : ordinal_shift_event_id Canal : ordinal_shift Tableau : ordinal_shift_values
2.16	Table > [Tous les points de terminaison] Canal > [Tous les points de terminaison]	Le type de métrique de ` target_cycles ` a été modifié, passant de `uint64` à `double`.
2.16	Gestion des données > Remplacer un appareil	Ajout d’un nouveau point de terminaison.
2.14	Processus de fabrication > Événement de mise hors service	Ajout d'un nouveau point de terminaison.
2.13	Canal > Commentaires	Ajout d'un nouveau point de terminaison.
2.13	Chaîne > [Tous les points de terminaison]	Ajout de la fonctionnalité « include=comments » pour récupérer les données des commentaires en même temps que celles de la chaîne.
2.12	Fabrication Processus > Activer l'état du processus (état de production)	Ajout de la possibilité d’activer les états « en cours d’exécution » et « à l’arrêt » si la détection automatique de l’exécution est désactivée.
2.12	Canaux > [Points de fin d’événement]	Ajout des points de fin d’événement « précédent », « premier » et « dernier » pour compléter le point de fin d’événement « actuel » existant.
2.12	Processus de fabrication > Soumettre les rejets avec motif	Ajout d’un nouveau point de terminaison POST permettant de soumettre un nombre de rejets avec un motif de rejet spécifié.
2.11	Processus de fabrication > Injection d’entrées logiques	Ajout d’un nouveau point de terminaison POST permettant d’injecter un certain nombre d’entrées logiques sur une seule broche en fonction d’une charge utile.
2.11	Processus de fabrication > Lancer une série de pièces (tâche)	Modifications apportées à la requête POST : Si une pièce existe déjà dans la configuration XL, la valeur « part_id » peut être soit l’ID de la pièce, soit l’ID de pièce alternatif.
2.10	Tables > [Tous les points de terminaison] Canaux > [Tous les points de terminaison]	Métriques ajoutées : current_target_labor_per_piece earned_labor rendement_de_main-d’œuvre main-d'œuvre_cible_par_pièce main-d'œuvre_perdue Indicateurs supprimés : perte_par_cycle_de_production
2.10	Tableaux > Dimensions Tableau de bord > Image de superposition graphique Tableau de bord > Mode de superposition graphique Tableau de bord > Position de la superposition graphique Processus de fabrication > Événement de division vers le bas	Ajout de nouveaux points de terminaison.
2.10	Processus de fabrication > Lancer la production d'une pièce (tâche)	Modifications apportées à la requête POST : disable_when peut être un tableau. Nouveau paramètre facultatif target_labor_per_piece (valeur par défaut : 0,0).

Présentation de l'API XL

Présentation

En savoir plus

Mises à jour