1LCDd(8) LCDproc suite LCDd(8)
2
6 LCDd - LCDproc server daemon
7
10 LCDd [-hf] [-c config] [-d driver] [-i bool] [-a addr] [-p port] [-u
11 user] [-w time] [-r level] [-s bool]
12
15 LCDd is the server part of LCDproc, a deamon which listens to a certain
16 port (normally 13666) and displays information on an LCD display. It
17 works with several types and sizes of displays.
18 Most settings of LCDd are configured through its configuration file
20 /etc/LCDd.conf, some of them can be overriden using command line
21 options. Before running LCDd you should carefully read through that
22 file and modify everything neccessary according to your needs. Other‐
23 wise you might encounter LCDd not running properly on your system.
24 To make full use of LCDd, a client such as lcdproc(1), lcdexec(1), or
26 lcdvd is required.
27
30 Available options are:
31 -h Display help screen
33 -c config
35 Use a configuration file other than /etc/LCDd.conf
36 -d driver
38 Specify a driver to use (output only to first), overriding the
39 Driver parameter in the config file's [Server] section.
40 -f Run in the foreground, overriding the Foreground parameter in
42 the config file's [Server] section. The default, if not speci‐
43 fied in the config file, is to daemonize LCDd as it is intended
44 to operate in the background.
45 -i bool
47 Tell whether the to enable (1) or disable (0) showing the LCD‐
48 proc server screen in n the screen rotation, overriding Server‐
49 Screen in the config file's [Server] section.
50 -w waittime
52 Time to pause at each screen (in seconds), overriding the Wait‐
53 Time parameter in the config file's [Server] section.
54 -a addr
56 Bind to network address addr, overriding the Bind parameter in
57 the config file's [Server] section.
58 -p port
60 Listen on port port for incoming connections, overriding the
61 Port parameter in the config file's [Server] section.
62 -u user
64 Run as user user, overriding the User parameter in the config
65 file's [Server] section.
66 -s bool
68 Output messages to syslog (1) or to stdout (0), overriding the
69 ReportToSyslog parameter in the config file's [Server] section.
70 -r level
72 Set reporting level to level, overriding th ReportLevel parame‐
73 ter in the config file's [Server] section.
74 SUPPORTED DRIVERS
77 Currently supported display drivers include:
78 bayrad BayRAD LCD modules by EMAC Inc.
80 CFontz CrystalFontz CFA-632 and CFA-634 serial LCD displays
82 CFontz633
84 CrystalFontz CFA-633 serial/USB LCD displays
85 CFontzPacket
87 CrystalFontz CFA-631, CFA-633 and CFA-635 serial/USB LCD dis‐
88 plays
89 curses Standard video display using the (n)curses library
91 CwLnx serial/USB displays by Cwlinux (http://www.cwlinux.com)
93 ea65 VFD front panel display on Aopen XC Cube EA65 media barebone
95 EyeboxOne
97 LCD display on the EyeboxOne (http://www.rightvision.com)
98 g15 LCD display on the Logitech G15 keyboard
100 glcdlib
102 graphical LCDs supported by graphlcd-base
103 glk Matrix Orbital GLK Graphic Displays
105 hd44780
107 Hitachi HD44780 LCD displays. This driver supports the follow‐
108 ing sub-drivers (a.k.a. connection types):
109 4bit LCD 4bit-mode, connected to a PC parallel port
111 8bit LCD 8bit-mode, connected to a PC parallel port
113 serialLpt
115 LCD in 4bit-mode through a 4094 shift register
116 winamp LCD in 8bit-mode using WinAmp-wiring, connected to a PC
118 parallel port
119 picanlcd
121 LCD driven by a PIC-an-LCD chip/board by Dale Wheat, con‐
122 nected to a serial port
123 lcdserializer
125 LCD driven by a PIC16C54-based piggy-back board, con‐
126 nected to a serial port
127 los-panel
129 LCD driven by an Atmel AVR based board, connected to a
130 serial port
131 vdr-lcd
133 ???, connected to a serial port
134 vdr-wakeup
136 VDR-Wake module by Frank Jepsen (http://www.jepsen‐
137 net.de/vdr/)
138 pertelian
140 Pertelian X2040 module (http://pertelian.com/)
141 lis2 LIS2 from VLSystem (http://www.vlsys.co.kr), connected to
143 USB
144 bwctusb
146 USB-to-HD44780 converter by BWCT (http://www.bwct.de)
147 lcd2usb
149 Till Harbaum's open source/open hardware LCD2USB
150 (http://www.harbaum.org/till/lcd2usb/)
151 i2c LCD in 4-bit mode driven by PCF8574(A) / PCA9554(A), con‐
153 nected via I2C bus
154 icp_a106
156 ICP A106 alarm/LCD board in 19" rack cases by ICP
157 imon iMON IR/VFD modules in cases by Soundgraph/Ahanix/Silver‐
159 stone/Uneed/Accent
160 IOWarrior
162 Code Mercenaries IOWarrior
163 irman IrMan infrared (input)
165 joy Joystick driver (input)
167 lb216 LB216 LCD displays
169 lcdm001
171 kernelconcepts.de 20x4 serial LCD displays
172 lcterm serial LCD terminal from Helmut Neumark Elektronik
174 (http://www.neumark.de)
175 lirc Infrared (input)
177 MD8800 VFD displays in Medion MD8800 PCs
179 ms6931 MSI-6931 displays in 1U rack servers by MSI
181 mtc_s16209x
183 MTC_S16209x LCD displays by Microtips Technology Inc
184 MtxOrb Matrix Orbital displays (except Matrix Orbital GLK displays)
186 NoritakeVFD
188 Noritake VFD Device CU20045SCPB-T28A
189 picolcd
191 Mini-box.com USB LCD (picoLCD 20x2)
192 pyramid
194 LCD displays from Pyramid (http://www.pyramid.de)
195 sed1330
197 SED1330/SED1335 (aka S1D13300/S1D13305) based graphical displays
198 sed1520
200 122x32 pixel graphic displays based on SED1520 controllers
201 serialVFD
203 NEC (FIPC8367 based) and FUTABA VFDs
204 sli Wirz SLI driver (unknown)
206 stv5730
208 STV5730A on-screen display chip
209 svga VGA monitors using svgalib
211 t6963 Toshiba T6963 based LCD displays
213 text Standard "hard-copy" text display
215 tyan LCD module in Tyan Barebone GS series
217 ula200 ULA-200 device from ELV (http://www.elv.de)
219 xosd On Screen Display on X11
221 Multiple drivers can be used simultaneously; thus, for example, a
223 Matrix Orbital display (MtxOrb driver) can be combined with an infrared
224 driver (irmanin driver).
225
228 LCDd -d MtxOrb -d joy
229 The invocation example above will start LCDd reading its configuration
230 from the default configuration file /etc/LCDd.conf but overriding the
231 drivers specified therein with the Matrix Orbital driver and the Joy‐
232 stick input driver.
233
236 There is a basic sequence:
237 1. Open a TCP connection to the LCDd server port (usually 13666).
239 2. Say "hello"
241 3. The server will return some information on the type
243 of display available.
244 4. Define (and use) a new screen and its widgets.
246 5. Close the socket when done displaying data.
248 CLIENT COMMANDS
250 There are many commands for the client to send to the LCDd server:
251 hello This starts a client-server session with the LCDd server; the
253 server will return a data string detailing the type of display
254 and its size.
255 client_set -name name
257 Set the client's name.
258 screen_add #id
260 Add a new screen to the display.
261 screen_del #id
263 Remove a screen from the display.
264 screen_set #id [-name name ] [-wid width] [-hgt height] [-priority
266 prio] [-duration int] [-timeout int] [-heartbeat mode] [-backlight
267 mode] [-cursor mode] [-cursor_x xpos] [-cursor_y ypos]
268 Initialize a screen, or reset its data.
269 widget_add #screen #id type [-in #frame]
271 Add a widget of type typeto screen #screen.
272 widget_del #screen #id
274 Delete widget #id from screen #screen.
275 widget_set #screen #id data
277 Set the data used to define a particular widget #id on screen
278 #screen.
279 HEARTBEAT MODES
282 Valid heartbeat mode values (for the screen_set command) are:
283 on Display pulsing heart symbol.
285 off No heartbeat display.
287 open Use client's heartbeat setting. This is the default.
289 BACKLIGHT MODES
292 Valid heartbeat mode values (for the screen_set command) are:
293 on Turn backlight on.
295 off Turn backlight off
297 toggle Turn backlight off when it is on and vice versa.
299 open Use client's backlight setting. This is the default.
301 blink Blinking backlight
303 flash Flashing blacklight
305 Priorities
308 Valid priority settings (used in the screen_set command) are as fol‐
309 lows:
310 input The client is doing interactive input.
312 alert The screen has an important message for the user.
314 foreground
316 an active client
317 info Normal info screen, default priority.
319 background
321 The screen is only visible when no normal info screens exists.
322 hidden The screen will never be visible.
324 For compatibility with older versions of clients a mapping of numeric
326 priority values is also supported:
327 1 - 64 foreground
329 65 - 192
331 normal
332 193 - (infinity)
334 background
335 An example of how to properly use priorities is as follows:
337 Imagine you're making an mp3 player for lcdproc. When the song
339 changes, it's nice to display the new name immediately. So, you could
340 set your screen's priority to foreground, wait for the server to dis‐
341 play (or ignore) your screen, then set the screen back to inormal.
342 This would cause the mp3 screen to show up as soon as the one onscreen
343 was finished, then return to normal priority afterward.
344 Or, let's say your client monitors the health of hospital patients. If
346 one of the patients has a heart attack, you could set the screen prior‐
347 ity to alert, and it would be displayed immediately. It wouldn't even
348 wait for the previous screen to finish. Also, the display would stay
349 on screen most of the time until the user did something about it.
350 WIDGET TYPES
353 Widgets can be any of the following:
354 string A text string to display (as is).
356 hbar A horizontal bar graph.
358 vbar A vertical bar graph.
360 title A title displayed across the top of the display, within a ban‐
362 ner.
363 icon A graphic icon.
365 scroller
367 A scrolling text display, scrolling either horizontally or ver‐
368 tically.
369 frame A container to contain other widgets, permitting them to be ref‐
371 ered to as a single unit. A widget is put inside a frame by
372 using the -in #id parameter, where #id refers to the id of the
373 frame.
374 Widgets are drawn on the screen in the order they are created.
376 SETTING WIDGET DATA
379 In the widget_set command, the data argument depends on which widget is
380 being set. Each widget takes a particular set of arguments which
381 defines its form and behavior:
382 string x y text
384 Displays text at position (x,y).
385 title text
387 Uses text as title to display.
388 hbar x y length
390 Displays a horizontal bar starting at position (x,y) that is
391 length pixels wide.
392 vbar x y length
394 Displays a vertical bar starting at position (x,y) that is
395 length pixels high.
396 icon x y name
398 Displays the icon name at position (x,y).
399 scroller left top right bottom direction speed text
401 The text defined will scroll in the direction defined. Valid
402 directions are h (horizontal) and v (vertical). The speed
403 defines how many "movements" (or changes) will occur per frame.
404 A positive number indicates frames per movement; a negative num‐
405 ber indicates movements per frame.
406 frame left top right bottom wid hgt dir speed
408 Frames define a visible "box" on screen, from the (left, top)
409 corner to the (right, bottom) corner. The actual data may be
410 bigger, and is defined as wid (width) by hgt (height); if it is
411 bigger, then the frame will scroll in the direction (dir) and
412 speed defined.
413 num x int
415 Displays large decimal digit int at the horizontal position x,
416 which is a normal character x coordinate on the display. The
417 special value 10 for int displays a colon.
418
421 If LCDd seems not to work as expected, try to run it in the foreground
422 with reporting level set to maximum and reporting to stderr. This can
423 be achieved without changes to the config file by using the command
424 line:
425 LCDd -f -r 5 -s 0
426
429 /etc/LCDd.conf, LCDd's default configuration file
430
433 lcdproc-config(5), lcdproc(1), lcdexec(1)
434
437 LCDd was originally written by William Ferrell (wwf@splatwerks.org) and
438 Scott Scriven (scriven@cs.colostate.edu).
439 Since that time various people have contributed to LCDproc.
441 The newest version of LCDd should be available from here as part of the
443 lcdproc package:
444 http://www.lcdproc.org/
446
449 The lcdproc package is released as "WorksForMe-Ware". In other words,
450 it is free, kinda neat, and we don't guarantee that it will do anything
451 in particular on any machine except the ones it was developed on.
452 It is technically released under the GNU GPL license (you should have
454 received the file, "COPYING", with LCDproc) (also, look on
455 http://www.fsf.org/ for more information), so you can distribute and
456 use it for free -- but you must make the source code freely available
457 to anyone who wants it.
458 For any sort of real legal information, read the GNU GPL (GNU General
460 Public License). It's worth reading.
461LCDproc 18 September 2006 LCDd(8)