NGCGUI

Para su uso, escriba un terminal:

Para su uso, escriba en un terminal:

Los siguientes elementos del archivo INI van en la sección [DISPLAY]. (Ver a continuación secciones adicionales para items adicionales necesarios)

Los siguientes elementos del archivo INI van en la sección [DISPLAY] para usar con Axis, gscreen o touchy. (Consulte las secciones adicionales a continuación para obtener información adicional)

Los siguientes elementos del archivo INI van en la sección [DISPLAY] para cualquier gui que incorpore ngcgui o pyngcgui.

Gcode-meta-compiler (gcmc) puede incluir declaraciones como: include ("filename.inc.gcmc"); Por defecto, gcmc incluye el directorio actual que, para linuxCNC, será el directorio que contiene el archivo ini linuxCNC. Directorios adicionales pueden ser antepuestos al orden de búsqueda de gcmc con el elemento GCMC_INCLUDE_PATH.

Ngcgui_ttt proporciona soporte para truetype-tracer (v4). Crea una pestaña Axis que permite al usuario crear una nueva página de pestaña ngcgui después de ingresar texto y seleccionar una fuente y otros parámetros. (Truetype-tracer debe estar instalado independientemente).

Para incrustar ngcgui_ttt en Axis, especifique los siguientes elementos además de los elementos ngcgui:

Ngcgui usa la ruta de búsqueda de linuxCNC.

La ruta de búsqueda comienza con el directorio estándar especificado por:

seguido de múltiples directorios especificados por: [RS274NGC]SUBROUTINE_PATH=directorio1_nombre:directorio1_nombre:directorio3_nombre …

Los directorios pueden especificarse como rutas absolutas o relativas.

Una ruta absoluta que comienza con "/" especifica una ubicación completa en el sistema de archivos. Una ruta que comienza con u "~/" especifica una ruta que comienza desde el directorio de usuario. Una ruta que comienza con "~nombre de usuario/" especifica una ruta que comienza en el directorio de nombre de usuario.

Caminos relativos Las rutas relativas se basan en el directorio de inicio, que es el directorio que contiene el archivo INI. El uso de rutas relativas puede facilitar la reubicación de configuraciones, pero requiere una buena comprensión de los especificadores de ruta de Linux.

Se pueden especificar varios directorios con [RS274NGC]SUBROUTINE_PATH separándolos con dos puntos. El siguiente ejemplo ilustra el formato para múltiples directorios y muestra el uso de rutas relativas y absolutas.

Esta es una línea larga, no continúa en varias líneas. Cuando linuxCNC y/o ngcgui busca archivos, se utiliza el primer archivo encontrado en la búsqueda.

LinuxCNC (y ngcgui) debe poder encontrar todas las subrutinas, incluidas las rutinas auxiliares que se llaman desde subfiles ngcgui. Es conveniente colocar las utilidades subs en un directorio separado como se indica en el ejemplo anterior.

La distribución incluye el directorio ngcgui_lib y los archivos de demostración para preámbulos, subarchivos, epíñogos y archivos auxiliares. Para modificar el comportamiento de los archivos, puede copiar cualquier archivo y colocarlo en una parte anterior de la ruta de búsqueda El primer directorio buscado es [DISPLAY]PROGRAM_PREFIX. Puede usar este directorio pero es mejor crear uno dedicado y colócarlo al comienzo de [RS274NGC]SUBROUTINE_PATH.

En el siguiente ejemplo, los archivos en /home/myname/linuxcnc/mysubs se encontrarán antes que archivos en ../../nc_files/ngcgui_lib.

Los nuevos usuarios pueden intentar inadvertidamente usar archivos que no están estructurados para ser compatibles con los requisitos de ngcgui. Ngcgui probablemente informará numerosos errores si los archivos no están codificados con las convenciones. Las buenas prácticas sugieren que los subarchivos compatibles con ngcgui deben colocarse en un directorio dedicado a ese propósito y que los archivos de preámbulo, epilogo y auxiliar deben estar en directorio(s separados) para desalentar los intentos de usarlos como subarchivos. Archivos no destinados para usar como subarchivos puede incluir un comentario especial: "(not_a_subfile)" para que ngcgui los rechace automáticamente con un mensaje relevante.

Un subfile compatible con NGCGUI contiene una única definición de subrutina. El nombre de la subrutina debe ser el mismo que el nombre del archivo (sin incluir el sufijo .ngc). LinuxCNC admite subrutinas con nombre o numeradas, pero solo las subrutinas con nombre son compatibles con NGCGUI. Para más información ver el Capítulo códigos O.

La primera línea sin comentarios debe ser una declaración sub. La última línea sin comentarios debe ser una declaración endsub.

El cuerpo de la subrutina debe comenzar con un conjunto de declaraciones que definen parámetros nombrados locales para cada parámetro posicional esperado para la llamada de subrutina Estas definiciones deben ser consecutivas comenzando con #1 y terminando con el último número de parámetro utilizado. Se deben proporcionar definiciones para cada uno de estos parámetros (sin omisiones).

Numeración de parámetros

LinuxCNC considera que todos los parámetros numerados en el rango #1 al #30 son parámetros de llamada por lo que ngcgui proporciona cuadros de entrada para cualquier ocurrencia de parámetros en este rango. Es una buena práctica evitar el uso de parámetros numerados #1 a #30 en cualquier otro lugar de la subrutina. El uso de parámetros locales con nombre esta recomendado para todas las variables internas.

Cada declaración de definición puede incluir opcionalmente un comentario especial y un valor predeterminado para el parámetro.

Prototipo de declaración

Si se proporciona un valor predeterminado, se ingresará en el cuadro de entrada para el parámetro al inicio.

Si se incluye comment_text, se usará para identificar la entrada en lugar del nombre del parámetro.

Notas sobre parámetros globales con nombre y ngcgui:

(los parámetros globales con nombre tienen un guión bajo en el nombre, como #<_someglobalname>)

Como en muchos lenguajes de programación, el uso de globales es poderoso pero a menudo puede conducir a consecuencias inesperadas. En LinuxCNC, los parámetros globales con nombre existentes serán válidos en la ejecución de subrutinas y las subrutinas pueden modificar o crear parámetros cun nombre globales.

Se desaconseja pasar información a subrutinas utilizando parámetros con nombre globales dado que dicho uso requiere el establecimiento y mantenimiento de un bien definido contexto global que es difícil de mantener. Usando los parámetros numerados de #1 a #30 como entradas de subrutina debería ser suficiente para satisfacer una amplia gama de requerimientos de diseño.

Si bien no se recomiendan los parámetros con nombre global de entrada, las subrutinas linuxCNC deben usar parámetros globales con nombre para devolver resultados. Los subarchivos ngcgui-compatible están destinados al uso de GUI; los valores de retorno no son un requisito común. Sin embargo, ngcgui es útil como herramienta de prueba para subrutinas que devuelven parámetros con nombre global y es común que los subfiles compatibles con ngcgui llamen archivos de subrutina de utilidad que devuelven resultados con parámetros globales con nombre.

Para admitir estos usos, ngcgui ignora los parámetros globales con nombre que incluyen dos puntos (:) en su nombre. El uso de los dos puntos (:) en el nombre evita que ngcgui haga cuadros de entrada para estos parámetros.

En el ejemplo anterior, la subrutina de la utilidad se encontrará en un archivo separado llamado helper.ngc. La rutina auxiliar devuelve un resultado en un parámetro global con nombre llamado #<_helper:answer>.

Para una buena práctica, el subarchivo de llamada localiza inmediatamente el resultado para su uso en otro lugar del subarchivo y el parámetro global con nombre utilizado para devolver resultado se anula en un intento de mitigar su uso involuntario en otros lugares del contexto global. (Un valor de anulación de 0.0 puede no siempre ser buena elección).

Ngcgui admite la creación y concatenación de múltiples funciones para un subfile y para múltiples subfiles. A veces es útil para subarchivos determinar su orden en tiempo de ejecución para que ngcgui inserte un parámetro global especial que se puede testear dentro de las subrutinas. El parámetro se llama # <_feature:>. Su valor comienza con un valor 0 y se incrementa para cada característica agregada.

Se puede incluir un comentario especial de información en cualquier lugar de un subarchivo ngcgui-compatible. El formato es:

Info_text se muestra cerca de la parte superior de la página de la pestaña ngcgui en Axis.

Los archivos que no están destinados a usarse como subarchivos pueden incluir un comentario especial para que ngcgui los rechace automáticamente con un mensaje relevante.

Un archivo de imagen opcional (.png, .gif, .jpg, .pgm) puede acompañar a un subarchivo. Los archivos de imagen puede ayudar a aclarar los parámetros utilizados por el subarchivo. El archivo de imagen debe estar en el mismo directorio que el subarchivo y tener el mismo nombre con un sufijo de imagen apropiado, p.ej. el subfile example.ngc podría ir acompañado de un archivo de imagen example.png. Ngcgui intenta cambiar el tamaño de las imágenes grandes submuestreando a un tamaño con un ancho máximo de 320 x 240 píxeles.

Ninguna de las convenciones requeridas para hacer un subfile compatible con ngcgui excluye su uso como archivo de subrutina de propósito general para LinuxCNC.

La distribución LinuxCNC incluye una biblioteca (directorio ngcgui_lib) que incluye archivos de utilidad y subfiles compatibles con ngcgui de ejemplo para ilustrar las características de las subrutinas LinuxCNC y el uso de ngcgui. Otra biblioteca (gcmc_lib) proporciona ejemplos de archivos de subrutina para el metacompilador Gcode (gcmc)

Se pueden encontrar subrutinas adicionales para usuarios en el Foro, en la sección de subrutinas.

Ngcgui lee los archivos de Gcode-meta-compiler (gcmc) y crea cuadros de entrada para variables etiquetadas en el archivo. Cuando una característica del archivo finaliza, ngcgui pasa el archivo como entrada al compilador gcmc y, si la compilación es exitosa, el archivo gcode resultante se envía a linuxCNC para su ejecución. El archivo resultante está formateado como subrutina de un solo archivo; Los archivos .gcmc y los archivos .ngc se pueden mezclar en ngcgui.

Las variables identificadas para su inclusión en ngcgui están etiquetadas con líneas que parecerán comentarios al compilador gcmc.

Ejemplos de formatos de etiquetas variables.

Ejemplos:

Para estos ejemplos, el cuadro de entrada para varname1 no tendrá un valor predeterminado, el cuadro de entrada para varname2 tendrá un valor predeterminado de value2, y el el cuadro de entrada para varname 3 tendrá un valor predeterminado de 3 y una etiqueta label3 (en lugar de varname3). Los valores predeterminados deben ser números.

Para facilitar la modificación de líneas válidas en un archivo gcmc, alterne formatos de línea de etiqueta aceptados. Los formatos alternativos ignoran los punto y coma finales (;) y marcadores de comentarios finales (//). Con esta disposición, a menudo permite agregar la etiqueta //ngcgui: a líneas existentes en un archivo .gcmc.

Ejemplos:

Una línea de información que aparecerá en la parte superior de una pestaña puede ser opcional incluido con una línea etiquetada como:

Cuando sea necesario, las opciones se pueden pasar al compilador gcmc con una línea etiquetada:

Formato de etiqueta de línea de opción

Ejemplos:

Las opciones para gcmc están disponibles con el comando de terminal:

Un programa gcmc por defecto usa el modo métrico. El modo puede establecerse en pulgadas con la opción:

Un archivo de preámbulo, si se usa, puede establecer un modo (g20 o g21) que entra en conflicto con el modo utilizado por un archivo gcmc. Para asegurar que el modo de programa gcmc está en vigor, incluya la siguiente declaración en el archivo .gcmc:

y proporcione una ruta adecuada para gcmc include_files en el archivo ini, por ejemplo: