U23 2005/Scripteditor

Beschreibung

Ein Editor, mit dem man sich ganz einfach Scripts für das Fnordlicht zusammenklicken kann. Dabei soll es einen Simple-Mode und einen Expert-Mode geben: Im Simple-Mode gibt man eine Farbe als Hex-Wert an (oder wählt sie mit einem Color-Picker aus), dann bestimmt man, wie lange diese Farbe angezeigt werden soll und ob es einen Fade zu dieser Farbe geben soll (und wie lange dieser dauern soll). Danach fügt man die nächste Farbe ein, etc.

Ein Beispiel:

1: Zeige mir 10 sec lang Rot an (ohne Fade)
2: Fade innerhalb von 5 sec zu Lila und zeige mir dann 30 sec lang Lila an.
3: Fade innerhalb von 10 sec zu Gelb und zeige mir dann 20 sec lang Gelb an.
4: ...

Der Expert-Mode hat im Grunde dieselben Funktionen, aber man kann die drei Threads (also Farbkanäle) getrennt steuern.

Ein Beispiel:

1: Der rote Kanal soll innerhalb von 15 sec auf volle Helligkeit und dann wieder innerhalb von 15 sec auf                                   
   Helligkeit 0 blenden.
2: Der blaue Kanal soll (gleichzeitig) in 5 sec auf volle Helligkeit und dann wieder innerhalb von 5 sec auf        
   Helligkeit 0 blenden.
3: Währenddessen soll der grüne Kanal mit einer Frequenz von 2 Hz (d.h. 2 mal pro Sekunde) blinken.

So hab ich das zumindest verstanden --Diozaka

Ich auch... --Pylon 13:43, 4 Nov 2005 (CET)

Ich auch... --Nico

Na dann wird's ja stimmen :) --Diozaka

Funktionen

• Die Scriptdateien per Parameter beim Kompilieren nachladen wie z.B. make install-fnordlicht meinTollesScript.inc
• Speichern der Script-Entwürfe in einem eigenen Dateiformat (z.B. .fs = fnordlicht Script)
• ...

Arbeitsschritte

• Doku zu den Firmware Makros die für die Scripts benötigt werden. Machen: diozaka, manuke. (fertig)
• GUI entwerfen. (fertig, siehe unten)
• GUI schreiben.
• Dateiformat für Script-Entwürfe (.fs) definieren. (Erster Vorschlag, siehe unten)
• Parser schreiben: Script-Entwurf -> Assembler-Macros
• Makefile anpassen. (siehe oben)

GUI

Unser erster Entwurf für den Simple-Mode

(Bild kommt, wenn Bilderupload wieder möglich ist)

Koordination

Ich hab mir nochmal überlegt, wie wir das Programm strukturieren könnten. Meiner Meinung nach, wenn wir schon Java benutzen, dann auch richtig. Daher würde ich sagen für jedes der 8 Makros, bzw. je nach Gebrauch auch weniger, gibt es eine Klasse. Diese Klasse bekommt einen einfachen Namen und bekommt vernünftige Werte als Argumente. Intern rechnet dann jede Klasse die Argumente in die Script Makro Argumente um und liefert durch eine Funktion getCode() oder sonst wie den fertigen Makroteil als String.

Diese Objekte können wir dann zB in einen 2-dimensionalen Array schreiben der die Zeitleiste repräsentiert. 1 Element ist das Befehlsobjekt und das andere Element ist der Button oder das Feld oder was auch immer dann diesen Befehl auf der Zeitleiste darstellt. So könnte man dann nachher beim Generieren einfach den Array durchlaufen und von jedem Objekt den entsprechenden Makrocode anfordern und zusammensetzen.

Alternativ kann man den Button auch als einen Parameter des Objektes abspeichern, dann reicht ein 1-dimensionales Array. Die innere Struktur der Klassen hängt dann vor allem auch vom Fnordlicht-Script-Dateiformat ab, damit es nicht zu kompliziert wird, die Sachen abzuspeichern und zu laden. Ein erster Entwurf ist unten...

Mir kommt grad noch eine Idee: Es wäre vielleicht vorteilhaft, eine Klasse zu schreiben, die dann ein ganzes Fnordlicht-Script beinhaltet. Da könnte man dann außer dem Array noch ein paar Meta-Informationen speichern, wie z.B. ob das Script nach dem Ablauf stehen bleiben soll oder ob es wieder von anfang an laufen soll, etc. --Diozaka

Evtl. würd ich auch wirlich erstmal den Simple Mode nach hinten schieben und mit 3 Leisten arbeiten, weil das erstmal schneller und einfacher ist und wir alle nicht viel Zeit haben.

Daher auch jetzt hier ein bisschen Koordination, weil wenn jeder ohne gemeinsame Struktur irgendwas zusammencoded ham wir alle nicht viel davon.

Also ich würde mich bereit erklären, die Wrapperklassen für die Makros zu schreiben, evtl mit Diozaka zusammen.

Bin dabei. :D --Diozaka

Soweit von mir, awaiting feedback..

Timo aka manuke

Dateiformat, tabellenartig (deprecated)

Blase16 hat den Vorschlag gemacht, XML zu benutzen. Find ich gut, also ist das hier erstmal deprecated. --Diozaka

Hier also eine erste Idee für das Dateiformat, Verbesserungen sind natürlich höchst willkommen.

Definition

Das Dateiformat basiert auf fünf Spalten:

• channel: 0, 1 oder 2 (rot, grün oder blau)
• time: Der Startzeitpunkt der Aktion
• fade: Die Länge des Fades (muss kleiner oder gleich $duration sein, 0 bedeuted kein Fade)
• duration: Die Dauer der Aktion (in Sekunden)
• brightness: Die Helligkeit der Farbe

Zeilen, die mit # anfangen, sind Kommentare.

Am besten versteht man das wohl mit einem Beispiel:

Beispiel-Datei

# channel  time   fade  duration  brightness
# -------------------------------------------

# the red thread:
    0       0     20      20        255
    0      20     20      20          0
# stops after 40 secs

# the green thread:
    1       0      5      10        255
    1      10     10      10          0
    1       0      5      10        255
    1      10     10      10          0
# stops after 40 secs

# the blue thread:
    2       0      0      40        128
# stops after 40 secs

Erklärungen zum Beispiel

Am besten erstmal selber versuchen, die Sache zu verstehen, dann weiterlesen. ;)

Der rote Kanal fadet innerhalb von 20 sec zu Helligkeit 255 und fadet dann direkt wieder zu Helligkeit 0, auch innerhalb von 20 sec.

Der grüne Kanal fadet innerhalb von 5 sec zu Helligkeit 255, hält diese Helligkeit dann weitere 5 sec und fadet dann innerhalb von 10 sec wieder zurück zu Helligkeit 0. Das Ganze zweimal nacheinander.

Der blaue Kanal wird direkt (ohne Fade) auf Helligkeit 128 gesetzt und bleibt dann 40 sec lang auf dieser Helligkeitsstufe.

--Diozaka

Dateiformat, in XML

XML ist sehr wahrscheinlich einfacher zu lesen und zu parsen, also hier eine Idee in XML.

Ein XML Beispiel (Blase16)

Das obige Script hier als XML.

<? xml version="1.0" ?>
<fnordlicht>
	<channel>
		<red time="0" fade="20" duration="20" brightness="255" />
		<red time="20" fade="20" duration="20" brightness="0" />
	</channel>
	<channel>
		<green time="0" fade="5" duration="10" brightness="255" />
		<green time="10" fade="10" duration="10" brightness="0" />
		<green time="0" fade="5" duration="10" brightness="255" />
		<green time="10" fade="10" duration="10" brightness="0" />
	</channel>
	<channel>
		<blue time="0" fade="0" duration="40" brightness="128"/>
	</channel>
 <fnordlicht>

Erläuterungen

• <fnordlicht> Ist das Wurzelement
• <channel> Das <channel> Element muss drei mal innerhalb des Wurzelelements vorkommen.
• <red /> (<green /> <blue />) Besitzt die Atributte time, fade, duration und brightness.
  • time: Der Startzeitpunkt der Aktion
  • fade: Die Länge des Fades (muss kleiner oder gleich $duration sein, 0 bedeuted kein Fade)
  • duration: Die Dauer der Aktion (in Sekunden)
  • brightness: Die Helligkeit der Farbe

--Blase16

Noch ein XML-Beispiel (Diozaka)

<? xml version="1.0" ?>
<fnordlicht>
	<channel color="red">
		<frame time="0"  fade="20" duration="20" brightness="255" />
		<frame time="20" fade="20" duration="20" brightness="0" />
	</channel>
	<channel color="green">
		<frame time="0"  fade="5"  duration="10" brightness="255" />
		<frame time="10" fade="10" duration="10" brightness="0" />
		<frame time="20" fade="5"  duration="10" brightness="255" />
		<frame time="30" fade="10" duration="10" brightness="0" />
	</channel>
	<channel color="blue">
		<frame time="0"  fade="0"  duration="40" brightness="128"/>
	</channel>
 <fnordlicht>

Ohne Erläuterung...