Aout 2010
Question:
Quels sont les avantages de l'utilisation de scripts et de quelle façon doit-on s'y prendre pour en concevoir?
Résumé :
Les ingénieurs d'aujourd'hui doivent faire face à des contraintes toujours plus gênantes les une que les autres, que ce soit au niveau de la conception, du temps, des tests, etc... Le temps que passe un ingénieur au niveau de la conception que ce soit au niveau de la saisie de schéma ou à la création de la carte est très important et bien souvent il fait face à des manipulations très redondantes. L'utilisation de script permet entre autre d'automatiser ces manipulations redondantes afin de se concentrer sur d'autres aspects critiques du développement. Ces mêmes scripts permettent bien souvent d'ouvrir les portes du logiciel à bien d'autres fonctionnalités.
Dans le support tip de ce mois, nous verrons quels sont les éléments dont vous avez besoin afin d'utiliser et de créer ces scripts puis une explication détaillée d'un exemple de script.
Qu'est ce qu'un script?
Un script est un langage de programmation qui permet un contrôle d'une ou plusieurs applications d'un logiciel. Ils se différencient par le code qu'ils contiennent et sont écrient dans différents langages de programmation. Ces scripts sont généralement utilisé par l'ingénieur pour automatiser une partie de son travail ou alors pour accéder à des applications avancées du logiciel qui ne sont pas disponible depuis les menus.
Quels sont les langages de programmation supportés dans Altium Designer?
Vous pouvez choisir un des langages suivant pour écrire un script qui sera utilisé dans Altium Designer, chacun de ces langages est lié à un type de fichier bien particulier listé ci-dessous:
- Delphi Script (*.pas)
- Enable Basic (*.bas)
- VB Script (*.vbs)
- Java Script (*.js)
Altium met à disposition de la documentation afin de pouvoir utiliser chacun de ces langages dans Altium Designer:
Dans l'exemple que nous allons voir plus loin, nous avons choisi le langage Delphi. La plupart des exemples de scripts qui sont fournis avec l'installation d'Altium Designer sont écris dans ce langage.
Quelles sont les syntaxes à utiliser et où les trouver?
Lorsque l'on écrit un script par rapport à certaines fonctions du logiciel, on a besoin des syntaxes appropriées à ces fonctions. Altium met à disposition ces syntaxes à travers différentes documentations disponible avec l'installation mais aussi depuis le site Altium Wiki
Altium Designer est un vaste logiciel qui contient plusieurs éditeurs et c'est pourquoi la documentation a été séparée de la même façon que ces différents éditeurs. Bien sûr, il y a encore beaucoup de distinctions parmi les syntaxes se trouvant dans chacun des éditeurs, c'est pourquoi Altium les tri en cinq domaines bien particulier:
- Les types
- Les constantes
- Les fonctions
- Les objets de conception
- Les interfaces systèmes
Pour chacun de ces domaines, on peut trouver une sous documentation bien approprié dans les documents d'aide de chaque éditeur que voici:
| Info | ||
|---|---|---|
| ||
Les syntaxes des documents API sont valable pour tous les langages de programmation supportés dans Altium Designer. |
Parmi les syntaxes que l'on peut utiliser pour créer des scripts, on trouve également les syntaxes RTL (Run Time Library) qui sont composées des éléments API (Application Programming Interfaces). Ces syntaxes RTL permettent une conception hiérarchique du script, elles réfèrent aux différents serveurs de la plate-forme Altium Designer qui sont en fait les différents éditeurs. Voici quelques exemple de syntaxe RTL: Client/Server API, Workspace Manager API, PCB API, Schematic API and Integrated Library API
Pour en savoir plus à propos de ces fameuses syntaxes RTL, référez vous à la documentation suivante:
What is the Altium Designer RTL
L'éditeur de scripts
Le système de script est composé de deux principaux domaines , l'éditeur et le débogueur, qui sont totalement liés l'un à l’autre afin de facilité l'écriture et le débogage du script. Un script peut être ajouter dans un projet de conception ou alors dans un projet script. Dans la partie de l'éditeur de texte, une seconde page peut être atteinte pour prévisualiser une fenêtre que l'on créé avec le script.
| Imagecaption |
|---|
Prévisualisation de la fenêtre du script |
L'éditeur de script met à disposition un éditeur texte avec multiples options, une reconnaissance des syntaxes par des couleurs mais aussi différents panneaux pour vous aider créer le code du script de la plus façon la plus intuitive qui soit. Par exemple le panneau Tool Palette qui permet de placer directement des objets, comme des boutons, sur la prévisualisation de la fenêtre du script.
| Imagecaption |
|---|
Le panneau Tool Palette |
Les propriétés ainsi que les options de l’éditeur script se trouve sous DXP>>Preferences>>Text Editor. On peut modifier ici l'affichage de l'éditeur, les couleurs des syntaxes et des éléments ainsi que différentes autres options.
| Imagecaption |
|---|
Préférences de l'éditeur texte |
Écriture d'un script
Avant de commencer à écrire le script, on doit avoir connaissance des points suivants:
- Les composants sont des objets visuels que l'on peut placer directement depuis le panneau Tool Palette vers la prévisualisation du script
- Un composant ou un contrôle qui est placé sur une prévisualisation du script a des propriétés, des méthodes et des événements.
- Les processus sont des commandes textes que l'on peut utiliser pour exécuter une commande d'Altium Designer dans le script.
- Les interfaces objets sont des interfaces spéciales que l'on peut utiliser afin d'extraire des informations ou de modifier des données dans des documents de conception depuis le script.
Les scripts se distinguent en deux types, le Script Unit qui est le code comprenant les fonctions et les processus de la trame principale du script et le Script Form qui est la prévisualisation de la fenêtre qui permet de contrôler différentes fonctions du script.
Créer et utiliser un script
On peut créer ou joindre un script à un projet de conception tel qu'un projet PCB (*.PrjPcb)
Depuis le menu File>>New>>Script Files on peut créer un nouveau script et choisir dans quels langage ce script sera écrit.
L’exécution du script fini, se fait depuis la fenêtre Run Script disponible dans le menu DXP>>Run Script.
Il suffit ensuite de sélectionner le script dans cette fenêtre puis de valider avec OK afin de lancer la procédure du script.
| Imagecaption |
|---|
La fenêtre de l’exécution du script |
| Info | ||
|---|---|---|
| ||
Grâce à la personnalisation des menus d'Altium Designer, un script peut être ajouter à une barre d'outil d'un éditeur afin d'accéder plus rapidement à ce script. |
Exemple de script
Dans cette partie, nous allons voir un script créé par un de nos ingénieurs afin de voir en détails les différentes syntaxes et fonctions que l'on peut utiliser.
Ce script permet de supprimer les pistes de cuivre verticales d'un PCB, vous pouvez télécharger cet exemple de script
ici
A présent nous allons voir comment le script a été créé et à quoi correspond les syntaxes de son contenu.
| Imagecaption |
|---|
Détail du contenu du script exemple |
Légende:
A: Le nom du script qui sera affiché dans la fenêtre Run Script
B: Déclaration des variables; Iterator pour déclarer une boucle; Prim est l'objet dans le PCB; Board pour définir le document
C: Détection du document PCB, si aucun document PCB n'est ouvert alors le message The current document is not a PCB document sera affiché
D: Application de filtres pour que la valeur Prim ne soit que des pistes de cuivre
E: Déclaration d'une itération dans le PCB avec ces filtres
F: Définition de l'application; tout d'abord la variable Prim doit être validée si l'objet est bien une piste de cuivre puis intervient la condition de la piste vertical via les coordonnées de l'objet (x1=x2). Si la condition est remplie alors la piste est supprimée et on passe à l'objet suivant.
Autres exemples de scripts
Il existe multiple exemples de script qui vous sont fourni avec l'installation du logiciel Altium Designer. La plupart de ces derniers sont écris en langage Delphi, il est vivement conseillé de jeter un œil à ces scripts lorsque vous voulez créer un fonction ou une application que vous ne connaissez pas.
Vous trouverez ces exemples au chemin suivant C:\Program Files\Altium Designer Summer 09\Examples\Scripts
Pour avoir une vue d'ensemble de ces exemples de script et pour connaître leurs descriptions, nous les avons rassemblés dans le document suivant:
Script Example Gallery Reference
Vous avez des questions? envoyez nous un e mail à support.eu@altium.com ou créez une requête dans Altiums SupportCenter.
Ce support tip a été créé avec la version Altium Designer Release Summer 09 (Build Nr. 9.3.1.19182).