Automating Design Tasks with Scripting

Les scripts offrent un moyen puissant d’accroître vos capacités et votre productivité avec Altium Designer. Un script contient un ensemble d’instructions (commandes automatisées) interprétées lors de son exécution dans Altium Designer. Les scripts peuvent être écrits dans plusieurs langages, avec des boîtes de dialogue sophistiquées, et débogués dans Altium Designer. Vous pouvez utiliser des scripts pour atteindre vos objectifs de conception avec une intervention minimale de l’utilisateur et moins d’appuis sur le clavier et de clics de souris.

Grâce aux scripts, vous pouvez automatiser les tâches répétitives et effectuer des modifications qui ne sont pas disponibles avec les commandes existantes dans Altium Designer. Par exemple, vous pouvez utiliser un script pour rechercher et mettre à jour des repères fiduciaires dans un document PCB, ou pour exporter une netlist personnalisée.

Les scripts peuvent être enregistrés dans un projet de script ou dans un projet de conception. Plusieurs langages de script sont disponibles pour écrire des scripts dans Altium Designer.

Vue d’ensemble et configuration du système de script

Le système de script d’Altium Designer fournit tous les outils et fonctionnalités nécessaires pour créer des scripts qui automatisent les tâches dans le logiciel.

Des scripts peuvent être écrits pour automatiser des tâches répétitives ou améliorer une fonctionnalité dans Altium Designer. Le système de script se compose de deux parties principales : l’éditeur et le débogueur. L’éditeur de scripts, le débogueur et les panneaux de script fonctionnent ensemble pour vous aider à écrire et déboguer facilement vos scripts. Un script peut être exécuté directement depuis l’éditeur de scripts ou affecté à un menu, une barre d’outils ou un raccourci clavier afin de pouvoir être appliqué au document actif – tel qu’un PCB – à tout moment.

► En savoir plus sur le système de script dans Altium Designer

Création et stockage des scripts

Les scripts Altium Designer sont généralement créés et stockés dans un projet de script (*.PrjScr), mais peuvent être ajoutés à ou stockés dans tout type de projet.

Pour commencer à écrire des scripts, créez d’abord un nouveau projet de script et ajoutez des fichiers de script à ce projet.

Un projet de script vous aide à gérer vos scripts et peut être créé en sélectionnant File » New » Project » Script Project dans les menus principaux. Un nouveau projet sera répertorié dans le panneau Projects. Pour ajouter un nouveau script au projet, cliquez avec le bouton droit sur le nom du projet et sélectionnez Add New to Project dans le menu contextuel.

Lors de la création d’un nouveau script, vous avez le choix entre deux types de scripts selon les exigences de votre projet : les unités de script et les formulaires de script. Les unités de script vous permettent d’écrire des procédures et fonctions autonomes. Les formulaires de script vous permettent de créer des boîtes de dialogue avec des contrôles et des gestionnaires d’événements, ainsi que des procédures et fonctions.

► En savoir plus sur la création et le stockage des scripts dans Altium Designer

Écriture de scripts

Il existe un certain nombre de concepts et de termes essentiels applicables à l’écriture de scripts :

• Les processus sont des chaînes de commande que vous pouvez utiliser pour exécuter des commandes dans des scripts.

• Les composants sont des objets de contrôle visuels du Tool Palette panneau que vous pouvez faire glisser sur un formulaire de script pour manipuler la conception.

• Un composant placé sur un formulaire de script possède des méthodes, des propriétés et des événements.

• Les interfaces d’objet sont des interfaces d’objet spéciales que vous pouvez utiliser pour extraire et modifier des données dans les documents de conception à partir de vos scripts.

Le langage de script par défaut est DelphiScript (*.pas). Le moteur de script lui-même est écrit en Embarcadero Delphi, et le Tool Palette panneau repose sur la VCL (Visual Component Library) de Delphi.

► En savoir plus sur l’écriture de scripts dans Altium Designer

Outils d’édition et de débogage des scripts

Le système de script d’Altium Designer se compose de deux parties principales – l’éditeur et le débogueur. L’éditeur offre une gamme de fonctions d’aide et d’inspection du code de script, et le débogueur donne accès aux composants de script et aux fonctions de débogage. Les outils de l’éditeur de scripts constituent un atout essentiel lors du débogage des scripts.

Le système de script propose toute une gamme d’outils pour faciliter le débogage des scripts. Ceux-ci incluent l’application de plusieurs points d’arrêt dans un script, l’utilisation du Watch List panneau pour surveiller la valeur des variables, l’utilisation de signets pour naviguer plus efficacement, ainsi que les fonctions pas à pas détaillé et pas à pas principal pour suivre l’exécution des scripts.

► En savoir plus sur les outils d’édition de scripts dans Altium Designer

► En savoir plus sur le débogage des scripts dans Altium Designer

Exécution des scripts

Bien que le système de script d’Altium Designer fournisse les moyens de créer des tâches automatisées sophistiquées pour Altium Designer, les scripts obtenus doivent également être facilement accessibles pendant le processus de conception. Par exemple, un script créé pour effectuer un ensemble complexe d’opérations lors de l’édition d’un PCB doit être facilement disponible dans l’éditeur PCB lui-même, où il peut être exécuté en un ou deux clics de souris.

Altium Designer permet cela en autorisant l’affectation d’un script à un lanceur de processus, et donc à une commande pouvant être assignée à un menu, une barre d’outils et un raccourci.

Un script peut être exécuté à l’aide de la commande Run de l’éditeur lorsqu’il est ouvert dans l’éditeur de scripts. Cela nécessite que le projet de script soit ouvert dans Altium Designer, ce qui n’est pas une approche pratique pour accéder à un script nécessaire pendant le processus de conception PCB, par exemple. En alternative, la boîte de dialogue Select Item To Run (File » Run Script) vous permet de parcourir un script sur votre disque dur local ou dans un Workspace connecté, puis d’exécuter le processus souhaité. Le script reste chargé pendant la session en cours.

Une méthode plus adaptée pour accéder à un script fréquemment utilisé consiste à installer le projet comme projet global depuis la page Scripting System – Global Projects de la boîte de dialogue Preferences. Dans ce cas, le projet est automatiquement chargé au démarrage d’Altium Designer et peut être exécuté à tout moment via la commande File » Run Script.

► En savoir plus sur l’exécution des scripts dans Altium Designer

Composants graphiques de script

Les composants visuels de formulaire disponibles pour une utilisation dans les scripts Altium Designer sont pour la plupart dérivés de la Visual Component Library (VCL) d’Embarcadero, qui est une collection de composants visuels définis pour le développement d’applications Windows à l’aide des langages Delphi et C++.

Développées comme bibliothèque de classes visuelles, les classes VCL descendent de l’objet TComponent (lui-même descendant de l’objet racine TObject) dans une hiérarchie d’objets linéaire. Par conséquent, un composant de script courant, tel que l’objet TButton, hérite des propriétés, méthodes et événements de ses objets ascendants. Dans ce cas, la hiérarchie de classes est : TObject → TPersistent → TComponent → TControl → TWinControl → TButtonControl → TButton.

Notez que les composants qui descendent de l’objet TControl sont généralement des composants visuels (contrôles), et que les composants courants qui descendent de TWinControl sont principalement des encapsulations de l’API Windows.

Lors de la création d’un formulaire dans l’éditeur de scripts Altium Designer, les composants sont accessibles depuis le Tool Palette panneau. Les formulaires de script ont un fichier *.DFM associé, qui comprend les détails de la configuration du formulaire, l’emplacement de ses composants et d’autres attributs ; ce fichier se trouve dans le dossier hôte du projet de script. Altium Designer permet d’utiliser les composants aussi bien avec DelphiScript qu’avec VBScript lors de la conception de formulaires de script.

► En savoir plus sur les composants graphiques de script dans Altium Designer

Exemples de scripts

Pour mieux comprendre les aspects généraux du système de script, ainsi que l’utilisation des modèles d’objet Delphi et X2 dans les scripts, deux projets d’exemple sont examinés du point de vue fonctionnel : un copieur de contour de carte et un script de génération de netlist. Les scripts Board Outline Copier et Netlister sont développés à l’aide des modèles d’objet X2 afin d’illustrer les capacités du système de script dans Altium Designer.

Il s’agit de scripts existants disponibles dans la collection d’exemples de scripts. Le dossier Scripts du fichier ZIP contient des sous-dossiers organisés selon les langages de script.

Notez qu’un large éventail de scripts utiles peut être trouvé dans la collection GitHub Altium Designer.

► En savoir plus sur l’analyse d’exemples de scripts dans Altium Designer

► En savoir plus sur la référence des exemples de scripts pour Altium Designer

Prise en charge des langages de script

Des scripts peuvent être écrits pour Altium Designer dans plusieurs langages de script. Notez que le langage principal, et celui le plus souvent mentionné dans la documentation sur les scripts, est DelphiScript, qui est étroitement lié à Embarcadero Delphi™.

► En savoir plus sur la prise en charge des langages de script dans Altium Designer