VDR - Setup - Plugin

VDR-Setup Konfiguration

Das VDR-Setup Plugin nutzt zwei Konfigurationsdateien.

Beschreibung minivdr-setup.xml

Die Dateiminivdr-setup.xml beschreibt die Konfiguration des Setup-Plugins im XML Format.

<setup>

Das ist das Wurzelelement der Konfigurationsdatei. Alle anderen Elemente liegen verschachtelt in diesem.
Attribute Beschreibung
sysconfigFile Pfad zu Sysconfig Datei. In dieser Datei speichert das Plugin die Einstellungen in Form von SHELL Variable Definitionen. Diese Datei 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"

 

<plugins>

Beinhaltet die Liste der Plugins.
Attribute Beschreibung
sysconfig Variablen Name im sysconfigFile. In dieser Variable wird die Liste der aktivierten Plugins gespeichert.

 

<plugin>

Beschreibt ein Plugin.
Attribute Beschreibung
name Name des Plugins. Gibt den Namen des Plugins an. Im VDR-Lib-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.
protected Hat den Wert "yes" oder "no". Wenn == yes , dann kann dieses Plugin nicht deaktiviert werden und im OSD erscheint "geschützt".

Dieses Attribut ist optional. Default: "no".

 

<menus>

Es folgen nun beliebig viele Menübeschreibungen <menu>. Innerhalb eines Menüs können weitere Menüs <menu> oder aber Einträge (<entry>) folgen.

 

<menu>

Beschreibt ein Menü. Innerhalb eines Menüs können weitere Menüs <menu> oder aber Einträge (<entry>) folgen.
Attribute Beschreibung
name Name des Menüs. Dieser String wird dann im VDR-Menü angezeigt.
command Dieses optionale Attribut gibt ein Kommando mit kompletter Pfadbeschreibung und Parametern an, welches ausgeführt wird, wenn das Submenü mit OK beendet wird.
system erlaubt die Angabe eines Standard Untermenüs der "Einstellungen".
Mögliche Werte sind:
  • OSD
  • EPG
  • DVB
  • LNB
  • CICAM
  • Record
  • Replay
  • Misc
  • Plugins
Zusätzlich zu den VDR-Standardmenüs sind die folgenden Untermenü definiert:
  • ActPlugins (Aktiviere /Deaktiviere Plugin)
  • VDRMenu (Editiere das VDR-Menü)
Während dem Build-Prozess werden alle in <vdr>/menu.c definierten Setup-Menüs eingelesen und konfiguriert.
Ist z.B. der BigPatch angewendet worden, dann können zum Beispiel zusätzlich die folgenden Werte genutzt werden:
  • BigPatch (Menü des Bigpatches)
  • 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.
help2 Dieses optionale Attribut gibt eine Datei mit einem langen Hilfstext 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.

 

<entry>

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.
command Dieses optionale Attribut gibt ein Kommando mit kompletter Pfadbeschreibung und Parametern an, welches ausgeführt wird, wenn das Submenü mit OK beendet wird.
type 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.
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 <entry> Eintrags mit <value> definiert werden muss.
value Ausgewählter Wert.
setup Mit diesem Attribut können interne Funktionen aufgerufen werden.
childlock
Definiert die Kindersicherungsfunktion. Die eingegebenen Werte werden in Form von "*" angezeigt.
channellist
Erlaubt die Auswahl von vordefinierten Kanallisten. Die Kanallisten müssen in den Verzeichnis <vdrdir>/plugins/channels mit der Endung *.conf abgelegt werden. Das Setup-Plugin linkt dann die ausgewählte Kanalliste nach <vdrdir>/channels.conf
networkdriver"
erlaubt die Auswahl eines Netzwerktreibers
help1 Dieses optionale Attribut gibt einen kurzen Hilfstext an welcher in der Statuszeile angezeigt wird, wenn der Cursor auf dem Eintrag steht.
help2 Dieses optionale Attribut gibt eine Datei mit einem langen Hilfstext 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.

 

<value>

Innerhalb eines Entries vom Typ "selection" können beliebig viele <value> Werte definiert werden, die dann zur Auswahl stehen.

 

Beschreibung vdr-menu.xml

In der Datei vdr-menu.xml wird die Menükonfiguration des VDR abgelegt.

<menus>

Das ist das Wurzelelement der Konfigurationsdatei. Innerhalb dieses Elementes dürfen beliebig viele Elemente der folgenden Typen liegen:

<menu>

Innerhalb eines Menüs, können beliebig viele weitere Tags von folgende Typen folgen:

Attribute Beschreibung
name Name des Menüs. Dieser String wird dann als VDR-Menü angezeigt.

<plugin>

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.

<system>

Beschreibt eines der Standart VDR-Menüs, die an dieser Stelle im Menü angezeigt wird.

Attribute Beschreibung
name 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
Das Menü Kanäle.
Timers
Das Timer Menü.
Recordings
Das Aufnahme Menü.
Setup
Das Menü Einstellungen.

<command>

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.