OSC-Steuerung
Über OSC steuerst du die FrenschPress von außen: aus QLab, einer Lichtkonsole, Companion oder einem eigenen Skript. Du schickst die Befehle per UDP an die IP-Adresse der FrenschPress, auf den OSC Listen Port.
| Parameter | Wert |
|---|---|
| Namespace | /fpress |
| Protokoll | OSC über UDP |
| Port | 53001 (Standard) |
| Ziel | IP-Adresse der FrenschPress |
Den Port änderst du in den Settings oder direkt am Stream Deck. Auf demselben Port empfängt die FrenschPress auch das QLab-Feedback.
Befehlsübersicht
Die Spalte Gespeichert zeigt, ob die FrenschPress die Änderung speichert. Befehle mit „Nein“ wirken nur zur Laufzeit.
| Befehl | Argumente | Gespeichert |
|---|---|---|
/fpress/mode | 1, 2, 3 | Ja |
/fpress/set | A, B, C + optionale Maske | Ja |
/fpress/preset | Preset-ID (String) | Ja |
/fpress/button | Taste + optionale Aktion | Nein |
/fpress/macro | Macro-Name oder -ID + optionale Aktion | Nein |
/fpress/timeline/arm | Timeline-Selektor | Ja |
/fpress/timeline/disarm | Timeline-Selektor | Ja |
/fpress/timeline/arm_all | – | Ja |
/fpress/timeline/disarm_all | – | Ja |
/fpress/led | r g b oder target r g b | Nein |
/fpress/led/release | – oder target | Nein |
/fpress/var | name wert | Nein |
/fpress/var/clear | – oder name | Nein |
/fpress/streamdeck/button | row col [action] | Nein |
/fpress/streamdeck/feedback | button state | Nein |
/fpress/streamdeck/feedback/all | state | Nein |
/fpress/streamdeck/feedback/clear | – | Nein |
/fpress/query | – oder Gruppe | Nein |
/fpress/mode
Wechselt den Betriebsmodus. Zahl und Name sind gleichwertig.
| Wert | Modus |
|---|---|
1 / "qlab" | QLab Mode |
2 / "macro" / "custom" | Custom Mode (Macros) |
3 / "companion" | Companion Mode |
/fpress/mode 1
/fpress/mode 2
/fpress/mode 3
/fpress/set
Wechselt das aktive Button-Set. Der Befehl wirkt nur im Custom Mode.
Erstes Argument: das Ziel-Set.
| Wert | Set |
|---|---|
"A" / 1 | Set A |
"B" / 2 | Set B |
"C" / 3 | Set C |
Zweites Argument (optional): eine Maske. Sie legt fest, welche Bedienelemente auf das neue Set wechseln. Ohne Maske wechseln alle.
/fpress/set "A"
/fpress/set "B"
/fpress/set "C" "stop,go,pause"
/fpress/set "A" 7
Maskenverzeichnis
Die Maske ist eine Integer-Bitmaske, ein Selector-String oder "all". Im Selector-String trennst du die Tokens mit ,, ;, | oder Leerzeichen.
| Selector-Token | Bitmask |
|---|---|
stop, 0 | 1 << 0 |
go, 1 | 1 << 1 |
pause, 2 | 1 << 2 |
enc, encoder, push, 3 | 1 << 3 |
left, prev, ccw, 4 | 1 << 4 |
right, next, cw, 5 | 1 << 5 |
push_left, combo_left, combo_prev, 6 | 1 << 6 |
push_right, combo_right, combo_next, 7 | 1 << 7 |
all | 0xFF |
/fpress/set "B" "stop,go,pause"
/fpress/set "C" "all"
/fpress/set "A" 255
/fpress/set "A" 7
/fpress/preset
Lädt ein Preset. Der Befehl erwartet die Preset-ID, nicht den Anzeigenamen. Die ID findest du im Preset-Picker der Weboberfläche.
| Preset-Typ | Format |
|---|---|
| User-Preset | "mein-preset-12ab" |
| Plugin-Preset | "pluginId:presetId" |
| Leeren | "empty" |
/fpress/preset "my-user-preset-12ab"
/fpress/preset "osc-qlab-basics:transport"
/fpress/preset "empty"
/fpress/button
Löst eine Taste der FrenschPress aus, als hättest du sie am Gerät gedrückt. So bedienst du auch Macros mit getrennter Press- und Release-Aktion aus der Ferne.
Erstes Argument: die Taste.
| Wert | Taste |
|---|---|
"stop" / 0 | STOP |
"go" / "play" / 1 | GO |
"pause" / 2 | PAUSE |
Zweites Argument (optional): die Aktion. Standard ist "tap".
| Aktion | Wirkung |
|---|---|
"tap" / "trigger" / "go" | Drücken und sofort loslassen |
"press" / "on" / "1" | Nur drücken (Taste bleibt logisch gehalten) |
"release" / "off" / "0" | Nur loslassen |
/fpress/button "go"
/fpress/button "stop" "press"
/fpress/button "stop" "release"
/fpress/button 1 "tap"
Wenn du press sendest, sende danach auch release. Eine logisch gehaltene Taste blockiert sonst Release-Sequenzen und Toggle-Zustände.
/fpress/macro
Startet ein Macro über seinen Namen oder seine ID. Das Macro muss dafür keiner Taste zugewiesen sein.
Erstes Argument: der exakte Macro-Name oder die Macro-ID. Passt ein Name auf mehrere Macros, lehnt die FrenschPress den Befehl ab. Nimm in dem Fall die ID.
Zweites Argument (optional): die Aktion. Standard ist "trigger".
| Aktion | Wirkung |
|---|---|
"trigger" / "tap" / "start" | Macro einmal ausführen |
"on" / "press" / "1" | Snapshot-Macro einschalten; bei allen anderen Macros wie trigger |
"off" / "release" / "0" | Snapshot-Macro ausschalten |
"toggle" | Snapshot-Macro umschalten |
/fpress/macro "Haus AN"
/fpress/macro "Haus AN" "toggle"
/fpress/macro "macro-7f3a" "trigger"
off, release und toggle gibt es nur für Snapshot-Macros (Art-Net/sACN-DMX-Snapshots). Nur sie haben einen dauerhaften Ein/Aus-Zustand.
/fpress/timeline/arm & /fpress/timeline/disarm
Schaltet eine einzelne Timeline scharf oder entschärft sie.
Argument: der Timeline-Selektor. Drei Formen sind möglich:
| Form | Beispiel |
|---|---|
| Sichtbare Nummer aus dem Dropdown | "1" |
| Anzeigename | "Main Timeline" |
| Interne ID | "main" |
/fpress/timeline/arm "1"
/fpress/timeline/arm "Main Timeline"
/fpress/timeline/disarm "main"
/fpress/timeline/arm_all & /fpress/timeline/disarm_all
Schaltet alle Timelines auf einmal scharf oder entschärft sie. Ohne Argumente.
/fpress/timeline/arm_all
/fpress/timeline/disarm_all
Die Befehle sind idempotent. Ist der Zustand schon erreicht, schreibt die FrenschPress nichts ins Dateisystem. Änderungen an allen Timelines speichert sie atomar.
/fpress/led
Setzt eine RGB-Farbe zur Laufzeit, für alle LEDs oder für eine einzelne. Die Farbe wird nicht gespeichert.
Wertebereich: 0–255 pro Kanal
Targets:
| Target | Beschreibung |
|---|---|
"all" / "*" / 0 | Alle LEDs |
"stop" / "btn0" / "button0" / 1 | Stop-Taste |
"go" / "btn1" / "button1" / 2 | Go-Taste |
"pause" / "btn2" / "button2" / 3 | Pause-Taste |
"encoder" / "enc" / "push" / "btn3" / 4 | Encoder |
/fpress/led 255 0 0
/fpress/led "all" 255 0 0
/fpress/led "stop" 255 0 0
/fpress/led "go" 0 255 0
/fpress/led "pause" 255 140 0
/fpress/led "encoder" 0 80 255
Die Farbe bleibt, bis ein weiteres /fpress/led sie ändert oder /fpress/led/release sie freigibt. Modus- und Feedback-Farben laufen im Hintergrund weiter. Nach dem Release siehst du wieder die aktuelle Farbe.
/fpress/led/release
Gibt die gesetzten Farben frei. Die LEDs zeigen danach wieder ihre aktuelle Live-Farbe. Ohne Argument gibst du alle frei, mit Target nur dieses. Die Targets sind dieselben wie bei /fpress/led.
Alias: /fpress/led/clear
/fpress/led/release
/fpress/led/release "all"
/fpress/led/release "stop"
/fpress/var
Schreibt eine Variable auf der FrenschPress. Stream-Deck-Beschriftungen mit $name zeigen ihren Wert an.
| Argument | Bedeutung |
|---|---|
| 1 | Name – 1–24 Zeichen aus A-Z, a-z, 0-9, _ |
| 2 | Wert – String, Integer, Float oder Bool |
/fpress/var "cue" "Blackout"
/fpress/var "ch" 12
/fpress/var "level" 0.5
/fpress/var "armed" true
Zahlen werden als Text abgelegt: Integer dezimal, Float mit drei Nachkommastellen, Bool als 1 oder 0. Über HTTP passiert dasselbe, beide Wege speichern also denselben Wert.
Werte über 48 Zeichen schneidet die FrenschPress ohne Warnung ab. Sie hält bis zu 64 Variablen. Ist die Tabelle voll, weist sie neue Namen ab.
Namen mit sys_ am Anfang gehören dem Gerät (sys_mode, sys_cue, sys_tc …). Die FrenschPress weist sie hier ab und meldet das. Die vollständige Liste steht unter Variablen.
/fpress/var/clear
Löscht Variablen: mit Argument eine, ohne Argument alle.
/fpress/var/clear "cue"
/fpress/var/clear
Eine Beschriftung mit einer gelöschten Variable verliert nur diesen $name. Aus CUE $cue wird CUE . Der gespeicherte Beschriftungstext bleibt, wie er ist.
Stream Deck über OSC
Diese Befehle wirken nur, wenn ein Stream Deck angeschlossen ist.
/fpress/streamdeck/button
Löst eine Deck-Taste aus. Row und Column zählen ab 0.
Beide Schreibweisen sind gleichwertig:
/fpress/streamdeck/button 1 2
/fpress/streamdeck/button/1/2
Als letztes Argument kannst du eine Aktion mitgeben. Standard ist "tap".
| Aktion | Wirkung |
|---|---|
"tap" / "trigger" / "go" | Drücken und loslassen |
"press" / "on" / "1" | Nur drücken |
"release" / "off" / "0" | Nur loslassen |
/fpress/streamdeck/button 0 0 "tap"
/fpress/streamdeck/button/0/0 "press"
/fpress/streamdeck/button/0/0 "release"
Tasten, die für die Timecode-Anzeige reserviert sind, und die Tools-Taste führen auch über OSC keine Macros aus.
/fpress/streamdeck/feedback
Setzt die Feedback-Farbe einer Deck-Taste von außen. So zeigst du zum Beispiel den Zustand eines anderen Systems auf dem Deck an.
Zustandswerte:
| Wert | Bedeutung |
|---|---|
1, "on", "true", "active", true | Active-/Feedback-Farbe erzwingen |
0, "off", "false", "idle", false | Idle-Farbe erzwingen |
"clear", "auto", "local", "release" | Override aufheben, die lokale Logik übernimmt wieder |
Floats zwischen 0.0 und 1.0 werden bei 0.5 gerundet.
Adressierung per Tastennummer (1–32, zählt ab 1):
/fpress/streamdeck/feedback 5 1
/fpress/streamdeck/feedback/5 1
/fpress/streamdeck/5/feedback 1
Adressierung per Raster (Row/Column, zählt ab 0):
/fpress/streamdeck/feedback/1/2 1
/fpress/streamdeck/1/2/feedback "clear"
/fpress/streamdeck/feedback/all
Setzt alle Tasten auf denselben Zustand.
/fpress/streamdeck/feedback/all 1
/fpress/streamdeck/feedback/all "clear"
/fpress/streamdeck/feedback/clear
Hebt alle OSC-Overrides auf. Ohne Argumente.
/fpress/streamdeck/feedback/clear
/fpress/query
Fragt den Zustand der FrenschPress ab. Sie antwortet mit einer oder mehreren /fpress/status/…-Nachrichten, und zwar an Adresse und Port, von denen die Anfrage kam. Dein Empfänger lauscht also auf dem Port, von dem er gesendet hat.
/fpress/query
/fpress/query "mode"
Ohne Argument kommen alle vier Antworten. Mit einem Gruppennamen (device, mode, set oder qlab) kommt nur diese eine.
Antworten
| Nachricht | Argumente |
|---|---|
/fpress/status/device | Gerätename · Firmware-Version · MAC-Adresse · IP-Adresse |
/fpress/status/mode | Mode (qlab / macro / companion) · QLab-Transport (osc / msc) · interner Transport-Code |
/fpress/status/set | Aktives Button-Set (A / B / C) · Set je Taste als Buchstabenfolge |
/fpress/status/qlab | Läuft ein Cue (0/1) · Pausiert (0/1) · QLab-Feedback abonniert (0/1) |
Pro Absender antwortet die FrenschPress höchstens einmal alle 100 ms. Schnellere Anfragen verwirft sie. Anfragen von ihrer eigenen Adresse ignoriert sie.
Steuerst du die FrenschPress aus Bitfocus Companion, musst du diese Befehle nicht selbst bauen. Das Companion-Modul übernimmt Abfrage und Auswertung.
Kurzreferenz
/fpress/mode 2
/fpress/set "B"
/fpress/set "B" "stop,go,pause"
/fpress/preset "my-user-preset-12ab"
/fpress/preset "osc-qlab-basics:transport"
/fpress/button "go"
/fpress/button "stop" "press"
/fpress/macro "Haus AN" "toggle"
/fpress/timeline/arm "Main Timeline"
/fpress/timeline/disarm_all
/fpress/led "stop" 255 0 0
/fpress/led 255 80 0
/fpress/led/release
/fpress/var "cue" "Blackout"
/fpress/var/clear
/fpress/streamdeck/button/0/0
/fpress/streamdeck/feedback/1/2 1
/fpress/streamdeck/feedback/clear
/fpress/query
/fpress/query "qlab"
Wenn es nicht klappt
| Symptom | Ursache | Abhilfe |
|---|---|---|
| Kein Befehl kommt an | Falscher Port oder falsche IP-Adresse | Port in den Settings prüfen (Standard 53001) und an die IP-Adresse der FrenschPress senden. |
/fpress/set bewirkt nichts | Die FrenschPress ist nicht im Custom Mode | Vorher /fpress/mode 2 senden. |
/fpress/macro wird abgelehnt | Der Name passt auf mehrere Macros | Die Macro-ID statt des Namens senden. |
Eine Taste reagiert nach press nicht mehr normal | Das release fehlt | /fpress/button … "release" senden. |
/fpress/var wird abgewiesen | Name beginnt mit sys_ oder alle 64 Plätze sind belegt | Anderen Namen wählen oder mit /fpress/var/clear aufräumen. |
Auf /fpress/query kommt keine Antwort | Empfänger lauscht auf dem falschen Port oder Anfragen kommen schneller als alle 100 ms | Auf dem Absende-Port lauschen und Abfragen langsamer senden. |