Utilisez l’API des attributs de machine

Comment utiliser l’API Machine Attributes

Créez une machine Tulip à partir de données provenant de Node-RED, de Python ou d’autres services.

Résumé

L’API Machine Attributes vous permet d’envoyer des données vers un attribut spécifique d’une machine via une API RESTful en utilisant le point de terminaison /attributes/report. Cela offre de nombreuses options flexibles pour s’intégrer à Tulip depuis Node-RED, Python ou d’autres langages et services.

Configuration de l’API Machine

Remarque : si vous avez déjà configuré une API de table Tulip, vous pouvez utiliser la clé et le secret de cette API.

1. Accédez à vos Paramètres > API Tulip
2. Cliquez sur « Créer un compte de service » dans le coin supérieur droit de votre écran
3. Donnez un nom à votre compte de service, puis sélectionnez « attributes:report » comme champ d’application :

1. Une fenêtre contextuelle contenant votre clé API, votre secret et votre en-tête d'authentification s'affichera. Veuillez enregistrer ces informations, car elles ne seront plus accessibles par la suite !

Configuration d’une nouvelle machine

Une fois votre API de machine configurée, une nouvelle source de données de machine apparaîtra sur votre instance. Pour afficher cette source de données, cliquez sur « Atelier » > « Machines », puis accédez à « Sources de données de machine » :

Vous devrez créer une nouvelle machine liée à cette source de données. Pour créer une nouvelle machine, accédez à Bibliothèque de machines, puis cliquez sur Créer une machine.

La fenêtre modale suivante s'affichera :

1. Nom de la machine (obligatoire) : nommez votre machine
2. Source de données de la machine (obligatoire) : sélectionnez « Tulip API »
3. Station (facultatif)
4. Type (obligatoire) : si aucun type n'est disponible, créez-en d'abord un ; dans cet exemple, le type créé est nommé « default »

Maintenant que votre machine est créée, vous devez ajouter un attribut. Cliquez sur « Modifier » en haut à droite de votre écran. Cliquez ensuite sur le bouton « + » en haut à droite de votre écran :

Comme aucun attribut de machine n’a encore été créé, cliquez sur le type de machine en bleu, dans ce cas « Default ».

Vous accéderez ainsi au type de machine associé à la machine. Cliquez sur le bouton « Modifier » situé dans le coin supérieur droit de votre écran.

Cliquez ensuite sur le bouton « + » situé à côté de « Attributs de la machine », dans le coin inférieur gauche.

Cliquez ensuite sur « + Créer un attribut de machine » dans le coin inférieur droit.

Dans cet exemple, nous allons créer un attribut « Compteur » de type « Entier ».

Une fois votre attribut créé, cliquez sur l’attribut « Compteur » dans la liste des « Attributs de la machine », puis cliquez sur « Enregistrer » dans le coin supérieur droit.

Revenez à la page de votre machine.

Maintenant que votre attribut de machine est créé, vous pouvez l'ajouter à votre machine. Cliquez sur le bouton « Modifier » dans le coin supérieur droit. Cliquez ensuite sur le bouton « + » dans le coin supérieur droit et sélectionnez l'attribut « Compteur » que vous venez de créer :

Cliquez sur « Enregistrer » dans le coin supérieur droit.

Votre instance Tulip est désormais configurée avec l’API Machine, une machine et un attribut de machine : vous pouvez désormais envoyer des données à une machine Tulip depuis n’importe où !

À partir de cette page, vous pouvez voir l’ `attributeId` et le `machineID` de l’attribut « Counter ». Ces informations peuvent être copiées en cliquant sur l’icône et seront utilisées dans le corps de la requête HTTP.

Pour ce faire, vous devez maîtriser les API REST. Vous trouverez la documentation complète sur l’utilisation du point de terminaison /attributes/report, y compris les paramètres de requête et le format du corps de la requête, à l’adresse your-company.tulip.co/apidocs ou en suivant le lien sur la page de l’API Tulip...

... et dans la documentation, il y a une section consacrée à la surveillance des machines

Pour aller plus loin

Consultez cet article si vous souhaitez aller plus loin avec l'API et découvrir comment l'utiliser avec Edge MC et Node-RED !