diff --git a/docs/lcdproc-user/bookinfo.docbook b/docs/lcdproc-user/bookinfo.docbook
index 9a7efc3..ebeca26 100644
--- a/docs/lcdproc-user/bookinfo.docbook
+++ b/docs/lcdproc-user/bookinfo.docbook
@@ -5,6 +5,12 @@
+
+Peter
+Marschall
+peter@adpm.de
+
+
ReneWagner
@@ -25,17 +31,19 @@
-2002-03-01
+2006-04-010.0.1
-This document is a guide to LCDproc written for users. It covers LCDproc 0.4.3 ONLY.
-Some things may be valid for 0.5 as well, but a lot has changed since 0.4.1 and a lot
-will change for 0.5.
+This document is a guide to LCDproc written for users. It covers LCDproc 0.5.x
+
+2006
+Peter Marschall
+2002Rene Wagner
@@ -63,7 +71,7 @@ Free Documentation License".
documentationLCDproc
-0.4.3
+0.5.0user's guide
diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook
index 9b2bdce..ce1908f 100644
--- a/docs/lcdproc-user/configuration.docbook
+++ b/docs/lcdproc-user/configuration.docbook
@@ -267,58 +267,56 @@ The Free*Key options enable you to influence this behaviour.
-
-FreePauseKey=
-
-
-If set to yes, this prevents LCDd from handling the PauseKey itself.
-Then a client can request the key 'A' and handle it.
-
-
-
-
-FreeBackKey=
-
-
-If set to yes, this prevents LCDd from handling the BackKey itself.
-Then a client can request the key 'B' and handle it.
-
-
-
-
-FreeForwardKey=
-
-
-If set to yes, this prevents LCDd from handling the ForwardKey itself.
-Then a client can request the key 'C' and handle it.
-
-
-
-
-
-FreeMainMenuKey=
-
-
-If set to yes, this prevents LCDd from handling the MainMenuKey itself.
-Then a client can request the key 'D' and handle it.
-
-
-
-Even if you "free" the above keys, you can still use the menu
-provided you set FreeMainMenuKey to no.
-
-
-
-
-
+
+ FreePauseKey=
+
+
+ If set to yes, this prevents LCDd from handling the PauseKey itself.
+ Then a client can request the key 'A' and handle it.
+
+
+
+
+ FreeBackKey=
+
+
+ If set to yes, this prevents LCDd from handling the BackKey itself.
+ Then a client can request the key 'B' and handle it.
+
+
+
+
+ FreeForwardKey=
+
+
+ If set to yes, this prevents LCDd from handling the ForwardKey itself.
+ Then a client can request the key 'C' and handle it.
+
+
+
+
+ FreeMainMenuKey=
+
+
+ If set to yes, this prevents LCDd from handling the MainMenuKey itself.
+ Then a client can request the key 'D' and handle it.
+
+
+
+ Even if you "free" the above keys, you can still use the menu
+ provided you set FreeMainMenuKey to no.
+
+
+
+
-
-LCDd.conf: The Drivers Section
+
+LCDd.conf: The Driver Section
As mentioned earlier, each driver has its own section in the
@@ -339,7 +337,7 @@ section of your driver and change everything neccessary.
The LCDproc distribution contains init scripts for RedHat- and Debian-based
-GNU/Linux distributions. You can find them in the docs/
+GNU/Linux distributions. You can find them in the scripts/
directory of the LCDproc sources.
diff --git a/docs/lcdproc-user/drivers.docbook b/docs/lcdproc-user/drivers.docbook
index 15e7d1b..c96654f 100644
--- a/docs/lcdproc-user/drivers.docbook
+++ b/docs/lcdproc-user/drivers.docbook
@@ -7,10 +7,41 @@ which may include the installation process of the hardware as
well as the configuration of LCDd.
+&bayrad;
+&CFontz;
+&CFontz633;
+&CFontzPacket;
+&curses;
+&CwLnx;
+&glcdlib;
+&glk;
&hd44780;
+&icp_a106;
+&imon;
+&IOWarrior;
+&irman;
+&joy;
+&lb216;
+&lcdm001;
+&lcterm;
+&lirc;
+&ms6931;
+&mtc_s16209x;
+&MtxOrb;
+&NoritakeVFD;
+&pylcd;
+&sed1330;
+&sed1520;
+&serialVFD;
+&sli;
+&stv5730;
+&svga;
&t6963;
+&text;
+&tyan;
+&ula200;
+&xosd;
+
&ppttrouble;
-&mtxorb;
-&lircin;
diff --git a/docs/lcdproc-user/drivers/CFontz.docbook b/docs/lcdproc-user/drivers/CFontz.docbook
new file mode 100644
index 0000000..0c7da2d
--- /dev/null
+++ b/docs/lcdproc-user/drivers/CFontz.docbook
@@ -0,0 +1,139 @@
+
+The CFontz Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+CFontz chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[CFontz]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the serial output device to use.
+ If not given, default is /dev/lcd.
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Set the LCD's dimensions in terms of characters per line and lines.
+ If not given, it defaults to 20x4.
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the initial contrast.
+ Legal values for CONTRAST are in the range
+ between 0 and 1000.
+ If not given, it defaults to 140.
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Set the initial brightness.
+ Legal values for BRIGHTNESS range from
+ 0 to 255.
+ If not given, it defaults to 255.
+
+
+
+
+
+ OffBrightness=
+ BRIGHTNESS
+
+
+ Set the initial off-brightness.
+ This value is used when the display is normally
+ switched off in case LCDd is inactive.
+ Legal values BRIGHTNESS are in the range
+ from 0 to 255.
+ The default is 0.
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+ 115200
+
+
+
+
+ Set the the baud rate to use when communicating with the LCD.
+ It defaults to 9600 if not specified.
+
+
+
+
+
+ NewFirmware=
+
+
+ yes
+ no
+
+
+
+
+ Set the firmware version (New means >= 2.0) [default: no; legal: yes, no]
+
+
+
+
+
+ Reboot=
+
+
+ yes
+ no
+
+
+
+
+ Reinitialize the LCD's BIOS [default: no; legal: yes, no]
+ normally you shouldn't need this
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/CFontz633.docbook b/docs/lcdproc-user/drivers/CFontz633.docbook
new file mode 100644
index 0000000..f44145a
--- /dev/null
+++ b/docs/lcdproc-user/drivers/CFontz633.docbook
@@ -0,0 +1,133 @@
+
+The CFontz633 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+CFontz633 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[CFontz633]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+ may be serial device or USB device in serial emulation mode.
+
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Select the LCD type (size) [default: 16x2]
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the initial contrast.
+ Legal values for CONTRAST are 0 - 1000.
+ If not specified, it defaults to 560.
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Set the initial brightness [default: 1000; legal: 0 - 1000]
+
+
+
+
+
+ OffBrightness=
+ BRIGHTNESS
+
+
+ Set the initial off-brightness [default: 0; legal: 0 - 1000]
+ This value is used when the display is normally
+ switched off in case LCDd is inactive
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+ 115200
+
+
+
+
+ Set the the baud rate for communication with the LCD.
+ If not specified, the default is 19200.
+
+
+
+
+
+ NewFirmware=
+
+
+ yes
+ no
+
+
+
+
+ Set the firmware version (New means >= 2.0) [default: no; legal: yes, no]
+ Currently this flag is not in use, there is no such thing as NewFirmware. ;=)
+
+
+
+
+
+ Reboot=
+
+
+ yes
+ no
+
+
+
+
+ Reinitialize the LCD's BIOS [default: no; legal: yes, no]
+ I want to reboot the LCD to make sure we start from a known state
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/CFontzPacket.docbook b/docs/lcdproc-user/drivers/CFontzPacket.docbook
new file mode 100644
index 0000000..74ba253
--- /dev/null
+++ b/docs/lcdproc-user/drivers/CFontzPacket.docbook
@@ -0,0 +1,149 @@
+
+The CFontzPacket Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+CFontzPacket chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[CFontzPacket]
+
+
+
+
+ Model=
+
+
+ 631
+ 633
+ 635
+
+
+
+
+ Select the LCD model [default: 633; legal: 631, 633, 635]
+
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+ May be a serial device or a USB device in serial emulation mode.
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Select the LCD size [default: depending on model: 635: 20x4, 631 & 633: 16x2]
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the initial contrast.
+ Legal values for CONTRAST are 0 - 1000.
+ If not specified, it defaults to 560.
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Set the initial brightness [default: 1000; legal: 0 - 1000]
+
+
+
+
+
+ OffBrightness=
+ BRIGHTNESS
+
+
+ Set the initial off-brightness [default: 0; legal: 0 - 1000]
+ This value is used when the display is normally
+ switched off in case LCDd is inactive
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+ 115200
+
+
+
+
+ Set the the baud rate for communication with the LCD.
+ If not specified, the default depends on the model: it is 9600
+ for the CFA633 and 115200 for the CFA631 and CFA635.
+
+
+
+
+
+ NewFirmware=
+
+
+ yes
+ no
+
+
+
+
+ Set the firmware version (New means >= 2.0) [default: no; legal: yes, no]
+ Currently this flag is not in use, there is no such thing as NewFirmware. ;=)
+
+
+
+
+
+ Reboot=
+
+
+ yes
+ no
+
+
+
+
+ Reinitialize the LCD's BIOS [default: no; legal: yes, no]
+ I want to reboot the LCD to make sure we start from a known state
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/CwLnx.docbook b/docs/lcdproc-user/drivers/CwLnx.docbook
new file mode 100644
index 0000000..1002d84
--- /dev/null
+++ b/docs/lcdproc-user/drivers/CwLnx.docbook
@@ -0,0 +1,185 @@
+
+The CwLnx Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+CwLnx chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[CwLnx]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+ May be serial device or USB device in serial emulation mode.
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Select the LCD size [default: 20x4]
+
+
+
+
+
+ Speed=
+
+
+ 9600
+ 19200
+
+
+
+
+ Set the the baud rate for communication with the LCD.
+ If not given, the default is 19200.
+
+
+
+
+
+ Reboot=
+
+
+ yes
+ no
+
+
+
+
+ Reinitialize the LCD's BIOS [default: no; legal: yes, no]
+ normally you shouldn't need this
+
+
+
+
+
+ Keypad=
+
+
+ yes
+ no
+
+
+
+
+ Tells if you have a keypad connected. Keypad layout is currently not
+ configureable from the config file.
+
+
+
+
+
+ KeyMap_A=
+ KEY
+
+
+ KeyMap_B=
+ KEY
+
+
+ KeyMap_C=
+ KEY
+
+
+ KeyMap_D=
+ KEY
+
+
+ KeyMap_E=
+ KEY
+
+
+ KeyMap_F=
+ KEY
+
+
+ If you have a non standard keypad you can associate any keystrings to keys.
+ There are 6 input key in the CwLnx hardware that generate characters
+ from 'A' to 'F'.
+ Legal values for KEY are Up,
+ Down, Left, Right,
+ Enter and Escape.
+
+
+ The following it the built-in default mapping hardcoded in the driver.
+
+
+
+
+
+ KeyMap_A
+ Up
+
+
+ KeyMap_B
+ Down
+
+
+ KeyMap_C
+ Left
+
+
+ KeyMap_D
+ Right
+
+
+ KeyMap_E
+ Enter
+
+
+ KeyMap_F
+ Escape
+
+
+
+
+
+ You may leave it unchanged if you have a standard keypad.
+ You can change it if you want to report other keystrings or have a non
+ standard keypad.
+
+
+
+
+
+
+ keypad_test_mode=
+
+
+ yes
+ no
+
+
+
+
+ keypad_test_mode permit to test keypad assignement
+ Default value is no
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/IOWarrior.docbook b/docs/lcdproc-user/drivers/IOWarrior.docbook
new file mode 100644
index 0000000..c4dd0ec
--- /dev/null
+++ b/docs/lcdproc-user/drivers/IOWarrior.docbook
@@ -0,0 +1,64 @@
+
+The IOWarrior Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+IOWarrior chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[IOWarrior]
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ display dimensions
+ Default: 20x4.
+
+
+
+
+
+ SerialNumber=
+ SERIALNO
+
+
+ serial number [exactly as listed by usbview]
+ (if not given, the 1st IOWarrior found gets used)
+
+
+
+
+
+ Lastline=
+
+
+ yes
+ no
+
+
+
+
+ Specifies if the last line is pixel addressable or it controls an
+ underline effect. [default: yes (= pixel addressable); legal: yes, no]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/Makefile.am b/docs/lcdproc-user/drivers/Makefile.am
index 2e19446..115d2c2 100644
--- a/docs/lcdproc-user/drivers/Makefile.am
+++ b/docs/lcdproc-user/drivers/Makefile.am
@@ -1,5 +1,40 @@
## Process this file with automake to produce Makefile.in
-EXTRA_DIST = hd44780.docbook lircin.docbook mtxorb.docbook ppttrouble.docbook t6963.docbook
+EXTRA_DIST = bayrad.docbook \
+ CFontz633.docbook \
+ CFontz.docbook \
+ CFontzPacket.docbook \
+ curses.docbook \
+ CwLnx.docbook \
+ glcdlib.docbook \
+ glk.docbook \
+ hd44780.docbook \
+ icp_a106.docbook \
+ imon.docbook \
+ IOWarrior.docbook \
+ irman.docbook \
+ joy.docbook \
+ lb216.docbook \
+ lcdm001.docbook \
+ lcterm.docbook \
+ lirc.docbook \
+ lircin.docbook \
+ ms6931.docbook \
+ mtc_s16209x.docbook \
+ mtxorb.docbook \
+ NoritakeVFD.docbook \
+ ppttrouble.docbook \
+ pylcd.docbook \
+ sed1330.docbook \
+ sed1520.docbook \
+ serialVFD.docbook \
+ sli.docbook \
+ stv5730.docbook \
+ svga.docbook \
+ t6963.docbook \
+ text.docbook \
+ tyan.docbook \
+ ula200.docbook \
+ xosd.docbook
## EOF
diff --git a/docs/lcdproc-user/drivers/NoritakeVFD.docbook b/docs/lcdproc-user/drivers/NoritakeVFD.docbook
new file mode 100644
index 0000000..5e1cb37
--- /dev/null
+++ b/docs/lcdproc-user/drivers/NoritakeVFD.docbook
@@ -0,0 +1,90 @@
+
+The NoritakeVFD Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+NoritakeVFD chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[NoritakeVFD]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Port where the VFD is. Usual values are /dev/ttyS0 and /dev/ttyS1
+ Default: /dev/lcd
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Specifies the size of the LCD.
+ Default: 20x4
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+ 115200
+
+
+
+
+ Set the the baud rate to use when communicating with the VFD.
+ If not specified, it defaults to 9600.
+
+
+
+
+
+ Reboot=
+
+
+ yes
+ no
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/bayrad.docbook b/docs/lcdproc-user/drivers/bayrad.docbook
new file mode 100644
index 0000000..a08fe9e
--- /dev/null
+++ b/docs/lcdproc-user/drivers/bayrad.docbook
@@ -0,0 +1,51 @@
+
+The bayrad Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+bayrad chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[bayrad]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the serial output device to use.
+ If not given, default is /dev/lcd.
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+
+
+
+
+ Set the the baud rate to use when communicating with the LCD.
+ 9600 is the default, if not specified.
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/curses.docbook b/docs/lcdproc-user/drivers/curses.docbook
new file mode 100644
index 0000000..0651073
--- /dev/null
+++ b/docs/lcdproc-user/drivers/curses.docbook
@@ -0,0 +1,83 @@
+
+The curses Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+curses chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[curses]
+
+
+ color settings
+
+
+
+ Foreground=
+ COLOUR
+
+
+ foreground color [default: blue]
+
+
+
+
+
+ Background=
+ COLOUR
+
+
+ background color [default: cyan]
+
+
+
+
+
+ Backlight=
+ COLOUR
+
+
+ backlight color [default: red]
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ display size [default: 20x4]
+
+
+
+
+
+ TopLeftx=
+ X-OFFSET
+
+
+ TopLefty=
+ Y-OFFSET
+
+
+ What position (X,Y) to start the left top corner at.
+ Default: (7,7)
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/glcdlib.docbook b/docs/lcdproc-user/drivers/glcdlib.docbook
new file mode 100644
index 0000000..ec8b5c0
--- /dev/null
+++ b/docs/lcdproc-user/drivers/glcdlib.docbook
@@ -0,0 +1,272 @@
+
+The glcdlib Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+glcdlib chipset.
+
+
+
+Connections
+
+
+The so-called "meta-driver" glcdlib extends LCDproc's supported drivers by
+all the drivers supported by graphlcd-base, which you can get from
+.
+
+
+In order to be able to use it, you have to get and install the glcdprocdriver
+from
+before configuring the LCDproc build process --enable-drivers=glcdlib.
+
+
+Author
+
+Lucian
+Muresan
+
+
+
+
+
+
+Configuration in LCDd.conf
+
+
+[glcdlib]
+
+## mandatory:
+
+
+
+
+ Driver=
+ GRAPHLCD-DRIVER
+
+
+ Specify which graphical display supported by graphlcd-base to use.
+ Legal values for GRAPHLCD-DRIVER are
+ specified in graphlcd's configuration file /etc/graphlcd.conf.
+ For graphlcd 0.13 they comprise avrctl, framebuffer,
+ gu140x32f, gu256x64-372, gu256x64C-3xx0,
+ hd61830, image, ks0108,
+ noritake800, sed1330, sed1520,
+ serdisp, simlcd, and t6963c.
+ If not specified it defaluts to image.
+
+
+
+
+
+ UseFT2=
+
+
+ yes
+ no
+
+
+
+
+ Tell whether to use FreeType2 or not.
+ If set to no use graphlcd's bitmap fonts, which is only one size/font file.
+ If set to to the default value yes use the fonts that FreeType2 provides.
+
+
+ Setting it to yes requires Freetype2 support in libglcdprocdriver and its dependants.
+
+
+
+
+
+
+ TextResolution=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Give text resolution in fixed width characters. If it won't fit according
+ to the available physical pixel resolution and the minimum available font
+ face size in pixels, 'DebugBorder' will automatically be turned on.
+ If not specified, it defaults to 16x4.
+
+
+
+
+
+ FontFile=
+ FILENAME
+
+
+ Set path to font file to use, e.g. /usr/share/fonts/corefonts/courbd.ttf.
+
+
+
+
+
+The following parameters only apply if UseFT2=yes:
+
+
+
+
+ CharEncoding=
+ CHARSET
+
+
+ Specify character encoding to use, e.g. iso8859-2.
+ If not given, use the default ISO8859-1.
+
+
+
+
+
+ MinFontFaceSize=
+
+ COLUMNS
+ x
+ ROWS
+
+
+
+ minumum size in pixels in which fonts should be rendered
+
+
+
+
+## optional:
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Brightness (in %) if applicable
+ Legal values are 0 - 100.
+ If not specified, the default is 50.
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the contrast (in %) if applicable.
+ Legal values are 0 - 100,
+ with 50 being the default when not specified.
+
+
+
+
+
+ Backlight=
+
+
+ yes
+ no
+
+
+
+
+ Backlight if applicable
+
+
+
+
+
+ UpsideDown=
+
+
+ yes
+ no
+
+
+
+
+ flip image upside down
+
+
+
+
+
+ Invert=
+
+
+ yes
+ no
+
+
+
+
+ invert light/dark pixels
+
+
+
+
+
+ ShowDebugFrame=
+
+
+ yes
+ no
+
+
+
+
+ turns on/off 1 pixel thick debugging
+ border whithin the usable text area,
+ for setting up TextResolution and
+ MinFontFaceSize (if using FT2);
+
+
+
+
+
+ ShowBigBorder=
+
+
+ yes
+ no
+
+
+
+
+ border around the unused area
+
+
+
+
+
+ ShowThinBorder=
+
+
+ yes
+ no
+
+
+
+
+ border around the unused area
+
+
+
+
+
+ PixelShiftX=0
+
+
+ PixelShiftY=2
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/glk.docbook b/docs/lcdproc-user/drivers/glk.docbook
new file mode 100644
index 0000000..ddd0e17
--- /dev/null
+++ b/docs/lcdproc-user/drivers/glk.docbook
@@ -0,0 +1,61 @@
+
+The glk Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+glk chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[glk]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ select the serial device to use [default: /dev/lcd]
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the initial contrast.
+ Legal values for CONTRAST are 0 - 1000.
+ If not given, it defaults to 560.
+
+
+
+
+
+ Speed=
+
+
+ 9600
+ 19200
+ 38400
+
+
+
+
+ Set the the baud rate for communication with the LCD.
+ The default is 19200.
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/hd44780.docbook b/docs/lcdproc-user/drivers/hd44780.docbook
index 71fa39e..0bbb75e 100644
--- a/docs/lcdproc-user/drivers/hd44780.docbook
+++ b/docs/lcdproc-user/drivers/hd44780.docbook
@@ -21,7 +21,7 @@ It also supports the following connections:
A PIC-an-LCD or LCD serializer connected to a serial port
-A I2C port expander connected to an I2C port
+A I2C port expander connected to an I2C port
The driver also lets you use multiple displays as a single virtual
@@ -90,19 +90,25 @@ There are several ways to get 5V:
-Connect to a 5V line intented for disk drives (the red
-wire is 5V, black is GND).
-Get it from a joystick port (pin 1 and 9 are 5V, 4, 5
-and 12 are GND). It seems that some soundcards can use these lines for
-communication, so if you want to use this first check wether it really
-gives a 'clean' 5V.
-If you don't have a backlight, you can sometimes get
-the needed mA's from the LPT port itself. Connect a few diodes from the
-data pins to a capacitor and you have the 5V. If it's strong enough is
-another question...
-Get it from the keyboard connector. I do not recommend
-to use this with a backlight, as the keyboard connector is often protected
-with a fuse of 100mA or 200mA.
+
+Connect to a 5V line intented for disk drives (the red wire is 5V,
+black is GND).
+
+
+Get it from a joystick port (pin 1 and 9 are 5V, 4, 5 and 12 are GND).
+It seems that some soundcards can use these lines for communication,
+so if you want to use this first check wether it really gives a 'clean' 5V.
+
+
+If you don't have a backlight, you can sometimes get the needed mA's
+from the LPT port itself. Connect a few diodes from the data pins to
+a capacitor and you have the 5V. If it's strong enough is another question...
+
+
+Get it from the keyboard connector. I do not recommend to use this with
+a backlight, as the keyboard connector is often protected with a fuse
+of 100mA or 200mA.
+
@@ -266,21 +272,48 @@ connected, with X and Y lines connected as show. To be more precise, it
assumes this:
-
If you only need 10 keys, leave the rest away. However, the lcdproc menu is
@@ -359,7 +392,7 @@ LPT Sub-D connector | 4k7 |
___ | b |/
BL pin o------------|___|---+---------|
1k |\
- bc327 |c
+ BC327 |c
| LCD connector
|
+--------o 15 backlight
@@ -373,7 +406,7 @@ The BC327 transistor has the following connections:
_____
| |
- |bc327|
+ |BC327|
|_____|
| | |
| | |
@@ -416,46 +449,46 @@ This is originally based on "lcdtext" (by Matthias Prinke).
(*) on the RW line of the display: this line decides whether the display receives data from the
@@ -640,33 +707,80 @@ connected to this line.
The optional keypad can be connected as follows:
-
The optional backlight wiring should be connected to nSEL, pin 17.
@@ -701,29 +815,67 @@ winamp or ext8bit wirings, because it only sends 4 bits at a time.
The LCD connections are:
-
(*) on the RW line of the display: this line decides whether the display receives data from the
@@ -741,33 +893,80 @@ connections.
The optional keypad can be connected as follows:
-
The backlight wiring should be attached to nSEL, pin 17. Because the portato
@@ -847,7 +1046,6 @@ GND to pin 8 of the IC.
| |
-----------
-
D2 4 o----------------------------------------------------------o 6 EN
D7 9 o----------------------------------------------------------o 6 EN2
@@ -951,20 +1149,33 @@ serialLpt wiring supports a keypad. The 3 wires version supports
7 x 5 = 35 keys.
-
On lines longer than, say a meter, you should buffer the return line(s).
@@ -1160,46 +1371,46 @@ if you want to see Booting... at startup, change the code above to look like thi
; This is where we should insert any little startup LCD messages...
; Print "Booting..." on startup...
- movlw 'B'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw 'o'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw 'o'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw 't'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw 'i'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw 'n'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw 'g'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw '.'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw '.'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
- movlw '.'
- movwf ARG1
- call SendLCDData
- call InitDelay200MS
+ movlw 'B'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw 'o'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw 'o'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw 't'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw 'i'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw 'n'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw 'g'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw '.'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw '.'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
+ movlw '.'
+ movwf ARG1
+ call SendLCDData
+ call InitDelay200MS
]]>
@@ -1229,11 +1440,12 @@ specifying which one (of multiple BWCT LCD devices) is wanted using the
-I2C with Port-Expander
+I2C with Port-Expander
-If you have an I2C port available that is supported by your kernel (through /dev/i2c*),
-you can add a I2C port expander there (PCF8574P in this example).
+If you have an I2C port available that is supported by your kernel
+(through /dev/i2c*), you can add a I2C port expander there
+(PCF8574P in this example).
@@ -1287,7 +1499,7 @@ you can add a I2C port expander there (PCF8574P in this example).
Configuration
-HD44780: Configuration for I2C with port expander
+HD44780: Configuration for I2C with port expander
-Device is the device file for your I2C bus (here /dev/i2c-0).
+Device is the device file for your I2C bus (here /dev/i2c-0).
You have to load the kernel standard module i2c-dev and
the bus driver, but NO i2c chip modules (e.g. pcf8574)!
@@ -1319,7 +1531,7 @@ off the address.
-HD44780: Examples of I2C port expander adresses
+HD44780: Examples of I2C port expander adresses
+
+
+Configuration in LCDd.conf
+
+
+[hd44780]
+
+
+
+
+ Port=
+ PORT
+
+
+ Specify the address of the parallel port the LCD is connected to.
+ Common values for PORT are 0x278,
+ 0x378 and 0x3BC.
+ If not given, the default is 0x378.
+
+
+
+
+
+ ConnectionType=
+
+
+ 4bit
+ 8bit
+ serialLpt
+ winamp
+ picanlcd
+ bwctusb
+ lcdserializer
+ lis2
+ i2c
+
+
+
+
+
+ Select the type of the wiring / display connection.
+
+
+
+
+
+ ConnectionType
+ Wiring / Display Type
+
+
+
+
+ 4bit
+ HD44780 4bit Wiring (default)
+
+
+ 8bit
+ HD44780 8bit Wiring ("lcdtime")
+
+
+ serialLpt
+ HD44780 Serial LPT Wiring
+
+
+ winamp
+ HD44780 8bit Wiring "winamp" Style
+
+
+ picanlcd
+ PIC-an-LCD serial device "picanlcd"
+
+
+ bwctusb
+ BWCT USB device "bwctusb"
+
+
+ lcdserializer
+ LCD serializer "lcdserializer"
+
+
+ lis2
+ LIS2 from VLSystem (http://www.vlsys.co.kr)
+
+
+ i2c
+ LCD driven by PCF8574(A)/PCA9554(A) connected via I2C
+
+
+
+
+
+
+
+ The above table might be outdated, when you read this.
+ If you suspect the table above to be outdated, you might want to have a look at
+ server/drivers/hd44780-drivers.h
+ which contains the actual translation code.
+
+
+
+
+
+
+
+
+ Keypad=
+
+
+ yes
+ no
+
+
+
+
+ Tell whether you have a keypad connected.
+ You may also need to configure the keypad layout further on in this file.
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the initial contrast for the bwctusb connection type.
+ Legal values for CONTRAST are 0 - 1000.
+ If not given, it defaults to 300.
+
+
+
+
+
+ Backlight=
+
+
+ yes
+ no
+
+
+
+
+ Specifiy if you have a switchable backlight.
+
+
+
+
+
+ OutputPort=
+
+
+ yes
+ no
+
+
+
+
+ Tell if you have the additional output port ("bargraph") and you want to
+ be able to control it with the lcdproc OUTPUT command
+
+
+
+
+
+ Lastline=
+
+
+ yes
+ no
+
+
+
+
+ Specifies if the last line is pixel addressable or it controls an
+ underline effect. [default: yes (= pixel addressable); legal: yes, no]
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Specifies the size of the LCD.
+ Default: 20x4
+ In case of multiple combined displays, this should be the total size.
+
+
+
+
+
+ vspan=
+
+ HEIGHT
+ ,…
+
+
+
+ For multiple combined displays: how many lines does each display have.
+ E.g. Vrspan=2,2 means you have two displays and
+ each has two lines.
+
+
+
+
+
+ ExtendedMode=
+
+
+ yes
+ no
+
+
+
+
+ If you have a KS0073 or an other 'almost HD44780-compatible', set this
+ flag to get into extended mode (4-line linear).
+ This flag is NOT the old obsolete Extended option.
+
+
+
+
+
+ DelayMult=
+ DELAY
+
+
+ If your display is slow and cannot keep up with the flow of data from
+ LCDd, garbage can appear on the LCDd. Set this delay factor to 2 or 4
+ to increase the delays. Default: 1.
+
+
+
+
+
+ DelayBus=
+
+
+ yes
+ no
+
+
+
+
+ You can reduce the inserted delays by setting this to no.
+ On fast PCs it is possible your LCD does not respond correctly.
+ Default: yes.
+
+
+
+
+
+ KeyMatrix_4_1=
+ KEY
+
+
+ KeyMatrix_4_2=
+ KEY
+
+
+ KeyMatrix_4_3=
+ KEY
+
+
+ KeyMatrix_4_4=
+ KEY
+
+
+ If you have a keypad you can assign keystrings to the keys.
+ See documentation for used terms and how to wire it.
+ For example to give directly connected key 4 the string "Enter", use:
+ KeyDirect_4=Enter
+ For matrix keys use the X and Y coordinates of the key:
+ KeyMatrix_1_3=Enter
+
+
+
+
+
+
+
+
Configuration
-
-Since LCDproc 0.4.3 the HD44780 driver can be configured from the configfile.
-
-
-
-The [HD44780] section is more or less self-explanatory. Yet, a list of the
-possible connection types has proved useful. The following table should make
-it clear, how the ConnectionType is to be set.
-
-
-
-
-
-
-The above table might be outdated, when you read this.
-If you suspect this is the case, you might want to have a look at server/drivers/hd44780-drivers.h
-which contains the actual translation code.
-
-
-
@@ -1462,5 +1901,10 @@ Converted to docbook March 2002, Rene Wagner reenoo@gmx.de
Updated April 2002, Rene Wagner reenoo@gmx.de
+
+Updated and extended April 200r62, Peter Marschall peter@adpm.de
+
+
+
diff --git a/docs/lcdproc-user/drivers/icp_a106.docbook b/docs/lcdproc-user/drivers/icp_a106.docbook
new file mode 100644
index 0000000..79b3b6d
--- /dev/null
+++ b/docs/lcdproc-user/drivers/icp_a106.docbook
@@ -0,0 +1,31 @@
+
+The icp_a106 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+icp_a106 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[icp_a106]
+
+
+
+
+ Device=
+ DEVICE
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/imon.docbook b/docs/lcdproc-user/drivers/imon.docbook
new file mode 100644
index 0000000..1c646af
--- /dev/null
+++ b/docs/lcdproc-user/drivers/imon.docbook
@@ -0,0 +1,72 @@
+
+The imon Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+imon chipset.
+
+
+
+General
+
+Driver for Soundgraph/Ahanix/Silverstone/Uneed/Accent iMON IR/VFD Module
+
+
+In order to be able to use it, you have to get and install one of
+the following kernel modules:
+ - standalone iMON VFD driver from http://venky.ws/projects/imon/
+ - the iMON module included with LIRC ver. 0.7.1 or newer
+ from http://www.lirc.org/
+
+
+
+Adjust the 'Device' key in the [imon] section of /etc/LCDd.conf as
+necessary, depending on what device is file created by the kernel module
+when loaded (this may depend on your system configuration).
+
+
+
+For further details, please consult the page and the forum at
+.
+
+
+
+
+
+
+Configuration in LCDd.conf
+
+
+[imon]
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ set display size [default: 20x4]
+
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/irman.docbook b/docs/lcdproc-user/drivers/irman.docbook
new file mode 100644
index 0000000..bbf8a6e
--- /dev/null
+++ b/docs/lcdproc-user/drivers/irman.docbook
@@ -0,0 +1,162 @@
+
+The irman Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+irman chipset.
+
+
+
+Connections
+
+
+
+
+Hello,
+
+I made a IRman input driver for lcdproc-0.4 wich is now include in
+"lcdproc-0.4-pre6". This input driver require "libirman-0.4.1b" the
+library with function support for IRman.
+
+I want to help you use this new driver (if anybody other than me use
+it... please tell me!!!).
+
+In order to help you compile your own version of LCDd with support for
+IRman, I recorded every step I took in order to compile my own copy
+based on two file downloaded directly from the internet.
+
+The first file is " lcdproc-0.4-pre6.tar.gz " the current version of
+lcdproc. You can download this file from
+"http://lcdproc.omnipotent.net/download.php3" The second file is
+"libirman-0.4.1b.tar.gz" the current version of libirman. You can
+download this file from http://www.evation.com/libirman/ DO NOT USE
+THE COPY OF LIBIRMAN FROM LCDPROC HOME PAGE... I don't know what is
+wrong with that one but I can't decompress it???
+
+How to compile lcdproc for use with support for IRman:
+
+-Untar lcdproc and libirman:
+ tar -xzvf lcdproc-0.4-pre6.tgz
+ tar -xzvf libirman$$$
+-Go, configure and compile libirman:
+ cd libirman-0.4.1b/
+ ./configure
+ make
+ cd ..
+-Go in lcdproc directory:
+ cd lcdproc-0.4-pre6
+-Here is the modification you need to include IRman driver in lcdproc:
+ edit Makefile.config
+ # Irman input... handy!
+ DRIVERS += -DIRMANIN_DRV
+ DOBJ += irmanin.o ../../../libirman-0.4.1b/libirman.a
+ IRMAN=1
+-Compile lcdproc
+ make
+-Make sure you have a network interface up and working:
+ ifup lo
+-Go and install your IRman configuration file:
+ cd server
+ cd drivers
+ cp DOTirmanrc ~/.irmanrc
+-Modify if needed (if you use another remote control) the .irmanrc file.
+-Run LCDd with two driver, irmanin and an output driver:
+ ./LCDd -d irmanin "-d /dev/ttyS0" -d curses
+-Try to access the menu by pressing the remote control.
+
+Now if it does not work:
+· Try your IRMAN on ttyS0 alone (with other software).
+· Try LCDd without the IrmanIN driver.
+· ...
+
+
+David
+GLAUDE
+dglaude@comtech.be
+
+
+PS: If you really have successfuly made LCDd working without IRman AND
+You have successfuly made IRman device working AND you don't succeed
+to make it work together ussing my driver... then maybe I can help and
+give you some support (as time permit and if it does not eat up too
+much bandwidth).
+
+
+The keys are mapped according to the following table:
+
+
+Mapping between LCDproc keys and IrMan commands
+
+
+
+ LCDproc key
+ IrMan command
+
+
+
+
+ Up
+ lcdproc-Up
+
+
+ Down
+ lcdproc-Down
+
+
+ Left
+ lcdproc-Left
+
+
+ Right
+ lcdproc-Right
+
+
+ Enter
+ lcdproc-Enter
+
+
+ Escape
+ lcdproc-Escape
+
+
+
+
+
+
+
+
+Configuration in LCDd.conf
+
+
+[IrMan]
+
+If in trouble with IrMan, try Lirc emulator for IrMan.
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the input device to use, e.g. /dev/irman.
+ default: none
+
+
+
+
+
+ Config=
+ FILENAME
+
+
+ Select the IrMan configuration file to use, e.g. /etc/irman.cfg.
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/joy.docbook b/docs/lcdproc-user/drivers/joy.docbook
new file mode 100644
index 0000000..8136811
--- /dev/null
+++ b/docs/lcdproc-user/drivers/joy.docbook
@@ -0,0 +1,51 @@
+
+The Joystick Input Driver
+
+
+This section covers the joystick input driver for LCDd.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[joy]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the input device to use [default: /dev/js0]
+
+
+
+
+
+ AxisMap=
+ MAP-LIST
+
+
+ Modify the axis mapa [default: EFGHIJKLMNOPQRST]
+
+
+
+
+
+ ButtonMap=
+ MAP-LIST
+
+
+ Modify the button map [default: BDACEFGHIJKLMNOP]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/lb216.docbook b/docs/lcdproc-user/drivers/lb216.docbook
new file mode 100644
index 0000000..d74e2af
--- /dev/null
+++ b/docs/lcdproc-user/drivers/lb216.docbook
@@ -0,0 +1,95 @@
+
+The lb216 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+lb216 chipset.
+
+
+
+Connections
+
+
+
+Chris
+Debenham
+eSun Systems Engineer
+chris.debenham@aus.sun.com
+
+
+Heres a bit more info on the display.
+It is the LB216 and is made by R.T.N. Australia
+The web page for it is http://www.nollet.com.au/
+It is a serial 16x2 LCD with software controllable backlight.
+They also make 40x4 displays (which I'll be getting one of soon :-) )
+3 wire connection (5V,0V and serial), 2400 or 9600 bps.
+8 custom characters
+40*83.5MM size
+made in australia :-)
+
+
+
+
+Configuration in LCDd.conf
+
+
+[lb216]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Set the initial brightness [default: 255; legal: 0 - 255]
+
+
+
+
+
+ Speed=
+
+
+ 2400
+ 9600
+
+
+
+
+ Set the the baud rate to use when communicating with the LCD.
+ If not given, the default is 9600.
+
+
+
+
+
+ Reboot=
+
+
+ yes
+ no
+
+
+
+
+ Reinitialize the LCD's BIOS [default: no; legal: yes, no]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/lcdm001.docbook b/docs/lcdproc-user/drivers/lcdm001.docbook
new file mode 100644
index 0000000..6a357bd
--- /dev/null
+++ b/docs/lcdproc-user/drivers/lcdm001.docbook
@@ -0,0 +1,94 @@
+
+The lcdm001 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+lcdm001 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[lcdm001]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Default: /dev/lcd
+
+
+
+
+
+ PauseKey=LeftKey
+ KEY
+
+
+ BackKey=UpKey
+ KEY
+
+
+ ForwardKey=DownKey
+ KEY
+
+
+ MainMenuKey=RightKey
+ KEY
+
+
+
+ keypad settings
+
+
+
+
+
+ key name
+ function (normal context)
+ function (menu context)
+
+
+
+
+ PauseKey
+ Pause/Continue
+ Enter/select
+
+
+ BackKey
+ Back(Go to previous screen)
+ Up/Left
+
+
+ ForwardKey
+ Forward(Go to next screen)
+ Down/Right
+
+
+ MainMenuKey
+ Open main menu
+ Exit/Cancel
+
+
+
+
+
+ You can rearrange the settings here.
+
+
+
+
+
+ If your device is broken, have a look at server/drivers/lcdm001.h
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/lcterm.docbook b/docs/lcdproc-user/drivers/lcterm.docbook
new file mode 100644
index 0000000..a7abd0c
--- /dev/null
+++ b/docs/lcdproc-user/drivers/lcterm.docbook
@@ -0,0 +1,46 @@
+
+The lcterm Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+lcterm chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[lcterm]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Default: /dev/lcd
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ 16x2
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/lircin.docbook b/docs/lcdproc-user/drivers/lircin.docbook
index 2a1ed19..c8018cc 100644
--- a/docs/lcdproc-user/drivers/lircin.docbook
+++ b/docs/lcdproc-user/drivers/lircin.docbook
@@ -111,6 +111,53 @@ The prog=... line must be the same as in your ~/.lircrc
+
+
+Configuration in LCDd.conf
+
+
+[lirc]
+
+
+
+
+ lircrc=
+ FILENAME
+
+
+
+ Normally all LIRC clients scan the file ~/.lircrc.
+ However, you might want to have a separate file to configure the LCDproc lircin driver only.
+
+
+ This option enables you to specify the file you want the lircin driver to scan.
+ If not given it defaults to ~/.lircrc.
+
+
+
+
+
+
+ Prog=
+ PROGRAM
+
+
+
+ All LIRC keys are assigned to a program using the prog=... option
+ in the lirc configuration file.
+
+
+ PROGRAM must be the same as in iyour lirc
+ configuration file.
+
+
+
+
+
+
+
+
+
@@ -128,31 +175,44 @@ lines to the file:
-~/.lircrc: Specify the keys for the lircin driver
+~/.lircrc: Specify the associations from buttons to keysi
+for the lircin driver
begin
prog = lcdd
button = 2
- config = A
+ config = Up
end
begin
prog = lcdd
button = 4
- config = B
+ config = Left
end
begin
prog = lcdd
button = 6
- config = C
+ config = Right
end
begin
prog = lcdd
button = 8
- config = D
+ config = Down
+end
+
+begin
+ prog = lcdd
+ button = 1
+ config = Escape
+end
+
+begin
+ prog = lcdd
+ button = 0
+ config = Enter
end
@@ -161,7 +221,18 @@ end
Which buttons you specify here depends on your RC and your LIRC configuration.
-Anyways, config=A/B/C/D is neccessary to control the server menu of LCDd.
+
+
+
+The config values need to be one of Up,
+Down, Left, Right,
+Escape or Enter.
+For LCDd's server menu at least the keys Up, Escape
+and Enter are necessary.
+
+
+
+
Of course you can define other keys. Those keys will not be handled by the
server but sent to a client. Refer to the documentation of the client you want
to use, to find out which keys are neccessary for that client.
diff --git a/docs/lcdproc-user/drivers/ms6931.docbook b/docs/lcdproc-user/drivers/ms6931.docbook
new file mode 100644
index 0000000..3251a8b
--- /dev/null
+++ b/docs/lcdproc-user/drivers/ms6931.docbook
@@ -0,0 +1,46 @@
+
+The ms6931 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+ms6931 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[ms6931]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ device to use [default: /dev/ttyS1]
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ display size [default: 16x2]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/mtc_s16209x.docbook b/docs/lcdproc-user/drivers/mtc_s16209x.docbook
new file mode 100644
index 0000000..31b3528
--- /dev/null
+++ b/docs/lcdproc-user/drivers/mtc_s16209x.docbook
@@ -0,0 +1,57 @@
+
+The mtc_s16209x Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+mtc_s16209x chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[mtc_s16209x]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Set the initial brightness [default: 255; legal: 0 - 255]
+
+
+
+
+
+ Reboot=
+
+
+ yes
+ no
+
+
+
+
+ Reinitialize the LCD's BIOS [default: no; legal: yes, no]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/mtxorb.docbook b/docs/lcdproc-user/drivers/mtxorb.docbook
index ba4484e..f9010c9 100644
--- a/docs/lcdproc-user/drivers/mtxorb.docbook
+++ b/docs/lcdproc-user/drivers/mtxorb.docbook
@@ -218,4 +218,166 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
+
+
+Configuration in LCDd.conf
+
+
+[MtxOrb]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Set the display size [default: 20x4]
+
+
+
+
+
+ Backlight=
+
+
+ yes
+ no
+
+
+
+
+ Switch on the backlight? [default: yes]
+
+
+ The driver will ignore this setting if the display
+ is a VFD or VKD as they crash if the backlight is turned off.
+
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the initial contrast.
+ Legal values for CONTRAST are 0 - 1000.
+ If not given, the default value is 480.
+
+
+ The driver will ignore this setting if the display
+ is a VFD or VKD as they do not support this feature.
+
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+
+
+
+
+ Set the the baud rate to use when communicating with the LCD.
+ If not specified, it defaults to 19200.
+
+
+
+
+
+ Type=
+
+
+ lcd
+ lkd
+ vfd
+ vkd
+
+
+
+
+ Set the display type [default: lcd; legal: lcd, lkd, vfd, vkd]
+
+
+
+
+
+ LeftKey=
+ MTX-KEY
+
+
+ RightKey=
+ MTX-KEY
+
+
+ EnterKey=
+ MTX-KEY
+
+
+ UpKey=
+ MTX-KEY
+
+
+ DownKey=
+ MTX-KEY
+
+
+ EscapeKey=
+ MTX-KEY
+
+
+ The following table translate from MtxOrb Key to Logical Key.
+ See [input] section for an explanation of the key mappings
+ This is a new implementation in 0.5
+ Legal values for MTX-KEY are the letters
+ A - F.
+
+
+
+
+
+ keypad_test_mode=
+
+
+ yes
+ no
+
+
+
+
+ You can find out which key of your display sends which
+ character by setting keypad_test_mode to yes and running
+ LCDd. LCDd will output all characters it receives.
+ Afterwards you can modify the settings above and set
+ keypad_set_mode to no again.
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/pylcd.docbook b/docs/lcdproc-user/drivers/pylcd.docbook
new file mode 100644
index 0000000..109df2c
--- /dev/null
+++ b/docs/lcdproc-user/drivers/pylcd.docbook
@@ -0,0 +1,109 @@
+
+The pylcd Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+pylcd chipset.
+
+
+
+Connections
+
+
+
+
+
+LED output
+
+
+I've added support for the LEDs on the Pyramid LC-Display to the
+pylcd driver of lcdproc.
+
+
+
+Since it seems that LEDs on an LCD are not directly supported by the
+lcdproc API I've used the "output" command of the server to trigger the
+LEDs, similar to what the IOWarrior driver does.
+
+
+
+The Pyramid LC-Display exists in two different versions, with 3 and with
+9 LEDs. 2 of these LEDs can not be controlled by software but are
+usually hard wired to power and HDD. The other 1 or 7 LEDs can now be
+controlled by sending an "output" command to the server. The one
+argument to the output command is a bitmask that controls the LEDs.
+
+
+
+bit 0: LED3
+bit 1: LED4
+bit 2: LED5
+bit 3: LED6
+bit 4: LED7
+bit 5: LED8
+bit 6: LED9
+
+
+
+There's no way of finding out whether 3 or 9 LEDs are available, so it
+is up to the software to do the right thing.
+
+
+
+How to use the LCED output from the lcient
+
+telnet localhost 13666
+hello
+output 67
+
+
+will light up LEDs 3, 4 and 9.
+
+
+output 0
+
+
+will clear all LEDs.
+
+
+
+More information on the Pyramid LC-Display can be found here:
+
+
+
+
+
+Author
+
+ Stefan
+ Reinauer
+
+
+coresystems GmbH · Brahmsstr. 16 · D-79104 Freiburg i. Br.
+Tel.: +49 761 7668825 · Fax: +49 761 7664613
+Email: info@coresystems.de · http://www.coresystems.de/
+
+
+
+Configuration in LCDd.conf
+
+
+[pylcd]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Device to connect to. Default: /dev/lcd
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/sed1330.docbook b/docs/lcdproc-user/drivers/sed1330.docbook
new file mode 100644
index 0000000..86029c3
--- /dev/null
+++ b/docs/lcdproc-user/drivers/sed1330.docbook
@@ -0,0 +1,58 @@
+
+The sed1330 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+sed1330 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[sed1330]
+
+
+
+
+ Port=
+ PORT
+
+
+ Specify the address of the parallel port the LCD is connected to.
+ Common values for PORT are 0x278,
+ 0x378 and 0x3BC.
+ If not given, it defaults to 0x278.
+
+
+
+
+
+ Type=
+
+
+ G321D
+ G121C
+ G242C
+ G191D
+ G2446
+
+
+
+
+
+ Type of LCD module.
+
+
+ The G321D is the only one that is tested currently.
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/sed1520.docbook b/docs/lcdproc-user/drivers/sed1520.docbook
new file mode 100644
index 0000000..63a24cc
--- /dev/null
+++ b/docs/lcdproc-user/drivers/sed1520.docbook
@@ -0,0 +1,35 @@
+
+The sed1520 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+sed1520 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[sed1520]
+
+
+
+
+ Port=
+ PORT
+
+
+ Specify the address of the parallel port the LCD is connected to.
+ Common values for PORT are 0x278,
+ 0x378 and 0x3BC.
+ The default value is 0x378.
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/serialVFD.docbook b/docs/lcdproc-user/drivers/serialVFD.docbook
new file mode 100644
index 0000000..dbe816c
--- /dev/null
+++ b/docs/lcdproc-user/drivers/serialVFD.docbook
@@ -0,0 +1,307 @@
+
+The serialVFD Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+serialVFD chipset.
+
+
+
+Connections
+
+
+The serialVFD-driver should work with all NEC FIPC8367 based VFDs:
+NEC FC20X2JA
+NEC FM20X2KB-AB
+NEC FC20X1SA-AB/AA
+...
+Tested only on: NEC FM20X2KB-AB
+The driver also works (tested) on "KD Rev 2.1" (an ATMEL AT90S....
+based FM20X2KB-AB replacement).
+Note: Above char. 128 the FIPC-displays and KD's charactersets
+are different.
+
+The driver may work or will be easy to get working on the following
+Displays / Controllers (not tested!).
+
+
+
+... or compatible.
+(most Futaba/Noritake 7x5 dot VFDs with serial(rs232) interface
+(including serial(rs232)/parallel types))
+
+
+Maybe there are little changes in the commands to do to get all
+functions to work correctly. But because of the similarity of the
+protocols, it wont be much work.
+
+
+
+If you want to add a new device to the driver add a new section
+to the displaytype-switch-case in the init-function and fill it
+with the correct commands for the display.
+(Try which displaytype works best with your display, copy and modify
+it's section that is the easiest way I guess.)
+
+
+
+On this page you may find pictures and datasheets of the VFDs:
+
+
+
+
+It is possible to switch the display off and back on while the server is
+running. It may take a few minutes until the next full refresh makes
+the display show everything correctly.
+
+
+
+To enable the bignumbers on 2-line displays (only this driver supports
+this yet) you have to edit clients/lcdproc/chrono.c
+before compiling.
+In function big_clock_screen you have to replace the
+4 by a 2 in this line:
+if (lcd_hgt < 4)
+
+
+
+This driver uses the serial mode of the displays.
+It is NOT possible to connect most of the displays directly to the
+serialport. The signal has to be inverted. I use the following
+circuit to do that job.
+
+
+
+serialVFD: Connecting the display
+
+- A*
+ | E| |
+ | | |
+5(GND) --------o----------o----o----------------- GND
+
+Shield ------------------------------------------
+optional
+
+*connect near display
+]]>
+
+
+
+The pins on the different displays vary.
+
+
+FM20X2KB-AB:
+
+CN1:
+Pin 33 <--- RxD
+(Testmode: connect pins 25 and 26, then power up)
+
+CN2:
+Pin 1 <--- +5V
+Pin 2 <--- GND
+
+
+
+KD Rev 2.1:
+
+blue connector (6pin in a row) (the important one!):
+
+
+
+
+
+
+
+ Hold the display in that position where you can read
+ the "KD Rev 2.1" marking normally!
+
+
+
+gray connector (10pin 2 rows):
+Do not use. (the ATMEL ISP connector I guess)
+
+The two jumpers next to the gray connector:
+Normally not used.
+You can activate two different testmodes with them.
+
+
+
+
+
+Configuration in LCDd.conf
+
+
+[serialVFD]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Device where the VFD is. Usual values are /dev/ttyS0 and /dev/ttyS1
+ Default: /dev/lcd
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Specifies the size of the VFD.
+ default: 20x2
+
+
+
+
+
+ Type=
+ CODE
+
+
+
+ Specifies the display type.[default: 0]
+ The following type codes are available:
+
+
+
+
+
+ CODE
+ VFD model
+
+
+
+
+ 0
+ NEC (FIPC8367 based) VFDs
+
+
+ 1
+ KD Rev 2.1
+
+
+ 2
+ Noritake VFDs
+
+
+ 3
+ Futaba VFDs
+
+
+
+
+
+ Options 3 and 4 should work, but have not been tested yet. Feedback is welcome.
+
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Display brightness [default: 255].
+ 0 min ... 255 max ... 1000 also max
+ (4 steps 0-64, 65-128, 129-192, 193-1000)
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+ 115200
+
+
+
+
+ Set the the baud rate communication with the VFD.
+ If not given, it defaults to 9600.
+
+
+
+
+
+ ISO_8859_1=
+
+
+ yes
+ no
+
+
+
+
+ Enable ISO-8859-1 compatibility. Ddefault is yes.
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/sli.docbook b/docs/lcdproc-user/drivers/sli.docbook
new file mode 100644
index 0000000..fdf4821
--- /dev/null
+++ b/docs/lcdproc-user/drivers/sli.docbook
@@ -0,0 +1,53 @@
+
+The sli Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+sli chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[Wirz-sli]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+
+
+
+
+
+ Speed=
+
+
+ 1200
+ 2400
+ 9600
+ 19200
+ 38400
+ 57600
+ 115200
+
+
+
+
+ Set the the baud rate communication with the LCD.
+ If not specified, the default is 19200.
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/stv5730.docbook b/docs/lcdproc-user/drivers/stv5730.docbook
new file mode 100644
index 0000000..5c01e0d
--- /dev/null
+++ b/docs/lcdproc-user/drivers/stv5730.docbook
@@ -0,0 +1,35 @@
+
+The stv5730 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+stv5730 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[stv5730]
+
+
+
+
+ Port=
+ PORT
+
+
+ Specify the address of the parallel port the LCD is connected to.
+ Common values for PORT are 0x278,
+ 0x378 and 0x3BC.
+ If not given, it defaults to 0x378.
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/svga.docbook b/docs/lcdproc-user/drivers/svga.docbook
new file mode 100644
index 0000000..9e61b22
--- /dev/null
+++ b/docs/lcdproc-user/drivers/svga.docbook
@@ -0,0 +1,87 @@
+
+The svga Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+svga chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[svga]
+
+
+
+
+ Mode=
+ SCGALIB-MODE
+
+
+ svgalib mode to use [default: G320x240x256]
+ SCGALIB-MODE can be any legal mode string for svgalib.
+ See the cwsvgalib
+ 7 manual page for legal mode strings.
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ set display size [default: 20x4]
+
+
+
+
+
+ Contrast=
+ CONTRAST
+
+
+ Set the initial contrast.
+ Legal values for CONTRAST are 0 - 1000.
+ If not given, the default value is 500.
+
+
+ This parameter can be set but it does not change anything in the driver.
+
+
+
+
+
+
+ Brightness=
+ BRIGHTNESS
+
+
+ Set the initial brightness [default: 1000; legal: 1 - 1000]
+
+
+
+
+
+ OffBrightness=
+ BRIGHTNESS
+
+
+ Set the initial off-brightness [default: 500; legal: 1 - 1000]
+ This value is used when the display is normally
+ switched off in case LCDd is inactive
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/t6963.docbook b/docs/lcdproc-user/drivers/t6963.docbook
index aa57e5a..ea432f7 100644
--- a/docs/lcdproc-user/drivers/t6963.docbook
+++ b/docs/lcdproc-user/drivers/t6963.docbook
@@ -3,7 +3,7 @@
This section talks about using LCDproc with LCD displays that use the
-T6963 chipset. Usually, this chipset is used on big character LCD
+T6963 chipset from Toshiba. Usually, this chipset is used on big character LCD
displays that can often act as a screen.
@@ -13,42 +13,42 @@ displays that can often act as a screen.
@@ -65,41 +65,74 @@ can be done by specifying "--enable-drivers=all" or by
-
-Configuration
+
+
+Configuration in LCDd.conf
-
-Since LCDproc 0.4.3 the T6963 driver must be configured from the configfile (LCDd.conf).
-
+
+[t6963]
-
-At the time of writing, the T6369 driver uses the Arguments option for its
-configuration. This will be parsed as if is was passed as argument to a program.
-
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ set display size [default: 20x6]
+
+
-
-Arguments
-
-
-
--p --port
-Select the output port to use [0x378]
-
-
-
-
--t --type
-Select the LCD type (size) [20x6]
-
-
-
-
+
+
+ Port=
+ PORT
+
+
+ Specify the address of the parallel port the LCD is connected to.
+ Common values for PORT are 0x278,
+ 0x378 and 0x3BC.
+ Legal values are 0x200 - 0x400.
+ If not given the default value is 0x378.
+
+
-
-
-An example configuration could look like this: Arguments="--port 0x378 --type=20x6"
-
-
+
+
+ ECPlpt=
+
+
+ yes
+ no
+
+
+
+
+ Is ECP mode on? [default: yes; legal: yes, no]
+
+
+
+
+
+ graphic=
+
+
+ yes
+ no
+
+
+
+
+ Use graphic? [default: no; legal: yes, no]
+
+
+
+
+
@@ -114,15 +147,19 @@ detailed instructions on how to configure the T6963 driver.
Then as usual, start LCDd with the correct config file:
+
E.g. LCDd -c ./LCDd.conf
+
If you want to override the driver selection in LCDd.conf then use:
+
LCDd -c ./LCDd.conf -d T6963
+
If you use this, the T6963 driver will read the options from the config
file anyway.
diff --git a/docs/lcdproc-user/drivers/text.docbook b/docs/lcdproc-user/drivers/text.docbook
new file mode 100644
index 0000000..adc6d29
--- /dev/null
+++ b/docs/lcdproc-user/drivers/text.docbook
@@ -0,0 +1,36 @@
+
+The text Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+text chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[text]
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Set the display size [default: 20x4]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/tyan.docbook b/docs/lcdproc-user/drivers/tyan.docbook
new file mode 100644
index 0000000..130f5f4
--- /dev/null
+++ b/docs/lcdproc-user/drivers/tyan.docbook
@@ -0,0 +1,62 @@
+
+The tyan Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+tyan chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[tyan]
+
+
+
+
+ Device=
+ DEVICE
+
+
+ Select the output device to use [default: /dev/lcd]
+
+
+
+
+
+ Speed=
+
+
+ 4800
+ 9600
+
+
+
+
+ Set the the baud rate communication with the LCD.
+ If not given, the default is 9600.
+
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ set display size [default: 16x2]
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/ula200.docbook b/docs/lcdproc-user/drivers/ula200.docbook
new file mode 100644
index 0000000..4d3e95b
--- /dev/null
+++ b/docs/lcdproc-user/drivers/ula200.docbook
@@ -0,0 +1,110 @@
+
+The ula200 Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+ula200 chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[ula200]
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ Select the LCD size [default: 20x4]
+
+
+
+
+
+ KeyMap_A=
+ KEY
+
+
+ KeyMap_B=
+ KEY
+
+
+ KeyMap_C=
+ KEY
+
+
+ KeyMap_D=
+ KEY
+
+
+ KeyMap_E=
+ KEY
+
+
+ KeyMap_F=
+ KEY
+
+
+ If you have a non standard keypad you can associate any keystrings to keys.
+ There are 6 input key in the CwLnx hardware that generate characters
+ from 'A' to 'F'.
+ Legal values for KEY are Up,
+ Down, Left, Right,
+ Enter and Escape.
+
+
+ The following it the built-in default mapping hardcoded in the driver.
+
+
+
+
+
+ KeyMap_A
+ Up
+
+
+ KeyMap_B
+ Down
+
+
+ KeyMap_C
+ Left
+
+
+ KeyMap_D
+ Right
+
+
+ KeyMap_E
+ Enter
+
+
+ KeyMap_F
+ Escape
+
+
+
+
+
+ You may leave it unchanged if you have a standard keypad.
+ You can change it if you want to report other keystrings or have a non
+ standard keypad.
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/drivers/xosd.docbook b/docs/lcdproc-user/drivers/xosd.docbook
new file mode 100644
index 0000000..01f075c
--- /dev/null
+++ b/docs/lcdproc-user/drivers/xosd.docbook
@@ -0,0 +1,46 @@
+
+The xosd Driver
+
+
+This section talks about using LCDproc with LCD displays that use the
+xosd chipset.
+
+
+
+
+Configuration in LCDd.conf
+
+
+[xosd]
+
+
+
+
+ Size=
+
+ WIDTH
+ x
+ HEIGHT
+
+
+
+ set display size [default: 20x4]
+
+
+
+
+
+ Font=
+ FONT
+
+
+ font to use, e.g. -*-terminus-*-r-*-*-*-320-*-*-*-*-*.
+
+
+
+
+
+
+
+
+
diff --git a/docs/lcdproc-user/lcdproc-user.docbook b/docs/lcdproc-user/lcdproc-user.docbook
index 7e4129b..48b70ef 100644
--- a/docs/lcdproc-user/lcdproc-user.docbook
+++ b/docs/lcdproc-user/lcdproc-user.docbook
@@ -11,11 +11,42 @@
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
]>