Descripción general y configuración del sistema de scripting

 

El sistema de scripting de Altium Designer proporciona todas las herramientas y funciones necesarias para crear scripts que automaticen tareas en el software.

El editor de scripts, el depurador y los paneles de scripting trabajan juntos para ayudarle a escribir y depurar sus scripts con facilidad. Un script puede ejecutarse directamente desde el editor de scripts o asignarse a un menú, barra de herramientas o tecla de acceso rápido para que pueda aplicarse al documento actual, como un diseño de PCB, en cualquier momento.

Altium Designer muestra las ventanas Script Code y Form junto con los paneles Object Inspector, Code Explorer y Tool Palette .
Altium Designer muestra las ventanas Script Code y Form junto con los paneles Object Inspector, Code Explorer y Tool Palette .

Funciones del sistema de scripting

El sistema de scripting se compone de dos partes principales: el editor y el depurador. Sus funciones principales son las siguientes:

  • Project access – Los scripts pueden guardarse en un proyecto de script o de diseño. Las rutinas de cualquier script de un proyecto son accesibles para otros scripts dentro del mismo proyecto.

  • Scripting Editor – El editor de scripting incluye un editor de texto dedicado con una variedad de opciones para configurar el entorno de edición y el coloreado de sintaxis.

  • Scripting Panels – El sistema de scripting incluye varios paneles que le ayudan a programar y depurar scripts rápidamente.

  • Scripting Debugger – Si un script tiene un error al ejecutarse, aparece un cuadro de diálogo con un mensaje de error conciso. Tiene la posibilidad de previsualizar variables en la ventana Watches, rastrear el código y controlar la ejecución del script con el Script Debugger.

  • Scripting Languages – Los scripts pueden crearse en DelphiScript y, si se habilita como lenguaje heredado, en VBScript.

  • El lenguaje de scripting predeterminado está configurado como DelphiScript. Puede abrir y ejecutar scripts existentes escritos en VBScript y JavaScript (Jscript). Para poder crear nuevos scripts escritos en VBScript, debe habilitar la opción Legacy.Scripts.SupportOldLanguages en el cuadro de diálogo Advanced Settings dialog.

  • La documentación de la API de scripting puede encontrarse aquí: Scripting API Objects. Tenga en cuenta que esta documentación se actualizó por última vez para una versión anterior de Altium Designer. Aunque muchos de los principios y enfoques seguirán siendo los mismos, tenga presente que las interfaces, los objetos, los métodos, las propiedades y elementos similares han cambiado desde entonces, y no reflejarán la totalidad de los que se encuentran en versiones posteriores del software.

Unidades y formularios de script

Los proyectos de script admiten dos tipos de documentos de script: Script Units y Script Forms. Las Script Units le permiten escribir procedimientos y funciones independientes. Los Script Forms le permiten crear cuadros de diálogo con controles y controladores de eventos, además de procedimientos y funciones.

  • Una Script Unit puede utilizar la interfaz de programación de aplicaciones (API) X2 para modificar o manipular objetos de diseño en un documento de diseño. Un Script Form aloja controles como interfaz de usuario y aprovecha la API X2 para proporcionar cuadros de diálogo de script que actúan sobre documentos de diseño activos.
  • Un Script Form es una unidad de formulario visual respaldada por el script. Cuando un formulario está activo, representa una ventana de diálogo.
  • Un Script Form tiene dos vistas: la vista Script Code y la vista Script Form. La vista Script Code contiene controladores de eventos y procedimientos/funciones. La vista Script Form representa un formulario de diálogo (de distintos tipos) y contiene controles junto con sus controladores de eventos asociados.
  • Un Script Form tiene dos archivos asociados. Un archivo *.pas que contiene controladores de eventos y procedimientos/funciones, y un archivo *.dfm que contiene los detalles del propio formulario de script junto con sus componentes y sus ubicaciones.
  • Un componente es un objeto de control visual o no visual (colocado desde el panel Tool Palette panel) que acepta entrada del usuario, como un clic del ratón o una secuencia de caracteres introducidos. Durante el diseño, el panel Object Inspector panel puede utilizarse para manipular componentes en un Script Form. Los componentes pueden utilizarse en cualquier Script Form con cualquier conjunto de lenguajes admitido por el sistema de scripting.
  • Un componente (objeto de control) tiene métodos, propiedades y eventos que pueden ser utilizados por un Script Form.
    • Los métodos son las acciones que un objeto puede realizar.
    • Las propiedades representan los datos contenidos en el objeto a los que se puede acceder o que se pueden modificar.
    • Los eventos son condiciones a las que puede reaccionar un componente de un Script Form.
  • Un Script Form tiene controladores de eventos que procesan las condiciones capturadas, como cuando se hace clic en un botón del formulario.

La documentación de scripting se centra principalmente en el conjunto de lenguajes DelphiScript. El conjunto de lenguajes DelphiScript se basa en la tecnología DelphiScript de Embarcadero. Para obtener información sobre las diferencias entre DelphiScript y Object Pascal (utilizado en Delphi), consulte el documento de referencia DelphiScript.

Ejemplos de scripts de Altium Designer

Los scripts de ejemplo y de referencia son un recurso útil para comprender cómo se aplican en los scripts las interfaces de objetos, métodos, procesos, propiedades y componentes. También pueden utilizarse como base para sus propios proyectos de script.

Los diseños de referencia heredados, creados en el lanzamiento de Altium Designer 10, pueden descargarse aquí. Incluyen varios ejemplos de simulación y scripting. Tenga en cuenta que son heredados y no se actualizan.
Para obtener información sobre otros ejemplos de scripts, consulte la Referencia de ejemplos de scripts. Para una explicación práctica sobre ejemplos de scripts funcionales en Altium Designer, consulte Writing Scripts y Script Example Analysis.

Ejecución de un ejemplo

Para ejecutar rápidamente un ejemplo de script en Altium Designer, primero abra un proyecto de ejemplo o un archivo de script individual desde una de las carpetas de scripts de ejemplo; por ejemplo, el sencillo proyecto "Hello World" (HelloWorld.PRJSCR) de la carpeta Scripts\Delphiscript Scripts\General.

Los ejemplos de scripts estarán disponibles en la carpeta de descargas ZIP extraídas.

El proyecto DelphiScript Hello World abierto en el panel Projects .
El proyecto DelphiScript Hello World abierto en el panel Projects .

El proyecto contiene dos versiones del script "Hello World", donde la segunda (HelloWorlDialog.pas) demuestra el uso básico de una unidad Form. Haga doble clic en el nombre de un script para abrirlo e inspeccionarlo en el editor; tenga en cuenta que un script puede ejecutarse sin estar abierto en el editor.

Para ejecutar uno de los scripts, seleccione File » Run Script en los menús principales y, a continuación, elija un procedimiento de script disponible en el cuadro de diálogo Select Item To Run. Cuando se ejecute una versión, se abrirá un cuadro de diálogo para mostrar el mensaje.

La forma rápida y sencilla de ejecutar un script de ejemplo.La forma rápida y sencilla de ejecutar un script de ejemplo.

Configuración del sistema de scripting

Preferencias

La configuración predeterminada de preferencias del sistema de scripting puede establecerse en el cuadro de diálogo Preferences, al que se accede haciendo clic en el botón de control , situado en la esquina superior derecha del espacio de diseño.

Preferencias generales

La página Text Editors – General del cuadro de diálogo Preferences le permite configurar los requisitos de edición de scripts, como el comportamiento de búsqueda de cadenas, cómo se tabulan y se sangran las líneas, cómo se asignan las teclas y varias otras opciones avanzadas.


La página Text Editors – General del cuadro de diálogo Preferences

Preferencias de color

La página Text Editors – Colors del cuadro de diálogo Preferences le permite configurar el coloreado de sintaxis del Script Editor para el lenguaje de scripting de su elección y establecer el color de los elementos dentro del editor de scripts. Por ejemplo, negro para el fondo, blanco para las palabras clave de comentarios, etc.

La página  Text Editors – Colors del cuadro de diálogo Preferences
La página Text Editors – Colors del cuadro de diálogo Preferences

Preferencias de visualización

La página Text Editors – Display del cuadro de diálogo Preferences le permite configurar las características visuales de los scripts, como mostrar márgenes derechos y números de línea, resaltado de sintaxis y esquema del código.

La página Text Editors – Display del cuadro de diálogo Preferences
La página Text Editors – Display del cuadro de diálogo Preferences

Preferencias globales de proyectos

La página Scripting System – Global Projects del cuadro de diálogo Preferences enumera los proyectos de script que están disponibles (instalados). Los proyectos de script pueden instalarse, eliminarse o reordenarse.

La página Scripting System – Global Projects  del cuadro de diálogo Preferences
La página Scripting System – Global Projects del cuadro de diálogo Preferences

Preferencias del diseñador de formularios

La página Scripting System – Form Designer del cuadro de diálogo Preferences proporciona las opciones de cuadrícula y designador de componentes para un documento de formulario de scripting.

La página Scripting System – Form Designer del cuadro de diálogo Preferences
La página Scripting System – Form Designer del cuadro de diálogo Preferences

AI-LocalizedLocalizado por IA
Si encuentra un problema, seleccione el texto/imagen y presioneCtrl + Enterpara enviarnos sus comentarios.
Disponibilidad de funciones

Las funciones disponibles dependen de la solución de Altium que tenga: Altium Develop, una edición de Altium Agile (Agile Teams o Agile Enterprise), o Altium Designer (con suscripción activa).

Si no ve alguna función mencionada en su software, contacte con Ventas de Altium para obtener más información.

Documentación heredada

La documentación de Altium Designer ya no está versionada. Si necesita acceder a la documentación de versiones anteriores de Altium Designer, visite la sección Documentación heredada de la página de Otros instaladores.

Contenido