****** Einleitung ****** Das SETUP-Plugin erlaubt die einfache Konfiguration der wichtigsten Systemeinstellungen über das OSD des VDR's. Dieses Plugin wurde ursprünglich für die MiniVDR Distribution entwickelt, kann aber einfach für andere Distributionen konfiguriert werden. ****** Features ****** Folgende Funktionen werden mit dem Setup Plugin realisiert: ****** An- und Abwahl von Plugins ****** Per OSD können Plugins an oder abgeschaltet werden. Eventuell benötigte Plugin- Parameter können im Konfigurationsfile setup.xml hinzugefügt werden. Eine geänderte Plugin-Konfiguration wird erst nach dem nächsten Neustart aktiv. ***** VDR-Menüs ***** Mit dem Setup-Plugin wird ein Patch für den VDR ab Version 1.3.33 geliefert, welcher die Erzeugung von Submenüs erlaubt. ACHTUNG: Hierbei handelt es sich um eine eigene neue Entwicklung, welcher beliebig viele geschachtelte Sub-Sub-Menüs zulässt. Das Plugin Submenu und dessen Patch kann nicht zusammen mit dem Setup-Plugin verwendet werden! In der Menükonfigurationsdatei "menu.xml" können Menüs, Plugins und Kommandos definiert werden, welche dann per OSD ausgeführt werden können. Eventuelle Bildschirmausgaben der Kommandos werden auf dem OSD ausgegeben. Menüs und Kommandos können im Setup-Plugin auch per OSD hinzugefügt, editiert und verschoben werden. Eine geänderte Menükonfiguration wird sofort nach dem Speichern und erneutem Öffnen des Menüs aktiv. Plugins können mit einem frei wählbaren Title versehen werden. ****** Systemkonfiguration ändern ****** Im Setup Plugin können die gängigen Systemkonfigurationen per OSD geändert werden. Im Konfigurations-File setup.xml können dazu beliebige geschachtelte Menüs (XML Tag konfiguriert werden. Jedem Systemparameter wird ein Variablenname zugeordnet, der dann im angegebenen System-Konfigurationsfile, welches mit dem Attribut "sysconfigFile" definiert wurde, abgespeichert. Diese Datei kann dann von der Distribution beim Booten und Starten des VDR ausgelesen werden und das System nach den Einstellungen des Benutzers konfigurieren. Die Beschreibung der Konfigurationsdateien wird hier im Detail beschrieben. ****** Systemvoraussetzungen ****** * In das Plugin Konfigurationsverzeichnis (z.B: /etc/vdr/plugins/setup) muss die Dateien setup.xml und (z.B. /etc/vdr) menu.xml abgelegt werden. * Die in der Datei setup.xml mit dem Attribut "sysconfigFile gekennzeichnete Datei wird vom Plugin angelegt, falls Sie nicht existieren sollte. In dieser Datei werden die Einstellungen in Form von Shellvariablen gespeichert. * Hilfedateien werden in dem Vezeichnis /etc/vdr/plugins/setup/help abgelegt. * Der beigefügte Patch für VDR 1.3.x muss installiert werden. * Das Submenü-Plugin darf nicht zusammen mit dem Setup-Plugin verwendet werden. ****** Support ****** Fragen, Verbesserungsvorschläge und eventuelle Fehler können direkt über das Forum im VDR-Portal weiter gegeben werden. ************************************* ****** VDR-Setup Konfiguration ****** ************************************* Das VDR-Setup Plugin nutzt zwei Konfigurationsdateien. * setup.xml * menu.xml ***** Beschreibung setup.xml ***** Die Datei setup.xml beschreibt die Konfiguration des Setup-Plugins im XML Format. Das ist das Wurzelelement der Konfigurationsdatei. Alle anderen Elemente liegen verschachtelt in diesem. Attribute Beschreibung Pfad zu Sysconfig Datei. In dieser Datei speichert das Plugin die Einstellungen in Form von SHELL Variable Definitionen. Diese Datei sysconfigFile kann dann vom Backend z.B.:runvdr einfach eingelesen und ausgewertet werden. Achtung: die Datei wird bei jeder Änderung innerhalb des Plugins neu erzeugt. bootLinux Enthält das Kommando, welches aufgerufen wird um LINUX zu rebooten. Default ="/sbin/reboot" VDRlibDir Gibt das Verzeichnsi an, in welchem die VDR-Plugins abgelegt sind. Deafult ="/usr/lib/vdr/plugins" Beinhaltet die Liste der Plugins. Attribute Beschreibung sysconfig Variablen Name im sysconfigFile. In dieser Variable wird die Liste der aktivierten Plugins gespeichert. Beschreibt ein Plugin. Attribute Beschreibung Name des Plugins. Gibt den Namen des Plugins an. Im VDR-Lib- name Verzeichnis muss das Plugin dann unter dem Namenlib-"name"-vdrversion gefunden werden. param Dieses optionale Attribut gibt die Aufrufparameter des Plugins an. info Beschreibung des Plugins active Hat den Wert "yes" oder "no" und gibt an, ob das Plugin aktiv ist. Hat den Wert "yes" oder "no". Wenn == yes , dann kann dieses Plugin protected nicht deaktiviert werden und im OSD erscheint "geschützt". Dieses Attribut ist optional. Default: "no". Es folgen nun beliebig viele Menübeschreibungen . Innerhalb eines Menüs können weitere Menüs oder aber Einträge () folgen. Beschreibt ein Menü. Innerhalb eines Menüs können weitere Menüs oder aber Einträge () folgen. Attribute Beschreibung name Name des Menüs. Dieser String wird dann im VDR-Menü angezeigt. Dieses optionale Attribut gibt ein Kommando mit kompletter command Pfadbeschreibung und Parametern an, welches ausgeführt wird, wenn das Submenü mit OK beendet wird. erlaubt die Angabe eines Standard Untermenüs der "Einstellungen". Mögliche Werte sind: * OSD * EPG * DVB * LNB * CICAM system * Record * Replay * Misc * Plugins Zusätzlich zu den VDR-Standardmenüs sind die folgenden Untermenüs definiert: * ActPlugins (Aktiviere / Deaktiviere Plugin) * VDRMenu (Editiere das VDR-Menü) Während dem Build-Prozess werden alle in /menu.c definierten Setup-Menüs eingelesen und konfiguriert. Ist der Live-Buffer Patch angewendet worden, kann auch der zusätzliche Wert genutzt werden: * LiveBuffer (Menü des Live-Buffer Patches) help1 Dieses optionale Attribut gibt einen kurzen Hilfstext an welcher in der Statuszeile angezeigt wird, wenn der Cursor auf dem Eintrag steht. Dieses optionale Attribut gibt eine Datei mit einem langen Hilfstext help2 an. Diese Datei muss sich in dem Verzeichnis PluginConfigDir/setup/ help befinden. Der Text der Datei wird ausgegeben, wenn die rote Taste gedrückt wird. Innerhalb eines Menü können beliebig viele Einträge aufgeführt werden, mit denen jeweils einen Wert konfiguriert werden kann. Attribute Beschreibung name Name des Eintrags. Dieser String wird dann im VDR-Menü angezeigt. sysconfig Variablen Name im sysconfigFile. In dieser Variable wird die Liste der aktivierten Plugins gespeichert. Dieses optionale Attribut gibt ein Kommando mit kompletter command Pfadbeschreibung und Parametern an, welches ausgeführt wird, wenn das Submenü mit OK beendet wird und der Wert geändert wurde. definiert den Typ des Eintrags. Erlaubt sind die folgenden Einträge: text Erlaubt das Editieren eines Textes. bool Erlaubt das Editieren eines Booleschen Wertes (yes oder no) numtext Erlaubt die Eingabe eines Strings der nur aus Ziffern besteht. Führende Nullen bleiben erhalten. type hex Erlaubt die Eingabe von Hexadezimalwerten. number Erlaubt die Eingabe eines Integer Wertes. ip Erlaubt die Eingabe einer Internetadresse der Form DDD.DDD.DDD.DDD. selection Erlaubt die Auswahl eines Elementes welches innerhalb des Eintrags mit definiert werden muss. value Ausgewählter Wert. Mit diesem Attribut können interne Funktionen aufgerufen werden. childlock Definiert die Kindersicherungsfunktion. Die eingegebenen Werte werden in Form von "*" angezeigt. channellist setup dieses comando wird ausgeführt um eine liste der attribute zu erhalten, mit denen eine selection liste gefuellt werden soll. help1 Dieses optionale Attribut gibt einen kurzen Hilfstext an welcher in der Statuszeile angezeigt wird, wenn der Cursor auf dem Eintrag steht. Dieses optionale Attribut gibt eine Datei mit einem langen Hilfstext help2 an. Diese Datei muss sich in dem Verzeichnis PluginConfigDir/setup/ help befinden. Der Text der Datei wird ausgegeben, wenn die rote Taste gedrückt wird. Innerhalb eines Entries vom Typ "selection" können beliebig viele Werte definiert werden, die dann zur Auswahl stehen. ***** Beschreibung menu.xml ***** In der Datei menu.xml wird die Menükonfiguration des VDR abgelegt. Das ist das Wurzelelement der Konfigurationsdatei. Innerhalb dieses Elementes dürfen beliebig viele Elemente der folgenden Typen liegen: * menu * plugin * system * command Innerhalb eines Menüs, können beliebig viele weitere Tags von folgende Typen folgen: * menu * plugin * system * command Attribute Beschreibung name Name des Menüs. Dieser String wird dann als VDR-Menü angezeigt. Beschreibt den Name des Plugins, der an dieser Stelle im Menü angezeigt wird. Attribute Beschreibung name Name des Plugins. Im Menü erscheint dann der Sprachen spezifische Name des Plugins. Beschreibt eines der Standart VDR-Menüs, die an dieser Stelle im Menü angezeigt wird. Attribute Beschreibung Name des System Kommandos. Im Menü erscheint dann der Sprachen spezifische Name des System Kommandos. Die folgenden Werte sind definiert: Schedule Das Programm Menü. Channels name Das Menü Kanäle. Timers Das Timer Menü. Recordings Das Aufnahme Menü. Setup Das Menü Einstellungen. Beschreibt ein Kommando welches im Menü eingebunden werden kann. Attribute Beschreibung name Name des Kommandos. Dieser String wird dann als VDR-Menü angezeigt. execute Kompletter String mit Pfadname zum Kommando und optionalen Parametern, der ausgeführt werden soll.