SVDRP

Version vom 22. Mai 2006, 20:58 Uhr

Inhaltsverzeichnis

1 Einführung
2 Die Befehle
- 2.1 Übersicht
- 2.2 Beschreibung
3 SVDRP Antwort Codes
4 Anmerkungen
5 Optionen
6 Anwendungen / Erweiterungen / Beispiele

Einführung

Das SVDRP (Simple VDR Protokoll) erlaubt es per simpler TCP-Verbindung auf Port 2001 einfache Befehle an den VDR zu schicken, um z.B. eine Nachricht auf dem Fernseher anzuzeigen oder VDR fernzusteuern. (Von win aus zB. mit putty (protocol: raw))

Bevor man jedoch von einem Host aus den vdr ansprechen darf, muß man ihn dafür freischalten. Dies geschieht über die Datei svdrphosts.conf im Konfigurationsverzeichnis des VDR. Der Aufbau ist recht simpel:

IP-Adresse[/Netzmaske]

Also einfach zeilenweise die erlaubten Host-IPs eintragen, oder wenn man gleich ganze Netzblöcke freigeben will, eine IP und eine Maske dazu, natürlich in der ultra modernen Schreibweise der Anzahl der Bits (also /24, usw.).

Die Befehle

Übersicht

shell> svdrpsend.pl HELP
220 pluto SVDRP VideoDiskRecorder 1.3.47; Thu Apr 20 14:53:32 2006
214-This is VDR version 1.3.47
214-Topics:
214-    CHAN      CLRE      DELC      DELR      DELT
214-    EDIT      GRAB      HELP      HITK      LSTC
214-    LSTE      LSTR      LSTT      MESG      MODC
214-    MODT      MOVC      MOVT      NEWC      NEWT
214-    NEXT      PLAY      PLUG      PUTE      QUIT     
214-    SCAN      STAT      UPDT      VOLU
214-To report bugs in the implementation send email to
214-    vdr-bugs@cadsoft.de
214 End of HELP info
221 pluto closing connection

Beschreibung

CHAN	[ + \| - \| <Nummer> \| <Name> \| <ID> ]
	Schaltet einen Kanal hoch, runter, oder springt zur angegebenen Kanalnummer, zum Kanalnamen, oder zur Kanal-ID. Ohne Parameter, bzw. nach einem Kanalwechsel wird die Nummer und der Name des aktuellen Kanals angezeigt.
CLRE
	Löscht die EPG-Daten.
DELC	<Nummer>
	Löscht den Kanal.
DELR	<Nummer>
	Löscht die Aufnahme mit der angegebenen Nummer. Um die Aufnahmenummer zu erhalten muss vorher der LSTR Befehl ausgeführt werden. Die Nummern ändern sich durch Löschen anderer Aufnahmen nicht. ACHTUNG: AUFNAHMEN WERDEN OHNE VORHERIGE NACHFRAGE GELÖSCHT!!
DELT	<Nummer>
	Löscht einen Timer.
EDIT	<Nummer>
	Bearbeitet die Aufnahme mit der nummer <Nummer>. Bevor eine Aufnahme bearbeitet wird, sollte die entsprechende Nummer der Aufnahme unter Zuhilfenahme des LSTR Befehls ermittelt werden.
GRAB	<filename> [ <Qualität> [ <Breite> <Höhe> ] ]
	Speichert das aktuelle Fernsehbild auf die lokalen Festplatte ab. Bilder können als JPEG oder PNM, abhängig von der vorgegebenen Dateiendung gespeichert werden. Die Qualität des erfassten Bildes kann in der Bereich von 0 bis 100 festgelegt werden, wobei 100 (der Standard) beste Qualität bedeutet (diese Option ist nur für JPEG verfügbar). Die Größe Parameter definieren die Größe des resultierenden Bildes (Standard ist der gesamte Bildschirm). Wenn der Dateiname nur die Endung ist (.jpg, .jpeg oder .pnm) werden die Bilddaten über die SVDRP Verbindung geschickt, diese Daten sind base64 kodiert. Das selbe geschieht wenn - (ein Minuszeichen) als Dateiname angegeben wird, in diesem Fall ist das Bildformat auf JPEG. Bespiel für die Anzeige des base64-kodierten Fernsehbildes über Netzwerk und die direkte Darstellung mittels des Programmes display von http://www.imagemagick.org svdrpsend.pl -d <hostname> 'grab -' \| sed -n -e 's/^216-//p' -e '1ibegin-base64 644 -' -e '$a====' \| uudecode \| display - Für das Abspeichern des erfassten Fernsehbildes auf der lokalen Festplatte muss die Option -g mit den Zielverzeichnis gesetzt werden.
HELP	[ <Begriff> ]
	Hilfe.
HITK	[ <Taste> ]
	"Drückt" die Taste der Fernbedienung. Ohne Parameter werden die Namen aller gültigen Tasten aufgelistet.
LSTC	[ <Nummer> \| <Name> ]
	Ohne Parameter werden alle Kanäle aufgelistet. Wird einen Nummer angegeben, wird nur dieser Kanal aufgelistet, bei Angabe eines Namens alle Kanäle, bei denen dieser im Namen auftaucht. Zur Beschreibung des Formates siehe channels.conf
LSTE	[ <Kanal> ] [ now \| next \| at <Zeit> ]
	Ohne Parameter werden alle EPG-Daten ausgegeben. Wird ein Kanal angegeben (entweder mit Nummer, oder mit Kanal-ID), werden nur die EPG-Daten dieses Senders angezeigt. 'now, 'next' 'at <time>' sind Filter.
LSTR	[ <Nummer> ]
	Ohne Parameter werden alle Aufnahmen aufgelistet. Sonst wird die Zusammenfassung der angegebenen Aufnahme angezeigt.
LSTT	[ <Nummer> ]
	Ohne Parameter werden alle Timer (programmierte Aufnahmen) aufgelistet, Sonst nur der angegeben Timer.
MESG	[ <Nachricht> ]
	Zeigt eine Nachricht über das OSD auf dem Fernseher an. Ohne Parameter wird die aktuell anhängige Nachricht (wenn vorhanden) angezeigt. Sobald das OSD verfügbar ist, wird die Nachricht für ein paar Sekunden angezeigt, wenn die vorige Nachricht noch nicht angezeigt werden konnte, wird sie überschrieben.
MODC	<Nummer> <Einstellungen>
	Ändert die Kanaleinstellungen. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTC Befehls.
MODT	<Nummer> on \| off \| <Einstellungen>
	Ändert einen Timer. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTT Befehls. Mit 'on und 'off' kann ein Timer einfach ein- und ausgeschaltet werden.
MOVC	<Nummer> <nach>
	Verschiebt einen Kanal nach <nach> in der Kanalliste.
MOVT	<Nummer> <nach>
	Verschiebt einen Timer nach <nach> in der Timerliste.
NEWC	<Einstellungen>
	Erstellt einen neuen Kanal. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTC Befehls.
NEWT	<Einstellungen>
	Erstellt einen neuen Timer. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTT Befehls. Beispiel für <Einstellungen>: 1:19:5:2010:2150:51:50:Das Gelbe vom Ei: active:channel:day_of_month:starttime:endtime:priority:durability:title: day_of_month kann dabei folgende Formate haben: 19 2005-03-19 MTWTFSS MTWTFSS@19 MTWTFSS@2005-03-19
NEXT	[ abs \| rel ]
	Zeigt den nächsten Timer an. Ohne Parameter geschieht die Ausgabe in menschenlesbarer Form. Mit dem Parameter 'abs' wird die absolute Zeit in Sekunden angegeben, während beim Parameter 'rel' die Zeit von jetzt bis zur Aufnahme in Sekunden angeben wird. Wenn die mit 'abs' zurückgegeben Zeit in der Vergangenheit liegt, bzw. die mit 'rel' zurückgegebene Zeit negativ ist, findet die Aufname des Timers gerade statt. Der Erste Wert der ausgegeben wird stellt die Nummer des Timers dar.
PLAY	<number> [ begin \| <position> ]
	Spielt die Aufnahme mit der nummer <Nummer> ab. Die entsprechende Nummer der Aufnahme sollte unter Zuhilfenahme des LSTR Befehls ermittelt werden. Durch Angabe von 'begin' kann die Aufnahme vom Anfang an wiedergegeben werden. Andere Startpositionen koennen als Frame index oder im Format hh:mm:ss[.ff] angegeben werden. Wird kein Startpunkt fuer die Wiedergabe angegeben, wird die letzte Wiedergabe fortgesetzt.
PLUG	<name> [ <command> [ <options> ]]
	Sendet ein Kommando an ein Plugin. Der PLUG Befehl ohne Parameter listet alle Plugins auf. Wenn nur ein Plunginname angegeben wird, werden für diese Plugins alle möglichen Befehle angezeigt. Wenn ein Kommando hinzugefügt wird ( optional gefolgt von Parametern), wird der Befehl an das Plugin gesendet und das Ergebnis wird ausgegeben. Das Schlüsselwort 'help' listet alle möglichen SVDRP Befehle für das Plugin auf. Wenn 'help' gefolgt von einem Befehl angegeben wird, wird eine detailierte hilfe für dieses Kommando ausgegeben. Das Schlüsselwort 'main' ruft die Hauptmenü Funktion des angegebenen Plugins auf.
PUTE
	Fügt EPG-Daten ein. Das Format der Daten ist in der Manualpage vdr(5) beschrieben und muss genau eingehalten werden. Ein einzelner Punkt in einer Zeile beendet die Eingabe und sorgt für die Weiterverarbeitung der eingegeben Daten, die bislang nur zwischengespeichert wurden.
SCAN
	Erzwingt einen EPG-Scan. Auf Systemen mit nur einer DVB-Karte wird der Scan auf dieser durchgeführt, wenn gerade keine Aufnahme läuft.
STAT	disk
	Liefert Informationen über den Festplattenspeicher-Verbrauch (Total, Frei, Prozent).
UPDT	<Einstellungen>
	Aktualisiert einen Timer. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTT Befehls. Wenn der Timer noch nicht existiert, wird er erstellt.
VOLU	[ <Nummer> \| + \| - \| mute ]
	Setzt die Lautstärke entweder direkt (Bereich: 0 - 255), oder Schrittweise. Mit mute wird der Ton stumm geschaltet. Ohne Parameter wird die aktuelle Lautstärke angezeigt.
QUIT
	Beendet die Verbindung zu VDR (SVDRP). Alternativ kann man auch CTRL-D drücken.

SVDRP Antwort Codes

214 Hilfetext
215 EPG Eintrag
216 Image grab data (base 64)
220 VDR-Service bereit
221 VDR-Service schließt Sende-Kanal
250 Angeforderte Aktion okay, beendet
354 Start senden von EPG-Daten
451 Angeforderte Aktion abgebrochen: lokaler Fehler bei der Bearbeitung
500 Syntax-Fehler, unbekannter Befehl
501 Syntax-Fehler in Parameter oder Argument
502 Befehl nicht implementiert
504 Befehls-Parameter nicht implementiert
550 Angeforderte Aktion nicht ausgeführt
554 Transaktion fehlgeschlagen

Die Antworten sind vom Format:

<Antwort Code><-|Leerzeichen><Text><newline>

Bei der letzten Zeile wird anstelle des - nach dem Antwort Code ein Leerzeichen gesetzt.

Beispiel:

shell> svdrpsend.pl help

Anmerkungen

Angemerkt sei, dass der VDR nur einen Thread für die SVDRP-Kommunikation führt. Dies erlaubt leider nur eine Verbindung zur selben Zeit.
Auch vdradmin / vdradmin AM verwendet SVDRP, somit sind die Skripts nicht verfügbar wenn jemand anderes SVDRP belegt.

Optionen

Parameter	Beschreibung
-d hostname	Ziel Hostname (standard: localhost)
-p port	SVDRP Portnummer (standard: 2001)

SVDRP

Version vom 22. Mai 2006, 20:58 Uhr

Inhaltsverzeichnis

Einführung

Die Befehle

Übersicht

Beschreibung

SVDRP Antwort Codes

Anmerkungen

Optionen

Anwendungen / Erweiterungen / Beispiele

Ansichten

Meine Werkzeuge

Navigation

mitmachen

links

Suche

Werkzeuge

In anderen Sprachen

@@ Zeile 28: / Zeile 28: @@
 ===Beschreibung===
-<div style="display:inline; color:black; background:blue">[]</div> vdr >= '''1.3.20'''<br>
-<div style="display:inline; color:black; background:red">[]</div> vdr >= '''1.3.31'''<br>
-<div style="display:inline; color:black; background:green">[]</div> '''>= 1.3.38'''<br>
 {| width=75% border=1 cellpadding=4 cellspacing=0
 |-id="CHAN"
-|
 |bgcolor=#efefef| CHAN
 |bgcolor=#efefef| [ + | - | <Nummer> | <Name> | <ID> ]
 |-
-|
 |
 | Schaltet einen Kanal hoch, runter, oder springt zur angegebenen Kanalnummer, zum Kanalnamen, oder zur Kanal-ID. Ohne Parameter, bzw. nach einem Kanalwechsel wird die Nummer und der Name des aktuellen Kanals angezeigt.
 |-id="CLRE"
-|
 |bgcolor=#efefef| CLRE
 |bgcolor=#efefef|
 |-
-|
 |
 | Löscht die EPG-Daten.
 |-id="DELC"
-|
 |bgcolor=#efefef| DELC
 |bgcolor=#efefef| <Nummer>
 |-
-|
 |
 | Löscht den Kanal.
 |-id="DELR"
-|
 |bgcolor=#efefef| DELR
 |bgcolor=#efefef| <Nummer>
 |-
-|
 |
 | Löscht die Aufnahme mit der angegebenen Nummer. Um die Aufnahmenummer zu erhalten muss vorher der LSTR Befehl ausgeführt werden. Die Nummern ändern sich durch Löschen anderer Aufnahmen nicht. ACHTUNG: AUFNAHMEN WERDEN OHNE VORHERIGE NACHFRAGE GELÖSCHT!!
 |-id="DELT"
-|
 |bgcolor=#efefef| DELT
 |bgcolor=#efefef| <Nummer>
 |-
-|
 |
 | Löscht einen Timer.
 |-id="EDIT"
-|bgcolor=red|
 |bgcolor=#efefef| EDIT
 |bgcolor=#efefef| <Nummer>
 |-
-|
 |
 | Bearbeitet die Aufnahme mit der nummer <Nummer>. Bevor eine Aufnahme bearbeitet wird, sollte die entsprechende Nummer der Aufnahme unter Zuhilfenahme des LSTR Befehls ermittelt werden.
 |-id="GRAB"
-|bgcolor=green|
 |bgcolor=#efefef| GRAB
 |bgcolor=#efefef| <filename> [ <Qualität> [ <Breite> <Höhe> ] ]
 |-
-|
 |
 | Speichert das aktuelle Fernsehbild auf die lokalen Festplatte ab. Bilder können als JPEG oder PNM, abhängig von der vorgegebenen Dateiendung gespeichert werden.  Die Qualität des erfassten Bildes kann in der Bereich von 0 bis 100 festgelegt werden, wobei 100 (der Standard) beste Qualität bedeutet (diese Option ist nur für JPEG verfügbar). Die Größe Parameter definieren die Größe des resultierenden Bildes (Standard ist der gesamte Bildschirm).  Wenn der Dateiname nur die Endung ist (.jpg, .jpeg oder .pnm) werden die Bilddaten über die SVDRP Verbindung geschickt, diese Daten sind base64 kodiert. Das selbe geschieht wenn - (ein Minuszeichen) als Dateiname angegeben wird, in diesem Fall ist das Bildformat auf JPEG.
@@ Zeile 93: / Zeile 75: @@
 Für das Abspeichern des erfassten Fernsehbildes auf der lokalen Festplatte muss die [[VDR_Optionen|Option]] -g mit den Zielverzeichnis gesetzt werden.
 |-id="HELP"
-|
 |bgcolor=#efefef| HELP
 |bgcolor=#efefef| [ <Begriff> ]
 |-
-|
 |
 | Hilfe.
 |-id="HITK"
-|
 |bgcolor=#efefef| HITK
 |bgcolor=#efefef| [ <Taste> ]
 |-
-|
 |
 | "Drückt" die Taste der Fernbedienung. Ohne Parameter werden die Namen aller gültigen Tasten aufgelistet.
 |-id="LSTC"
-|
 |bgcolor=#efefef| LSTC
 |bgcolor=#efefef| [ <Nummer> | <Name> ]
 |-
-|
 |
 | Ohne Parameter werden alle Kanäle aufgelistet. Wird einen Nummer angegeben, wird nur dieser Kanal aufgelistet, bei Angabe eines Namens alle Kanäle,  bei denen dieser im Namen auftaucht.
 Zur Beschreibung des Formates siehe [[channels.conf]]
 |-id="LSTE"
-|
 |bgcolor=#efefef| LSTE
 |bgcolor=#efefef| [ <Kanal> ] [ now | next | at <Zeit> ]
 |-
-|
 |
 | Ohne Parameter werden alle EPG-Daten ausgegeben. Wird ein Kanal angegeben (entweder mit Nummer, oder mit Kanal-ID), werden nur die EPG-Daten dieses Senders angezeigt. 'now, 'next' 'at <time>' sind Filter.
 |-id="LSTR"
-|
 |bgcolor=#efefef| LSTR
 |bgcolor=#efefef| [ <Nummer> ]
 |-
-|
 |
 | Ohne Parameter werden alle Aufnahmen aufgelistet. Sonst wird die Zusammenfassung der angegebenen Aufnahme angezeigt.
 |-id="LSTT"
-|
 |bgcolor=#efefef| LSTT
 |bgcolor=#efefef| [ <Nummer> ]
 |-
-|
 |
 | Ohne Parameter werden alle Timer (programmierte Aufnahmen) aufgelistet, Sonst nur der angegeben Timer.
 |-id="MESG"
-|
 |bgcolor=#efefef| MESG
 |bgcolor=#efefef| [ <Nachricht> ]
 |-
-|
 |
 | Zeigt eine Nachricht über das OSD auf dem Fernseher an. Ohne Parameter wird die aktuell anhängige Nachricht (wenn vorhanden) angezeigt. Sobald das OSD verfügbar ist, wird die Nachricht für ein paar Sekunden angezeigt, wenn die vorige Nachricht noch nicht angezeigt werden konnte, wird sie überschrieben.
 |-id="MODC"
-|
 |bgcolor=#efefef| MODC
 |bgcolor=#efefef| <Nummer> <Einstellungen>
 |-
-|
 |
 | Ändert die Kanaleinstellungen. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTC Befehls.
 |-id="MODT"
-|
 |bgcolor=#efefef| MODT
 |bgcolor=#efefef| <Nummer> on | off | <Einstellungen>
 |-
-|
 |
 | Ändert einen Timer. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTT Befehls. Mit 'on und 'off' kann ein Timer einfach ein- und ausgeschaltet werden.
 |-id="MOVC"
-|
 |bgcolor=#efefef| MOVC
 |bgcolor=#efefef| <Nummer> <nach>
 |-
-|
 |
 | Verschiebt einen Kanal nach <nach> in der Kanalliste.
 |-id="MOVT"
-|
 |bgcolor=#efefef| MOVT
 |bgcolor=#efefef| <Nummer> <nach>
 |-
-|
 |
 | Verschiebt einen Timer nach <nach> in der Timerliste.
 |-id="NEWC"
-|
 |bgcolor=#efefef| NEWC
 |bgcolor=#efefef| <Einstellungen>
 |-
-|
 |
 | Erstellt einen neuen Kanal. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTC Befehls.
 |-id="NEWT"
-|
 |bgcolor=#efefef| NEWT
 |bgcolor=#efefef| <Einstellungen>
 |-
-|
 |
 | Erstellt einen neuen Timer. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTT Befehls.
@@ Zeile 207: / Zeile 163: @@
   MTWTFSS@2005-03-19
 |-id="NEXT"
-|
 |bgcolor=#efefef| NEXT
 |bgcolor=#efefef| [ abs | rel ]
 |-
-|
 |
 | Zeigt den nächsten Timer an. Ohne Parameter geschieht die Ausgabe in menschenlesbarer Form. Mit dem Parameter 'abs' wird die absolute Zeit in Sekunden angegeben, während beim Parameter 'rel' die Zeit von jetzt bis zur Aufnahme in Sekunden angeben wird. Wenn die mit 'abs' zurückgegeben Zeit in der Vergangenheit liegt, bzw. die mit 'rel' zurückgegebene Zeit negativ ist, findet die Aufname des Timers gerade statt. Der Erste Wert der ausgegeben wird stellt die Nummer des Timers dar.
 |-id="PLAY"
-|bgcolor=red|
 |bgcolor=#efefef| PLAY
 |bgcolor=#efefef| <number> [ begin | <position> ]
 |-
-|
 |
 | Spielt die Aufnahme mit der nummer <Nummer> ab. Die entsprechende Nummer der Aufnahme sollte unter Zuhilfenahme des LSTR Befehls ermittelt werden. Durch Angabe von 'begin' kann die Aufnahme vom Anfang an wiedergegeben werden. Andere Startpositionen koennen als Frame index oder im Format hh:mm:ss[.ff] angegeben werden. Wird kein Startpunkt fuer die Wiedergabe angegeben, wird die letzte Wiedergabe fortgesetzt.
 |-id="PLUG"
-|bgcolor=red|
 |bgcolor=#efefef| PLUG
 |bgcolor=#efefef| <name> [ <command> [ <options> ]]
 |-
-|
 |
 |Sendet ein Kommando an ein Plugin. Der PLUG Befehl ohne Parameter listet alle Plugins auf. Wenn nur ein Plunginname angegeben wird, werden für diese Plugins alle möglichen Befehle angezeigt. Wenn ein Kommando hinzugefügt wird ( optional gefolgt von Parametern), wird der Befehl an das Plugin gesendet und das Ergebnis wird ausgegeben. Das Schlüsselwort 'help' listet alle möglichen SVDRP Befehle für das Plugin auf. Wenn 'help' gefolgt von einem Befehl angegeben wird, wird eine detailierte hilfe für dieses Kommando ausgegeben. Das Schlüsselwort 'main' ruft die Hauptmenü Funktion des angegebenen Plugins auf.
 |-id="PUTE"
-|
 |bgcolor=#efefef| PUTE
 |bgcolor=#efefef|
 |-
-|
 |
 | Fügt EPG-Daten ein. Das Format der Daten ist in der Manualpage vdr(5) beschrieben und muss genau eingehalten werden. Ein einzelner Punkt in einer Zeile beendet die Eingabe und sorgt für die Weiterverarbeitung der eingegeben Daten, die bislang nur zwischengespeichert wurden.
 |-id="SCAN"
-|bgcolor=blue|
 |bgcolor=#efefef| SCAN
 |bgcolor=#efefef|
 |-
-|
 |
 | Erzwingt einen EPG-Scan. Auf Systemen mit nur einer [[DVB-Karte]] wird der Scan auf dieser durchgeführt, wenn gerade keine Aufnahme läuft.
 |-id="STAT"
-|
 |bgcolor=#efefef| STAT
 |bgcolor=#efefef| disk
 |-
-|
 |
 | Liefert Informationen über den Festplattenspeicher-Verbrauch (Total, Frei, Prozent).
 |-id="UPDT"
-|
 |bgcolor=#efefef| UPDT
 |bgcolor=#efefef| <Einstellungen>
 |-
-|
 |
 | Aktualisiert einen Timer. Das Format von <Einstellungen> muss das gleiche sein wie das des LSTT Befehls. Wenn der Timer noch nicht existiert, wird er erstellt.
 |-id="VOLU"
-|
 |bgcolor=#efefef| VOLU
 |bgcolor=#efefef| [ <Nummer> | + | - | mute ]
 |-
-|
 |
 | Setzt die Lautstärke entweder direkt (Bereich: 0 - 255), oder Schrittweise. Mit mute wird der Ton stumm geschaltet. Ohne Parameter wird die aktuelle Lautstärke angezeigt.
 |-id="QUIT"
-|
 |bgcolor=#efefef| QUIT
 |bgcolor=#efefef|
 |-
-|
 |
 | Beendet die Verbindung zu VDR (SVDRP). Alternativ kann man auch CTRL-D drücken.