Uruchamianie skryptów

W skrócie

Ułatw sobie dostęp do skryptów podczas projektowania w Altium Designer. W tym artykule wyjaśniamy, jak uruchamiać skrypty z poziomu edytora skryptów lub okna dialogowego Run Script, automatycznie wczytywać często używane projekty oraz tworzyć na podstawie skryptów niestandardowe polecenia dostępne w menu, na paskach narzędzi i za pomocą skrótów klawiaturowych. Omawiamy również dostępne procesy wykonywania skryptów oraz sposób konfigurowania ich parametrów. Czytaj dalej, aby mieć skrypty zawsze pod ręką podczas projektowania.

- Dowiedz się, jak uruchamiać skrypty i rozpoznawać błędy zgłaszane podczas ich wykonywania.
- Poznaj sposób tworzenia niestandardowych poleceń skryptowych przy użyciu procesów RunScript, RunScriptFile i RunScriptText.
- Sprawdź, jak dodawać polecenia skryptowe do menu i pasków narzędzi edytora oraz opcjonalnie przypisywać im skróty klawiaturowe.
Zagłęb się w temat dzięki AI:
 

System skryptowy Altium Designer umożliwia tworzenie zaawansowanych zadań automatycznych dla Altium Designer, jednak utworzone skrypty muszą być również łatwo dostępne podczas projektowania. Na przykład skrypt wykonujący złożony zestaw operacji podczas edycji PCB powinien być dostępny bezpośrednio w edytorze PCB, gdzie można go uruchomić jednym lub dwoma kliknięciami myszy.

Altium Designer spełnia tę potrzebę, umożliwiając przypisanie skryptu do mechanizmu uruchamiania procesu, a tym samym utworzenie polecenia, które można przypisać do menu, paska narzędzi i skrótu klawiaturowego.

Uruchamianie skryptów

Skrypt otwarty w edytorze skryptów można uruchomić za pomocą polecenia Run » Run dostępnego w menu głównym edytora (skrót: F9). Uruchomiony zostanie bieżący skrypt wskazany przez polecenie Run » Set Project Startup Procedure.

Jeśli polecenie Set Project Startup Procedure nie zostało skonfigurowane, pojawi się okno dialogowe Select Item To Run z prośbą o wybranie skryptu i procedury do uruchomienia.

Jeśli skrypt zawiera błędy, jego wykonywanie zostanie zatrzymane. Można wówczas użyć różnych poleceń debugowania, aby usunąć błędy i spróbować uruchomić go ponownie.

Polecenie Run wymaga, aby projekt skryptowy był otwarty w Altium Designer, co nie jest wygodnym sposobem uzyskiwania dostępu do skryptu potrzebnego na przykład podczas projektowania PCB. Alternatywnie okno dialogowe Select Item To Run (File » Run Script) umożliwia wyszukanie skryptu na lokalnym dysku twardym lub w połączonym obszarze roboczym Workspace albo wybranie skryptu otwartego w panelu Projects, a następnie uruchomienie żądanego procesu. Skrypt pozostaje załadowany przez całą bieżącą sesję.

Uruchamianie skryptu za pomocą mechanizmu uruchamiania procesu skryptowego w oknie dialogowym Select Item to Run.Uruchamianie skryptu za pomocą mechanizmu uruchamiania procesu skryptowego w oknie dialogowym Select Item to Run.

Jeśli skrypt zawiera błędy, po kliknięciu OK w oknie dialogowym Select Item To Run otworzy się okno z powiadomieniem o błędzie. Okno to wyświetli informacje o błędzie, a dokument źródłowy skryptu zostanie otwarty z wyróżnionym wierszem zawierającym błąd. Zamknij to okno, klikając przycisk OK, a następnie zatrzymaj system skryptowy, wybierając polecenie Run » Stop z menu głównego (skrót: Ctrl+F3).

Okno błędu sygnalizuje tylko pierwszy napotkany błąd skryptu. Skrypt może zawierać kolejne błędy, które zostaną wykryte podczas następnych prób jego uruchomienia.

Wygodniejszym sposobem uzyskiwania dostępu do często używanego skryptu jest zainstalowanie projektu jako Global Project na stronie Scripting System – Global Projects w oknie dialogowym Preferences. W takim przypadku projekt jest automatycznie ładowany podczas uruchamiania Altium Designer i można go uruchomić w dowolnym momencie za pomocą polecenia File » Run Script.

Najlepszym sposobem korzystania z funkcji skryptu jest jednak zintegrowanie go z interfejsem graficznym Altium Designer jako polecenia menu lub paska narzędzi. Zwykle jest to proces dwuetapowy: najpierw skrypt jest definiowany jako polecenie (z opcjonalnym skrótem klawiaturowym), a następnie polecenie jest przypisywane do menu (stałego lub podręcznego) bądź paska narzędzi.

Skrypt jako polecenie

Skrypt można zdefiniować jako polecenie aplikacji, wykorzystując wbudowane procesy serwerowe Altium Designer, a konkretnie proces ScriptingSystem:RunScript.

Polecenie reprezentuje wykonywaną czynność i jest obsługiwane przez ciąg procesu za pośrednictwem mechanizmu uruchamiania procesu. W przypadku procesu ScriptingSystem:RunScript zawiera on parametry wskazujące konkretny plik projektu skryptowego, należący do niego plik skryptu (*.pas) oraz proces w tym skrypcie. Odpowiednio zestawione elementy te tworzą ciąg polecenia.

Zaletą tego podejścia jest to, że uruchamianie skryptu jako procesu eliminuje konieczność bezpośredniego otwierania skryptu lub ładowania go jako projektu globalnego. Drugą, istotniejszą zaletą uruchamiania skryptu w ten sposób jest możliwość udostępnienia go jako łatwo dostępnego polecenia Altium Designer. W tym celu dostosowuje się system menu Altium Designer, w którym skrypt można przypisać do polecenia dla wybranego serwera — czyli podaplikacji, takiej jak system plików lub edytor dokumentu projektowego.

Tworzenie polecenia

Aby na przykład przypisać skrypt HelloWorld jako polecenie edytora PCB, najpierw otwórz dokument PCB (a tym samym edytor) i wybierz View » Tools » Customize z menu głównego, aby otworzyć okno dialogowe Customizing PCB Editor. Okno to można również otworzyć, klikając prawym przyciskiem myszy pasek menu lub pasek narzędzi, a następnie wybierając Customize z menu rozwijanego, albo klikając dwukrotnie pusty obszar paska menu lub paska narzędzi (poza poleceniami).

Aby utworzyć nowe polecenie, kliknij przycisk New w tym oknie, aby otworzyć okno dialogowe Edit Command, w którym można wprowadzić dane procesu serwerowego i ścieżki skryptu. Podczas tworzenia polecenia na podstawie skryptu upewnij się, że kategoria [Scripts] nie jest wybrana.

Wpisy Action w tym oknie mają następującą postać:

Process: ScriptingSystem:RunScript
Parameters: ProjectName|ProcName>Process

W zależności od ścieżki źródłowej skryptu ciąg Parameters będzie wyglądać podobnie do poniższego:

ProjectName=C:\Users\Public\Documents\Altium\Delphiscript Scripts\General\HelloWorld.PRJSCR|ProcName=HelloWorld.pas>HelloWorld

W przypadku projektu skryptowego przechowywanego w obszarze roboczym Workspace ścieżka, a zatem również wpis parametrów polecenia, musi wskazywać prawidłową lokalizację w tym obszarze — opartą na identyfikatorze GUID skryptu. Dlatego odwołanie to należy uzyskać before próbą utworzenia nowego polecenia skryptu. Aby pobrać prawidłowe parametry skryptu zainstalowanego z obszaru roboczego Workspace, otwórz okno dialogowe Select Item To Run (File » Run Script), kliknij prawym przyciskiem myszy żądaną procedurę w skrypcie i wybierz polecenie Copy script parameters z menu kontekstowego. Spowoduje to skopiowanie do schowka całej ścieżki, nazwy procesu i procedury.

Wybierz wymagany proces lub procedurę w projekcie skryptowym w obszarze roboczym Workspace, a następnie skopiuj parametry skryptu.
Wybierz wymagany proces lub procedurę w projekcie skryptowym w obszarze roboczym Workspace, a następnie skopiuj parametry skryptu.

 

Okno dialogowe Edit Command zawiera również pola umożliwiające wprowadzenie podpisu polecenia, opisu, skrótu klawiaturowego i powiązanego obrazu bitmapowego (BMP/GIF/PNG; 18 x 18 pikseli). Ustawienia te są zapisywane wraz z poleceniem i obowiązują we wszystkich miejscach, w których zostanie ono umieszczone w menu, na paskach narzędzi i w menu podręcznych — zgodnie z opisem w sekcji Przypisywanie poleceń do menu poniżej.

Wymagane parametry można skopiować z wpisu skryptu w kategorii [Scripts] w oknie dialogowym Customize PCB Editor, jeśli skrypt jest aktualnie załadowany. Aby tymczasowo załadować skrypt, odszukaj go i otwórz za pomocą polecenia File » Run Script. Po skopiowaniu parametrów, przed utworzeniem polecenia przyciskiem New , upewnij się, że na liście Categories nie jest już wybrana pozycja [Scripts].

► Zobacz przykładową ilustrację

Po uzupełnieniu danych i zamknięciu okna edycji () skrypt HelloWorld staje się dostępny jako polecenie niestandardowe (w kategorii [Custom]) w edytorze PCB.

Pamiętaj, że polecenia są implementowane na poziomie serwera, dlatego polecenie niestandardowe utworzone dla edytora PCB (jak powyżej) nie będzie dostępne w innych modułach, takich jak edytor schematów czy system skryptowy.

Uruchamianie skryptu za pomocą procesu RunScriptFile

Skrypt modułu DelphiScript z Altium Designer (z rozszerzeniem *.pas) można uruchomić za pomocą procesu RunScriptFile. Pamiętaj, że można używać wyłącznie skryptów modułów DelphiScript — nie skryptów zawierających formularze. W takim przypadku wpisy Action w oknie dialogowym mają następującą postać:

Process: ScriptingSystem:RunScriptFile
Parameters: FileName|ProcName

W zależności od ścieżki do pliku skryptu ciąg Parameters będzie wyglądać podobnie do poniższego:

FileName=C:\Users\Public\Documents\Altium\Delphiscript Scripts\Processes\ShowNetList.pas|ProcName=RunNetList

Uruchamianie skryptu za pomocą procesu RunScriptText

Ten proces umożliwia wykonanie serii poleceń w bloku Begin End;. W takim przypadku wpisy Action w oknie dialogowym mają następującą postać:

Process: ScriptingSystem:RunScriptText
Parameters: Text

Na przykład aplikację zewnętrzną, taką jak Notatnik systemu Microsoft Windows, można uruchomić programowo z poziomu Altium Designer. W takim przypadku wpisy procesu polecenia i parametrów będą następujące:

Process: ScriptingSystem:RunScriptText
Parameters: Text=Begin RunApplication('notepad.exe'); End;

W tym przypadku proces oprogramowania ScriptingSystem:RunScriptText wykonuje bezpośrednio sekwencję instrukcji skryptowych, zamiast otwierać i uruchamiać określony plik skryptu, jak opisano powyżej.

Alternatywnym rozwiązaniem jest utworzenie skryptu z kilkoma równoważnymi wierszami kodu, a następnie utworzenie standardowego wpisu polecenia ScriptingSystem:RunScript.

Procedure RunNotepad;
Begin
    RunApplication('notepad.exe');
End;

Pamiętaj, że w obu sposobach implementacji polecenia uruchamiającego zewnętrzny Notatnik wystarczy wpisać 'notepad.exe' jako parametr procesu RunApplication, zamiast podawać pełną ścieżkę i nazwę pliku aplikacji. Ścieżki do aplikacji systemu Windows, takich jak Kalkulator i Notatnik, są już określone przez system operacyjny.

Aby uruchomić z poziomu Altium Designer aplikację, której ścieżka nie jest znana systemowi Windows, należy podać jej pełną ścieżkę i nazwę pliku (w apostrofach, aby uwzględnić ewentualne spacje w ścieżce). Na przykład, aby uruchomić drugą instancję Altium Designer, proces RunApplication i parametry będą następujące:

RunApplication('C:\Program Files\Altium\xx\X2.EXE') — gdzie xx oznacza nazwę folderu wersji Altium Designer.

Polecenia można edytować, powielać i usuwać bezpośrednio w oknie dialogowym dostosowywania (w tym przypadku w oknie Customizing PCB Editor) za pomocą przycisków znajdujących się w jego dolnej części.

Przypisywanie poleceń do menu

Po zaimplementowaniu skryptu jako niestandardowego polecenia serwera za pomocą funkcji dostosowywania Altium Designer (View » Toolbars » Customize), zgodnie z powyższym opisem, można przypisać go do interfejsu graficznego serwera, po prostu przeciągając go i upuszczając.

► Zobacz także Dostosowywanie obszaru projektowego

Paski narzędzi

Aby przypisać polecenie niestandardowe na przykład do menu głównego lub paska narzędzi edytora PCB, otwórz okno dialogowe Customizing PCB Editor, znajdź polecenie niestandardowe i przeciągnij je w żądane miejsce w menu. Pamiętaj, że dostęp do menu edytora PCB wymaga otwarcia dokumentu PCB. Po zamknięciu okna dostosowywania nowe polecenie menu będzie dostępne w edytorze PCB w dowolnym momencie.

Polecenie niestandardowe można przeciągnąć w żądane miejsce w menu.
Polecenie niestandardowe można przeciągnąć w żądane miejsce w menu.

Polecenie można również dodać za pomocą opcji Wstaw łącze z menu wyświetlanego po kliknięciu prawym przyciskiem myszy.

Ponieważ w tym przykładzie nowe polecenie niestandardowe zostało przypisane do paska Active Bar edytora PCB, jest ono widoczne w kategorii poleceń PCB Active Bar w oknie dialogowym Customizing PCB Editor.

Po przypisaniu do menu niestandardowe polecenie skryptowe pojawi się w kategorii tego menu w oknie dostosowywania.
Po przypisaniu do menu niestandardowe polecenie skryptowe pojawi się w kategorii tego menu w oknie dostosowywania.

Aby usunąć polecenie z menu, otwórz okno dostosowywania, a następnie przeciągnij ikonę polecenia z menu z powrotem do tego okna.

Usuwanie polecenia przypisanego do paska narzędzi.
Usuwanie polecenia przypisanego do paska narzędzi.

W trybie dostosowywania polecenia przypisane do menu można również edytować i usuwać, klikając je prawym przyciskiem myszy.

Menu

Polecenie niestandardowe można przypisać do menu na dowolnym poziomie zagnieżdżenia, korzystając z opisanej powyżej metody przeciągania i upuszczania.

Gdy serwer jest w trybie dostosowywania, menu nadal reagują na wskaźnik myszy, odpowiednio się rozwijając i zwijając. Aby na przykład umieścić polecenie w menu Reports edytora PCB, przeciągnij je do tego menu, a następnie w dół listy i upuść w odpowiednim miejscu. Po zamknięciu okna dostosowywania nowe polecenie menu — w tym przypadku Notatnik — będzie dostępne w menu Reports .

Aktywne menu podczas dostosowywania umożliwiają przeciągnięcie polecenia niestandardowego do menu rozwijanego.
Aktywne menu podczas dostosowywania umożliwiają przeciągnięcie polecenia niestandardowego do menu rozwijanego.

Menu podręczne

Polecenie można przypisać do menu podręcznego otwieranego prawym przyciskiem myszy w taki sam sposób, jak opisano powyżej, bez ograniczeń dotyczących poziomu zagnieżdżenia podmenu.

W tym przykładzie polecenie jest przeciągane przez ścieżkę menu PCB Popups » Right Mouse Click Free Space i upuszczane w podmenu, jak pokazano poniżej. Po przypisaniu niestandardowe polecenie skryptowe Notatnik staje się dostępne w edytorze PCB po kliknięciu prawym przyciskiem myszy w pustym obszarze.

Polecenie niestandardowe przypisane do podmenu otwieranego prawym przyciskiem myszy
Polecenie niestandardowe przypisane do podmenu otwieranego prawym przyciskiem myszy

Bezpośrednie przypisywanie skryptów

Zamiast tworzyć ze skryptu polecenie niestandardowe wielokrotnego użytku, a następnie przypisywać je do menu, można bezpośrednio przypisać skrypt do menu jako szybkie, jednorazowe rozwiązanie.

Ta metoda pomija etap tworzenia polecenia niestandardowego przez bezpośrednie przypisanie załadowanego skryptu do menu. Ponieważ nie powstaje odpowiadające mu polecenie niestandardowe, które można przypisać jako w pełni skonfigurowane polecenie do wielu menu, ta bezpośrednia metoda zapewnia dostęp do skryptu tylko z jednego miejsca w menu. W związku z tym poszczególne ustawienia polecenia, takie jak podpis, opis, obraz i skróty klawiaturowe, dotyczą wyłącznie tego konkretnego przypisania.

Aby przypisać skrypt bezpośrednio do menu, załaduj projekt skryptowy, otwórz okno dialogowe Customizing serwera (View » Toolbars » Customize), wybierz [Scripts] na liście Categories, znajdź żądany skrypt i przeciągnij go w odpowiednie miejsce w menu. Kliknij , aby zamknąć okno dialogowe Edit Command.

Do menu można również przypisać bezpośrednio skrypt zamiast polecenia.
Do menu można również przypisać bezpośrednio skrypt zamiast polecenia.

Podobnie jak w przypadku wszystkich elementów umieszczanych w menu, jeśli nowa pozycja menu nadal ma ustawienia domyślne (nazwę, skrót klawiaturowy itp.), można je zmienić, klikając tę pozycję prawym przyciskiem myszy i wybierając Edit z podmenu. Spowoduje to otwarcie okna dialogowego Edit Command, w którym można wprowadzić odpowiednie ustawienia.

W trybie dostosowywania kliknij menu prawym przyciskiem myszy, aby uzyskać dostęp do jego parametrów.
W trybie dostosowywania kliknij menu prawym przyciskiem myszy, aby uzyskać dostęp do jego parametrów.

Po skonfigurowaniu nowe menu będzie dostępne podczas projektowania bez konieczności jawnego wczytywania projektu skryptu lub instalowania go jako projektu globalnego.

Należy pamiętać, że ten sposób przypisywania skryptu do menu automatycznie tworzy wymagane polecenie. Nie jest to w pełni skonfigurowane polecenie niestandardowe, które można ponownie przypisać, jak opisano w powyższych metodach, lecz polecenie utworzone dla tej konkretnej pozycji menu.

Można to zaobserwować we wpisie odpowiadającym danej kategorii menu w oknie dialogowym Customizing . W powyższym przykładzie indywidualnie skonfigurowane polecenie jest widoczne w kategorii Reports w oknie dialogowym Customizing PCB Editor.

W przypadku bezpośredniego przypisywania skryptu do menu odpowiednie polecenie jest tworzone wyłącznie dla danej pozycji menu.
W przypadku bezpośredniego przypisywania skryptu do menu odpowiednie polecenie jest tworzone wyłącznie dla danej pozycji menu.

AI-LocalizedTłumaczenie SI
Jeśli znajdziesz błąd, zaznacz tekst/obraz i naciśnij Ctrl + Enter aby wysłać nam wiadomość.
Nav
Contents
Dostępność funkcji

Dostępne funkcje zależą od tego, z którego rozwiązania Altium korzystasz – Altium Develop, Altium Agile Teams, Altium Agile Enterprise lub Altium Designer (w ramach aktywnej subskrypcji terminowej).

Jeśli opisana funkcja nie jest widoczna w Twoim oprogramowaniu, skontaktuj się z działem sprzedaży Altium, aby dowiedzieć się więcej.

Starsza dokumentacja

Dokumentacja Altium Designer nie jest już wersjonowana. Jeśli potrzebujesz dostępu do dokumentacji dla starszych wersji Altium Designer, odwiedź sekcję Starsza dokumentacja na stronie Inne instalatory.

Contents