Programmierschnittstelle

  Vorangehende Seite Nächste Seite Für die Druckfunktion wird JavaScript benötigt!  

Der »Frontplatten Designer« bietet in einer Beta-Version eine Programmierschnittstelle (API), die es Anwendern erlaubt, Aktionsfolgen mit Fräs- und Gravurelementen auf der aktuellen bzw. auf einer neu angelegten Frontplatte als ausführbares, in JavaScript verfasstes Skript zu formulieren.

Skripting-Fenster

Alle im folgenden beschriebenen Aktionen werden im sog. Skripting-Fenster ausgeführt, welches mittels Bearbeiten > Skripte aufgerufen wird. Es öffnet sich in einer vereinfachten Ansicht, um den Blick auf die aktuelle, eventuell per Skript zu bearbeitende Frontplatte frei zu halten. Aus demselben Grund geht das Skripting-Fenster nach Ausführung eines Skriptes stets in die vereinfachte Ansicht über.

Die Vollanzeige mit dem integrierten Skript-Editor öffnen Sie mit dem Button „ >> “ oberhalb der Anzeige der vorhandenen Skripte. Dieser Editor wird automatisch aufgeschlagen, wenn Sie mit dem Button „Neu“ ein neues Skript beginnen wollen.

Die im Skripting-Fenster aufrufbaren Funktionen werden im folgenden im Zusammenhang mit verschiedenen Aktionen beschrieben.

Die Dokumentation der Programmierschnittstelle wird im entsprechenden Abschnitt ganz unten als PDF-Download angeboten.

Skripte organisieren

Nach Öffnen des Skripting-Fensters (siehe oben) werden in obersten Bereich alle Skripte angezeigt, die entweder vom Benutzer erstellt („Benutzerskripte“) oder die mit dem »Frontplatten Designer« mitgeliefert („FPD-Skripte“) wurden. Die Benutzerskripte sind dabei unter folgendem Pfad abgelegt:

Windows: %APPDATA%\FrontDesign\Scripts
Mac: $HOME/.FrontDesign/Scripts
Linux: $HOME/.FrontDesign/Scripts

Sollten Sie den Inhalt des entsprechenden Pfads z.B. mittels eines Dateimanagers verändert haben, können Sie die Anzeige der vorhandenen Skripte im Skripting-Fenster jederzeit mit dem Button links neben dem Button „PastePad“ (oberhalb der Skriptlisten-Anzeige) aktualisieren.

Der Dialog zur Umbenennung des Dateinames eines Benutzerskripts rufen Sie im Skripting-Fenster über den Button „Umbenennen…“ auf.

Bezieht sich das Skript auf HPGL-Gravuren oder Freikonturen bzw. damit verbundene PLT- oder DXF-Dateien, so kann man alle Dateien in einem Verzeichnis zusammenfassen, das dann unter dem entsprechenden Pfad abzulegen ist. Details dazu finden Sie im Abschnitt „Zusammengehörige Skript-, Gravur- und Freikonturdaten als Bundle ablegen“ ganz unten.

Die Beschreibung eines Skripts (mittleres Anzeigefeld in der vereinfachten Ansicht) wird aus einer Kommentarzeile im Skript abgeleitet, die mit #de#:, #en#: oder #fr#: beginnt, wobei sich der Beschreibungs-Text aus der anschließenden Zeichenfolge ergibt (siehe Bild unten).

Skript ausführen

Um ein gelistetes Skript zu starten, müssen Sie es markieren und dann den Button „Start“ drücken. Um ein externes Skript zu starten, können Sie den Code aus dem verwendeten Editor kopieren, im „PastePad“ (Aufruf über den Button oberhalb der Skriptlisten-Anzeige) einfügen und mit dem entsprechenden Button starten.

Während der Ausführung des Skriptes im »Frontplatten Designer« werden

Ausgaben mittels Print()
Resultate des Skripts
Fehlermeldungen

im jeweiligen Bereich „Ausgabe“ angezeigt.

Nach Ausführung des Skriptes wird dann die bearbeitete bzw. erzeugte Frontplatte im Arbeitsbereich des »Frontplatten Designer« angezeigt.

Skript bearbeiten

Um ein markiertes Skript bearbeiten zu können, aktivieren Sie den integrierten Skript-Editor mit dem Button „ >> “ oberhalb der Anzeige der vorhandenen Skripte (dieser Editor wird automatisch aufgeschlagen, wenn Sie mit dem Button „Neu“ ein neues Skript beginnen wollen).

Sie können das bearbeitete Skript jederzeit ausführen (Button „Start“), es zwischendurch speichern (Button „Speichern“) bzw. es auch unter neuem Namen als zusätzliches Skript anlegen (Button „Speichern unter…“).

Am Javascript-Prompt können Sie erstellte oder eingefügte Zeilen jederzeit separat testen (zum Beispiel Varianten eines bestimmten Fräselementes ausprobieren, wobei Sie auf der Frontplatte entstandene Elemente jederzeit löschen können).

Die Dokumentation der Programmierschnittstelle wird im entsprechenden Abschnitt ganz unten als Download angeboten.

Externes Skript hinzufügen

Ein externes Skript (Dateiendung muss „fpjs“ sein), das Ihnen z.B. von einem anderen Anwender gemailt worden ist, fügen Sie mittels des gleichnamigen Buttons (unten links) hinzu. Es wird dann automatisch unter folgendem Pfad abgelegt:

Windows: %APPDATA%\FrontDesign\Scripts
Mac: $HOME/.FrontDesign/Scripts
Linux: $HOME/.FrontDesign/Scripts

Ersatzweise können Sie das externe Skript natürlich auch direkt ins vorgesehene Verzeichnis kopieren bzw. verschieben.

Den Code eines externen Skripts können Sie vorab ganz unkompliziert testen, indem Sie ihn aus einer entsprechenden Anwendung heraus kopieren, im „PastePad“ einfügen (siehe den Abschnitt „Externen Code direkt testen“ weiter unten) und direkt vorn dort aus starten.

Neues Skript anlegen

Ein neues (leeres) Skript legen Sie mit dem Button „Neu“ an, das dann in der Skriptanzeige unter „Benutzerskripte“ mit dem Namen „Unbenannt?.fpjs“ („?“ steht für einen hochgezählten Index) erscheint. Die Vorgehensweise für seine Bearbeitung wird im entsprechenden Abschnitt weiter oben beschrieben. Der automatisch generierte Dateinamen kann jederzeit mittels des Buttons „Umbenennen…“ editiert werden.

Alternativ kann natürlich auch ein vorhandenes Skript unter neuem Namen gespeichert werden.

Externen Code direkt testen

Den Code eines externen Skripts können Sie ohne Anlage eines neuen Benutzerskripts testen, indem Sie ihn aus einer entsprechenden Anwendung heraus kopieren und im „PastePad“ einfügen, das sich über den entsprechenden Button oberhalb der Skriptlisten-Anzeige aufrufen lässt.

Das PastePad ist ein Fenster für Anwender, die Skripttext direkt via Copy & Paste von einer externen Quelle in den »Frontplatten Designer« kopieren und sofort ausführen möchten. Das PastePad besteht aus einem Textfeld, in das kopiert wird, einem Ausgabefeld und zwei Buttons zum Löschen der Ausgabe und zum Ausführen des Skripttexts.

Dokumentation der Programmierschnittstelle

Das hier zum Download angebotene Dokument beschreibt die Scripting-Programmierschnittstelle des »Frontplatten Designer«. Die verwendete Skriptsprache ist JavaScript. Grundkenntnisse im Programmieren mit JavaScript werden vorausgesetzt  (unsere Buchempfehlung: „Javascript: The Good Parts“ von Doug Crockford). Mit dem Frontplatten Designer werden Beispielskripte mitgeliefert, die einen Überblick über den Aufbau eines Skripts bieten.

Laden Sie hier die Beschreibung der Scripting-Programmierschnittstelle des »Frontplatten Designer« herunter:

Button

Zusammengehörige Skript-, Gravur- und Freikonturdateien als Bundle ablegen

Falls sich ein Skript auf Gravur- und/oder Freikonturdateien bezieht, ist die Adressierung am einfachsten, wenn sich alle Dateien im selben Verzeichnis befinden. Fasst man die betreffenden Dateien in einem Ordner zusammen und stellt diesen ins vorgesehene Skript-Verzeichnis ein, dann wird dieses „Bundle“ in der Skriptlisten-Anzeige mit dem Namen des Ordners aufgeführt, wobei das zugrundeliegende Skript wie üblich editiert und gestartet werden kann.

Achtung: Der Inhalt eines solchen Ordners wird nur dann als Bundle erkannt, wenn das enthaltene Skript den Namen „script.fpjs“ hat.

Das Verzeichnis kann auch gezippt und von einem beliebigen Ort den Benutzerskripten hinzugefügt werden. Durch diese Prozedur wird der Inhalt der ZIP-Datei dauerhaft ins vorgesehene Verzeichnis entpackt.