Sleeptimer-plugin
(→Patches) |
Wirbel (Diskussion | Beiträge) |
||
(15 dazwischenliegende Versionen von 8 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
==Beschreibung== | ==Beschreibung== | ||
− | ''' | + | '''Autoren:''' Thomas Koch (bis 0.7), Michael Schneider (ab 0.8) |
− | Plugin um den | + | Ein Plugin, um den VDR nach einer einstellbaren Zeit herunterzufahren, stummzuschalten oder einen Befehl auszuführen zu lassen. |
− | == | + | ===Status=== |
− | + | Letztes Update 08/2011 | |
− | + | ==Hauptmenü== | |
− | + | [[Bild:Sleeptimer_main_menu.png|thumb|none|''Hauptmenü'']] | |
− | + | ||
− | + | ||
− | == | + | ==Bedienung== |
− | + | Das Plugin lässt sich über das Hauptmenü bedienen oder ohne Hauptmenü-Beteiligung über einen user key in [[keymacros.conf]]. | |
− | + | {| | |
− | + | | [[Bild:Sleeptimer_main_menu_action.png|thumb|none|''Sleeptimer in 45 min über das Hauptmenü'']] | |
+ | | [[Bild:Sleeptimer_deaktivieren.png|thumb|none|''Sleeptimer deaktivieren über das Hauptmenü'']] | ||
+ | |} | ||
− | + | Über das Hauptmenü lassen sich die Zeit bis zum Herunterfahren in Minuten oder als Uhrzeit angeben, sowie der sleeptimer aktivieren oder deaktivieren. Der Startwert für Shutdown [min] entspricht dabei dem im Setup unter Standardzeitspanne eingestellten Wert. Der sleeptimer lässt sich durch Bestätigen von Shutdown [min] oder Shutdown (Uhrzeit) mit 'Ok' aktivieren. Ist der Sleeptimer aktiv werden die Hauptmenüeinträge umgeordnet und die erste Auswahlmöglichkeit ist nun das Deaktivieren. In Kombination mit der Standardzeitspanne lässt sich das Plugin so hauptsächlich mit der 'Ok'-Taste bedienen. Falls möglich sollte jedoch die Benutzung über einen User key eingerichtet werden, da dies die Bedienung des plugins mit noch weniger Tastendrücken und ohne Hauptmenübeteiligung ermöglicht. Im Wesentlichen entspricht dabei die Bedienung der Taste 'Rot' im Hauptmenü, so dass man die Funktion auch ohne user key, jedoch mit Hauptmenü-Beteiligung ausprobieren kann. Dabei werden mit einer Taste vordefinierte Werte als sleeptimer durchgeschaltet (siehe nächster Abschnitt). 'Grün' deaktiviert den sleeptimer. | |
− | + | {| | |
+ | | [[Bild:Sleeptimer_inaktiv.png|thumb|none|''Beispiel für das automatische Durchschalten per user key / [[keymacros.conf]]. 1. Druck auf den user key bei inaktivem Sleeptimer.'']] | ||
+ | | [[Bild:Sleeptimer_45min.png|thumb|none|''Zweiter Druck auf den user key. Der voreingestellte Wert von Standardzeitspanne wird berücksichtigt und das Durchschalten startet mit 45 min.'']] | ||
+ | | [[Bild:Sleeptimer_in_1_min.png|thumb|none|''Nach Ablauf des Sleeptimers wird für 1 Minute alle 10 Sekunden diese Info-Meldung eingeblendet. Danach führt der VDR die unter 'Aktion' eingestellte Aktion aus (Standard ist Herunterfahren).'']] | ||
+ | |} | ||
− | == | + | Die Möglichkeit über [[keymacros.conf]] plugins aufzurufen macht die Bedienung des sleeptimers besonders einfach. Dabei wird einer Taste auf der Fernbedienung ein Macro zugewiesen, dass durch Info-Einblendungen mit den vordefinierten Werten Aus, 15, 30, 45, 60, 90, 120, 180 schaltet. Als erste Einblendung wird immer eine Information über den aktuellen Zustand des sleeptimers angezeigt, erst danach beginnt das Durchschalten der Werte. Es besteht die Möglichkeit, den Wert für Standardzeitspanne zu berücksichtigen, wobei dieser in die Abfolge eingeordnet wird und das Durchschalten fortan bei diesem Wert beginnt. Ist der Sleeptimer aktiv, beginnt das Durchschalten natürlich beim aktuellen Wert. Ferner kann eine Sicherheitsabfrage aktiviert werden, bei der der jeweilige Wert erst nach Bestätigung mit 'Ok' eingestellt wird. Während der Info-Einblendungen kann der Sleeptimer außerdem mit 'Grün' deaktiviert werden. |
− | + | ||
− | |- | + | ==Softwareanforderungen== |
+ | Das Plugin wird auf einer aktuellen Entwicklerversion von vdr entwickelt und auch mit der aktuellen stable Version getestet. Für ältere VDR-Versionen sind Anpassungen im Bereich der Internationalisierung vorhanden. Jedoch ist die Unterstützung für ältere Versionen ungetestet und wird nicht supportet. | ||
+ | |||
+ | ==Einstellungen== | ||
+ | |||
+ | ===Plugin Setup=== | ||
+ | [[Bild:Sleeptimer_setup.png|thumb|none|''Plugin Setup'']] | ||
+ | ''Standard-Zeitspanne'': Definiert den Wert, der im Hauptmenü unter 'Shutdown [min]' angeboten wird. Ferner beginnt auf Wunsch das automatische Durchschalten bei diesem Wert (siehe unten). | ||
+ | |||
+ | ''Aktion'': 'Herunterfahren' sendet bei Ablauf des Sleeptimers ein internes Signal an vdr und dessen Shutdown-Prozedur gestartet. Damit ist sichergestellt, dass beispielsweise Aufnahmen nicht abgebrochen werden und Aufwachtimer korrekt gesetzt werden etc. Dies entspricht einem Druck auf die 'Power'-Taste der Fernbedienung. 'Stummschalten' schaltet nach Ablauf des Sleeptimers Audio auf stumm, insofern Audio nicht bereits stummgeschaltet ist. 'Befehl ausführen' ermöglicht den Aufruf eines Kommandos oder Scripts nach Ablauf des Sleeptimers. Dies entspricht der Standard-Einstellung für 'Herunterfahren' in Versionen <0.8.1 des sleeptimer plugins. | ||
+ | |||
+ | ''Befehl'': Definiert das auszuführende Kommando bei Einstellung 'Befehl ausführen' unter 'Aktion'. ACHTUNG: Voreingestellt ist /sbin/poweroff, wodurch eine recht harsche Methode zum Herunterfahren genutzt wird, bei der ausstehende VDR-Operationen abgebrochen und Aufwachtimer ggfs. nicht gesetzt werden. Eine bessere Methode bietet 'Aktion' -> 'Herunterfahren'. Für eigene Scripte ermöglicht 'Befehl' andererseits die Ausführung nach einer definierten Zeitspanne. | ||
+ | |||
+ | ''Standard in Automatik'': Hier wird eingestellt, ob das automatische Durchschalten den Wert unter Standard-Zeitspanne berücksichtigen soll oder nicht. Bei 'Ja' wird der Wert eingeordnet und die Automatik beginnt fortan bei diesem Wert. | ||
+ | |||
+ | ''Bestätigen'': Gegen die versehentliche Aktivierung des Sleeptimers über einen user key besteht hier die Möglichkeit den Sleeptimer erst nach Bestätigung der Info-Einblendung mittels 'Ok' zu aktivieren. | ||
+ | |||
+ | ===Hauptmenü=== | ||
+ | [[Bild:Sleeptimer_main_menu.png|thumb|none|''Hauptmenü'']] | ||
+ | ''Shutdown [min]'': Zeit in Minuten bis zur im Setup eingestellten Aktion (Default: Herunterfahren). Der Wert entspricht dabei dem unter 'Standard-Zeitspanne' im Setup eingestellten Wert. | ||
+ | |||
+ | ''Shutdown (Uhrzeit)'': Uhrzeit zu der die im Setup eingestellte Aktion ausgeführt werden soll (Default: Herunterfahren). | ||
+ | |||
+ | ''Nicht aktiv'': Bei inaktivem Sleeptimer. Bei aktivem Sleeptimer wird diese Option zu 'Sleeptimer in x Minuten abbrechen' und an erster Stelle im Hauptmenü angezeigt. | ||
+ | |||
+ | ===User keys / keymacros.conf=== | ||
+ | Um den Sleeptimer ohne Hauptmenü-Beteiligung zu nutzen, kann ein User Key in [[keymacros.conf]] eingefügt werden. VDR bietet dazu die Tasten User1 bis User9, wobei ein User key auch in der [[remote.conf]] gemappt sein muss. | ||
+ | |||
+ | keymacros.conf Beispielzeile: | ||
+ | User1 @sleeptimer red | ||
+ | |||
+ | Hier wird die Funktion der roten Taste im Hauptmenü des sleeptimer plugins auf die Taste User1 gelegt und damit das Durchschalten der sleeptimer Werte ohne Hauptmenü ermöglicht. | ||
+ | |||
+ | remote.conf Beispielzeile | ||
+ | LIRC.User1 KEY_SLEEP | ||
+ | |||
+ | Im optimalen Fall hat die Fernbedienung eine Taste KEY_SLEEP, so dass User1 auf diese Taste gemappt werden kann. Hat die Fernbedienung keine solche Taste kann natürlich auch ein anderer Wert als KEY_SLEEP eingetragen werden. Bei korrekter Konfiguration kann in diesem Beispiel mit minimaler Anzahl an Tastendrücken der Sleeptimer aktiviert werden, ohne dass man das Hauptmenü des vdr aufrufen muss. | ||
+ | |||
+ | ===Parameter=== | ||
+ | Mit dem plugin-Parameter -e lässt sich der Wert für 'Befehl' beim VDR-Aufruf übergeben. | ||
+ | {| class="wikitable" | ||
+ | |- | ||
!Parameter | !Parameter | ||
!Beschreibung | !Beschreibung | ||
|- | |- | ||
− | | -e CMD || shutdown command ( | + | | -e ''<CMD>'' || shutdown command (Standard: ''/sbin/poweroff'') |
|} | |} | ||
+ | Beispiel für den Aufruf eines Scripts. Ab Version 0.8.1 des plugins ist [[sleeptimer.sh]] überflüssig, da die 'Aktion' 'Herunterfahren' im plugin setup einen besseren Weg bietet den vdr herunterzufahren. Für die Entwicklung eigener Scripte bietet es jedoch einen Ausgangspunkt. | ||
− | + | vdr -P'sleeptimer -e [[Struktur|$PATH]]/[[sleeptimer.sh]]' | |
− | + | ||
− | + | ||
− | == | + | ==Aktuelle Version== |
− | + | [http://projects.vdr-developer.org/attachments/download/652/vdr-plugin-sleeptimer-0.8.2.tgz 0.8.2] | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
==Links== | ==Links== | ||
− | + | # [http://projects.vdr-developer.org/projects/plg-sleeptimer Homepage des Plugins] | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
+ | [[Kategorie:Plugins]] | ||
+ | [[Kategorie:Admin-Plugins]] | ||
{{i18n|sleeptimer-plugin}} | {{i18n|sleeptimer-plugin}} |
Aktuelle Version vom 30. August 2013, 17:00 Uhr
Inhaltsverzeichnis |
[Bearbeiten] Beschreibung
Autoren: Thomas Koch (bis 0.7), Michael Schneider (ab 0.8)
Ein Plugin, um den VDR nach einer einstellbaren Zeit herunterzufahren, stummzuschalten oder einen Befehl auszuführen zu lassen.
[Bearbeiten] Status
Letztes Update 08/2011
[Bearbeiten] Hauptmenü
[Bearbeiten] Bedienung
Das Plugin lässt sich über das Hauptmenü bedienen oder ohne Hauptmenü-Beteiligung über einen user key in keymacros.conf.
Über das Hauptmenü lassen sich die Zeit bis zum Herunterfahren in Minuten oder als Uhrzeit angeben, sowie der sleeptimer aktivieren oder deaktivieren. Der Startwert für Shutdown [min] entspricht dabei dem im Setup unter Standardzeitspanne eingestellten Wert. Der sleeptimer lässt sich durch Bestätigen von Shutdown [min] oder Shutdown (Uhrzeit) mit 'Ok' aktivieren. Ist der Sleeptimer aktiv werden die Hauptmenüeinträge umgeordnet und die erste Auswahlmöglichkeit ist nun das Deaktivieren. In Kombination mit der Standardzeitspanne lässt sich das Plugin so hauptsächlich mit der 'Ok'-Taste bedienen. Falls möglich sollte jedoch die Benutzung über einen User key eingerichtet werden, da dies die Bedienung des plugins mit noch weniger Tastendrücken und ohne Hauptmenübeteiligung ermöglicht. Im Wesentlichen entspricht dabei die Bedienung der Taste 'Rot' im Hauptmenü, so dass man die Funktion auch ohne user key, jedoch mit Hauptmenü-Beteiligung ausprobieren kann. Dabei werden mit einer Taste vordefinierte Werte als sleeptimer durchgeschaltet (siehe nächster Abschnitt). 'Grün' deaktiviert den sleeptimer.
Die Möglichkeit über keymacros.conf plugins aufzurufen macht die Bedienung des sleeptimers besonders einfach. Dabei wird einer Taste auf der Fernbedienung ein Macro zugewiesen, dass durch Info-Einblendungen mit den vordefinierten Werten Aus, 15, 30, 45, 60, 90, 120, 180 schaltet. Als erste Einblendung wird immer eine Information über den aktuellen Zustand des sleeptimers angezeigt, erst danach beginnt das Durchschalten der Werte. Es besteht die Möglichkeit, den Wert für Standardzeitspanne zu berücksichtigen, wobei dieser in die Abfolge eingeordnet wird und das Durchschalten fortan bei diesem Wert beginnt. Ist der Sleeptimer aktiv, beginnt das Durchschalten natürlich beim aktuellen Wert. Ferner kann eine Sicherheitsabfrage aktiviert werden, bei der der jeweilige Wert erst nach Bestätigung mit 'Ok' eingestellt wird. Während der Info-Einblendungen kann der Sleeptimer außerdem mit 'Grün' deaktiviert werden.
[Bearbeiten] Softwareanforderungen
Das Plugin wird auf einer aktuellen Entwicklerversion von vdr entwickelt und auch mit der aktuellen stable Version getestet. Für ältere VDR-Versionen sind Anpassungen im Bereich der Internationalisierung vorhanden. Jedoch ist die Unterstützung für ältere Versionen ungetestet und wird nicht supportet.
[Bearbeiten] Einstellungen
[Bearbeiten] Plugin Setup
Standard-Zeitspanne: Definiert den Wert, der im Hauptmenü unter 'Shutdown [min]' angeboten wird. Ferner beginnt auf Wunsch das automatische Durchschalten bei diesem Wert (siehe unten).
Aktion: 'Herunterfahren' sendet bei Ablauf des Sleeptimers ein internes Signal an vdr und dessen Shutdown-Prozedur gestartet. Damit ist sichergestellt, dass beispielsweise Aufnahmen nicht abgebrochen werden und Aufwachtimer korrekt gesetzt werden etc. Dies entspricht einem Druck auf die 'Power'-Taste der Fernbedienung. 'Stummschalten' schaltet nach Ablauf des Sleeptimers Audio auf stumm, insofern Audio nicht bereits stummgeschaltet ist. 'Befehl ausführen' ermöglicht den Aufruf eines Kommandos oder Scripts nach Ablauf des Sleeptimers. Dies entspricht der Standard-Einstellung für 'Herunterfahren' in Versionen <0.8.1 des sleeptimer plugins.
Befehl: Definiert das auszuführende Kommando bei Einstellung 'Befehl ausführen' unter 'Aktion'. ACHTUNG: Voreingestellt ist /sbin/poweroff, wodurch eine recht harsche Methode zum Herunterfahren genutzt wird, bei der ausstehende VDR-Operationen abgebrochen und Aufwachtimer ggfs. nicht gesetzt werden. Eine bessere Methode bietet 'Aktion' -> 'Herunterfahren'. Für eigene Scripte ermöglicht 'Befehl' andererseits die Ausführung nach einer definierten Zeitspanne.
Standard in Automatik: Hier wird eingestellt, ob das automatische Durchschalten den Wert unter Standard-Zeitspanne berücksichtigen soll oder nicht. Bei 'Ja' wird der Wert eingeordnet und die Automatik beginnt fortan bei diesem Wert.
Bestätigen: Gegen die versehentliche Aktivierung des Sleeptimers über einen user key besteht hier die Möglichkeit den Sleeptimer erst nach Bestätigung der Info-Einblendung mittels 'Ok' zu aktivieren.
[Bearbeiten] Hauptmenü
Shutdown [min]: Zeit in Minuten bis zur im Setup eingestellten Aktion (Default: Herunterfahren). Der Wert entspricht dabei dem unter 'Standard-Zeitspanne' im Setup eingestellten Wert.
Shutdown (Uhrzeit): Uhrzeit zu der die im Setup eingestellte Aktion ausgeführt werden soll (Default: Herunterfahren).
Nicht aktiv: Bei inaktivem Sleeptimer. Bei aktivem Sleeptimer wird diese Option zu 'Sleeptimer in x Minuten abbrechen' und an erster Stelle im Hauptmenü angezeigt.
[Bearbeiten] User keys / keymacros.conf
Um den Sleeptimer ohne Hauptmenü-Beteiligung zu nutzen, kann ein User Key in keymacros.conf eingefügt werden. VDR bietet dazu die Tasten User1 bis User9, wobei ein User key auch in der remote.conf gemappt sein muss.
keymacros.conf Beispielzeile:
User1 @sleeptimer red
Hier wird die Funktion der roten Taste im Hauptmenü des sleeptimer plugins auf die Taste User1 gelegt und damit das Durchschalten der sleeptimer Werte ohne Hauptmenü ermöglicht.
remote.conf Beispielzeile
LIRC.User1 KEY_SLEEP
Im optimalen Fall hat die Fernbedienung eine Taste KEY_SLEEP, so dass User1 auf diese Taste gemappt werden kann. Hat die Fernbedienung keine solche Taste kann natürlich auch ein anderer Wert als KEY_SLEEP eingetragen werden. Bei korrekter Konfiguration kann in diesem Beispiel mit minimaler Anzahl an Tastendrücken der Sleeptimer aktiviert werden, ohne dass man das Hauptmenü des vdr aufrufen muss.
[Bearbeiten] Parameter
Mit dem plugin-Parameter -e lässt sich der Wert für 'Befehl' beim VDR-Aufruf übergeben.
Parameter | Beschreibung |
---|---|
-e <CMD> | shutdown command (Standard: /sbin/poweroff) |
Beispiel für den Aufruf eines Scripts. Ab Version 0.8.1 des plugins ist sleeptimer.sh überflüssig, da die 'Aktion' 'Herunterfahren' im plugin setup einen besseren Weg bietet den vdr herunterzufahren. Für die Entwicklung eigener Scripte bietet es jedoch einen Ausgangspunkt.
vdr -P'sleeptimer -e $PATH/sleeptimer.sh'