From ca3745d75fbf448e359522e691e0090273890a01 Mon Sep 17 00:00:00 2001 From: marschap Date: Sun, 28 Oct 2007 11:19:53 +0000 Subject: [PATCH] update documentation a bit --- docs/lcdproc-user/configuration.docbook | 55 ++++-- docs/lcdproc-user/drivers/hd44780.docbook | 170 ++++++++++++------- docs/lcdproc-user/drivers/picolcd.docbook | 4 +- docs/lcdproc-user/drivers/ppttrouble.docbook | 2 +- docs/lcdproc-user/drivers/sed1330.docbook | 8 +- docs/lcdproc-user/drivers/t6963.docbook | 2 +- docs/lcdproc-user/drivers/xosd.docbook | 2 +- 7 files changed, 151 insertions(+), 92 deletions(-) diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook index 007fc79..334bb70 100644 --- a/docs/lcdproc-user/configuration.docbook +++ b/docs/lcdproc-user/configuration.docbook @@ -599,10 +599,13 @@ input "events". --> -The menu is an LCDproc client built into LCDd. +The menu is a special LCDproc client built into LCDd +that allows changing server and display settings as well as extending it +with entries from client applications. + + + You can configure what keys the menu should use. -Note that the MenuKey will be reserved exclusively, -while the others work in shared mode. @@ -611,12 +614,19 @@ while the others work in shared mode. MenuKey= KEY - - The key that switches into menu mode (=open the main menu). - In menu mode it cancels any operation. Cancelling the main menu - means returning to the regular display mode. - It has no default, but a natural candidate is Menu. - + + + The key that switches into menu mode (=open the main menu). + In menu mode it cancels any operation. Cancelling the main menu + means returning to the regular display mode. + It has no default, but a natural candidate is Menu. + + + The MenuKey will be reserved exclusively, + while the others work in shared mode and can thus be used by a + client application when not in the menu. + + @@ -625,7 +635,13 @@ while the others work in shared mode. KEY - The key to enter a sub menu and/or, to select an entry. + The key to enter a sub menu, to select an entry and/or + to confirm the value of an input field. + If the RightKey is not defined, + it is also used to move right in input fields. + In this case the value of the input field is not confirmed, + until the right end of the input has been reached. + It is not set by default, but a natural candidate is Enter. @@ -636,9 +652,11 @@ while the others work in shared mode. KEY - The key to move to the previous menu item. - If the LeftKey is not set, - it is also used to move left in input fields. + The key to move to the previous item in a menu and/or to select + the previous value in input fields (e.g. the previous character + available for the current position). + If the DownKey is not set, moving up + before the first entry automatically wraps around to the last entry. It is not set by default, but a natural candidate is Up. @@ -649,9 +667,11 @@ while the others work in shared mode. KEY - The key to move to the next menu item. - If the RightKey is not set, - it is also used to move right in input fields. + The key to move to the next item in a menu andi/or to select + the next value in input fields (e.g. the next character available + for the current position). + If the UpKey is not set, moving down + below the last entry automatically wraps around to the first entry. It has no default, but a natural candidate is Down. @@ -683,7 +703,7 @@ while the others work in shared mode. -The keys required for the menu work correctly are the MenuKey, +The minimal keys required for the menu work correctly are the MenuKey, the EnterKey and one of UpKey or DownKey. With these 3 keys the menus can be operated. @@ -693,6 +713,7 @@ Especially the LeftKey and RightKey make a big difference in user experience. + diff --git a/docs/lcdproc-user/drivers/hd44780.docbook b/docs/lcdproc-user/drivers/hd44780.docbook index 6f3ac77..8c78e3c 100644 --- a/docs/lcdproc-user/drivers/hd44780.docbook +++ b/docs/lcdproc-user/drivers/hd44780.docbook @@ -70,12 +70,12 @@ All variants use the same method of obtaining power. i.e., for each LCD: - VSS + VEE 1 GND (connect to any of pins 18 - 25 of you parallel port) - VDD + VCC 2 +5V @@ -100,25 +100,28 @@ 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 the VCC pin of an USB connector. + + + 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. +
@@ -380,7 +383,7 @@ Y3 o---|<---o o---+----o return line If the driver generates keypresses without that you actually press a key, it might be that the unconnected input lines are picking up electromagnetic waves from the air. In that case connect the unconnected - input lines (pin 10, 11, 12, 13 and 15 of the LPT) to VCC = 5V. + input lines (pin 10, 11, 12, 13 and 15 of the LPT) to VCC = 5V. @@ -488,6 +491,48 @@ This is originally based on "lcdtext" (by Matthias Prinke). + + + + GND + VEE + 1 + + + + + +5V + VCC + 2 + + + + + (contrast adjustment) + VLC + 3 + + + D4 + 6 + + RS + 4 + + + + + GND + RW + 5 + + + D6 + 8 + + EN + 6 + D0 2 @@ -507,7 +552,7 @@ This is originally based on "lcdtext" (by Matthias Prinke). 4 D6 - (13) + 13 D3 @@ -516,49 +561,28 @@ This is originally based on "lcdtext" (by Matthias Prinke). D7 14 - - D4 - 6 - - RS - 4 - - - D5 - 7 - - RW - 5 (LCD3 - 6) (optional - pull all LCD RW low (*) ) - - - D6 - 8 - - EN - 6 - - - D7 - 9 - - EN2 - (LCD2 - 6) (optional) - - -(*) on the RW line of the display: this line decides whether the display receives data from the + +The RW (pin 5) line of the display decides whether the display receives data from the LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that you need it otherwise, then connect it to GND. This certainly applies if you have only one display. + + + +The 4bit connection type supports more than one display connected +to the same parallel port. +If you want to connect more than one display, then wire the all the displays to the +parallel port according to the scheme above with the exception of the EN +(pin 6) line of the LCDs. -If you want to connect more than two displays to the parallel port then -wire D5 (pin 7) to the enable line (pin 6) of the third LCD. Then for -displays four to seven use: +For the second and further displays, you can find the wiring for the EN +(pin 6) line in the table below. @@ -583,33 +607,47 @@ displays four to seven use: + + D7 + 9 + + EN2 + 6 of 2nd display + + + D5 + 7 + + EN3 + 6 of 3rd display + STR 1 - EN4 - 6 + EN4 + 6 of 4th display LF 14 - EN5 - 6 + EN5 + 6 of 5th display INIT 16 - EN6 - 6 + EN6 + 6 of 6th display SEL 17 - EN7 - 6 + EN7 + 6 of 7th display @@ -2469,7 +2507,7 @@ This can be done by specifying or by inclu Running -Modify the LCDd.conf file before you run LCDd. In this config file are +Modify the LCDd.conf file before you run LCDd. In this config file are detailed instructions on how to configure the HD44780 driver. @@ -2480,7 +2518,7 @@ 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: +If you want to override the driver selection in LCDd.conf then use: LCDd -c ./LCDd.conf -d HD44780 diff --git a/docs/lcdproc-user/drivers/picolcd.docbook b/docs/lcdproc-user/drivers/picolcd.docbook index e13a0c2..14b365d 100644 --- a/docs/lcdproc-user/drivers/picolcd.docbook +++ b/docs/lcdproc-user/drivers/picolcd.docbook @@ -45,7 +45,7 @@ to the LCDproc ./configure --drivers option (or use all), set the Driver= to picolcd in the LCDd.conf config - file, and then start LCDd either directly or using startup scripts. + file, and then start LCDd either directly or using startup scripts. The driver has sane default options and the options that are user configurable are limited to mostly simple items, like contrast and which keys to light up. @@ -179,7 +179,7 @@ DURATION - (Advanced) This value controls how long LCDd waits for a key press when + (Advanced) This value controls how long LCDd waits for a key press when get_key() is called. The value represents microseconds and the default is 500 or .5 seconds. Lowering this value will make LCDd more responsive but also causes LCDd to use more CPU time and, as the timeout grows shorter, key presses become harder to detect. diff --git a/docs/lcdproc-user/drivers/ppttrouble.docbook b/docs/lcdproc-user/drivers/ppttrouble.docbook index 8f4f5c2..65b2307 100644 --- a/docs/lcdproc-user/drivers/ppttrouble.docbook +++ b/docs/lcdproc-user/drivers/ppttrouble.docbook @@ -42,7 +42,7 @@ thick enough (or not existent, see 1) the resistance of the wire may cause differing GND potentials in the circuit. This may lead to strange display behaviour. It may also be wise to solder a 100nF capacitor directly to the GND and -VDD pins of the display. +VCC pins of the display. diff --git a/docs/lcdproc-user/drivers/sed1330.docbook b/docs/lcdproc-user/drivers/sed1330.docbook index 7d7e3f2..1dd39e3 100644 --- a/docs/lcdproc-user/drivers/sed1330.docbook +++ b/docs/lcdproc-user/drivers/sed1330.docbook @@ -146,14 +146,14 @@ the connections given here are also correct for your display ! D7 - VDD + VCC 16 +5V - VSS + VEE 17 GND 18..25 @@ -368,7 +368,7 @@ the connections given here are also correct for your display ! ^SELECT_IN - VSS + VEE 17 GND 18..25 @@ -403,7 +403,7 @@ the connections given here are also correct for your display ! - VDD + VCC 16 +5V diff --git a/docs/lcdproc-user/drivers/t6963.docbook b/docs/lcdproc-user/drivers/t6963.docbook index ccfc050..c40a704 100644 --- a/docs/lcdproc-user/drivers/t6963.docbook +++ b/docs/lcdproc-user/drivers/t6963.docbook @@ -140,7 +140,7 @@ can be done by specifying "--enable-drivers=all" or by Running -Modify the LCDd.conf file before you run LCDd. In this config file are +Modify the LCDd.conf file before you run LCDd. In this config file are detailed instructions on how to configure the T6963 driver. diff --git a/docs/lcdproc-user/drivers/xosd.docbook b/docs/lcdproc-user/drivers/xosd.docbook index 93fc27a..0afaf80 100644 --- a/docs/lcdproc-user/drivers/xosd.docbook +++ b/docs/lcdproc-user/drivers/xosd.docbook @@ -106,7 +106,7 @@ Offset=200x200 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 + switched off in case LCDd is inactive -->