Graphlcd-plugin/touchcol

From VDR Wiki

Jump to: navigation, search

Contents

Description

Author: Community maintained.

The GraphLCD plugin integrates a graphical display into VDR and makes it possible to control VDR even if the television is off.

This page is about a branch of the GraphLCD plugin with the following added or enhanced features:

  • skins
  • interaction (e.g. touchpads)
  • colour devices (including alpha channel)
  • external services (data from other plugins)

The branch was started by Andreas 'powarman' Regel but was then abandoned and given to new maintainers by his request.

The documentation for the new features is rather 'sparse' at the moment but this page will be used as a starting point for collecting and formatting its features, thus this page will be started being a pigsty and improved 'along the way'.

Images

OLED, 256x64, customised skin
GLCD, 240x128, another customised skin
LCD panel, 640x200, connected to USB13700 module


Installation

Hardware requirements

To use this plugin you need a graphical display with supported controller. It's even possible to redirect the output of the plugin to image files or to the framebuffer to drive e.g. TFT monitors.

Supported are the following controllers (or compatibles) and modules:

  • Hitachi HD61830
  • Samsung KS0108
  • Toshiba T6963
  • Epson SED1520
  • Epson SED1330
  • Noritake GU140X32F-7806
  • Noritake GU256X64-372

and with the extra library [serdisplib] even a lot more (list of supported displays/modules: [supported displays]).

displays/drivers currently supported (not all drivers are verified to correctly support the new internal 32bit colour representation)

Please adapt this list if a driver is working flawlessly (add a cross to 'verified') or inform the maintainer!

Status informations are related to the most current GIT-version!

driver verified may work (not verified)
avrctl x
ax206dpf 2) x
dm140gink x
framebuffer x
futabaMDM166A x
g15daemon x
gu126x64D-K610A4 x
gu140x32f x
gu256x64-372 x
gu256x64-3900 x
hd61830 x
image x
ks0108 x 1)
network x
noritake800 x
sed1330 x
sed1520 x
serdisp x
simlcd x
t6963c x

1) graphic output is very slow. use ks0108-support of serdisplib instead.

2) experimental. only available if enabled during build process.

Software requirements

  • freetype (rendering of TrueType fonts)
  • ImageMagick or GraphicsMagick (optional, required for reading image formats other than glcd and pbm)
  • serdisplib (optional, see above, not required at compile time)

Installation of graphlcd

graphlcd (touchcol-branch) consists of two parts:

  • graphlcd-base: library with low level drivers, basic functionality, and skin support
  • vdr-plugin-graphlcd: VDR plugin.


First of all a current version (contains included skin support) of graphlcd-base needs to be installed:

  • Get current version from the GIT repoository:
  git clone git://projects.vdr-developer.org/graphlcd-base.git -b touchcol graphlcd-base.git.touchcol
  • compile and install the library (default installation directory: /usr/local/include/, can be changed in Make.config)
  make
  make install

Then the VDR plugin needs to be retrieved, installed, and compiled:

  • Note: $SOURCEDIR/VDR is the source directory of VDR and needs to be adapted accordingly.
  • Get current version of the branch from the GIT repository:
  cd $SOURCEDIR/VDR/PLUGINS/src/
  git clone git://projects.vdr-developer.org/vdr-plugin-graphlcd.git -b touchcol vdr-plugin-graphlcd_0.3.0
  ln -s vdr-plugin-graphlcd_0.3.0 graphlcd
  • compile plugin, eg:
  cd $SOURCEDIR/VDR/
  make plugins

Everything else is the same as described in plugin installation.

Configuration

After finishing the installation, some files need to be copied.

  • copy the configuration file graphlcd.conf to some destination, on most installations this will be /etc.
    can be manually configured by setting parameter skin (see below):
    (replace /etc/ if your distribution expects another destination)
 cp graphlcd.conf /etc/
  • copy the directory with logos, fonts, and skins to $VDRCONFIG/plugins (depending on your installation this will be /etc/vdr/plugins, or /video/plugins, or some other destination):
 cp -r $SOURCEDIR/VDR/PLUGINS/src/graphlcd/graphlcd $VDRCONFIG/plugins/

Parameter

Parameter (short) Parameter (long) Description Default (if parameter not given)
-c CFG --config=CFG use CFG as driver config file /etc/graphlcd.conf
-d DISP --display=DISP use display DISP for ouput first display defined in config file
-s SKIN --skin=SKIN use skin SKIN default
-p SKINPATH path to skin files $VDRCONFIG/plugins/graphlcd/skins


Skins

A skin gives a high flexibility of how and which information is brought to a display. Its markup language is the well-known XML.

Structure and elements of a skin

Example skeleton of a skin

<?xml version="1.0"?>
<skin version="1.0" name="testskin">
 <font id="FontInfo" url="ft2:somefont.ttf:8" condition="le({ScreenHeight},64)" />
 <font id="FontInfo" url="ft2:somefont.ttf:14" />

 <variable id="LogoWdith" value="40" condition="le({ScreenHeight},64)" />
 <variable id="LogoWdith" value="64" />

 <display id="normal">

   <variable id="TextX" value="4" />

   <text x1="#TextX" ...>
     {PresentTitle}
   </text>

   <image ... />
   <rectangle ... />
   <progress ... />

   <block condition="{Recordings}">
     <image ... />
     <text ...>
       {Recordings}
     </text>
   </block>

   <variable id="Arrow" value="'images/arrow.pbm'"/>
   <text ... >{MenuTitle}</text>
   <list ...>
     <item height="ITEMHEIGHT" />
     <text ... >{MenuCurrent}</text>
     <text ... >{Menuitem}</text>
     <image ... path="#Arrow" condition="{IsMenuCurrent}" />
   </list>

 </display>
</skin>
Info
Info
  • skins are always UTF-8, on non UTF-8 systems UTF-8 text will be transcoded on-the-fly.
  • All variable and font names must be 7-bit safe (no umlauts or diacritics).
  • HTML-entities are not supported, except &lt;, &gt;, &amp;, &#x<hexID>; and &#<decID>; (e.g.: &#xE001;).


A skin definition contains different types and sections of information:

font
defines an easy to remember font 'handle'. if a condition is given the font item is only defined if the condition is true.
Note:: fonts can only be defined in the context 'skin'.
variable
defines a variable which can be a constant or calculated using a complex evaluation.
Note:: variables can be defined everywhere, but the scope will always be skin-wide!


sections:

skin
root element.
display
a layer containing drawing elements.
block
groups elements together. may be displayed or hidden depending on a condition.
list
a menu with a defined item height, selected text line, line marker, maybe some lines before, and after the .selected line.

drawing elements:

  • image
  • text
  • pixel
  • line
  • rectangle
  • elipse
  • slope
  • progress (progress bar)
  • item (needed in lists)


functions, conditions, evaluations, and tokens:

function
retrieves a value of a certain entity, eg. the height of a font or width of a text string in pixels.
condition
evaluates boolean terms (returns either true or false).
evaluation
evaluates a simple calculation using basic arithmetic operations.
token
contains an information (eg. runtime information from VDR like present title, current channel name, ...) and is either displayed or used in evaluations or conditions.

List of tokens defined in either graphlcd-base or vdr-plugin-graphlcd

  • Current channel
{ChannelNumber}
Returns an integer value
Channel number
{ChannelName}
Returns a string value, may be empty
Channel name or group name
{ChannelShortName}
Returns a string value, may be empty
Short name of channel, if available
{ChannelProvider}
Returns a string value, may be empty
Provider/bouquet name, if available
{ChannelPortal}
Returns a string value, may be empty
Portal name, if available
{ChannelSource}
Returns a string value, may be empty
Signal source of channel, as defined in sources.conf.
{ChannelID}
Returns a string value: "<Source>-<NID>-<TID>-<SID>[-<RID>]"
Identifier of the current channel
{ChannelHasTeletext} | {HasTeletext}
Returns a boolean
True if teletext is present
{ChannelHasMultilang} | {HasMultilang}
Returns a boolean
True if more than one audio stream is present
{ChannelHasDolby} | {HasDolby}
Returns a boolean
True if a Dolby Digital stream is present
{ChannelIsEncrypted} | {IsEncrypted}
Returns a boolean
True if the channel is encrypted
{ChannelIsRadio} | {IsRadio}
Returns a boolean
True if the channel is a radio channel
{ChannelAlias}
Returns a string, may be empty
The ChannelAlias is a virtual channel name mapped through the channels.alias mapping file.
It's the preferred way for naming channel logos.
  • Recording
{IsRecording[,<card number>]}
?
{Recordings[,<card number>]}
?
  • Present EPG
{PresentValid}
?
{PresentStartDateTime[:<strftime format>]}
?
{PresentVpsDateTime[:<strftime format>]}
?
{PresentEndDateTime[:<strftime format>]}
?
{PresentDuration[:<duration format>]}
?
{PresentProgress[:<duration format>]}
?
{PresentRemaining[:<duration format>]}
?
{PresentTitle}
?
{PresentShortText}
?
{PresentDescription}
?
  • Following EPG
{FollowingValid}
?
{FollowingStartDateTime[:<strftime format>]}
?
{FollowingVpsDateTime[:<strftime format>]}
?
{FollowingEndDateTime[:<strftime format>]}
?
{FollowingDuration[:<duration format>]}
?
{FollowingTitle}
?
{FollowingShortText}
?
{FollowingDescription}
?
  • Volume
{VolumeCurrent}
?
{VolumeTotal}
?
{VolumeIsMute} | {IsMute}
?
  • Replay
{ReplayTitle}
?
{ReplayPositionIndex[:<duration format>]}
?
{ReplayDurationIndex[:<duration format>]}
?
{ReplayIsPlaying} | {IsPlaying}
?
{ReplayIsFastForward[:<replay speed>]} | {IsFastForward[:<replay speed>]}
?
{ReplayIsFastRewind[:<replay speed>]} | {IsFastRewind[:<replay speed>]}
?
{ReplayIsSlowForward[:<replay speed>]} | {IsSlowForward[:<replay speed>]}
?
{ReplayIsSlowRewind[:<replay speed>]} | {IsSlowRewind[:<replay speed>]}
?
{ReplayIsPausing} | {IsPausing}
?
{ReplayPosition}
?
{ReplayDuration}
?
{ReplayRemaining[:<duration format>]}
?
{ReplayMode}
"cd", "dvd", "file", "image", "music", "vdr"
{ReplayIsShuffle}
Not implemented yet!
{ReplayIsLoop}
Not implemented yet!
  • OSD related
{Message}
?
{MenuTitle}
?
{MenuItem}
?
{MenuCurrent}
?
{IsMenuCurrent}
?
{ButtonRed}
?
{ButtonGreen}
?
{ButtonYellow}
?
{ButtonBlue}
?
  • Settings
{SettingShowChannelLogo}
?
{SettingShowReplayLogo}
?
{SettingShowSymbols}
?
{SettingShowTimebar}
?
{ScrollMode}
?
{ScrollSpeed}
?
{ScrollTime}
?
{BrightnessActive}
?
{BrightnessIdle}
?
{BrightnessDelay}
?
{DisplayMode}
?
Return "Normal" or "Interactive"
  • General info
{IsUTF8}
Returns a boolean
true if the VDR is runnig with UTF-8 encoding enabled.
{DateTime[:<strftime format>]}
?
{ConfigPath}
?
{SkinPath}
?
{ScreenWidth}
?
{ScreenHeight}
?
{DefaultForegroundColor}
Returns a colour string representation, format: "0x<AA><RR><GG><BB>".
Contains the default foreground colour of the currently used graphlcd driver without consideration of user settings.
{DefaultBackgroundColor}
Returns a colour string representation, format: "0x<AA><RR><GG><BB>".
Contains the default background colour of the currently used graphlcd driver without consideration of user settings.
{ForegroundColor}
Returns a colour string representation, format: "0x<AA><RR><GG><BB>", (eg: 0xFFFFFFFF).
Contains the foreground colour (if set in graphlcd.conf: returns FGColour, or, if not set: the same as {DefaultForegroundColor}).
(Setting FGColour is currently only supported by driver serdisp).
On monochrome displays this colour defines the colour for setting a pixel.
{ForegroundColor} should be used in favour of {DefaultForegroundColor}.
{BackgroundColor}
Returns a colour string representation, format: "0x<AA><RR><GG><BB>", (eg: 0xFF000000).
Contains the background colour (if set in graphlcd.conf: returns BGColour, or, if not set: the same as {DefaultBackgroundColor}).
(Setting BGColour is currently only supported by driver serdisp).
On monochrome displays this colour defines the colour for clearing a pixel.
{BackgroundColor} should be used in favour of {DefaultBackgroundColor},
CLS
   Clear display
UPD
   Update display
OFF
   Switch off plugin
ON
   Switch on plugin
SET <key>[,display=<display>][,expire=<expire] <value>
   Set entry <key> to value <value>. optionally expire after <expire> seconds. <value> may contain spaces
GET <key>[,display=<display>]
   Unset (clear) entry <key>
UNSET <key>[,display=<display>]
   Get value assigned to entry <key>
CONNECT [<display> [<skin>]]
   Connect given display or reconnect all displays if called w/o parameter
DISCONN [<display>]
   Disconnect given display or all displays if called w/o parameter
examples:
 PLUG GRAPHLCD SET somekey somevalue
 PLUG GRAPHLCD UNSET somekey
 PLUG GRAPHLCD SET someotherkey,expire=30 this will expire after 30 seconds
  • Read variables set by SVDRP command SET
{ExtDataIsAvailable:<key>}
Check if a given variable was set
{ExtDataItem:<key>}
Retrieve the content of the given variable
example:
 <block condition="{ExtDataIsAvailable:somekey}">
   <text x="0" y="0" font="somefont">SomeKey: {ExtDataItem:somekey}</text>
 </block>
  • Other Plugins Services
{ServiceIsAvailable:<service>}
Return: boolean
Check if a given Service is available
{ServiceItem:<service>,<key>[,<parameter 1>][,<parameter 2>]}
Return: based on <key>
Retrieve a service value
{ServiceItem:radio,<key>}
key Return Description
default string at rds_info = 2: "<start hh>:<start mm> <title> | <artist>"
at rds_info = 1: "<radiotext>"
at rds_info = 0: empty
title string Title
artist string Artist
text string Radiotext
rds_info info integer 0 = No RDS present
1 = Radiotext present
2 = Radiotext, Title and Artist present
rds_pty pty integer Program type
http://tech.ebu.ch/docs/techreview/trev_255-beale.pdf (Page 3)
Update interval 100 ms
{ServiceItem:lcr,<key>}
key Return Description
default string  ?
destination string  ?
price string  ?
pulse string  ?
Update interval 60 s
{ServiceItem:femon,<key>[,<printf format>][,<divisor>]}
key Return Description
default status string "Status <"LOCKED"|"-">:<"SIGNAL"|"-">:<"CARRIER"|"-">:<"VITERBI"|"-">:<"SYNC"|"-"> on device #<device number>"
name string "<frontend name> on device #<device number>"
snr integer  ?
signal integer  ?
percent_snr integer  ?
percent_signal integer  ?
ber integer  ?
unc integer  ?
video_bitrate vbr integer
string*)
 ?
audio_bitrate abr integer
string*)
 ?
dolby_bitrate dbr integer
string*)
 ?
*) if <printf format> given
Update interval 2 s
<printf format> and <divisor> are only available with key video_bitrate/vbr, audio_bitrate/abr and dolby_bitrate/dbr
{ServiceItem:mailbox,<key>}
key Return Description
default hasnew boolean return true if there are unread mails in one of the accounts configured to report unread mails.
false if accounts not checked yet or if there are no new mails
newcount integer report how many mails are unread in all accounts configured to report this.
return zero if accounts not checked yet, use hasnew to check this
Update interval 10 s
Format Strings
  • printf Format String
<printf format> is an valid printf format string
  • strftime Format String
<strftime format> is an valid strftime format string
  • duration Format String
specifier Replaced by
%H Hour Part, leading Zero (2 Chars)
%k Hour Part, leading Whitespace (2 Chars)
%M Minute Part, leading Zero (2 Chars)
%m Time in Minutes
%S Second Part, leading Zero (2 Chars)
%f  ?

Problems

Links

[1] http://projects.vdr-developer.org/projects/show/graphlcd new plugin homepage
[2] http://projects.vdr-developer.org/wiki/graphlcd/GraphlcdSkin page for skin branch
Personal tools
Participate