Path scripting/fr

Introduction
L'atelier Path propose des outils pour importer, créer, manipuler et exporter des parcours-outils dans FreeCAD. Avec eux, l'utilisateur peut importer, voir et modifier des programmes G-Code existants, créer des chemins d'outils depuis des formes 3D et exporter ces chemins d'outils vers G-Code.

L'atelier Path en est actuellement à ses débuts et n'offre pas toutes les fonctions avancées de certaines alternatives commerciales. Cependant, l'interface de script en Python facilite la modification ou le développement d'outils plus puissants.

Prise en main rapide
Les objets Path de FreeCAD sont des commandes de séquences de déplacement. Voici une utilisation typique :



Le format G-code interne de FreeCAD
Il est important de comprendre un concept préliminaire. La majeure partie de la mise en œuvre ci-dessous s'appuie fortement sur des commandes de mouvement qui portent les mêmes noms que les commandes du G-code, mais qui ne sont pas censées être proches de la mise en œuvre d'un contrôleur particulier. Des noms tels que "G0" pour représenter un mouvement "rapide" ou "G1" pour représenter un mouvement "d'avance" ont été choisis pour des raisons de performance (économie de fichiers efficace) et pour minimiser le travail nécessaire à la traduction vers/depuis d'autres formats de G-code. Étant donné que le monde de la CNC parle des milliers de dialectes de G-code, un sous-ensemble très simplifié a été choisi. On pourrait décrire le format G-code de FreeCAD comme une forme de G-code "agnostique".

Les données Path sont sauvegardées directement sous cette forme de G-code dans les fichiers .FCStd.

Toutes les traductions vers/depuis les dialectes vers le G-code de FreeCAD sont effectuées par des pré et post-scripts. Cela signifie que si vous voulez travailler avec une machine qui utilise un contrôleur LinuxCNC, Fanuc, Mitusubishi ou HAAS spécifique, vous devrez utiliser (ou écrire s'il n'existe pas) un post-processeur pour ce contrôleur particulier (voir la section "Importer et exporter du G-code" ci-dessous).



Référence du G-code
Les règles et les lignes directrices suivantes définissent le jeu de G-code employé en interne dans FreeCAD :


 * Les données en G-code, à l'intérieur des objets Path de FreeCAD, sont séparées en "Commandes". Une commande est définie par un nom de commande, qui doit commencer par G ou M, et (optionnellement) des arguments, qui sont sous la forme Lettre plus un Flottant, par exemple X 0.02 ou Y 3.5 ou F 300. Voici des exemples de commandes typiques en G-code dans FreeCAD :

G0 X2.5 Y0 (le nom de commande est G0, les arguments X=2.5 et Y=0)

G1 X30 (le nom de commande est G1, le seul argument X=30)

G90 (le nom de commande est G90, sans argument)


 * Pour la partie numérique d'une commande G ou M, les deux formes "G1" ou "G01" sont prises en charge.
 * Seules les commandes commençant par G ou M sont prises en charge pour le moment.
 * Seuls les millimètres sont acceptés pour le moment. G20/G21 sont ignorés.
 * Les arguments sont toujours triés par ordre alphabétique. Cela signifie que si vous créez une commande avec "G1 X2 Y4 F300", elle sera stockée sous la forme "G1 F300 X2 Y4"
 * Les arguments ne peuvent pas être répétés à l'intérieur d'une même commande. Par exemple, "G1 X1 Y2 X2 Y3" ne fonctionnera pas. Vous devrez le diviser en deux commandes, par exemple : "G1 X1 Y2, G1 X2 Y3"
 * Les arguments X, Y, Z, A, B, C sont absolus ou relatifs, selon le mode G90/G91 en cours. La valeur par défaut (si elle n'est pas spécifiée) est absolue.
 * I, J, K sont toujours relatifs au dernier point. K peut être omis.
 * X, Y ou Z (et A, B, C) peuvent être omis. Dans ce cas, les coordonnées X, Y ou Z précédentes sont conservées.
 * Les commandes G-code autres que celles énumérées dans le tableau ci-dessous sont prises en charge, c'est-à-dire qu'elles sont sauvegardées dans les données du chemin (pour autant qu'elles respectent les règles ci-dessus, bien entendu), mais elles ne produiront tout simplement pas de résultat visible à l'écran. Par exemple, vous pouvez ajouter une commande G81, elle sera enregistrée, mais ne sera pas affichée.



Liste des commandes G-code actuellement acceptées


L'objet Command
L'objet Command représente une commande G-code. Il a trois attributs : Nom, Paramètres et Placement, ainsi que deux méthodes : toGCode et setFromGCode. En interne, il ne contient qu'un nom et un dictionnaire de paramètres. La suite (placement et G-code) est interprétée depuis/vers ces données.



L'objet Path
L'objet Path contient une liste de commandes.

En simplifiant, un objet Path peut aussi être créé directement depuis une séquence G-code complète. Elle sera automatiquement divisée en séquences de commandes.



La fonction Path
La fonction Path est un objet document de FreeCAD, qui contient un chemin et le présente en une vue 3D.

La fonction Path contient aussi une propriété de Placement. Changer la valeur de ce placement modifiera la position dans la vue 3D, bien que l'information de Path elle-même ne soit pas modifiée. La transformation est purement visuelle. Cela vous permet, par exemple, de créer un parcours autour d'une face qui a une orientation particulière sur votre modèle, qui n'aura pas la même orientation que la matière première que vous positionnerez sur votre CNC.

Néanmoins, Path Compounds peut utiliser le Placement de ses enfants (voir ci-dessous).



Objets Tool et Tooltable
REMARQUE : ce type d'utilisation des outils est déprécié à partir de la version officielle 0.19. Dans la version 0.19, le nouveau système d'outils ToolBit a été mis en place pour remplacer cet ancien système. Par conséquent, le codage a changé par rapport à ce qui est représenté ci-dessous. Veuillez consulter la page Path Outils pour plus d'informations.



Script <= 0.18
L'objet Tool contient les définitions d'un outil de CNC. L'objet Tooltable contient, lui, une liste ordonnée d'outils. Les Tooltables sont reliées comme propriété dans les caractérisques de Path Project et peuvent donc être éditées par l'interface graphique en double-cliquant sur le bouton « Edit tooltable » de l'arborescence d'un projet dans les tâches qui s'ouvrent.

Les tables d'outils peuvent être importées depuis les .xml de FreeCAD et les formats .tooltable de HeeksCad et exportés au format .xml de FreeCAD depuis cette interface.

Fonctions


La fonction Path Compound
L'objectif de cette fonction est d'assembler un ou plusieurs parcours d'outils et l'(les) associer à une table d'outils. La fonction Compound se comporte aussi comme un groupe standard FreeCAD dont vous pouvez y ajouter ou y enlever les objets directement depuis la vue en arborescence. Vous pouvez aussi réordonner les items en double-cliquant sur l'objet Compound de la vue en arborescence et réordonner ses élements dans la vue des tâches qui s'ouvre.

Une fonction importante de Path Compounds est la possibilité de prendre en compte ou non le Placement des parcours enfants en cochant leur propriété UsePlacements à True ou False. Sans cela, les données Path des enfants seront simplement ajoutées séquentiellement. Si True, chaque commande des parcours enfants, s'ils contiennent des informations de position (G0, G1, etc..), seront d'abord transformés par Placement avant d'être ajoutés.

En créant un composant avec un seul parcours enfant, vous pouvez donc de rendre le Placement du parcours enfant "réel" (il affecte les données Path).



La fonction Path Project
Le projet Path est une sorte d'extension de Compound, qui possède quelques propriétés liées à la machine telle que tooltable. Il a principalement été créé pour être le type d'objet à exporter en G-code une fois que la totalité de l'initialisation du chemin est prête. L'objet Project est maintenant codé en Python, d'où un mécanisme de création un peu différent :

Le module Path propose aussi un éditeur graphique de la table d'outils qui peut être appelé depuis Python, en lui donnant un objet qui possède une propriété ToolTable :



La fonction Path Shape
Attribuez la forme de la polyligne à un objet Path normal, en utilisant la fonction de script Path.fromShape (ou la fonction plus puissante Path.fromShapes). En donnant en paramètre un objet polyligne de Part, son parcours sera automatiquement calculée à partir de la forme. Notez que dans ce cas, le placement est automatiquement fixé au premier point de la polyligne et l'objet n'est donc plus déplaçable en changeant son placement. Pour le déplacer, il faut déplacer la forme sous-jacente elle-même.



Les fonctions Python
Les fonctions Path::Feature et Path::FeatureShape ont toutes deux une version Python, respectivement nommée Path::FeaturePython et Path::FeatureShapePython, qui peuvent être utilisées dans le code Python pour créer des objets paramétriques plus avancés dérivés de ces fonctions.



Importer et exporter du G-code


Format natif
Les fichiers G-code peuvent être importés et exportés directement via l'interface graphique, en utilisant les éléments de menu "ouvrir", "insérer" ou "exporter". Après avoir saisi le nom du fichier, une boîte de dialogue apparaît pour demander quel script de traitement doit être utilisé. Il est également possible de le faire à partir de Python :

Les informations sur les parcours sont stockées dans des objets Path en utilisant un sous-ensemble de G-code décrit dans la section "Format interne de G-code de FreeCAD" ci-dessus. Ce sous-ensemble peut être importé ou exporté "tel quel", ou converti en/à partir d'une version particulière de G-code adaptée à votre machine.

Si vous avez un programme en G-code très simple et standard, qui respecte les règles décrites dans la section "Format interne du G-code de FreeCAD" ci-dessus, par exemple le boomerang de cnccookbook, il peut être importé directement dans un objet Path, sans traduction (cela équivaut à utiliser l'option "Aucun" de la boîte de dialogue GUI) :

De la même manière, vous pouvez obtenir les informations sur le chemin d'accès sous forme de G-code "agnostique" et les stocker manuellement dans un fichier :

Si vous avez besoin d'un résultat différent, vous devrez convertir ce G-code agnostique dans un format adapté à votre machine. C'est le travail des scripts de post-traitement.



Utiliser les scripts de pre- et post-traitement
Si vous avez un fichier G-code écrit pour une machine particulière, qui n'est pas conforme aux règles internes utilisées par FreeCAD, décrites dans la section "Format G-code interne de FreeCAD" ci-dessus, il peut ne pas être importé et/ou rendu correctement dans la vue 3D. Pour remédier à cela, vous devez utiliser un script de prétraitement, qui convertira le format spécifique de votre machine au format FreeCAD.

Si vous connaissez le nom du script de prétraitement à utiliser, vous pouvez importer votre fichier en l'utilisant, à partir de la console Python comme ceci :

De la même manière, vous pouvez convertir un objet Path en G-code, en utilisant un script post_processeur comme celui-ci :



Écrire des scripts de traitement
Les scripts de pré- et post-traitement se comportent comme d'autres importateurs/exportateurs habituels de FreeCAD. Lors du choix d'un script de pré/post traitement depuis l'invite, le processus d'import/export sera redirigé vers le script spécifique donné. Les scripts de pré-traitement doivent contenir au moins des méthodes open(filename) et insert(filename,docname). Les scripts de post-traitement doivent implémenter export(objectslist,filename).

Les scripts sont placés soit dans le dossier Mod/Path/Path/Post/scripts soit dans le répertoire du chemin de la macro de l'utilisateur. Vous pouvez leur donner le nom que vous voulez, mais par convention, et pour être pris en compte par le dialogue de l'interface graphique, les noms des scripts de prétraitement doivent se terminer par "_pre", ceux des scripts de post-traitement par "_post" (assurez-vous d'utiliser le trait de soulignement, et non le trait d'union, sinon Python ne pourra pas l'importer). Ceci est un exemple de préprocesseur très, très simple. Des exemples plus complexes se trouvent dans le dossier Mod/Path/Path/Post/scripts :

Les pré et post-processeurs fonctionnent exactement de la même manière. Ils font simplement le contraire : les pré-scripts convertissent du G-code spécifique au G-code "agnostique" de FreeCAD, tandis que les post-scripts convertissent du G-code "agnostique" de FreeCAD au G-code spécifique à la machine.

<span id="Adding_all_faces_of_a_ShapeString_to_the_BaseFeature&#039;s_list_of_a_ProfileFromFaces_operation">

Ajouter toutes les faces d'une ShapeString à la liste de BaseFeature d'une opération ProfileFromFaces
Cet exemple est basé sur une discussion sur le forum germanophone.

Prérequis

 * Créer un solide avec ShapeString comme Cutout
 * Créer une tâche en utilisant ce solide comme son BaseObject
 * Créez une opération ProfileFromFaces nommée "Profile_Faces" avec une BaseGeometry vide.

<span id="The_code">

Le code
Le code suivant va ensuite ajouter toutes les faces de ShapeString et créer les chemins: