This is a "plugin" for the Video Disk Recorder (VDR).

Written by : Andreas Brachold <vdr07 AT deltab de>

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

This iMON LCD plugin for VDR 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, version 3 of the License.

This iMON LCD plugin for VDR is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
for more details.

You should have received a copy of the GNU General Public License
along with this iMON LCD plugin for VDR. If not, see <http://www.gnu.org/licenses/>.

See the file COPYING for license information.

Description:
------------
imonlcd is a plugin for the Video Disc Recorder and shows information
about the current state of VDR on iMON LCD.


Install LIRC kernel module lirc_imon:
-------------------------------------
You need installed kernel module lirc_imon installed to use the iMon LCD.
This module are provided by LIRC (which will also allow you to use the IR 
receiver that is built into the screen).

Other software like LCDproc should not be used, it could locking the 
device access. 

Install LIRC
A newer or current CVS version of LIRC is required for support of the iMON LCD.
You need to have the CVS client installed and then you can issue the following 
commands:

#> cvs -d:pserver:anonymous@lirc.cvs.sourceforge.net:/cvsroot/lirc login
#> cvs -z8 -d:pserver:anonymous@lirc.cvs.sourceforge.net:/cvsroot/lirc co lirc
#> cd lirc
#> ./autogen.sh
#> ./setup.sh

If you have any errors at this point, make sure you've installed all the 
prerequisite build tools. At this you'll be at the "setup" menu for LIRC. 
You'll need to choose "Driver Configuration" then 
  
  "USB Devices" then "Soundgraph iMON IR/LCD". 

Choose OK, then "Save configuration & run configure" to run the configure script. 
Once that finishes, run the following commands to install the modules:

#> make
#> make install
#> modprobe lirc_imon

At this point, you've got LIRC installed, and you might like to take some time
to set up your remote (if you've got one). 

That step is outside the scope of these instructions, so I'll just skip that 
and move on to install vdr-plugin-imonlcd now.


Install vdr-plugin-imonlcd:
---------------------------
Unpack the vdr-plugin-imonlcd tarball to $VDRSOURCE/PLUGINS/src directory.
Variable $VDRSOURCE stands for a directory, where source archive of VDR package 
was be decompressed.

#> cd $VDRSOURCE/PLUGINS/src
#> tar -xzvf vdr-imonlcd-0.0.1.tgz
#> ln -s imonlcd-0.0.1 imon

Compile the plugin (from VDR's source directory)

Change the working directory to VDR source root and compile this plugin 
like all other VDR plugins.

#> cd $VDRSOURCE
#> make plugins

After everything has been compiled without errors, copy the plugin to their 
target directory.

#> make install


Check follow requirements 
-------------------------
* module lirc_imon is loaded
* /dev/lcd0 still exits
* /dev/lcd0 are writable

* To determine need protocol to communicate with LCD, known values
  0038 - For LCD with ID 15c2:0038 SoundGraph Inc (default)
  ffdc - For LCD with ID 15c2:ffdc SoundGraph Inc

  #> lsusb | grep 15c2
  Bus 002 Device 002: ID 15c2:0038 SoundGraph Inc. 

  or by udev      
  #> udevinfo -a -n /dev/lcd0 \
  | grep -2 'ATTRS{idVendor}=="15c2"' \
  | grep ATTRS{idProduct} | cut -d '=' -f 3
  "0038"


Start VDR with the plugin.
---------------------------
You have to specify the device and protocol of your display in the config file
on the command line.
Possible options are:
     -d DEV,   --device=DEV      sets the lcd-device to other device than /dev/lcd0
     -p MODE,  --protocol=MODE   sets the protocol of lcd-device
                          0038 - For LCD with ID 15c2:0038 SoundGraph Inc (default)
                          ffdc - For LCD with ID 15c2:ffdc SoundGraph Inc

   Examples:
     vdr -P'imonlcd'
     vdr -P'imonlcd -d /dev/lcd0 -p ffdc'

Setup options
-------------
This options are editable at run time. (Menu: Setup > Plugin > imonlcd ... )

* Contrast 
  - Set contrast from display. (Default: 200)

* Default font 
  - Used font, there should installed like other FreeType supported fonts 
* Height of big font
* Height of small font

* Render mode
  - Single line
  - Dual lines
  - Single line (Channel names only)

* Disc spinning mode
  - Mode of disc icons at top left corner (used as playback notification) 
    Options are Slim disc/Full disc

* Exit mode
  - Do nothing - Just leave the "last" message there
  - Showing clock - Show the big clock
  - Turning backlight off - Blank the device completely
  - Show next timer - Show time and title of next timer
  - Wake up on next timer - Use display to wake up the VDR-PC, at next active timer

* Margin time at wake up (min)
  - Define a margin time, if wake up on exit mode used. (Default: 5 minutes)

* Suspend display at night
  - Allow turn display off at night, depends selected mode and time frame.

Plugin SVDRP commands
---------------------
* HELP - List known commands
* OFF - Suspend driver of display.
* ON  - Resume driver of display.
* ICON [name] [on|off|auto] - Force state of icon. 

Use this commands like follow samples 
    #> svdrpsend.pl PLUG imonlcd OFF
    220 vdr SVDRP VideoDiskRecorder ....
    250 driver suspended
    221 vdr closing connection

    #> svdrpsend.pl PLUG imonlcd HELP ICON
    214-ICON [name] [on|off|auto]
    214-    Force state of icon. Names of icons are:
    214-    Music,Movie,Photo,DVD,TopTV,Web,News
    ...

This commands can have follow responses 
OFF :   250 driver suspended           
        251 driver already suspended
ON :    250 driver resumed
        251 driver already resumed
        554 driver could not resumed
ICON :  250 icon state 'auto'
        251 icon state 'on'
        252 icon state 'off'
*       501 unknown command