From b0a8da6079c651e569b18929230312c5a586c9d8 Mon Sep 17 00:00:00 2001 From: mmdolze Date: Sun, 23 Jan 2011 14:07:41 +0000 Subject: [PATCH] Document missing or new settings for picoLCD driver. --- LCDd.conf | 11 +++- docs/lcdproc-user/drivers/picolcd.docbook | 63 +++++++++++++++-------- 2 files changed, 52 insertions(+), 22 deletions(-) diff --git a/LCDd.conf b/LCDd.conf index 1874616..622609f 100644 --- a/LCDd.conf +++ b/LCDd.conf @@ -871,9 +871,18 @@ Reboot=no # and a balanced value. [default: 500; legal: 0 - 1000] KeyTimeout=500 -# Set the initial brightness [default: 1000; legal: 0 - 1000] +# Sets the initial state of the backlight upon start-up. +# [default: on; legal: on, off] +#Backlight=on + +# Set the initial brightness [default: 1000; legal: 0 - 1000]. Works only +# with the 20x4 device Brightness=1000 +# Set the brightness while the backlight is 'off' [default: 0; legal: 0 - 1000]. +# Works only with the 20x4 device. +#OffBrightness=0 + # Set the initial contrast [default: 1000; legal: 0 - 1000] Contrast=1000 diff --git a/docs/lcdproc-user/drivers/picolcd.docbook b/docs/lcdproc-user/drivers/picolcd.docbook index e38d211..ddf7ebc 100644 --- a/docs/lcdproc-user/drivers/picolcd.docbook +++ b/docs/lcdproc-user/drivers/picolcd.docbook @@ -2,7 +2,7 @@ The Mini-Box.com USB LCD picoLCD Driver - This section covers the installation and use of the Mini-Box USB LCD displays. + This section covers the use of the Mini-Box USB LCD displays. @@ -19,10 +19,10 @@ PicoLCD 4x20-Sideshow is the desktop variant targeted at end users. - It an external USB 2.0 full speed device that comes in a stylish casing and + It is an external USB 2.0 full speed device that comes in a stylish case and sports a 4 line by 20 character display with white letters - on a blue background, a built-in InfraRed receiver as well as an - keypad with 8 keys labeled Escape, F1, + on a blue background, a built-in InfraRed receiver as well as a + keypad with 8 keys labelled Escape, F1, F2, F3, Home, Up, Down and Enter. @@ -110,12 +110,21 @@ [picolcd] + + + + The Brightness and OffBrightness settings only have an effect on the 20x4 + device. With the 20x2 device the backlight can only be set on (any value + greater than 1000) or off (0). + + + Backlight = ¶meters.yesdefno; - Turns the backlight on or off, default yes. + Turns the backlight on or off on start-up, default yes. @@ -126,9 +135,23 @@ - Set the initial brightness. - Legal values are: 0 - 1000. - If not given, it defaults to 1000. + Set the initial brightness if the backlight is on. Legal values are: + 0 - 1000. If not given, it defaults + to 1000. + + + + + + + OffBrightness = + OFFBRIGHTNESS + + + + Set the initial value for the backlight if it is off. Legal values are: + 0 - 1000. If not given, it defaults + to 0. @@ -139,9 +162,8 @@ CONTRAST - Contrast: 0-1000. - 0 is visible, and 1000 is not on my M300. - Default is 1000. + Contrast: 0-1000, default to + 1000 (full contrast). @@ -151,6 +173,8 @@ Allow key LEDs to be turned on or off. Default is yes. + This setting affects all keys. If set to on each key + can be disabled independently by setting KeyXLight below. @@ -220,11 +244,12 @@ DURATION - (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 + This value controls how long LCDd waits for a key press when + get_key() is called. The value represents milliseconds 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. - Lparameterer values make key presses more reliable if somewhat slow to take effect. + Large values make key presses more reliable but may slow down LCDd. Values + in the range 0-1000 (1s) are allowed. @@ -272,7 +297,7 @@ This value is the length in jiffies (1/16384 seconds) of the synthesized sync space that will trigger sending the queued IR data to LIRC. Values up to 32767 (2s) are permitted, values lower than 16 will suppress the flushing IR data during processing. The default is - 100 jiffies (6.1ms). It's should only be needed to change this value when + 100 jiffies (6.1ms). It's should only be needed to change this value when lircd.conf has a gap < 6100 or the samples > 6300. @@ -288,12 +313,12 @@ The hardware also reports key-up events. Normally this would be of no issue (they are - usually a 0 or 'no key') except that when keys are used in combonation, the key-up + usually a 0 or 'no key') except that when keys are used in combination, the key-up event may actually come back as multiple events depending on how the user released the keys. If the key-up event for a multiple key press comes back as two events, the first up event will actually look like a new key press. The algorithm in get_key tries to deal with this in a sane way and toss out all key-up events for now. The hardware is - touchy and both combo key-down and key-up actions may be reported as mutiple events if + touchy and both combo key-down and key-up actions may be reported as multiple events if the user is more than a tenth of a second (maybe less?) off in motions. @@ -312,10 +337,6 @@ to feed it a template configuration containing sync and gap data. - - This code could therefore use more testing, more research, and more work. - -