summaryrefslogtreecommitdiff
path: root/README
blob: 90547b835497cd2a999de4888f93b6e08d3c5c02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
This is a "plugin" for the Video Disk Recorder (VDR).

Written by:                  Martin Schirrmacher <vdr.skinflatplus@schirrmacher.eu>

Project's homepage:          http://projects.vdr-developer.org/projects/plg-skinflatplus/

Projekt Wiki                 http://projects.vdr-developer.org/projects/plg-skinflatplus/wiki

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
See the file COPYING for more information.


Anforderungen
-------------------------------
- VDR Version >= 1.7.34
- ImageMagick zur Anzeige von png/jpg Icons, Kanal Logos and EPG Bilder


Beschreibung
-------------------------------
Skin flatPlus ist ein moderner und aktueller Skin für VDR.
Das Design ist flach und geradlinig (keine glossy oder 3D-Effekte)


git-Zugriff
-------------------------------
Auf das git kann mittels

git clone http://projects.vdr-developer.org/git/skin-flatplus.git/

zugegriffen werden.
Da im git natürlich aktiv entwickelt wird können Fehler nicht ausgeschlossen werden (ich empfehle es nicht für produktiv Systeme)


Installation
-------------------------------
Installation wie bei allen VDR Plugins.
    make
    make install

Für die Kanallogos empfehle ich die Logos von Copperhead: http://creimer.net/channellogos/
Ich nutze "nopacity-logos-white"
Die Logos müssen im folgenden Ordner zur Verfügung gestellt werden:
    <vdrconfigdir>/plugins/skinflat/logos/

Der Skin muss im Menü unter Einstellungen -> OSD ausgewählt werden.


Versteckte Einstellungen
-------------------------------
Versteckte Einstellungen sind Einstellungen die in der VDR setup.conf konfiguriert werden können, wozu es aber keine Einstellungen im OSD -> Einstellungen -> Plugins -> skinflatplus gibt.

* MenuItemRecordingClearPercent - Wenn die Einstellung auf 1 gesetzt ist, wird vom Aufnahmetext das Prozentzeichen am Anfang des Strings entfernt.
* MenuItemRecordingShowFolderDate - Wenn die Einstellung auf 1 gesetzt ist, wird bei einem Ordner von der neuesten Aufzeichnung das Datum angezeigt, Wenn die Einstellung auf 2 gesetzt ist, wird bei einem Ordner von der ältesten Aufzeichnung das Datum angezeigt.
* MenuItemParseTilde - Wenn die Einstellung auf 1 gesetzt ist, wird beim Menü-Item-Text auf den Buchstaben Tilde '~' geprüft und wenn eine Tilde gefunden wurde, wird die Tilde entfernt und alles was nach der Tilde steht in einer anderen Farbe dargestellt. Dies ist z.B. interessant wenn man epgsearch hat.
* ChannelBitrateShowCalcInterval - In welchen Intervall soll die Bitrate (Kanalanzeige) aktualisiert werden (default 20)

Widgets
_______________________________
h1. Widgets

Seit Version 0.5.0 gibt es die Widgets.
Es gibt interne und externe Widgets. Die internen Widgets funktionieren out-of-the-box, da Sie innerhalb des VDR implementiert sind.
Externe Widgets sind externe Programme/Scripte, hier sind (teilweise) manuelle Anpassungen notwendig damit diese laufen.

Die Widgets werden auf der rechten Seite des Hauptmenüs angezeigt. In der Höhe ist nur begrenzt Platz, deshalb kann es passieren das nicht alle Widgets angezeigt werden können (da einfach kein Platz mehr ist). Hier muss du selbst entscheiden welches Widget auf welcher Position angezeigt werden soll.

h2. Interne Widgets

h3. DVB Geräte

Zeigt die DVB Geräte an, wer dieses benutzt und auf welchem Kanel das Gerät gerade ist. Über die Plugineinstellungen kann konfiguriert werden ob "unbekannte" und/oder "nicht benutzte" Geräte ausgeblendet werden sollen.
Leider ist es derzeit nicht möglich 100% herauszufinden wer das Gerät derzeit nutzt. Z.B. gibt es Fälle wie den EPG-Scan welcher nicht erkannt wird.

h3. Aktive Timer

Zeit die aktiven Timer an. Über die Plugineinstellungen kann die max. Anzahl der Timer konfiguriert werden welche angezeigt wird. Weiter kann konfiguriert werden, dass das Widget ausgeblendet wird, wenn keine aktiven Timer existieren.

h3. Timer Konflikte

Zeigt die Anzahl der Timer-Konflikte an. Es ist in Plannung das auch die eigentlichen Konflikte und nicht nur die Anzahl angezeigt wird. Es kann wieder konfiguriert werden das das Widget ausgeblendet wird wenn keine Timer Konflikte vorhanden sind.

h3. Letzte Aufnahmen

Zeigt die letzten Aufnahmen nach Datum sortiert an. Über die Plugineinstellungen kann die max. Anzahl der Elemente konfiguriert werden.

h2. Externe Widgets

Externe Scripte werden (wenn nicht anders konfiguriert) in das LIBDIR installiert. Normalerweise sollte dies folgender Pfad sein.
<pre>
/usr/local/lib/vdr/skinflatplus/widgets/
</pre>

Alle Ausgaben der Scripte sind unter
<pre>
/tmp/skinflatplus/widgets/
</pre>

h3. Wetter-Widget

Zeigt das aktuelle Wetter und eine Vorschau an. Die Ansicht der Vorschau kann konfiguriert werden. Es existiert eine Lang- und eine Kurzansicht. Bei der langen Ansicht gibt es pro Tag eine Zeile bei der kurzen Ansicht wird alles in einer Zeile dargestellt. Die Anzahl der Tage kann über die Plugineinstellungen konfiguriert werden, wobei max. 7 Tage möglich sind.
Dieses Widget benötigt php5, unter Ubuntu ist z.B. das Paket php5-cli notwendig.
Im Ordner existiert eine update_weather.config.sample diese muss nach update_weather.config kopiert werden.
<pre>
cd /usr/local/lib/vdr/skinflatplus/widgets/weather
cp update_weather.config.sample update_weather.config
</pre>
Anschließend muss Latitude und Longitude vom Ort ermittelt werden, dafür gibt es das kleine php-Script GetLatLangFromCity.php. Einfach ausführen und den Ort eingeben.
<pre>
php5 GetLatLangFromCity.php
</pre>
Die Werte von Latitude und Longitude in die update_weather.config schreiben und auch den Wert "LocationSkin" entsprechend anpassen. "LocationSkin" wird später im Skin als Ort angezeigt.

Das Script (update_weather.php) wird nicht vom Skin aufgerufen. Dies muss extern über cron oder ähnliches erfolgen. Z.B. über folgende Zeile in der /etc/crontab
<pre>
# update weather every 12 hours
7 */12   * * *   root    php5 /usr/local/lib/vdr/skinflatplus/widgets/weather/update_weather.php
</pre>

Für die Wetterdaten wird forecast.io verwendet. Hier sind 1000 Abfragen am Tag frei, jede weiteren 10.000 Abfragen kosten dann $1. Pro Aufruf von update_weather.php werden 2 Abfragen getätigt. Bitte registriere dich kostenlos bei forecast.io und erstelle einen eigenen Api-Key. Diesen dann einfach in die update_weather.config eintragen. Hierfür ist nur eine E-Mail Adresse + Passwort notwendig. Wenn das Script nicht mehr funktioniert sind höchstwahrscheinlich die 1000 Abfragen/Tag überschritten.

Für die Kanalinfo gibt es eine kleine Version des Wetter Widgets. hier wird Heute + Morgen angezeigt.

h3. System-Informationen

Mit diesem Widget können verschiedenene Systeminformationen angezeigt werden.
Dieses Script wird bei jedem Aufruf des Menü erneut ausgeführt. Daher sollte das Script kurz und schnell sein.
Es wird das Script "system_information" ausgeführt. Dieses muss manuell verlinkt werden! Für Ubuntu z.B. wie folgt
<pre>
cd /usr/local/lib/vdr/skinflatplus/widgets/system_information
ln -s system_information.ubuntu system_information
</pre>

In dem Script ist auch die Konfiguration enthalten. Hier kann festgelegt werden welche Informationen ausgegeben werden sollen und in welcher Position diese sein sollen.

h3. Temperaturen

Mit diesem Widget können die Temperaturen des System angezeigt werden.
Dieses Script wird bei jedem Aufruf des Menü erneut ausgeführt. Daher sollte das Script kurz und schnell sein.
Es wird das Script "temperatures" ausgeführt. Dieses muss manuell verlinkt werden! Z.B. wie folgt
<pre>
cd /usr/local/lib/vdr/skinflatplus/widgets/temperatures
ln -s temperatures.default temperatures
</pre>

Das default Script nutzt lm-sensors um die Temeperaturen zu ermitteln. Du musst sicherstellen das du lm-sensors installiert und auch richtig konfiguriert hast. Weiterhin wird die GPU-Temperatur mittels nvidia-settings ermittelt. Dies funktioniert natürlich nur mit Nvidia Grafikkarten.

h3. System-Updatestatus

Mit diesem Widget können die Updates des System angezeigt werden. Dabei wird die Anzahl der Updates und der Sicherheitsupdates angezeigt.
Das Script (system_update_status) wird nicht vom Skin aufgerufen. Dies muss extern über cron oder ähnliches erfolgen. Z.B. über folgende Zeile in der /etc/crontab
<pre>
# update system_updates every 12 hours
7 */12   * * *   root    /usr/local/lib/vdr/skinflatplus/widgets/system_updatestatus/system_updatestatus
</pre>

h3. Benutzerdefinierte Ausgabe

Mit diesem Widget können eigene Befehle ausgeführt und angezeigt werden.
Wenn es in dem Ordner das Script "command" gibt, wird dieses bei jedem Aufruf des Menüs ausgeführt.
Das Script command muss 2 Dateien bereitstellen: title & output
Jeweils für den Titel und der eigentlichen Ausgabe.
Es sollte darauf geachtet werden das nicht zu viele Zeilen ausgeben werden da immer die gesamte Datei angezeigt wird. Die Zeilen werden rechts einfach abgeschnitten und nicht umgebrochen!


TVScraper & scraper2vdr
-------------------------------
Since version 0.3.0 the skin support TVScraper & scraper2vdr.
With both plugins you'll get poster, banner and actor images for recordings and epg info.
If You use scraper2vdr, which I recommend, you'll also get movie and series information.


epgd & doppelte Informationen in EPG-Text
-------------------------------
Wenn epgd + epg2vdr verwendet wird, wird der angezeigte EPG-Text über die eventsview.sql festgelegt (in der epgd.conf Option: EpgView).
Mit der default eventsview.sql ist im EPG-Text die Schauspieler, Serien- und Filminformationen mit enthalten. Da diese dann doppelt angezeigt werden würden (im EPG-Text und in den extra Bereichen über scraper2vdr) existiert im contrib-Ordner von flatPlus eine eigene "eventsview-flatplus.sql". Mit dieser wird im EPG-Text wirklich nur der EPG-Text ausgeben und keine weiteren Informationen.
Ich empfehle diese zu verwenden. Dafür einfach die Datei aus den contrib Ordner nach /etc/epgd/ kopieren und in der epgd.conf folgenden Eintrag verwenden:

EpgView = eventsview-flatplus.sql


Themes und Theme spezifische Icons
-------------------------------
Der Skin ist weitestgehend über Themes anpassbar.
Die Decorations (Border, ProgressBar) sind über das Theme einstellbar. Dabei kann jeweils der Typ und
die Größe (in Pixeln) eingestellt werden. Dabei wird von dem ARGB im Theme nur B verwendet. Es muss darauf geachtet werden
das die Werte in Hex angegeben werden. Wenn man also z.B. eine Größe von 20 Pixeln angeben möchte heißt der Wert: 00000014
Siehe dazu die Beispiele.

Borders:
    0 = none
    1 = rect
    2 = round
    3 = invert round
    4 = rect + alpha blend
    5 = round + alpha blend
    6 = invert round + alpha blend
Beispiel:
    clrChannelBorderType = 00000004
    clrChannelBorderSize = 0000000F

ProgressBar:
    0 = small line + big line
    1 = big line
    2 = big line + outline
    3 = small line + big line + dot
    4 = big line + dot
    5 = big line + outline + dot
    6 = small line + dot
    7 = outline + dot
    8 = small line + big line + alpha blend
    9 = big line + alpha blend
Beispiel
    clrChannelProgressType = 00000008
    clrChannelProgressSize = 0000000F