Plugin Installation

Aus VDR Wiki
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
K (→‎Ein praktisches Beispiel zum besseren Verständnis)
 
(109 dazwischenliegende Versionen von 55 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
Da die Plugin Schnittstelle von Klaus Schmidinger "standardisiert" wurde, ist auch die Installation in den Grundzügen immer gleich. Auf Besonderheiten wird auf den jeweiligen [[Plugins|Plugin]]-Seiten eingegangen. Letzte Instanz ist aber immer das README-file des Plugins.
 
−
 
 
==Vorbereitung==
 
==Vorbereitung==
−
Nachdem man sich das Plugin-Archiv aus dem Internet heruntergeladen hat wechselt man in das ''PLUGINS/src'' Verzeichnis von [[VDR]] und entpackt das Archiv
+
Die Installation der verschiedenen Plugins ist in den Grundzügen immer gleich. Auf Besonderheiten wird auf den jeweiligen [[Plugins|Plugin]]-Seiten eingegangen. Letzte Instanz ist aber immer das '''README'''-file des Plugins.
 +
 
 +
{{Box Hinweis|
 +
Die Variable '''$SOURCEDIR''' enthält den Pfad zum Verzeichnis, in dem sich die VDR-Quellen befinden.
 +
Übliche Verzeichnisse sind '''/usr/local/src''', '''/usr/src''' und das '''home-Verzeichnis''' des jeweiligen Nutzers.
 +
 
 +
Die Variable '''$PLUGIN_NAME''' steht für den Namen des zu installierenden Plugins.
 +
}}
 +
 
 +
Nachdem man sich das Plugin-Quellarchiv aus dem Internet heruntergeladen hat wechselt man in das '''PLUGINS/src''' Verzeichnis von VDR und entpackt das Archiv.
 +
 
 
<pre>
 
<pre>
−
cd /home/user/vdr/VDR/PLUGINS/src
+
cd $SOURCEDIR/VDR/PLUGINS/src
−
tar jxvf /path/to/vdr-name-x.y.z.tar.bz2
+
 
</pre>
 
</pre>
−
bei einem BZIP2-Archiv (*.bz2) oder
+
 
 +
Entpacken eines BZIP2-Quellarchivs (*.tar.bz2):
 +
 
 
<pre>
 
<pre>
−
tar zxvf /path/to/vdr-name-x.y.z.tgz
+
tar jxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.tar.bz2
 +
</pre>
 +
 
 +
Entpacken eines GZIP-Quellarchivs (*.tgz, *.tar.gz).
 +
 
 +
<pre>
 +
tar zxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.{tgz,tar.gz}
 
</pre>
 
</pre>
−
bei einem GZIP-Archiv (*.tgz, *.tar.gz).
 
  
 
Nun noch einen symbolischen Link auf das gerade entpackte Verzeichnis anlegen. Die Versionsnummer wird dabei nicht angegeben
 
Nun noch einen symbolischen Link auf das gerade entpackte Verzeichnis anlegen. Die Versionsnummer wird dabei nicht angegeben
 +
 
<pre>
 
<pre>
−
ln -s name-x.y.z name
+
ln -s $PLUGIN_NAME-<VERSION> $PLUGIN_NAME
 
</pre>
 
</pre>
−
{| width=75%
+
 
−
| style="background-color:#ffeaa5; border:solid 1px #ffeaa5; font-weight:bold; text-align:center;"|
+
{{Box Hinweis|
−
Hinweis
+
−
|-
+
−
| style="background-color:#ffffee; border:solid 1px #ffeaa5; padding:1em; font-size:75%;"|
+
 
Die Beschreibung hier geht davon aus, dass sich die Plugin Autoren an das vorgegebene Namensschema halten. Leider ist dies nicht immer der Fall.
 
Die Beschreibung hier geht davon aus, dass sich die Plugin Autoren an das vorgegebene Namensschema halten. Leider ist dies nicht immer der Fall.
  
−
Damit VDR das Plugin kompiliert darf das Verzeichnis der Plugins, oder der Link dorthin nur den Name enthalten, kein "vdr-...", "plugin-..." oder gar die Versionsnummer dabei (Achtung: 'vdrcd' ist richtig, 'vdr-cd' nicht).
+
Damit VDR das Plugin kompiliert, darf der Link in VDR/PLUGINS/src nur den Namen enthalten, aber keine Bindestriche, Zahlen. Man kann sich einfach an den mit VDR mitgelieferten Plugins orientieren.
 +
}}
  
−
Man kann sich einfach an den mit VDR mitgelieferten Plugins orientieren.
+
==Kompilieren==
−
|}
+
Die [[Plugins]] liegen nach dem Auspacken als [[Quelltext]] auf der Festplatte. Für die Verwendung im VDR müssen die Quelltexte jedoch mit einem [[Compiler]] in einen maschinell lesbaren Binärcode übersetzt werden. Für den Aufruf des Compilers muss man in das zwei Ebenen höher liegende VDR-Verzeichnis wechseln und den Kompiliervorgang mit dem Befehl "make plugins" starten. Dieser Vorgang übersetzt den Quelltext aller Plugins.
−
 
+
−
==Für Entwickler==
+
−
Bitte haltet Euch an die Konventionen, beim packen der Plugins, Auszug aus VDR/PLUGINS.html:
+
 
<pre>
 
<pre>
−
Building the distribution package
+
cd $SOURCEDIR/VDR
 +
make plugins
 +
</pre>
  
−
If you want to make your plugin available to other VDR users, you'll need to make a package that can be easily distributed.
+
==Installation==
−
The Makefile that has been created by the call to newplugin provides the target dist, which does this for you.  
+
Nachdem der Compiler-Lauf fehlerfrei durchgelaufen ist, können die entstandenen [[Bibliothek]]en ins Zielverzeichnis kopiert werden.
  
−
Simply change into your source directory and execute make dist:
+
<pre>
 +
mkdir -p /usr/lib/vdr/plugins
 +
cp PLUGINS/lib/* /usr/lib/vdr/plugins/
 +
</pre>
  
−
cd VDR/PLUGINS/src/hello
+
Dieses Verzeichnis kann je nach System variieren. Beim Start des VDR wird das Verzeichnis mit
−
make dist
+
  
−
After this you should find a file named like
+
<pre>
 +
vdr -L /usr/lib/vdr
 +
</pre>
  
−
vdr-hello-0.0.1.tgz
+
oder
  
−
in your source directory, where hello will be replaced with your actual plugin's name,
+
<pre>
−
and 0.0.1 will be your plugin's current version number
+
vdr --lib='/usr/lib/vdr'
 
</pre>
 
</pre>
−
==Kompilieren==
 
−
Die Plugins liegen nach dem Auspacken als [[Quelltext]] auf der Festplatte. Für die Verwendung im VDR müssen die Quelldaten jedoch kompiliert werden (überführen in einen maschinell lesbaren Binärcode siehe http://de.wikipedia.org/wiki/Compiler).
 
  
−
Zum Compiler-Aufruf in das zwei Ebenen höher liegende VDR-Verzeichnis wechseln und den Kompiliervorgang über das make-Programm des VDR aufrufen
+
als Parameter übergeben.
 +
 
 +
==Alte Plugins unter VDR 1.4==
 +
Die API-Version wird von der VDR-Version getrennt. Deshalb müssen nicht jedes mal alle Plugins neu kompiliert werden, wenn sich nur die VDR-Version ändert, die API-Definition jedoch gleich bleibt.
 +
 
 +
Ville Skyttä hat dazu folgenden Lösungsvorschlag in der ML gepostet:
 +
 
 +
"Plugins that have not been changed to use APIVERSION yet upstream can be usually locally updated with something as simple as:"
 +
 
 +
sed -i -e s/VDRVERSION/APIVERSION/g Makefile
 +
 
 +
Dieser Befehl muss für jedes verwendete Plugin im zugehörigen Verzeichnis des Quelltextes ausgeführt werden. Oder man führt folgenden Befehl aus:
 +
 
 +
find [[Struktur|$SOURCEDIR]]/VDR/PLUGINS -name Makefile -exec sed -i -e 's:VDRVERSION:APIVERSION:g' {} \;
 +
 
 +
==Ein praktisches Beispiel zum besseren Verständnis==
 +
 
 +
Das [[Streamdev-plugin|streamdev Plugin]] soll manuell installiert werden. Der [[Aktuelle_Ereignisse|Quellcode des VDR]] liegt entpackt unter /usr/src ("$SOURCEDIR"). Die Ordnerstruktur in /usr/src sieht dann so aus:
 
<pre>
 
<pre>
−
cd ../..
+
/usr/src/vdr-1.6.0-1
−
make plugins
+
/usr/src/VDR -> /usr/src/vdr-1.6.0-1
 
</pre>
 
</pre>
−
==Installation==
+
Der Quellcode von streamdev wird im VDR Quellcode nach PLUGINS/src entpackt:
−
Nachdem der Compiler-Lauf fehlerfrei durchgelaufen ist, müssen die entstandenen [[Library|Bibliotheken]] ins Zielverzeichnis kopiert werden
+
 
<pre>
 
<pre>
−
cp PLUGINS/lib/* /usr/lib/vdr
+
cp vdr-streamdev-0.3.4.tgz /usr/src/VDR/PLUGINS/src
 +
cd /usr/src/VDR/PLUGINS/src
 +
tar xfz vdr-streamdev-0.3.4.tgz
 
</pre>
 
</pre>
−
Dieses Verzeichnis kann natürlich je nach System variieren.
+
Anschließend muss noch das neu entstandene Verzeichnis streamdev-0.3.4 nach streamdev verlinkt werden:
−
Später beim Aufruf von VDR wird diesem das Verzeichnis mittels '--lib=<DIR>' bekannt gemacht.
+
<pre>
 +
ln -s streamdev-0.3.4 streamdev
 +
</pre>
 +
Die Ordnerstruktur sollte nun so aussehen:
 +
<pre>
 +
/usr/src/VDR/PLUGINS/src/streamdev-0.3.4
 +
/usr/src/VDR/PLUGINS/src/streamdev -> /usr/src/VDR/PLUGINS/src/streamdev-0.3.4
 +
</pre>
 +
Anschließend kann compiliert werden:
 +
<pre>
 +
cd /usr/src/VDR
 +
make plugins
 +
</pre>
 +
Hinweise:
 +
*wenigstens einmal nach Entpacken des VDR Quelltextes sollte vorher ein "make" aufgerufen worden sein, damit die VDR include Verzeichnisse angelegt wurden.
 +
*Bei einigen Plugins müssen vor der ersten Benutzung noch in das Konfigurationsverzeichnis von VDR Dateien kopiert werden oder Dateien modifiziert werden. In diesem Beispiel ist es die [[streamdevhosts.conf]] die in den Ordner 'plugins' im Konfigurationsordner des VDR kopiert werden soll und entsprechend der README angepasst werden muss. Deswegen muss zusätzlich stets die Datei README aus dem jeweiligen Plugin-Quelltext gelesen werden.
  
−
==Struktur==
+
Der Konfigurationsordner des VDR ist im Beispiel '/etc/vdr', d.h. die Datei streamdevhosts muss nach /etc/vdr/plugins kopiert werden:
−
Ist als Beispiel anzusehen, falls ab und zu mal Begriffe auftauchen wie "unterhalb der channels.conf" oder "plugins verzeichnis"...
+
 
<pre>
 
<pre>
−
----+ /etc/vdr
+
cd /usr/src/VDR/PLUGINS/src/streamdev-0.3.4
−
    |----+ ca.conf
+
cp streamdevhosts.example /etc/vdr/plugins/streamdevhosts
−
    |----+ channels.conf
+
−
    |----+ diseqc.conf
+
−
    |----+ keymacros.conf
+
−
    |----+ remote.conf
+
−
    |----+ sources.conf
+
−
    |----+ svdrphosts.conf
+
−
    |----+ /etc/vdr/plugins
+
−
    |    |----+ accounts.conf
+
−
    |    |----+ browser.conf
+
−
    |    |----+ imagecmds.conf
+
−
    |    |----+ imagesources.conf
+
−
    |    |----+ mp3sources.conf
+
−
    |    |----+ mplayerclusterkeys.conf
+
−
    |    |----+ mplayersources.conf
+
−
    |    |----+ prefermenu.conf
+
−
    -    -
+
 
</pre>
 
</pre>
 +
Nach Anpassen der streamdevhosts ist das Plugin einsatzbereit und kann in der runvdr mit "-P streamdev" gestartet werden.
 +
 +
==Links==
 +
# [[Plugins#Liste|Auflistung der Plugins]]
 +
# [[Entwicklung - Hinweise für Plugin Entwickler|Hinweise für Plugin Entwickler]]
 +
 +
 +
[[Kategorie:Plugins]]
 +
[[Kategorie:Installationsanleitungen]]
 +
[[ru:Инсталляция модуля расширения]]

Aktuelle Version vom 30. Dezember 2012, 13:42 Uhr

Inhaltsverzeichnis

[Bearbeiten] Vorbereitung

Die Installation der verschiedenen Plugins ist in den Grundzügen immer gleich. Auf Besonderheiten wird auf den jeweiligen Plugin-Seiten eingegangen. Letzte Instanz ist aber immer das README-file des Plugins.

Hinweis
Hinweis

Die Variable $SOURCEDIR enthält den Pfad zum Verzeichnis, in dem sich die VDR-Quellen befinden. Übliche Verzeichnisse sind /usr/local/src, /usr/src und das home-Verzeichnis des jeweiligen Nutzers.

Die Variable $PLUGIN_NAME steht für den Namen des zu installierenden Plugins.


Nachdem man sich das Plugin-Quellarchiv aus dem Internet heruntergeladen hat wechselt man in das PLUGINS/src Verzeichnis von VDR und entpackt das Archiv. 

cd $SOURCEDIR/VDR/PLUGINS/src

Entpacken eines BZIP2-Quellarchivs (*.tar.bz2): 

tar jxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.tar.bz2

Entpacken eines GZIP-Quellarchivs (*.tgz, *.tar.gz). 

tar zxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.{tgz,tar.gz}

Nun noch einen symbolischen Link auf das gerade entpackte Verzeichnis anlegen. Die Versionsnummer wird dabei nicht angegeben 

ln -s $PLUGIN_NAME-<VERSION> $PLUGIN_NAME
Hinweis
Hinweis

Die Beschreibung hier geht davon aus, dass sich die Plugin Autoren an das vorgegebene Namensschema halten. Leider ist dies nicht immer der Fall.

Damit VDR das Plugin kompiliert, darf der Link in VDR/PLUGINS/src nur den Namen enthalten, aber keine Bindestriche, Zahlen. Man kann sich einfach an den mit VDR mitgelieferten Plugins orientieren.


[Bearbeiten] Kompilieren

Die Plugins liegen nach dem Auspacken als Quelltext auf der Festplatte. Für die Verwendung im VDR müssen die Quelltexte jedoch mit einem Compiler in einen maschinell lesbaren Binärcode übersetzt werden. Für den Aufruf des Compilers muss man in das zwei Ebenen höher liegende VDR-Verzeichnis wechseln und den Kompiliervorgang mit dem Befehl "make plugins" starten. Dieser Vorgang übersetzt den Quelltext aller Plugins. 

cd $SOURCEDIR/VDR
make plugins

[Bearbeiten] Installation

Nachdem der Compiler-Lauf fehlerfrei durchgelaufen ist, können die entstandenen Bibliotheken ins Zielverzeichnis kopiert werden. 

mkdir -p /usr/lib/vdr/plugins
cp PLUGINS/lib/* /usr/lib/vdr/plugins/

Dieses Verzeichnis kann je nach System variieren. Beim Start des VDR wird das Verzeichnis mit 

vdr -L /usr/lib/vdr

oder 

vdr --lib='/usr/lib/vdr'

als Parameter übergeben.

[Bearbeiten] Alte Plugins unter VDR 1.4

Die API-Version wird von der VDR-Version getrennt. Deshalb müssen nicht jedes mal alle Plugins neu kompiliert werden, wenn sich nur die VDR-Version ändert, die API-Definition jedoch gleich bleibt.

Ville Skyttä hat dazu folgenden Lösungsvorschlag in der ML gepostet:

"Plugins that have not been changed to use APIVERSION yet upstream can be usually locally updated with something as simple as:" 

sed -i -e s/VDRVERSION/APIVERSION/g Makefile

Dieser Befehl muss für jedes verwendete Plugin im zugehörigen Verzeichnis des Quelltextes ausgeführt werden. Oder man führt folgenden Befehl aus: 

find $SOURCEDIR/VDR/PLUGINS -name Makefile -exec sed -i -e 's:VDRVERSION:APIVERSION:g' {} \;

[Bearbeiten] Ein praktisches Beispiel zum besseren Verständnis

Das streamdev Plugin soll manuell installiert werden. Der Quellcode des VDR liegt entpackt unter /usr/src ("$SOURCEDIR"). Die Ordnerstruktur in /usr/src sieht dann so aus: 

/usr/src/vdr-1.6.0-1
/usr/src/VDR -> /usr/src/vdr-1.6.0-1

Der Quellcode von streamdev wird im VDR Quellcode nach PLUGINS/src entpackt: 

cp vdr-streamdev-0.3.4.tgz /usr/src/VDR/PLUGINS/src
cd /usr/src/VDR/PLUGINS/src
tar xfz vdr-streamdev-0.3.4.tgz

Anschließend muss noch das neu entstandene Verzeichnis streamdev-0.3.4 nach streamdev verlinkt werden: 

ln -s streamdev-0.3.4 streamdev

Die Ordnerstruktur sollte nun so aussehen: 

/usr/src/VDR/PLUGINS/src/streamdev-0.3.4
/usr/src/VDR/PLUGINS/src/streamdev -> /usr/src/VDR/PLUGINS/src/streamdev-0.3.4

Anschließend kann compiliert werden: 

cd /usr/src/VDR
make plugins

Hinweise:

  • wenigstens einmal nach Entpacken des VDR Quelltextes sollte vorher ein "make" aufgerufen worden sein, damit die VDR include Verzeichnisse angelegt wurden.
  • Bei einigen Plugins müssen vor der ersten Benutzung noch in das Konfigurationsverzeichnis von VDR Dateien kopiert werden oder Dateien modifiziert werden. In diesem Beispiel ist es die streamdevhosts.conf die in den Ordner 'plugins' im Konfigurationsordner des VDR kopiert werden soll und entsprechend der README angepasst werden muss. Deswegen muss zusätzlich stets die Datei README aus dem jeweiligen Plugin-Quelltext gelesen werden.

Der Konfigurationsordner des VDR ist im Beispiel '/etc/vdr', d.h. die Datei streamdevhosts muss nach /etc/vdr/plugins kopiert werden: 

cd /usr/src/VDR/PLUGINS/src/streamdev-0.3.4
cp streamdevhosts.example /etc/vdr/plugins/streamdevhosts

Nach Anpassen der streamdevhosts ist das Plugin einsatzbereit und kann in der runvdr mit "-P streamdev" gestartet werden.

[Bearbeiten] Links

  1. Auflistung der Plugins
  2. Hinweise für Plugin Entwickler
Von „http://vdr-wiki.de/wiki/index.php?title=Plugin_Installation&oldid=71853“
In anderen Sprachen