Automating Design Tasks with Scripting

Skripting bietet eine leistungsstarke Methode, Ihre Möglichkeiten und Produktivität mit Altium Designer zu erweitern. Ein Skript enthält eine Reihe von Anweisungen (automatisierte Befehle), die bei der Ausführung in Altium Designer interpretiert werden. Skripte können in verschiedenen Sprachen geschrieben, mit anspruchsvollen Dialogen ausgestattet und innerhalb von Altium Designer debuggt werden. Sie können Skripte verwenden, um Ihre Designziele mit minimaler Benutzereingabe sowie weniger Tastaturanschlägen und Mausklicks zu erreichen.

Mit Skripten können Sie sich wiederholende Aufgaben automatisieren und Bearbeitungen durchführen, die mit den vorhandenen Befehlen in Altium Designer nicht verfügbar sind. Beispielsweise könnten Sie ein Skript verwenden, um Passermarken in einem PCB-Dokument zu suchen und zu aktualisieren oder eine angepasste Netzliste zu exportieren.

Skripte können in einem Skriptprojekt oder in einem Designprojekt gespeichert werden. In Altium Designer stehen mehrere Skriptsprachen zum Schreiben von Skripten zur Verfügung.

Überblick und Einrichtung des Skriptsystems

Das Skriptsystem von Altium Designer stellt alle Werkzeuge und Funktionen bereit, die zum Erstellen von Skripten zur Automatisierung von Aufgaben in der Software erforderlich sind.

Skripte können geschrieben werden, um sich wiederholende Aufgaben zu automatisieren oder eine Funktion in Altium Designer zu erweitern. Das Skriptsystem besteht aus zwei Hauptteilen: dem Editor und dem Debugger. Der Skripteditor, der Debugger und die Skripting-Bedienfelder arbeiten zusammen, damit Sie Ihre Skripte einfach schreiben und debuggen können. Ein Skript kann direkt aus dem Skripteditor ausgeführt oder einem Menü, einer Symbolleiste oder einem Hotkey zugewiesen werden, sodass es jederzeit auf das aktuelle Dokument – beispielsweise ein PCB – angewendet werden kann.

► Lesen Sie mehr über das Skriptsystem in Altium Designer

Erstellen und Speichern von Skripten

Altium Designer-Skripte werden normalerweise in einem Skriptprojekt (*.PrjScr) erstellt und gespeichert, können jedoch zu jedem Projekttyp hinzugefügt oder darin gespeichert werden.

Um mit dem Schreiben von Skripten zu beginnen, erstellen Sie zunächst ein neues Skriptprojekt und fügen diesem Projekt Skriptdateien hinzu.

Ein Skriptprojekt hilft Ihnen bei der Verwaltung Ihrer Skripte und kann durch Auswahl von File » New » Project » Script Project in den Hauptmenüs erstellt werden. Ein neues Projekt wird im Projects panel aufgeführt. Um dem Projekt ein neues Skript hinzuzufügen, klicken Sie mit der rechten Maustaste auf den Projektnamen und wählen Sie Add New to Project im Kontextmenü aus.

Beim Erstellen eines neuen Skripts stehen abhängig von Ihren Projektanforderungen zwei Skripttypen zur Auswahl – Skript-Units und Skriptformulare. Mit Skript-Units können Sie eigenständige Prozeduren und Funktionen schreiben. Mit Skriptformularen können Sie Dialoge mit Steuerelementen und Ereignishandlern sowie Prozeduren und Funktionen erstellen.

► Lesen Sie mehr über das Erstellen & Speichern von Skripten in Altium Designer

Schreiben von Skripten

Es gibt eine Reihe wesentlicher Konzepte und Begriffe, die für das Schreiben von Skripten gelten:

• Prozesse sind Befehlszeichenfolgen, mit denen Sie Befehle in Skripten ausführen können.

• Komponenten sind visuelle Steuerelementobjekte im Tool Palette Bedienfeld, die Sie per Drag-and-drop auf ein Skriptformular ziehen können, um das Design zu bearbeiten.

• Eine Komponente, die auf einem Skriptformular platziert wird, verfügt über Methoden, Eigenschaften und Ereignisse.

• Objektschnittstellen sind spezielle Objektschnittstellen, mit denen Sie Daten in Designdokumenten aus Ihren Skripten heraus extrahieren und ändern können.

Die Standardskriptsprache ist auf DelphiScript eingestellt (*.pas). Die Skripting-Engine selbst ist in Embarcadero Delphi geschrieben, und das Tool Palette Bedienfeld basiert auf Delphis VCL (Visual Component Library).

► Lesen Sie mehr über das Schreiben von Skripten in Altium Designer

Werkzeuge zum Bearbeiten und Debuggen von Skripten

Das Skriptsystem von Altium Designer besteht aus zwei Hauptteilen – dem Editor und dem Debugger. Der Editor bietet eine Reihe von Hilfs- und Prüfungsfunktionen für Skriptcode, und der Debugger ermöglicht den Zugriff auf Skriptkomponenten und Debug-Funktionen. Die Werkzeuge des Skripteditors sind ein wesentlicher Bestandteil beim Debuggen von Skripten.

Im Skriptsystem steht eine Reihe von Werkzeugen zur Verfügung, die beim Debuggen von Skripten helfen. Dazu gehören das Setzen mehrerer Haltepunkte in einem Skript, die Verwendung des Watch List Bedienfelds zur Überwachung des Werts von Variablen, die Verwendung von Lesezeichen für effizienteres Navigieren sowie die Funktionen Step Into und Step Over zum Nachverfolgen von Skripten.

► Lesen Sie mehr über die Werkzeuge zum Bearbeiten von Skripten in Altium Designer

► Lesen Sie mehr über das Debuggen von Skripten in Altium Designer

Ausführen von Skripten

Während das Skriptsystem von Altium Designer die Mittel zum Erstellen anspruchsvoller automatisierter Aufgaben für Altium Designer bereitstellt, müssen die resultierenden Skripte während des Designprozesses auch leicht zugänglich sein. Beispielsweise sollte ein Skript, das erstellt wurde, um beim Bearbeiten eines PCB einen komplexen Satz von Operationen auszuführen, direkt im PCB-Editor selbst verfügbar sein, wo es mit ein oder zwei Mausklicks ausgeführt werden kann.

Altium Designer ermöglicht dies, indem ein Skript einem Prozessstarter und damit einem Befehl zugewiesen werden kann, der einem Menü, einer Symbolleiste und einer Tastenkombination zugeordnet werden kann.

Ein Skript kann mit dem Befehl Run des Editors ausgeführt werden, wenn es im Skripteditor geöffnet ist. Dazu muss das Skriptprojekt in Altium Designer geöffnet sein, was beispielsweise während des PCB-Designprozesses kein komfortabler Ansatz für den Zugriff auf ein benötigtes Skript ist. Alternativ können Sie im Dialogfeld Select Item To Run (File » Run Script) zu einem Skript auf Ihrer lokalen Festplatte oder in einem verbundenen Workspace navigieren und dann den gewünschten Prozess ausführen. Das Skript bleibt für die aktuelle Sitzung geladen.

Eine besser geeignete Methode für den Zugriff auf ein häufig verwendetes Skript besteht darin, das Projekt auf der Seite Scripting System – Global Projects des Dialogfelds Preferences als Global Project zu installieren. In diesem Fall wird das Projekt beim Start von Altium Designer automatisch geladen und kann jederzeit über den Befehl File » Run Script ausgeführt werden.

► Lesen Sie mehr über das Ausführen von Skripten in Altium Designer

Grafische Komponenten für das Skripting

Die visuellen Formularkomponenten, die zur Verwendung in Altium Designer-Skripten verfügbar sind, stammen größtenteils aus Embarcaderos Visual Component Library (VCL), einer Sammlung definierter visueller Komponenten für die Entwicklung von Windows-Anwendungen mit den Sprachen Delphi und C++.

Die VCL-Klassen wurden als visuelle Klassenbibliothek entwickelt und leiten sich in einer linearen Objekthierarchie vom Objekt TComponent ab (das selbst vom Stammobjekt TObject abstammt). Daher erbt eine allgemeine Skriptkomponente, wie etwa das Objekt TButton, die Eigenschaften, Methoden und Ereignisse ihrer übergeordneten Objekte. In diesem Fall lautet die Klassenhierarchie: TObject → TPersistent → TComponent → TControl → TWinControl → TButtonControl → TButton.

Beachten Sie, dass die Komponenten, die vom Objekt TControl abstammen, im Allgemeinen visuelle Komponenten (Steuerelemente) sind und allgemeine Komponenten, die von TWinControl abstammen, meist Wrapper um die Windows-API darstellen.

Beim Erstellen eines Formulars im Skripteditor von Altium Designer wird auf die Komponenten über das Tool Palette Bedienfeld zugegriffen. Skriptformulare verfügen über eine zugehörige *.DFM Datei, die Details zur Konfiguration des Formulars, zu den Positionen seiner Komponenten und zu weiteren Attributen enthält; die Datei befindet sich im Host-Ordner des Skriptprojekts. Altium Designer ermöglicht die Verwendung der Komponenten beim Entwerfen von Skriptformularen entweder mit DelphiScript oder VBScript.

► Lesen Sie mehr über grafische Komponenten für das Skripting in Altium Designer

Skriptbeispiele

Um weitere Einblicke in die allgemeinen Aspekte des Skriptsystems sowie in die Verwendung von Delphi- und X2-Objektmodellen in Skripten zu geben, werden zwei Beispielprojekte aus funktionaler Sicht betrachtet – ein Board-Outline-Kopierer und ein Skript zur Erzeugung einer Netzliste. Die Skripte Board Outline Copier und Netlister wurden unter Verwendung der X2-Objektmodelle entwickelt, um die Möglichkeiten des Skriptsystems in Altium Designer zu veranschaulichen.

Dies sind vorhandene Skripte, die in der Sammlung von Beispielskripten verfügbar sind. Der Ordner Scripts innerhalb der ZIP-Datei enthält Unterordner, die nach Skriptsprachen organisiert sind.

Beachten Sie, dass eine große Auswahl nützlicher Skripte in der Altium Designer GitHub collection zu finden ist.

► Lesen Sie mehr über die Analyse von Skriptbeispielen in Altium Designer

► Lesen Sie mehr über die Referenz zu Skriptbeispielen für Altium Designer

Unterstützung für Skriptsprachen

Skripte für Altium Designer können in mehreren Skriptsprachen geschrieben werden. Beachten Sie, dass die primäre Sprache und die in der Skripting-Dokumentation am häufigsten erwähnte Sprache DelphiScript ist, das eng mit Embarcadero Delphi™ verwandt ist.

► Lesen Sie mehr über die Unterstützung für Skriptsprachen in Altium Designer