Comment utiliser l'API des attributs de machine

Article avancé - suppose une expérience préalable avec les API REST
:: :

Résumé

L'API Attributs de Machine vous permet d'envoyer des données à un attribut spécifique d'une Machine via une API RESTful en utilisant le point de terminaison /attributs/report. Cela permet de nombreuses options flexibles pour intégrer Tulip à partir de 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 > Bots
2. Cliquez sur Créer un robot dans le coin supérieur droit de l'écran.
3. Nommez votre robot, et sélectionnez attributes:write pour sa portée :

1. Une modale contenant votre clé API, votre secret et votre en-tête d'authentification s'affiche. Veuillez enregistrer ces informations, car elles ne seront plus accessibles !

Félicitations, vous avez officiellement configuré votre API Machine !

Configuration d'une nouvelle machine

Une fois que vous avez configuré votre API Machine, une nouvelle source de données Machine apparaîtra sur votre instance. Pour visualiser cette source de données, cliquez sur Atelier > Machines, et naviguez jusqu'à Sources de données machine :

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

La modale suivante s'affiche :

1. Nom de la machine (obligatoire) : Nom de votre machine
2. Source de données de la machine (obligatoire) : Sélectionnez Tulip API
3. Station (facultatif)
4. Type (Requis) : Si aucun type n'est disponible, créez d'abord un type. Dans cet exemple, le type créé est nommé default.

Maintenant que votre machine est créée, vous devez ajouter un attribut. Cliquez sur Editer en haut à droite de votre écran. Puis cliquez sur le bouton + en haut à droite de votre écran :

Puisqu'aucun attribut de machine n'a encore été créé, appuyez sur le type de machine en bleu, dans ce cas, c'est Default.

Vous accédez ainsi au type de machine associé à la machine. Appuyez sur le bouton Editer dans le coin supérieur droit de votre écran.

Appuyez ensuite sur le bouton + à côté de Attributs de la machine dans le coin inférieur gauche.

Appuyez ensuite sur + Create Machine Attribute dans le coin inférieur droit.

Dans cet exemple, nous allons créer un attribut de compteur de type Integer.

Une fois que votre attribut est créé, cliquez sur l'attribut Counter dans la liste des attributs de machine, puis appuyez sur le bouton 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. Appuyez sur le bouton Editer dans le coin supérieur droit. Cliquez ensuite sur le bouton + dans le coin supérieur droit et sélectionnez l'attribut de compteur que vous venez de créer :

Cliquez ensuite sur Enregistrer dans le coin supérieur droit.

Votre Instance Tulip est maintenant configurée avec l'API Machine, une Machine et un Attribut Machine - vous pouvez maintenant envoyer des données à une Machine Tulip de n'importe où !

D'ici, vous pouvez voir l'attributeId et l'attribut machineID pour 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 être familier avec les API REST. Une documentation complète sur la façon d'utiliser le point de terminaison /attributs/rapport, y compris les paramètres de la requête et le format du corps, peut être trouvée à l'adresse your-company.tulip.co/apidocs ou en suivant le lien sur la page Bots...

... et dans la docs il y a une section pour la surveillance des machines

Autres lectures

Consultez cet article si vous voulez aller plus loin avec l'API et voir comment elle peut être utilisée avec Edge MC et Node-RED !