L’utilitaire graphique NGCGUI

Ngcgui est un outil puissant pour construire les programmes de G-code en sous-programmes.

Trois configurations sont fournies, elles se trouve dans le répertoire sim du sélecteur de configuration de LinuxCNC. Le sélecteur de configuration se trouve quand à lui dans le menu Applications → CNC → LinuxCNC.

Pour visualiser les sous-programmes presser l'Arrêt d'Urgence puis, activer la Marche Machine et réaliser la Prise d’origine générale. Cliquer sur un onglet de ngcgui et presser Créer la fonction puis Finaliser. Enfin, presser sur le bouton Départ cycle pour exécuter le G-code.

Les configurations en simulation pour ngcgui utilisent les liens suivants vers des librairies de LinuxCNC protégées en écriture:

Ces librairies sont définies dans le fichier ini par les items:

C’est une longue ligne (ne pas continuer sur de multiples lignes) qui spécifie les répertoires utilisés dans le chemin de recherche. Les noms de répertoires sont séparés par le caractère (:).

L’utilisateur peut créer de nouveaux répertoires pour ses propres sous-programmes et fichiers M et les ajouter dans le chemin de recherche.

Par exemple, un utilisateur pourrait créer ces répertoires à partir de la console.

Puis y créer ou y copier des fichiers qui lui seront accessibles en écriture. Par exemple, créer un sous-fichier compatible ngcgui nommé:

Le fichier ini doit être édité pour lui inclure les nouveaux sous-fichiers et les ajouter au chemin. Pour cet exemple:

LinuxCNC et ngcgui utilisent le premier fichier trouvé lors d’une recherche dans les répertoires du chemin de recherche. Avec ce comportement, Il est possible de substituer un sous-fichier ngcgui_lib en plaçant un sous-fichier avec un nom identique plus tôt dans le chemin de recherche pour qu’il soit trouvé avant. Plus d’informations peuvent être trouvées au chapitre INI dans le Manuel de l’intégrateur.

D’autres exemples de sous-programmes se trouvent dans le répertoire sim/ngcgui

Les items de fichier INI pour NGCGUI vont dans la section [DISPLAY].

Voici un exemple d’intégration de NGCGUI dans Axis. Les sous-programmes doivent être placés dans un répertoire spécifié par la variable [RS274NGC]SUBROUTINE_PATH. Certains exemples de sous-programmes utilisent d’autres sous-programmes, bien vérifier pour être sur d’avoir les bonnes dépendances, le cas échéant, dans un répertoire SUBROUTINE_PATH. Certains sous-programmes peuvent utiliser des fichiers M (Mfiles) personnalisés qui doivent se trouver dans un répertoire spécifié par [RS274NGC]USER_M_PATH.

Un sous-fichiers compatible NGCGUI contient une simple définition de sous-programme. Le nom du sous-programme doit être le même que celui du fichier (non inclus l’extension .ngc). LinuxCNC supporte les sous-programmes nommés ou numérotés, mais seuls les sous-programmes nommés sont compatible avec NGCGUI. Pour plus d’informations voir le chapitre sur les O-Codes.

La première ligne, autre qu’un commentaire, doit être une déclaration sub. La dernière ligne, autre qu’un commentaire, doit être une déclaration endsub.

Le corps du sous-programme doit commencer par un jeu de déclarations définissant les paramètres nommés locaux pour chaque paramètre positionnel attendu pour l’appel du sous-programme. Ces définitions doivent être consécutives, commencer par #1 et finir avec le numéro du dernier paramètre utilisé. Les définitions doivent être fournies pour chacun de ces paramètres (aucune omissions).

LinuxCNC considère tous les paramètres numérotés entre #1 est #30 comme étant des paramètres appelables, de même, ngcgui fourni des dialogues de saisie pour n’importe quel paramètres dans cette fourchette. Il est de bonne pratique d'éviter d’utiliser un paramètre numéroté de #1 jusqu'à #30 n’importe où ailleurs dans le sous-programme. L’utilisation de paramètres nommés locaux est recommandée pour toutes le variables internes.

Chaque définition de déclaration peut optionnellement inclure un commentaire spécial et une valeur par défaut pour le paramètre.

Si une valeur_par_défaut est donnée, elle sera placée au démarrage, dans la boîte de saisie pour le paramètre.

Si un texte_de_commentaire est inclus, il sera utilisé pour identifier l’entrée à la place du nom du paramètre.

Note sur les paramètres nommés globaux (#<nom_global>) avec ngcgui:

Comme dans de nombreux langages de programmation, l’utilisation de variables globales est puissante, mais peut souvent mener à des conséquences inattendues. Dans LinuxCNC, les paramètres nommés globaux existants seront valides lors de l’exécution du sous-programme et les sous-programmes peuvent les modifier ou en créer.

L’utilisation de paramètres nommé globaux comme entrées dans un sous-programme est déconseillé parce-que de tels usages requiert l'établissement et la maintenance d’un contexte global bien défini, ce qui est problématique à maintenir. L’utilisation de paramètres numérotés en #1 et #30 devrait être suffisant pour satisfaire les besoins les plus exigeants.

Ngcgui supporte quelques entrées par paramètres nommés globaux mais leurs usage est obsolète et non documenté ici.

Bien que les entrées par paramètres nommés globaux soient déconseillées, les sous-programmes LinuxCNC doivent utiliser des paramètres nommés globaux pour retourner les résultats. Puisque les sous-fichiers compatibles ngcgui sont destinés à l’usage de l’interface graphique, les valeurs de retour n’ont pas d’exigence commune. Toutefois, ngcgui est utile comme outil de test pour les sous-programmes qui ne retournent pas de paramètres nommés globaux et il est commun pour les sous-fichiers compatibles ngcgui d’appeler des fichiers de sous-programmes utilitaires qui eux retournent des résultats avec des paramètres nommés globaux.

Pour supporter ces usages, ngcgui ignore les paramètres nommés globaux qui incluent le caractère (:) dans leur nom. Utilisation des deux points (:) dans un nom prévient ngcgui de créer une bîte de saisie pour ces paramètres.

Dans l’exemple précédent, le sous-programme utilitaire sera trouvé dans un fichier séparé nommé helper.ngc. Le sous-programme d’aide retourne un résultat dans un paramètre nommé global nommé #<_helper:answer>.

Pour une bonne pratique, le sous-fichier appelant localise immédiatement le résultat pour une utilisation ailleurs dans le sous-fichier et le paramètre nommé global, utilisé pour retourner le résultat est mis à zéro pour diminuer les chances qu’il soit utilisé par inadvertance ailleurs dans le contexte global. (La mise à zéro avec 0.0 n’est pas toujours le meilleur choix).

Ngcgui supporte la création et la concaténation de multiples fonctions pour un sous-fichier et pour de multiples sous-fichiers. Il est parfois pratique pour les sous-fichiers de déterminer leur ordre au début de l’exécution afin que ngcgui insère un paramètre global spécial qui pourra être testé par tous les sous-programmes. Ce paramètre est nommé #<_feature:>. Sa valeur commence avec 0 et est incrémentée avec chaque fonction qui lui est ajoutée.

Un commentaire spécial info peut être inclus quelque part dans les sous-fichier compatibles ngcgui. Le format est le suivant:

La chaine info_text est affichée vers le haut de la page de l’onglet ngcgui dans Axis.

Les fichiers non destinés à servir de sous-fichiers peuvent inclure le commentaire spécial: "(not_a_subfile)" de sorte que ngcgui les rejette automatiquement avec un message explicatif.

Un fichier image optionnel (.png, .gif, .jpg, .pgm) peut accompagner un sous-fichier. Le fichier image peut aider à clarifier les paramètres utilisés par le sous-fichier. Le fichier image doit être dans le même répertoire que le sous-fichier et doit avoir le même nom avec une extension appropriée au fichier image, ex: le sous-fichier exemp.ngc doit être accompagné par l’image exemp.png. Ngcgui tente de redimensionner de grandes images par sous-échantillonnage à une largeur maximale de 320 et une hauteur maximum de 240 pixels.

Aucune des conventions nécessaires pour faire une sous-fichier compatible ngcgui n’empêche son utilisation en tant que fichier de sous-programme pour LinuxCNC.

La distribution LinuxCNC inclus une librairie (répertoire ngcgui_lib) qui contient plusieurs exemples de sous-fichiers et de fichiers utilitaires compatibles ngcgui pour illustrer les fonctions des sous-programmes de LinuxCNC et l’usage de ngcgui.

Des sous-programmes additionnels soumis par les utilisateurs se trouvent dans le forum dans la section Subroutines.

L’exemple ci-dessous montre l’utilisation du sous-programme DB25. Dans la première image on voit les champs remplis pour chaque variable.

Cette image montre le parcours d’outil du sous-programme DB25.

Cette image montre l’action du bouton Nouveau et de l’onglet personnalisé pour créer très facilement la découpe de trois DB25 en un seul programme.