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'heure actuelle, l'atelier Path est encore au début de son développement et ne peut pas encore vous proposer les fonctionnalités avancées de certains logiciels commerciaux. Néanmoins, son interface de script pour python vous facilite les modifications ou le développement d'outils plus puissants et est, pour l'instant, plus destiné aux utilisateurs avec des connaissances en scripts python qu'aux utilisateurs finaux.

Ci-dessous, vous trouverez une description plus approfondie de l'API de script python.

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

Format G-Code interne de FreeCAD
Un concept préliminaire est important à appréhender. La plus grande partie de l'implémentation ci-dessous est fortement liée aux commandes de déplacement qui ont les même noms que ceux de G-Code mais sans être proche d'une implémentation spécifique à un contrôleur. Nous avons choisi des noms tels que « G0 » pour indiquer un mouvement « rapide » ou « G1 » pour un déplacement « d'alimentation » pour la performance (sauvegarde de fichier efficace) et pour minimiser le travail de traduction de et vers les autres formats G-Code. Puisque le monde de la CNC utilise des milliers de dialectes G-Code, nous avons choisi de rester avec une partie simplifiée de ce code. On pourrait décrire le format G-Code de FreeCAD comme une forme indépendante des machines.

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

Toutes les traductions de et vers des dialectes G-Code FreeCAD sont réalisées par des scripts pre et post. Cela signifie que si vous voulez travailler avec une machine qui utilise un contrôleur spécifique tel que LinuxCNC, Fanuc, Mitusubishi, ou HAAS, etc., vous devrez utiliser (ou écrire s'il n'existe pas) un post-processeur pour ce contrôleur spécifique (allez voir la section « Importer et exporter du G-Code » ci-dessous).

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


 * la donnée G-Code, dans les objets Path de FreeCAD, est séparée en « Commandes ». Une Commande est définie par un nom qui doit débuter par G ou M et (optionnellement) des arguments, qui sont sous la forme Lettre = Nombre Flottant, par exemple X 0.02 ou Y 3.5 ou F 300. Ce sont des exemples typiques de commandes G-Code de 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 acceptées.
 * Seules les commandes débutant par G ou M sont actuellement acceptées pour l'instant.
 * Seuls les millimètres sont acceptés pour le moment. G20/G21 ne sont pas pris en compte.
 * Les arguments sont toujours triés alphabétiquement. Cela signifie que si vous créez une commande « G1 X2 Y4 F300 », elle sera écrite comme « G1 F300 X2 Y4 ».
 * Les arguments ne peuvent pas être répétés dans une même commande. Par exemple, « G1 X1 Y2 X2 Y3 » ne fonctionnera pas. Vous devrez la séparer en deux, par exemple: « G1 X1 Y2, G1 X2 Y3 ».
 * Les arguments X, Y, Z, A, B, C sont absolus ou relatifs, en fonction du mode G90/G91 actuel. C'est par défaut à absolu (si ce n'est pas spécifié).
 * I, J, K sont toujours relatifs au dernier point. K peut être oublié.
 * X, Y, ou Z (et A, B, C) peuvent être oubliés. Dans ce cas, les coordonnées X, Y ou Z précédentes sont gardées.
 * Les commandes G-code autres que celles listées dans la table ci-dessous sont supportées, ceci étant, elles sont sauvegardées dans le path data (tant qu'elles satisfont aux règles ci-dessus, bien sûr), mais elle ne produiront tout simplement pas de résultat visible à l'écran. Par exemple, vous pouvez ajouter la commande G81, elle sera enregistrée mais pas affichée.

L'objet Command
L'objet Command représente une commande gcode. 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 gcode) 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.

Caractéristique de Path
Path est un objet document de FreeCAD, qui contient un chemin et le présente en une vue 3D. 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 Path elle-même, ne soit pas modifiée. La transformation est purement visuelle. Cela vous permet, par exemple, de créer un Path 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
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.

Path Compound
L'objectif de cette fonction est d'assembler un ou plusieurs chemins 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 arborescente. Vous pouvez aussi réordonner les items en double-cliquant sur l'objet Compound de la vue arborescente et réordonner ses élements dans la vue de Taches qui s'ouvre. Une caractéristique importante de Path Compounds est la possibilité de prendre en compte ou non le Placement des sous-chemins en cochant leur propriété UsePlacements à True ou False. Sans cela, les données Path des sous-chemins seront simplement ajoutées séquentiellement. Si c'est positionné sur True, chaque commande des sous-chemins, 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 path enfant vous permet donc de rendre le Placement du Path enfant « réel » (il affecte les données Path).

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 gcode une fois que la totalité de l'initialisation du path 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 de table d'outils graphique qui peut être appelé depuis python, en lui donnant un objet qui possède une propriété ToolTable:

Path Shape
Cette fonctionnalité est un objet Path normal avec une propriété Shape additionnelle. En donnant à cette propriété une forme Wire, son chemin sera automatiquement calculé à partir de sa forme. Notez que dans ce cas, le placement est positionné automatiquement sur le premier point du fil et l'objet n'es donc plus déplaçable en changeant sa position. Pour le déplacer, la forme sous-jacente doit être bougée.

Python
Les fonctions Path::Feature et Path::FeatureShape ont une version en python, appelées respectivement Path::FeaturePython et Path::FeatureShapePython, qui peuvent être utilisées pour créer des objets paramétriques dérivés plus avancés.

Format Natif
Les fichiers G-Code peuvent être directement importés et exportés par l'interface graphique, en utilisant les éléments du menu « open », « insert » ou « export ». Après la saisie du nom de fichier, une fenêtre de dialogue apparaît pour demander quel script de traitement doit être utilisé. Cela peut être fait depuis python:

Les informations de Path sont stockées dans des objets Path utilisants le jeu gcode décrit dans la section « format G-Code interne de FreeCAD » ci-dessus. Ce jeu peut être importé ou exporté « tel quel » ou converti vers/depuis une version spécifique de G-Code adapté à votre machine.

Si vous avez un programme G-Code très simple et standard, qui respecte les règles décrites dans la section « format G-Code interne de FreeCAD » ci-dessus, par exemple le boomerang de http://www.cnccookbook.com/GWESampleFiles.html, il peut être importé directement dans un objet Path, sans traduction (c'est la même chose qu'utiliser l'option « None » de l'invite graphique):

De même, vous pouvez obtenir l'information path comme un G-Code « indépendant » et le sauvegarder manuellement dans un fichier:

Si vous avez besoin d'une sortie adaptée, vous aurez alors besoin de convertir ce G-Code « indépendant » 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 spécifique, qui ne respecte pas les règles internes utilisées FreeCAD, décrites dans la section « format G-Code interne de FreeCAD » ci-dessus, il pourrait échouer à l'import et/ou ne pas être correctement affiché en 3D. Pour y remédier, vous pouvez utiliser un scrit de pré-traitement qui convertira le format spécifique de votre machine vers celui de FreeCAD.

Si vous connaissez le nom du script de pré-traitement, vous pouvez importer votre fichier en l'utilisant, depuis la console python de cette manière: De la même manière, vous pouvez sortir un objet Path vers G-Code, en utilisant un script de post-traitement comme ceci:

Écrire des scripts de traitement
Les scripts de pre- et post-traitement se comportent comme d'autres importateurs/exportateurs habituels de FreeCAD. Lors du choix d'un script de pre/post traitement depuis l'invite, le processus d'import/export sera redirigé vers le script donné spécifique. 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 répertoire Mod/Path/PathScripts soit dans le répertoire path macro de l'utilisateur. Vous pouvez leur donner le nom que vous voulez mais par convention et pour être utilisé dans les menus graphiques, les noms des scripts de pre-traitement doivent terminer par « _pre », les scripts de post-traitement avec « _post » (assurez-vous d'utiliser underscore et pas le trait-d'union, sinon python ne pourra pas les importer). Voici un exemple de pre-traitement très, très simple. Des exemple plus complexes peuvent être trouvés dans le répertoire Mod/Path/PathScripts: Les pré- et post-traitements travaillent exactement de la même manière. Ils font simplement le contraire: les scripts pré convertissent un G-Code spécifique vers le G-Code de FreeCAD, alors que les scripts post convertissent le G-Code de FreeCAD vers un G-Code spécifique à une machine.