Ejecutar scripts
De un vistazo
- Aprende a ejecutar scripts e identificar los errores que se notifican durante su ejecución.
- Comprende cómo crear comandos de script personalizados mediante los procesos RunScript, RunScriptFile y RunScriptText.
- Descubre cómo asignar comandos de script a los menús y las barras de herramientas del editor, con atajos de teclado opcionales.
Aunque el sistema de scripting de Altium Designer permite crear sofisticadas tareas automatizadas para Altium Designer, los scripts resultantes también deben ser fácilmente accesibles durante el proceso de diseño. Por ejemplo, un script creado para realizar un conjunto complejo de operaciones durante la edición de una PCB debería estar disponible directamente en el propio editor de PCB, donde pueda ejecutarse con uno o dos clics del ratón.
Altium Designer satisface esta necesidad al permitir asignar un script a un lanzador de procesos y, de este modo, a un comando que puede asignarse a un menú, una barra de herramientas y un atajo de teclado.
Ejecución de scripts
Cuando se abre en el editor de scripts, un script puede ejecutarse mediante el comando Run » Run del editor desde los menús principales (atajo de teclado: F9). Se ejecutará el script actual al que hace referencia el comando Run » Set Project Startup Procedure.
El comando Run requiere que el proyecto de scripts esté abierto en Altium Designer, lo cual no es una forma práctica de acceder a un script necesario durante el proceso de diseño de PCB, por ejemplo. Como alternativa, el cuadro de diálogo Select Item To Run (File » Run Script) permite buscar un script en el disco duro local o en un espacio de trabajo conectado o seleccionar un script abierto en el panel Projects y, a continuación, ejecutar el proceso deseado. El script permanece cargado durante la sesión actual.
Ejecución de un script mediante el lanzador de procesos de scripts a través del cuadro de diálogo Select Item to Run.
Opciones y controles del cuadro de diálogo Select Item to Run
- Grid - muestra los proyectos de scripts disponibles (*.PrjScr) y los documentos fuente asociados. Seleccione el elemento de script deseado en la lista y, a continuación, haga clic en OK para ejecutar el script.
-
Examinar - haga clic para abrir un menú desplegable en el que puede elegir dónde buscar:
- From File - haga clic para buscar y seleccionar el elemento de script deseado en el cuadro de diálogo estándar de Windows Open.
- From Server - haga clic para buscar y seleccionar el elemento de script deseado en el cuadro de diálogo Choose item (una variante del panel Explorer).
- Copy script parameters - haga clic con el botón derecho en el elemento de script deseado para obtener los parámetros correctos. Esto copiará la ruta completa, el nombre del proceso y el procedimiento en el portapapeles.
Un método más adecuado para acceder a un script de uso frecuente es instalar el proyecto como un Global Project desde la página Scripting System – Global Projects del cuadro de diálogo Preferences. En este caso, el proyecto se carga automáticamente al iniciar Altium Designer y puede ejecutarse en cualquier momento mediante el comando File » Run Script.
Sin embargo, la forma ideal de acceder a la funcionalidad de un script es integrarlo en la interfaz gráfica de Altium Designer como un comando de menú o de barra de herramientas. Normalmente, este proceso consta de dos pasos: implementar un script como comando (con un atajo de teclado opcional) y, a continuación, asignar el comando a un menú (estático o emergente) o a una barra de herramientas.
Script como comando
Un script puede implementarse como un comando de la aplicación aprovechando los procesos de servidor integrados de Altium Designer o, más concretamente, el proceso ScriptingSystem:RunScript.
Un comando representa una acción que se realiza y se basa en una cadena de proceso a través de un lanzador de procesos empaquetado. En el caso del proceso ScriptingSystem:RunScript, incluye parámetros que apuntan a un archivo de proyecto de scripts específico, a uno de sus archivos de script (*.pas) y a un proceso dentro de ese script. Cuando se organizan adecuadamente, estos elementos constituyen una cadena de comando.
La ventaja de este enfoque es que ejecutar el script como un proceso evita la necesidad de abrirlo directamente o de tenerlo cargado como proyecto global. La segunda ventaja, y la más importante, de utilizar el método de procesos para ejecutar un script es que puede implementarse como un comando accesible de Altium Designer. Esto se hace personalizando el sistema de menús de Altium Designer, donde se puede asignar un script a un comando de un servidor específico, es decir, una subaplicación como el sistema de archivos o un editor de documentos de diseño.
Creación de un comando
Para asignar, por ejemplo, el script HelloWorld como comando del editor de PCB, abra primero un documento PCB (y, por tanto, el editor) y seleccione View » Tools » Customize en el menú principal para abrir el cuadro de diálogo Customizing PCB Editor. También puede acceder al cuadro de diálogo haciendo clic con el botón derecho en una barra de menús o de herramientas y eligiendo Customize en el menú desplegable, o haciendo doble clic en un área vacía (alejada de cualquier comando) de una barra de menús o de herramientas.
Para crear un comando nuevo, haga clic en el botón New del cuadro de diálogo para abrir el cuadro de diálogo Edit Command, donde podrá introducir los detalles del proceso de servidor y de la ruta del script. Asegúrese de que la categoría [Scripts] no esté seleccionada al crear un comando a partir de un script.
Las entradas Action del cuadro de diálogo tienen la siguiente forma:
Process: ScriptingSystem:RunScript
Parameters: ProjectName|ProcName>Process
Según la ruta de origen del script, la cadena Parameters sería similar a la siguiente:
ProjectName=C:\Users\Public\Documents\Altium\Delphiscript Scripts\General\HelloWorld.PRJSCR|ProcName=HelloWorld.pas>HelloWorld
El cuadro de diálogo Edit Command también proporciona campos para introducir el texto del comando, la descripción, el método abreviado de teclado y la imagen de mapa de bits asociada (BMP/GIF/PNG; 18 x 18 píxeles). Estos ajustes se guardan con el comando y se aplican a todas las instancias en las que se inserta en menús, barras de herramientas y menús emergentes, como se describe en la sección Asignación de comandos a menús más adelante.
Una vez completados los detalles y cerrado el cuadro de diálogo de edición , el script HelloWorld estará disponible como comando personalizado (en [Custom]) para el editor de PCB.
Ejecución de un script mediante el proceso RunScriptFile
Un script de unidad DelphiScript de Altium Designer (con la extensión *.pas) se puede ejecutar mediante el proceso RunScriptFile. Tenga en cuenta que solo se pueden utilizar scripts de unidad DelphiScript, no scripts que tengan formularios. En este caso, las entradas Action del cuadro de diálogo adoptan la siguiente forma:
Process: ScriptingSystem:RunScriptFile
Parameters: FileName|ProcName
Según la ruta de origen del archivo de script, la cadena Parameters sería similar a:
FileName=C:\Users\Public\Documents\Altium\Delphiscript Scripts\Processes\ShowNetList.pas|ProcName=RunNetList
Ejecución de un script mediante el proceso RunScriptText
Este proceso se puede utilizar para ejecutar una serie de comandos dentro del bloque Begin End;. En este caso, las entradas Action del cuadro de diálogo adoptan la siguiente forma:
Process: ScriptingSystem:RunScriptText
Parameters: Text
Por ejemplo, se puede iniciar una aplicación externa, como el Bloc de notas de Microsoft, desde Altium Designer mediante control por software. En este caso, las entradas del proceso del comando y de los parámetros serían:
Process: ScriptingSystem:RunScriptText
Parameters: Text=Begin RunApplication('notepad.exe'); End;
En este caso, el proceso de software, ScriptingSystem:RunScriptText, ejecuta literalmente una secuencia de instrucciones de script, en lugar de abrir y ejecutar un archivo de script específico como se ha descrito anteriormente.
El enfoque alternativo consiste en crear un script con unas pocas líneas de código equivalentes y, a continuación, crear una entrada de comando ScriptingSystem:RunScript convencional.
Procedure RunNotepad;
Begin
RunApplication('notepad.exe');
End;
Tenga en cuenta que, para ambos métodos de implementación del comando externo del Bloc de notas, basta con introducir 'notepad.exe' como parámetro de RunApplication, en lugar de especificar la ruta completa y el nombre de archivo de la aplicación. El sistema operativo ya tiene especificadas las rutas de aplicaciones de Windows como la Calculadora y el Bloc de notas.
Para iniciar desde Altium Designer una aplicación que no tenga una ruta predefinida en Windows, es necesario especificar la ruta completa y el nombre de archivo de la aplicación (entre comillas simples, para admitir posibles espacios en blanco en la ruta). Por lo tanto, para iniciar una segunda instancia de Altium Designer, por ejemplo, el proceso RunApplication y los parámetros serían:
RunApplication('C:\Program Files\Altium\xx\X2.EXE') – donde xx representa el nombre de la carpeta de la versión de Altium Designer.
Asignación de comandos a menús
Una vez implementado un script como comando personalizado del servidor mediante la función de personalización de Altium Designer (View » Toolbars » Customize), tal como se ha detallado anteriormente, se puede asignar a la interfaz gráfica del servidor simplemente arrastrándolo y soltándolo.
► Consulte también Personalización del espacio de diseño
Barras de herramientas
Para asignar un comando personalizado al menú principal o al menú de la barra de herramientas del editor de PCB, por ejemplo, abra el cuadro de diálogo Customizing PCB Editor, localice el comando personalizado y arrástrelo hasta la ubicación deseada del menú. Tenga en cuenta que debe haber un documento de PCB abierto para acceder a los menús del editor de PCB. Una vez cerrado el cuadro de diálogo de personalización, se podrá acceder al nuevo comando de menú en cualquier momento desde el editor de PCB.

Se puede arrastrar un comando personalizado hasta la ubicación deseada del menú.
Como en este ejemplo el nuevo comando personalizado se ha asignado a la barra activa de PCB, se puede ver en la categoría de comandos PCB Active Bar del cuadro de diálogo Customizing PCB Editor.

Cuando se asigna a un menú, el comando de script personalizado aparece en la categoría de ese menú en el cuadro de diálogo de personalización.
Para quitar un comando de un menú, abra el cuadro de diálogo de personalización y arrastre el icono del comando de menú de vuelta al cuadro de diálogo.

Eliminación de un comando asignado a la barra de herramientas.
Menús
Se puede asignar un comando personalizado a un menú, en cualquier nivel de profundidad, mediante el mismo procedimiento de arrastrar y soltar descrito anteriormente.
Cuando el servidor está en modo de personalización, los menús siguen respondiendo al puntero del ratón y se expanden y contraen según corresponda. Para colocar un comando en el menú Reports del editor de PCB, por ejemplo, arrastre el comando al menú y desplácelo por la lista hasta soltarlo en una posición adecuada. Una vez cerrado el cuadro de diálogo de personalización, se podrá acceder al nuevo comando de menú —en este caso, Bloc de notas— desde el menú Reports .

Los menús activos durante la personalización permiten arrastrar un comando personalizado a un menú desplegable.
Menú emergente
Se puede asignar un comando a un menú emergente del botón derecho de la misma forma descrita anteriormente, sin restricciones en cuanto a la profundidad de los submenús.
En este ejemplo, el comando se arrastra a través de la ruta de menú PCB Popups » Right Mouse Click Free Space y se suelta en el submenú, como se muestra a continuación. Una vez asignado, el comando de script personalizado del Bloc de notas estará disponible en el editor de PCB al hacer clic con el botón derecho en un espacio libre.

Un comando personalizado asignado a un submenú del botón derecho
Asignación directa de scripts
Como alternativa a crear un comando personalizado reutilizable a partir de un script y luego asignarlo a un menú, se puede aplicar un script directamente a un menú como solución rápida y puntual.
Este método omite el paso de crear un comando personalizado al asignar directamente un script cargado a un menú. Al no existir un comando personalizado correspondiente que se pueda aplicar como comando completamente configurado a varios menús, este método directo es una solución individual para acceder al script desde un menú. Por lo tanto, los distintos ajustes del comando, como su texto, descripción, imagen y métodos abreviados de teclado, solo se aplican a la instancia asignada.
Para asignar un script directamente a un menú, cargue el proyecto de script, abra el cuadro de diálogo Customizing del servidor (View » Toolbars » Customize), seleccione [Scripts] en la lista Categorías, localice el script deseado y arrástrelo hasta una posición del menú. Haga clic en
para cerrar el cuadro de diálogo Edit Command.

También se puede asignar directamente a un menú un script, en lugar de un comando.
Como ocurre con todos los elementos que se añaden a los menús, si el nuevo elemento de menú aún conserva su configuración predeterminada (texto, método abreviado, etc.), esta se puede modificar haciendo clic con el botón derecho en la entrada del menú y seleccionando Edit en el submenú. Esto abre el cuadro de diálogo Edit Command, donde se pueden introducir los ajustes adecuados.

En el modo de personalización, haga clic con el botón derecho en un menú para acceder a sus parámetros.
Una vez configurado, el nuevo menú estará disponible durante el diseño sin necesidad de cargar explícitamente el proyecto de script ni de instalarlo como proyecto global.
Tenga en cuenta que este método para asignar un script a un menú crea automáticamente el comando necesario. No se trata de un comando personalizado totalmente configurado que pueda reasignarse, como los descritos en los métodos anteriores, sino de un comando creado para esa entrada de menú específica.
Esto se puede observar en la entrada de la categoría del menú correspondiente en el cuadro de diálogo Customizing . En el ejemplo anterior, el comando configurado individualmente se puede ver en la categoría Reports del cuadro de diálogo Customizing PCB Editor.

Al asignar directamente un script a un menú, el comando correspondiente se crea únicamente para esa entrada de menú.






