1. Tastenbedienung

Das Verhalten der Tasten wird durch die ProffieOS-Konfiguration und die Anzahl der für das Lichtschwert definierten Tasten bestimmt. Die folgenden Funktionen setzen mindestens eine Ein-/Aus-Taste voraus und können je nach Konfiguration durch eine AUX-Taste ergänzt werden.

2. Befehle über den seriellen Monitor

ProffieOS stellt serielle Befehle für Tests, Diagnose, Konfigurationsprüfungen, Audiotests und den Wechsel zwischen Presets bereit.

3. Softwareinstallation und Einrichtung

Für die Entwicklung und das Aufspielen der Firmware auf das ProffieBoard benötigen Sie die Arduino IDE, das ProffieBoard-Arduino-Plugin sowie die entsprechenden USB-Treiber.

3.1 Benötigte Software

3.2 Installation der Arduino IDE

Installieren Sie die aktuelle stabile Version der Arduino IDE . Verwenden Sie keine Beta-Version.

Unter Windows wird die Installation der Arduino IDE als Windows-Store-App nicht empfohlen. Die Anwendung kann dadurch in einem geschützten Verzeichnis installiert werden, wodurch zusätzliche Plugins oder Software unter Umständen nicht korrekt installiert werden können.

3.3 ProffieBoard-Plugin und Zadig installieren

Installieren Sie das ProffieBoard-Arduino-Plugin und Zadig gemäß den jeweiligen Installationsanweisungen.

3.4 Board-Einstellungen in der Arduino IDE

Wählen Sie in der Arduino IDE:

Tools → Board → Proffieboard V2

Verbinden Sie das ProffieBoard über ein USB-Datenkabel mit Ihrem Computer. Der zugewiesene COM-Port sollte anschließend im Menü Port verfügbar sein.

4. Firmware-Upload und Aktualisierung

Schritt 1 – ProffieOS und SD-Karten-Dateien herunterladen

Laden Sie das ProffieOS-Firmwarepaket sowie die zugehörigen SD-Karten-Dateien herunter.

Für SUPERNEOX Lichtschwerter mit ProffieBoard V2.2 verwendet dieser Entwicklerleitfaden ProffieOS 5.9 als Referenzversion.

Entpacken Sie:

ProffieOS-v5.9.zip

Entpacken Sie das Paket in ein normales Arbeitsverzeichnis, beispielsweise in den Ordner „Dokumente“ oder auf den Desktop.

Die entpackte Ordnerstruktur sollte Folgendes enthalten:

ProffieOS-v5.9/

└── ProffieOS/

Benennen Sie die Ordner und Dateien innerhalb des Verzeichnisses ProffieOS nicht um und verschieben Sie sie nicht.

Schritt 2 – Inhalte auf die SD-Karte kopieren

Entpacken Sie:

ProffieOS_SD_Card.zip

Kopieren Sie alle Dateien aus dem entpackten Ordner ProffieOS_SD_Card in das Stammverzeichnis der microSD-Karte des ProffieBoards.

Dateinamenerweiterungen unter Windows anzeigen

Aktivieren Sie im Windows-Datei-Explorer die Anzeige von Dateinamenerweiterungen, damit Erweiterungen wie .h sichtbar sind.

Schritt 3 – Konfigurationsdatei erstellen

Öffnen Sie:

ProffieOS/config/

Erstellen Sie Ihre Konfigurationsdatei in diesem Verzeichnis.

Empfohlen wird, die passende Standard-Konfigurationsdatei zu kopieren, die Kopie umzubenennen und anschließend den Inhalt durch die für Ihr Lichtschwert erstellte Konfiguration zu ersetzen.

Für ProffieBoard V2.x verwenden Sie den offiziellen ProffieBoard V2.x Configurator .

Schritt 4 – Konfigurationsdatei auswählen

Öffnen Sie:

ProffieOS/ProffieOS.ino

Suchen Sie nach der Definition CONFIG_FILE.

#define CONFIG_FILE "config/my_saber_config.h"

Wenn sich mehrere Konfigurationsdateien im Verzeichnis config befinden, darf nur die zu kompilierende Konfiguration aktiv sein.

Mehrere Lichtschwert-Konfigurationen können im selben Verzeichnis config gespeichert werden. Wechseln Sie zwischen ihnen, indem Sie die aktive CONFIG_FILE-Definition ändern.

Schritt 5 – Board anschließen

Verbinden Sie das ProffieBoard über ein Micro-USB-Datenkabel mit dem Computer.

Schritt 6 – Kompilieren und Upload

1. Öffnen Sie ProffieOS.ino in der Arduino IDE.
2. Überprüfen Sie, ob das richtige ProffieBoard V2 und der richtige COM-Port ausgewählt sind.
3. Stellen Sie sicher, dass die richtige CONFIG_FILE aktiv ist.
4. Klicken Sie auf Upload.
5. Warten Sie, bis Kompilierung und Upload abgeschlossen sind.

Nach einem erfolgreichen Upload sollte die Fortschrittsanzeige 100 % erreichen.

Wenn ein Lautsprecher angeschlossen ist, sollte das ProffieBoard nach einem erfolgreichen Upload den Startton wiedergeben.

Wenn Serial + Mass Storage ausgewählt ist und das ProffieBoard als Wechseldatenträger angezeigt wird, werfen Sie das Laufwerk sicher aus, bevor Sie das USB-Kabel trennen.

Fehlerbehebung beim Upload

Wenn der Upload fehlschlägt, prüfen Sie zunächst die folgenden häufigen Ursachen:

1. Die Konfigurations-Headerdatei kann einen Syntax- oder Konfigurationsfehler enthalten.
2. Der Name der CONFIG_FILE kann falsch sein.
3. Die Konfigurationsdatei befindet sich möglicherweise nicht im Verzeichnis ProffieOS/config/.
4. Der Windows-Benutzername oder das Arbeitsverzeichnis kann Nicht-Latein-Zeichen enthalten, die Probleme mit der Toolchain verursachen.
5. Board, USB-Typ, CPU-Geschwindigkeit oder COM-Port können falsch ausgewählt sein.

5. Inhalte der SD-Karte

ProffieOS verwendet die microSD-Karte des Lichtschwerts zum Speichern von Soundfonts, konfigurationsbezogenen Dateien und Musikstücken.

Soundfonts

Kopieren Sie unterstützte Soundfont-Ordner in das Stammverzeichnis der microSD-Karte.

Die ursprüngliche Konfiguration unterstützt unter anderem folgende gängige Soundfont-Strukturen:

Bei Verwendung einer unterstützten Soundfont-Struktur müssen die Namen der WAV-Dateien normalerweise nicht geändert werden.

Musiktitel

Speichern Sie Musiktitel im Verzeichnis:

tracks/

Beispiel:

tracks/venus.wav

tracks/mars.wav
tracks/mercury.wav

Benennung von Dateien und Ordnern

Verwenden Sie für eine möglichst hohe Kompatibilität lateinische Zeichen und einfache Dateinamen für Soundfont-Ordner und Musiktitel.

Vermeiden Sie unnötige Sonderzeichen wie:

? , . | \ } { [ / -

Jeder Soundfont-Ordner sollte die erforderlichen Konfigurationsdateien enthalten, beispielsweise:

config.ini

smoothsw.ini

6. Konfiguration und Parameter

Die Konfiguration des ProffieBoards erfolgt hauptsächlich über eine C++-Konfigurations-Headerdatei im Verzeichnis:

ProffieOS/config/

Die Konfiguration legt unter anderem Board-Einstellungen, Anzahl der Klingen, Tasten, Audioeinstellungen, Bewegungsfunktionen, LED-Konfiguration, Clash-Empfindlichkeit, Presets und Klingeneffekte fest.

Grundlegende ProffieBoard-V2-Konfiguration

#ifdef CONFIG_TOP

#include "proffieboard_v2_config.h"

#define NUM_BLADES 1
#define NUM_BUTTONS 2
#define VOLUME 1000

const unsigned int maxLedsPerStrip = 144;

#define CLASH_THRESHOLD_G 1.0

#define ENABLE_AUDIO
#define ENABLE_MOTION
#define ENABLE_WS2811
#define ENABLE_SD
#define SAVE_STATE

#endif

Parameterübersicht

Clash-Empfindlichkeit

Ein dokumentierter Ausgangswert ist:

#define CLASH_THRESHOLD_G 1.0

Niedrigere Werte führen im Allgemeinen zu einer empfindlicheren Clash-Erkennung, während höhere Werte die Empfindlichkeit reduzieren.

Konfiguration bearbeiten

Verwenden Sie zum Bearbeiten von C++-Konfigurationsdateien einen einfachen Texteditor oder einen geeigneten Code-Editor.

Nach einer Änderung der Konfiguration:

1. Speichern Sie die Konfigurationsdatei.
2. Öffnen Sie ProffieOS.ino.
3. Überprüfen Sie, ob die richtige CONFIG_FILE aktiv ist.
4. Kompilieren Sie die Firmware.
5. Laden Sie die Firmware auf das ProffieBoard.

7. Preset-Konfiguration

Presets definieren den verwendeten Soundfont, den Soundtrack, den Klingeneffekt und den für den Benutzer sichtbaren Preset-Namen des Lichtschwerts.

Grundstruktur eines Presets

Ein typisches Preset wird innerhalb des Abschnitts CONFIG_PRESETS definiert:

#ifdef CONFIG_PRESETS

Preset presets[] = {

{
"TeensySF",
"tracks/venus.wav",
StyleNormalPtr(),
"cyan"
}

};

#endif

Bestandteile eines Presets

Klingenkonfiguration

Die physische Klingenkonfiguration wird über ein Array BladeConfig blades[] definiert.

Diese Konfiguration ordnet die physische LED-/Klingenhardware der Preset-Konfiguration zu.

BladeConfig blades[] = {

{
0,
WS281XBladePtr<
144,
bladePin,
Color8::GRB,
PowerPINS
>(),
CONFIGARRAY(presets)
},

};

8. Klingeneffekte

ProffieOS verwendet sogenannte Blade Styles, um das visuelle Verhalten der Hauptklinge und weiterer konfigurierter LEDs zu definieren.

Funktionen von Blade Styles

• Grundfarbe
• Farbwechsel
• Flackereffekte
• Clash-Blitze
• Blaster-Effekte
• Lockup-Effekte
• Drag-Effekte
• Zündungseffekte
• Einfahreffekte
• Zeitsteuerung
• Übergangsverhalten

Blade Style Editor

Die ursprüngliche Entwicklerdokumentation empfiehlt die Verwendung eines Blade Style Editors zum Erstellen und Bearbeiten von Blade Styles.

Nützliche Referenzressourcen sind:

• ProffieOS Blade Style Editor
• Megtooth Sith Sabers Tutorial
• TRA Blade Style Resources
• Fett263 Blade Style Library

Struktur eines Blade Styles

Ein Blade Style befindet sich normalerweise innerhalb eines Ausdrucks StylePtr<...>.

Effekte können ineinander verschachtelt werden, wobei jede Ebene das Ergebnis des darunterliegenden Effekts verändert oder transformiert.

InOutHelper

InOutHelper<base color, 200, 300, Black>

Farbdefinitionen

Für gängige Klingenfarben können vordefinierte Farbkonstanten verwendet werden:

WHITE

RED
GREEN
BLUE
PURPLE
CYAN
YELLOW
MAGENTA

Individuelle RGB-Farben können mit folgendem Format definiert werden:

Rgb<R, G, B>

Beispiel:

Rgb<255, 50, 0>

Jeder RGB-Kanal verwendet einen Wert zwischen 0 und 255:

• 0 = keine Ausgabe auf diesem Kanal
• 255 = maximale Ausgabe auf diesem Kanal

AudioFlicker

AudioFlicker<"A" color, "B" color>

AudioFlicker erzeugt einen flackernden Klingeneffekt, der auf das Audiosignal bzw. den Brummton des Lichtschwerts reagiert.

Ein größerer Unterschied zwischen den beiden Farben erzeugt im Allgemeinen eine stärkere visuelle Variation.

OnSpark

OnSpark<base color, spark color, duration>

OnSpark fügt während der Zündung einen Funkeneffekt hinzu. Die Dauer wird in Millisekunden angegeben.

SimpleClash

SimpleClash<base color, clash color, 40>

Fügt einen Clash-Blitzeffekt hinzu. Der letzte Parameter definiert die Dauer des Effekts in Millisekunden.

Lockup

Lockup<base color, lockup color>

Fügt den Lockup-Effekt hinzu und definiert das während des Effekts verwendete Farbverhalten.

Blast

Blast<base color, blast color>

Fügt den Blaster-Effekt hinzu und definiert die dafür verwendete Farbe.

Beispiel für einen kombinierten Blade Style

Ein fortgeschrittener Blade Style kann mehrere Effekte zu einem einzigen verschachtelten Ausdruck kombinieren.

Ein typischer kombinierter Style kann folgende Elemente enthalten:

• Grüne Grundfarbe
• AudioFlicker
• Funken während der Zündung
• Clash-Effekt
• Blaster-Effekt
• Lockup-Effekt
• Drag-Effekt
• Zündverzögerung
• Einfahrverzögerung

Der fertige Blade Style wird innerhalb des entsprechenden StylePtr<...>-Containers im Preset eingefügt.

9. Entwicklerressourcen

Für aktuelle Informationen zur ProffieOS-Entwicklung, Konfiguration und zum jeweiligen Board verwenden Sie die folgenden offiziellen Ressourcen zusammen mit diesem SUPERNEOX Entwicklerleitfaden.

10. Geltungsbereich dieser Dokumentation

ProffieOS wird kontinuierlich weiterentwickelt. Konfigurationssyntax, verfügbare Funktionen, unterstützte Hardware und Verhalten können sich zwischen verschiedenen Versionen unterscheiden.