Configuration for 1.2.x and 2.2.x - herrnst/script.xbmc.lcdproc GitHub Wiki

Table of Contents

GUI Add-On Settings

Category: Behaviour

Delay for scrolling text:

Increase this value for slower scroll speed (may improve readability on "bad/slow" displays).

Scroll mode:

Sets text scrolling mode either to Marquee (scrolled text scrolls straight through the display; default setting) or Left/Right (bounces scrolled text from left to right and vice versa).

Navigation display duration (s):

Timeout before switching back to current playing media content display when navigating.

Display refresh rate (Hz):

Sets how often it shall be checked if display contents needs updating. Higher values improve "responsiveness", but can lead to performance problems on slow/embedded systems and/or LCDproc.

Category: Backlight

Dim backlight on screensaver:

Turns off display backlight when screensaver mode gets active.

Dim backlight on shutdown:

Turns off display backlight when unloading the addon (e.g. when shutting down XBMC).

Category: Connection

Use remote LCDproc:

Enable to connect to a host running LCDd other than localhost.

LCDd IP:

(editable when "Use remote LCDproc" option is set) Host address or name of remote LCDd server.

LCDd Port:

(editable when "Use remote LCDproc" option is set) TCP port number of remote LCDd server (default: 13666).

Show heartbeat symbol:

Show animated LCDproc heartbeat symbol ontop of XBMC display contents.

Hide connection error notifications:

If enabled, suppressed kai toaster popup display for connection problems/restoration to LCDd (default: enabled).

LCD.xml

Inside LCD.xml's <lcd></lcd> configuration block, these tags can be set to change the behaviour and contents of the addon:

Options

  • <disableonplay>[video,music]</disableonplay>
Turns off backlight when playing video and/or music media.
  • <disableonplaydelay>(numeric value)</disableonplaydelay>
Delay in seconds after turning off backlight when disableonplay is configured.
  • <scrollseparator>(separatortext)</scrollseparator>
When string length exceeds the display width and the line gets scrolled, use (separatortext) as separator between repetitions. Adds greatly on readability.
  • <progressbarsurroundings>[on]</progressbarsurroundings>
When set to "on", progress bar lines get enclosed in "[]" brackets. If set to anything else than "on", no brackets are drawn.
  • <icontextoffset>(numeric value)</icontextoffset>
If specified, this overrides the default offset of two (2) characters for lines containing a play/pause icon. Handy for users using e.g. graphlcd-based displays where e.g. the play icon occupies two characters and additional information shall be displayed with a blank inbetween.
  • <allowemptylines>[on]</allowemptylines>
Set this to "on" if empty/blank lines should not be filtered but rather are inserted for layout purposes, e.g. when using displays with more than 4 text lines.
  • <extrabarX>[progress|volume|menu]</extrabarX> (new in v1.2.0)
Sets additional display bar X (depending on display type, up to 20 additional bars manageable) to represent the specified value. "progress" represents a progress bar of the currently playing media. "volume" shows XBMC's volume setting. "menu" shows a 100% filled bar when the menu is active.

Modes

  • <navigation>...</navigation>
User-triggered navigation (e.g. by keyboard, mouse or remote control).
  • <music>...</music>
XBMC playing music.
  • <video>...</video>
XBMC playing video/movie/TV show.
  • <general>...</general>
Generic (fallback) display mode.
  • <screensaver>...</screensaver>
Screensaver is active.
  • <xbelaunch>...</xbelaunch>
External program is run.
  • <pvrtv>...</pvrtv>
XBMC is playing Live TV delivered via any PVR addon.
  • <pvrradio>...</pvrradio>
Playing Live Radio from PVR addon.

Special InfoLabel handling

These InfoLabels are intercepted by this addon and replaced by native LCDd widgets:

  • $INFO[LCD.ProgressBar]
If this label is found, all other contents of this line are dropped, and a "hbar" widget will be displayed showing a progress bar of the currently playing media file.
  • $INFO[LCD.PlayIcon]
When this is found, the line will be indented by two characters, and a Play/Pause/FastForward/Rewind icon is shown in front of it. If the line exceeds the display width, the text (not the icon) will be scrolled.
  • $INFO[LCD.Time21] (and all known variants like .Time22, TimeWide21 et al)
If any of the current modes lines contain one of these, all other configured contents are ignored/removed, and a "Full Screen" Big Digit display showing current playback time of the running media is displayed, using the "num" widgets. If nothing is playing (plain idle screensaver), local system time will be shown.
  • $INFO[LCD.AlignCenter]
Aligns the line where this Label is found centered when the text length doesn't exceed the display size. Applies only to text-only lines and lines containing a PlayIcon (Note: Icons stay fixed at the left while the rest of the text will be centered)
  • $INFO[LCD.AlignRight]
Like $INFO[LCD.AlignCenter], but aligns the line to the right.

Example LCD.xml file

Usable configuration example for 16x2 character (96x16 graphic) displays, e.g. SoundGraph iMON LCD:

 <lcd>
    <disableonplay></disableonplay>
    <disableonplaydelay>0</disableonplaydelay>
    <scrollseparator>*</scrollseparator>
    <progressbarsurroundings>on</progressbarsurroundings>
    <icontextoffset>2</icontextoffset>
    <allowemptylines>off</allowemptylines>
    <extrabar1>progress</extrabar1>
    <extrabar2>volume</extrabar2>
    <navigation>
       <line>$INFO[System.CurrentWindow]</line>
       <line>$INFO[System.CurrentControl]</line>
    </navigation>
    <music>
       <line>$INFO[LCD.PlayIcon] $INFO[Player.Time]</line>
       <line>$INFO[MusicPlayer.Artist] - $INFO[MusicPlayer.Title]</line>
    </music>
    <video>
       <line>$INFO[LCD.PlayIcon] $INFO[Player.Time]</line>
       <line>$INFO[VideoPlayer.Title]</line>
    </video>
    <general>
       <line>XBMC running...</line>
       <line>$INFO[System.Time] $INFO[System.Date]</line>
    </general>
    <screensaver>
      <line>$INFO[LCD.TimeWide21]</line>
    </screensaver>
    <xbelaunch>
      <line>Playing</line>
      <line>$INFO[System.LaunchXBE]</line>
    </xbelaunch>
    <pvrtv>
       <line>$INFO[VideoPlayer.ChannelName]</line>
       <line>$INFO[VideoPlayer.Title]</line>
    </pvrtv>
    <pvrradio>
       <line>$INFO[MusicPlayer.ChannelName]: $INFO[MusicPlayer.Title]</line>
       <line>$INFO[LCD.ProgressBar]</line>
    </pvrradio>
 </lcd>
⚠️ **GitHub.com Fallback** ⚠️