API RoboDK

L’API RoboDK (Application Program Interface) représente un ensemble de routines et de commandes que RoboDK propose à travers un langage de programmation. L’API RoboDK vous permet de programmer n’importe quel robot en utilisant l’un des langages de programmation pris en charge, tels que C#, Python ou C++. Vous pouvez également automatiser des tâches répétitives à l’aide de l’API RoboDK.

Par rapport à la programmation de robots spécifique à chaque fabricant, avec l’API RoboDK, il est possible de simuler et de programmer n’importe quel robot en utilisant un langage de programmation unique/universel comme Python. La page suivante fournit un aperçu et une vidéo montrant la programmation hors ligne avec l’API.

L’API RoboDK est disponible pour Python, C#, C, C++, Visual Basic (.NET) et MATLAB. N’importe lequel de ces langages de programmation peut être utilisé pour simuler et programmer n’importe quel bras robotique.

Astuce : Avez-vous des doutes sur le langage de programmation à utiliser ? Nous vous recommandons d’utiliser Python ! Si vous avez installé RoboDK en utilisant les paramètres par défaut, vous avez déjà installé Python et vous êtes prêt à commencer. Python est un langage de programmation de haut niveau largement utilisé pour la programmation à usage général. La plupart des exemples et la documentation de RoboDK sont basés sur des programmes Python.

Note : L’API peut être implémentée dans n’importe quel langage de programmation. L’API se compose d’un protocole TCP/IP implémenté dans RoboDK. Lorsque RoboDK est en cours d’exécution, il se comporte comme un serveur et il expose un ensemble de commandes via le protocole TCP/IP.

L’API de RoboDK peut être utilisée pour les tâches suivantes :

1.Automatiser la simulation: Créer des macros pour automatiser des tâches précises dans le simulateur RoboDK, comme déplacer des objets, des repères ou des robots.

2.Programmation hors ligne: Programmation de robots hors ligne à partir d’un langage de programmation universel. RoboDK générera des programmes spécifiques pour un contrôleur de robot spécifique lorsque l’API est utilisée (comme un programme en Python ou C#). Le programme robot est généré selon le post-processeur sélectionné pour un robot spécifique. La section Programmation hors ligne avec Python de ce document fournit plus d’informations et des exemples.

3.Programmation en ligne: Programmation de robots en ligne en utilisant un langage de programmation universel: Il est possible de déplacer les robots et de récupérer leur position actuelle à partir de l’API RoboDK. RoboDK pilotera les robots en utilisant des pilotes de robot. La section Programmation en ligne avec Python de ce document fournit plus d’informations et des exemples.

En d’autres termes, le même programme qui est utilisé pour la simulation (1) peut être utilisé pour générer des programmes de robot (2, Programmation hors ligne) et pour déplacer le robot en temps réel (3, Programmation en ligne).

Note : Lorsque la simulation robot est créée à partir d’un langage de programmation générique utilisant l’API RoboDK, les commandes de mouvement de robot sont automatiquement utilisées pour générer des programmes hors ligne lorsque la simulation est prête. En outre, le même programme peut être utilisé pour déplacer le robot en temps réel si le robot est connecté à l’aide du pilote du robot.

Ce document couvre les sujets suivants :

●L’API Pythonavec des exemples de Simulations, Programmation Hors-Ligne et En Ligne.

●L’API en C#avec des exemples de simulations, Programmation Hors-Ligne et En Ligne.

●L’API MATLABavec un exemple de simulation Simulink.

●Les options de Ligne de commandeafin de démarrer RoboDK

Note : Ce document ne couvre pas les post-processeurs, requis pour la programmation hors ligne.

Note : Ce document ne couvre pas les pilotes de robot, requis pour la programmation en ligne.

Astuce : Téléchargez les dernières versions de l’API RoboDK depuis notre dépôt GitHub officiel.

Python API

Python est un langage de programmation de haut niveau largement utilisé pour la programmation généraliste. Python est un langage de programmation qui vous permet de travailler plus rapidement et d’intégrer plus efficacement vos systèmes. La syntaxe de Python permet aux programmeurs d’exprimer des concepts en moins de lignes de code par rapport à d’autres langages, ce qui le rend convivial et facile à apprendre.

La section précédenteexplique les avantages de l’utilisation de l’API RoboDK avec un langage de programmation largement utilisé pour la programmation de robots, tel que Python.

Python est installé automatiquement et intégré avec RoboDK par défaut. Sélectionner Outils➔Options➔Autres pour changer les paramètres par défaut (emplacement de Python et éditeur Python).

Astuce : Il est possible d’utiliser n’importe quel éditeur de texte avec RoboDK, comme Notepad++ ou PyCharm (contrairement à VSCodium, VScode ou Python IDLE utilisés par défaut). Saisir l’emplacement de votre éditeur de texte préféré dans l’onglet Python du menu Options, comme indiqué dans l’image suivante.

RoboDK API - Image 1

L’API RoboDK pour Python est divisée en les modules suivants :

●Le package robodk est le point d’entrée distribué de l’API Python. Il est le parent commun de tous les sous-packages et modules. Le sous-module robolink (robolink.py) est l’interface entre RoboDK et Python. Tout objet de l’arborescence de la station RoboDK peut être récupéré à l’aide d’un objet Robolink et est représenté par l’objet Item. Il est possible d’effectuer différentes opérations sur cet élément selon la classe Robolink.Item.

4.Le sous-module roboapps (roboapps.py) est une boîte à outils RoboDK Apps. Pour plus d'informations sur les applications, consultez la page suivante : AppLoader.

5.Le sous-module robofileio (robofileio.py) est une boîte à outils dédiée aux opérations sur les fichiers. Propriétés des fichiers, CSV, FTP, etc.

6.Le sous-module robodialogs (robodialogs.py) est une boîte à outils de boîtes de dialogue. Il s'agit par exemple de boîtes de dialogue d'ouverture et d'enregistrement de fichiers, de messages d'invite, etc.

●Le sous-module robomath (robomath.py) est une boîte à outils robotique pour Python qui permet d’effectuer des transformations de pose et d’obtenir des angles d’Euler pour différentes marques de robots. Tous les post-processeurs dépendent de ce module. Le sous-module robodialogs (robodialogs.py) est une boîte à outils de dialogues, par exemple les dialogues d’ouverture et d’enregistrement de fichiers, les messages d’invite, etc. Le sous-module robofileio (robofileio.py) est une boîte à outils d’opérations sur les fichiers : propriétés de fichiers, CSV, FTP, etc. Le sous-module roboapps (roboapps.py) est une boîte à outils pour les Apps RoboDK. Plus d’informations sur les Apps sont disponibles ici : AppLoader.

Les modules Python se trouvent dans le dossier C:/RoboDK/Python/. Ce dossier est automatiquement inclus par défaut (utilisé comme PYTHONPATH) lorsque vous exécutez des programmes Python et des post-processeurs dans RoboDK.

Astuce : les fichiers Python disponibles dans le dossier « Scripts » peuvent être exécutés directement depuis RoboDK en tant que scripts en sélectionnant Outils ➔ Exécuter le script (Maj+S).

Les sections suivantes expliquent comment créer un programme simple pour la simulation, la programmation hors ligne et la programmation en ligne, respectivement. D'autres exemples sont disponibles sur la page API Python pour RoboDK. De plus, la bibliothèque RoboDK est fournie avec des exemples de scripts Python dans le dossier « Scripts and Macros », accessible depuis la Bibliothèque par défaut (C:/RoboDK/Library/).

Les sections suivantes montrent respectivement comment créer un programme simple pour la simulation, la programmation hors ligne et la programmation en ligne. D’autres exemples sont disponibles sur la page de l’API Python pour RoboDK. De plus, la bibliothèque RoboDK contient des exemples de scripts Python dans les dossiers Scripts et Macros, disponibles dans la bibliothèque par défaut (C:/RoboDK/Library/). Astuce : Les fichiers Python disponibles dans le dossier Scripts peuvent être exécutés directement depuis RoboDK en tant que scripts en sélectionnant Outils Exécuter un script (Shift+S).

Simulation Python

Cet exemple montre comment créer une nouvelle station en utilisant un robot UR et simuler un mouvement hexagonal avec le robot.

1.Sélectionner Fichier➔RoboDK API - Image 2 Ouvrir

2.Ouvrir le robot UR10

3.Sélectionner Fichier➔RoboDK API - Image 3 Ouvrir

4.Ouvrir le fichier Paint_gun.tool

5.Ouvrir l’exemple de programme Python SampleOfflineProgramming.pydepuis C:/RoboDK/Library/Macros/

Astuce : Plus d’information sur le paramétrage d’une station RoboDK dans la section Getting started.

6.Double-cliquez sur l'élément « SampleOfflineProgramming » pour lancer la simulation. Le robot devrait dessiner un hexagone autour de sa position actuelle et la trajectoire du CDO s'affichera en jaune.          
Vous pouvez également cliquer avec le bouton droit sur le programme et sélectionner « Exécuter le scriptRoboDK API - Image 4 Python ».

7.Faire un clic droit sur  SampleOfflineProgramming et sélectionner Modifier programme Python. Le programme doit apparaitre dans une fenêtre tel que montre l’image suivante.

La macro SampleOfflineProgramming dessinera un polygone de côté n_sides et de rayon R à l’emplacement actuel du robot, par rapport au repère du robot. Si vous le souhaitez, déplacer le robot vers un emplacement différent en changeant les dimensions du polygone et relancer le programme.

Cet exemple est similaire au programme montré dans la section de Programmation hors-lignesur le site internet (avec vidéo).

RoboDK API - Image 6

Python PHL

Les programmes Python peuvent être générés hors ligne en utilisant le même code Python utilisé pour simuler le robot (comme indiqué dans la section précédente de Python Simulation). La programmation hors ligne permet de générer des programmes de robot qui peuvent être exécutés sur un contrôleur de robot spécifique :

1.Faire un clic droit sur un programme RoboDK API - Image 7Python

2.Sélectionner Générer programme robot (F6)

Dans ce cas, le programme n’est pas simulé mais exécuté rapidement pour obtenir le résultat : un programme robot spécifique à un contrôleur robot.

Astuce : Faire un clic droit sur un robot et sélectionner Sélectionner le post-processeur pour spécifier un post-processeur différent pour la programmation hors ligne (comme indiqué dans la section Post-processeur).

harsRoboDK API - Image 8

Note : L’option Générer programme robot définit automatiquement le mode d’exécution de la connexion RDK/Robolink à RUNMODE_MAKE_ROBOTPROG. En d’autres termes, il est possible de générer par programmation le programme spécifique au fabricant du robot au lieu de le simuler, si le programme Python est exécuté en dehors de l’interface graphique de RoboDK. Par exemple :

RDK = Robolink()

RDK.setRunMode(RUNMODE_MAKE_ROBOTPROG)

Programmation En Ligne Python

Les programmes Python peuvent être exécutés directement sur le robot en utilisant le même code Python utilisé pour la simulation robot (comme indiqué dans la section Simulation Python). La programmation en ligne permet d’exécuter un programme générique sur un contrôleur de robot spécifique en utilisant les Pilotes robot :

1.Faire un clic droit sur RoboDK API - Image 9 le programme Python

2.Sélectionner Run on robot

Le programme s’exécutera sur le robot pendant que le programme Python est en train de s’exécuter.

RoboDK API - Image 10

Note : L’option Run on robot change automatiquement le mode d’exécution de la connexion RDK/Robolink sur RUNMODE_RUN_ROBOT. En d’autres termes, il est possible d’exécuter les commandes de mouvement du robot en dehors de l’interface graphique de RoboDK (GUI). Par exemple :

RDK = Robolink()

RDK.setRunMode(RUNMODE_RUN_ROBOT)

Astuce : La macro SampleOnlineProgramming.py provenant du dossier C:/RoboDK/Library/Macros/ fournit un exemple complet pour le tester avec la même trajectoire hexagonale que celle de la section Simulation Python.

Note : Plus d’informations à propos de l’utilisation des Pilotes robot à travers l’API dans la section Pilotes robot.

Dépannage de la configuration de Python dans RoboDK

Si vous avez installé RoboDK après avoir installé Python, il est possible que RoboDK ne parvienne pas à exécuter correctement les scripts Python ou à générer des programmes. Cette section présente les étapes à suivre pour configurer correctement l'interpréteur Python dans RoboDK et exécuter des scripts Python sans problème.

Vous devez suivre ces étapes si vous voyez un message d'erreur tel que : « Set the path to the Python interpreter in Tools-Options-Python » ou « Failed to run Python script. Set the path to the Python interpreter in: Tools-Options-Python tab ».

Suivez ces étapes pour configurer correctement le chemin de l'interpréteur Python si vous avez déjà Python installé :

3.Sélectionnez le menu Démarrer de Windows et tapez python.

4.Faites un clic droit sur la version de Python que vous souhaitez utiliser avec RoboDK et sélectionnez Ouvrir l'emplacement du fichier.

RoboDK API - Image 11

Répétez cette procédure dans le dossier qui s'ouvre :

5.Faites un clic droit sur Python 3.7 et sélectionnez Ouvrir l'emplacement du fichier.

RoboDK API - Image 12

6.Sélectionnez Copier sur le chemin dans la barre de titre du chemin.

RoboDK API - Image 13

Indiquez le chemin de Python dans les paramètres de RoboDK :

7.Ouvrez RoboDK.

8.Sélectionnez Outils-Options.

9.Sélectionnez l'onglet Python.

10.Collez le chemin dans la boîte de l'interpréteur Python en ajoutant /python.exe, comme indiqué dans l'image suivante. L'utilisation de barres obliques ou de barres obliques inverses devrait fonctionner dans les deux cas.

RoboDK API - Image 14

C# API

L’API RoboDK pour le langage C# est un fichier source RoboDK.cs contenant la classe RoboDK (similaire à la classe Robolink de Python), la classe RoboDK.Item (similaire à l’API de classe Robolink.Item de Python) et d’autres outils pour la robotique tels qu’une classe Matrix (RoboDK.Mat) pour les opérations matricielles permettant d’opérer avec des transformations de pose.

Le langage C# (prononcé "C sharp") est un langage de programmation développé par Microsoft et conçu pour construire une variété d’applications qui s’exécutent sur le .NET Framework. C# est simple, puissant, à typage sûr et orienté objet. La section principale de ce document explique les avantages de l’utilisation de l’API RoboDK avec un langage de programmation largement utilisé comme C# pour la programmation robotisée.

L’API RoboDK pour C# est fournie avec un exemple de projet comme indiqué dans l’image suivante (le code source complet est inclus). Il est également possible de l’utiliser comme un package NuGet pour l’intégrer dans n’importe quel projet .Net.

RoboDK API - Image 15

Sélectionner Load File pour ouvrir une station RoboDK ou tout autre fichier pris en charge par RoboDK. Si un robot est chargé, la variable ROBOT sera mise à jour en conséquence (comme avec Select Robot).

Vidéo : La vidéo suivante présente un aperçu de l’exemple de projet C# utilisant l’API RoboDK : https://www.youtube.com/watch?v=3I6OK1Kd2Eo.

Simulation C#

Les programmes C# sont simulés par défaut lorsque des commandes de robot sont utilisées (comme MoveJ, MoveL ou setDO). Lorsque le projet exemple C# est lancé, le mode de simulation est également sélectionné par défaut.

RoboDK API - Image 16

Cela signifie que les mouvements du robot seront simulés dans RoboDK. Par exemple, nous pouvons déplacer le robot par pas de 10 mm en sélectionnant les boutons à droite (+Tx, -Tx, …), ou nous pouvons sélectionner Run Test Program pour exécuter un mouvement hexagonal autour de l’emplacement actuel du robot.

Vous pouvez définir les points d’arrêt pour déboguer votre application et inspecter les cibles du robot. Les cibles de robot peuvent être définies comme des coordonnées articulaires ou des variables Mat (matrices de pose 4x4) et peuvent être inspectées au format XYZWPR pour résoudre les problèmes de programme. Plus d’informations sur les repères dans la section Repères de référence.

RoboDK API - Image 17

Il est aussi possible de changer le Mode d’exécution à Programmation Hors Ligne ou Programmation en Ligne (Exécuter sur le robot), tel que décrit dans les sections suivantes.

C# PHL

Les programmes C# peuvent être générés hors ligne en utilisant le même code C# utilisé pour simuler le robot (programmation hors ligne). Suivre ces étapes pour tester cette fonctionnalité :

1.Sélectionner Offline Programming dans la section Run Mode

2.Sélectionner Run Test Program ou n’importe quelles autres combinaisons de mouvements

3.Sélectionner Generate Prog afin d’obtenir le programme robot spécifique à la marque.

Dans ce cas le programme n’est pas simulé mais exécuté rapidement pour obtenir le résultat : un programme de robot spécifique à un contrôleur de robot. Une fois le programme généré, le Run Mode redevient Simulation.

RoboDK API - Image 18

Astuce : Faire un clic droit sur un robot et sélectionner Sélectionner le post-processeur pour spécifier un post-processeur différent pour la programmation hors ligne (comme indiqué dans la section Post Processor).

Note : Le robot ne bougera pas lorsque le mode Offline Programming est actif car cela change le Run Mode en RUNMODE_MAKE_ROBOTPROG, comme le montre la section PHL de Python.

C# Programmation En Ligne

Les programmes C# peuvent être exécutés directement sur le robot en utilisant le même code C# utilisé pour la simulation. La programmation en ligne permet d’exécuter un programme générique sur un contrôleur de robot spécifique en utilisant les pilotes de robot. Suivre les étapes suivantes pour mettre à l’essai cette fonction à l’aide du projet exemple C# :

1.Sélectionner Run on Robot depuis la section Run Mode

2.Sélectionner n’importe quelle autre commande qui fera bouger le robot

Les mouvements fonctionneront sur le vrai robot et le simulateur synchronisera les mouvements avec le robot.

RoboDK API - Image 19

RDK = Robolink();

RDK.setRunMode(RUNMODE_RUN_ROBOT);

Astuce : La macro SampleOnlineProgramming.py provenant du dossier C:/RoboDK/Library/Macros/ fournit un exemple Python pour la programmation en ligne en dehors du GUI de RoboDK.

Note : Plus d’informations à propos de l’utilisation des pilotes de robot à travers l’API dans la section Robot Drivers.

API MATLAB

MATLAB est un langage de programmation propriétaire développé par MathWorks. Entre autres, MATLAB permet des manipulations matricielles, le traçage de fonctions et de données et la mise en œuvre d’algorithmes. RoboDK est un partenaire officiel du programme MathWorks Connections.

L’API RoboDK pour MATLAB est fournie sous forme d’un ensemble de fichiers de script (fichiers m), disponibles ici : dans le dossier d’installation de RoboDK, généralement C:/RoboDK/Matlab/ ; sur MathWorks MATLAB Central ; sur le GitHub de l’API RoboDK.

1.Sur le GitHub de l'API RoboDK.

2.Sur MathWorks MATLAB Central.

3.Dans le dossier d'installation de RoboDK, généralement C:/RoboDK/Matlab/.

La section principale de ce document explique les avantages de l’utilisation de l’API RoboDK avec un langage de programmation largement utilisé comme MATLAB pour la programmation de robots.

L’API RoboDK pour MATLAB comprend :

●Robolink.m est une classe qui interagit avec RoboDK. Tout objet dans l’arborescence de la station RoboDK peut être récupéré à l’aide de l’objet Robolink et il est représenté par l’objet RobolinkItem (comme la classe Robolink de Python).

●RobolinkItem.m est une classe qui représente un élément RoboDK dans l’arborescence de la station. Il est possible d’effectuer différentes opérations sur cet élément (comme la classe Robolink.Item de Python).

●transl.m, rotx.m, roty.m et rotz.m sont des fonctions qui créent des matrices de pose à partir d’un vecteur de translation XYZ ou de rotations autour d’un axe spécifique.

●Pose_2_XYZRPW.m et XYZRPW_2_Pose.m permettent de convertir des poses en position XYZ et en angles d’Euler RPW et vice versa. Plus d’informations dans la section Repères de référence.

La page suivante présente plusieurs exemples de l’API MATLAB de RoboDK, comme la manipulation d’éléments, la génération de programmes robot et le contrôle du robot : https://robodk.com/Matlab-API

Exemple Simulink

Un projet Simulink est disponible à titre d’exemple. Dans la simulation, le robot est déplacé le long d’un ensemble de coordonnées XYZ générées arbitrairement.

Vidéo : La vidéo suivante montre le résultat de l’exécution de la simulation :         
https://www.youtube.com/watch?v=7DDBMwa0-Oc

RoboDK API - Image 20

Options de Ligne de Commande

Cette section décrit comment passer des options de ligne de commande au démarrage de RoboDK. Cette section présente quelques commandes pertinentes qui peuvent vous aider à personnaliser le démarrage de RoboDK. Les options de ligne de commande peuvent également être passées en utilisant la fonction Command de l’API. Consultez la documentation de l’API pour obtenir la liste complète des commandes. Astuce : Sélectionnez Outils-Exécuter le script-ShowCommands pour afficher toutes les commandes que vous pouvez utiliser au démarrage de RoboDK.

L’appel suivant représente un appel générique à RoboDK avec quelques arguments :

RoboDK.exe -[option1] -[option2] open_fileA -[option3] open_fileB ...

Tous les formats de fichiers pris en charge par RoboDK peuvent être fournis comme arguments. Y compris les formats suivants :

●RDK    ➔ fichier station RoboDK : ce fichier comprend tout le projet, incluant toutes les dépendances (robots, outils, fichiers CN, …).

●robot    ➔ fichier Robot : charger un fichier robot créera aussi un repère pour ce robot.

●tool      ➔ fichier outil : Attaché automatiquement au dernier robot ajouté.

●stl/wrl/step/stp/iges/igs/sld ➔ Objet (géométrie 3D) : les objets peuvent facilement être convertis en outils.

●apt/gcode/cnc ➔ fichier programme CN : RoboDK prépare automatiquement un projet de fraisage (Utilitaires ➔ Projet de fraisage).

Astuce : les fichiers d’usinage robotisé tels que les fichiers CN seront automatiquement liés au repère actif et au repère de l’outil dans la station RoboDK. Vous trouverez quelques exemples de chargement de fichiers CN pour l’usinage robotisé dans les fichiers BAT ici : C:/RoboDK/Other/Plugin-Mecsoft.

RDK = Robolink(args='-ADDFRAME "-RENAME=Main Ref " load_object.stl')

La liste suivante présente quelques-unes des options de ligne de commande disponibles :

-NOSPLASH

Supprime l’image d’ouverture RoboDK au démarrage.

-DEBUG

Affiche les informations de débogage dans la console et crée un fichier RoboDK.debug.txt dans le dossier bin qui permet de déboguer l’application.

-SETTINGS=filepath.txt

Charge les arguments à partir d’un fichier texte. Chaque ligne de ce fichier texte est considérée comme un seul argument.

-NEWINSTANCE

Masque toutes les fenêtres pendant que RoboDK charge les fichiers et met à jour les programmes.

-HIDDEN

Évite le /SHOW automatique une fois que RoboDK a terminé le chargement. La seule façon d’afficher la fenêtre par la suite est en utilisant l’API.

-EXIT_LAST_COM

Masque toutes les fenêtres qui sont habituellement affichées automatiquement lors du chargement d’un fichier CN.

-NOUI

Démarrer RoboDK sans l’interface utilisateur (Fenêtre et vue 3D). Utiliser cette option pour exécuter RoboDK sans interface en arrière-plan à l’aide de l’API. Si vous affichez RoboDK, vous ne pourrez pas voir la vue 3D.

-PORT=20501

Force la communication de l’API par le port donné (protocole TCP/IP). Le port par défaut est 20500.

-TREE_STATE=-1

N’affiche pas l’arborescence de la station.

-TREE_STATE=6

Afficher l’arborescence de la station ancrée sur le côté gauche de la fenêtre et opaque.

-SKIPINI

Ajoute un nouveau repère de référence. Tout nouvel objet chargé sera placé dans ce repère.

-SKIPMAINT

Ignore les fenêtres contextuelles de renouvellement de la maintenance. Un mois avant l’expiration de la maintenance, RoboDK peut afficher une fenêtre bloquante au démarrage pour renouveler la licence. Ce paramètre vous permet de désactiver cet avertissement.

-UPDATE=file.apt

Charge ou met à jour le fichier APT et génère le programme robot s’il n’y a pas de problème.

-SHOW

Affiche la fenêtre RoboDK. Cela se fait automatiquement lorsque tous les fichiers ont été chargés et que les projets d’usinage ont été mis à jour.

L’utilisation de l’une des options suivantes modifiera la visibilité provoquée par la commande -SHOW.

-QUIT

Quitte le programme s’il n’y a pas de message d’erreur.

-END

Quitte le programme même s’il y a des messages d’erreur.