mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- added missing id attributes to tags to avoid xmlto warnings

Browse Source 
- a few re-wordings
- a litte tagging there and there
This commit is contained in:
marschap
2007-04-03 19:38:18 +00:00
parent c109e27930
commit 327ab00298
11 changed files with 273 additions and 223 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-user/configuration.docbook
+1 -1
View File
@@ -19,7 +19,7 @@ your system's package manager list all the files in the <package>LCDproc</packag
</note>
<para>
The format of the <filename>/etc/LCDd.conf</filename> is ini-file-like.
The format of the <filename>/etc/LCDd.conf</filename> is INI-file like.
</para>
<para>
docs/lcdproc-user/drivers/hd44780.docbook
+189 -147
View File
@@ -6,23 +6,28 @@ There are several ways of wiring up the HD44780 devices. Your choice
will probably be governed largely by your ability to wire up each one
and/or a desire to use the device with other programs.
</para>
<para>
The LCDproc HD44780 driver supports the following connections on a
parallel port:
</para>
<itemizedlist>
<listitem><para>4-bit</para></listitem>
<listitem><para>8-bit (winamp style)</para></listitem>
<listitem><para>extended 8-bit (LCD + LED bargraph)</para></listitem>
<listitem><para>serial LPT</para></listitem>
<listitem><para>4-bit</para></listitem>
<listitem><para>8-bit (winamp style)</para></listitem>
<listitem><para>extended 8-bit (LCD + LED bargraph)</para></listitem>
<listitem><para>serial LPT</para></listitem>
</itemizedlist>
<para>
It also supports the following connections:
</para>
<itemizedlist>
<listitem><para>A PIC-an-LCD or LCD serializer connected to a serial port</para></listitem>
<listitem><para>A I<superscript>2</superscript>C port expander connected to an I<superscript>2</superscript>C port</para></listitem>
<listitem><para>A PIC-an-LCD or LCD serializer connected to a serial port</para></listitem>
<listitem><para>A I<superscript>2</superscript>C port expander connected to an I<superscript>2</superscript>C port</para></listitem>
</itemizedlist>
<para>
The driver also lets you use multiple displays as a single virtual
display. For example, a 4, 2 and 1 line display can be used to form a
@@ -48,41 +53,41 @@ connections. They are explaned here.
All variants use the same method of obtaining power. i.e., for each LCD:
</para>
<table>
<table id="hd44780-connections-power.table">
<title>HD44780: Power Connections</title>
<tgroup cols="3">
<thead>
<row>
<entry>LCD</entry>
<entry>pin</entry>
<entry>signal</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>GND</entry>
<entry>(connect to any of pins 18 - 25 of you parallel port)</entry>
</row>
<row>
<entry>2</entry>
<entry>+5V</entry>
<entry></entry>
</row>
<row>
<entry>3</entry>
<entry>Vadj</entry>
<entry>(contrast)</entry>
</row>
</tbody>
<thead>
<row>
<entry>LCD</entry>
<entry>pin</entry>
<entry>signal</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>GND</entry>
<entry>(connect to any of pins 18 - 25 of you parallel port)</entry>
</row>
<row>
<entry>2</entry>
<entry>+5V</entry>
<entry></entry>
</row>
<row>
<entry>3</entry>
<entry>Vadj</entry>
<entry>(contrast)</entry>
</row>
</tbody>
</tgroup>
</table>
<warning>
<para>
Always double check your power connection, your display will probably
NOT survive a reversely connected supply !
</para>
<para>
Always double check your power connection, your display will probably
<emphasis>not</emphasis> survive a reversely connected supply !
</para>
</warning>
<para>
@@ -90,28 +95,28 @@ There are several ways to get 5V:
</para>
<itemizedlist>
<listitem><para>
Connect to a 5V line intented for disk drives (the red wire is 5V,
black is GND).
</para></listitem>
<listitem><para>
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.
</para></listitem>
<listitem><para>
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...
</para></listitem>
<listitem><para>
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.
</para></listitem>
<listitem><para>
Connect to a 5V line intented for disk drives (the red wire is 5V,
black is GND).
</para></listitem>
<listitem><para>
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.
</para></listitem>
<listitem><para>
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...
</para></listitem>
<listitem><para>
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.
</para></listitem>
</itemizedlist>
<figure>
<figure id="hd44780-connections-power.contrast-circuit">
<title>HD44780: Connecting the contrast adjusting pin (Vadj.)</title>
<screen>
<![CDATA[
@@ -134,7 +139,7 @@ of 100mA or 200mA.
<title>Keypad</title>
<para>
You can connect a keypad with all connection types. The maximum supported
You can connect a keypad with most connection types. The maximum supported
number of keys differs per type. There are several ways to connect the keys
to the input pins.
</para>
@@ -147,7 +152,7 @@ If you connect a key like sketched below, then you can only connect one key
per input pin. It is a simple solution if you need only few keys.
</para>
<figure>
<figure id="hd44780-connections-keypad-direct.circuit">
<title>HD44780: Direct Keys</title>
<screen>
<![CDATA[
@@ -178,28 +183,28 @@ per input pin. It is a simple solution if you need only few keys.
By default, the following keystrokes are generated by the different keys:
</para>
<table>
<title>HD44780: Default Keystrokes</title>
<tgroup cols="2">
<tbody>
<row>
<entry>X0</entry>
<entry>A</entry>
</row>
<row>
<entry>X1</entry>
<entry>B</entry>
</row>
<row>
<entry>X2</entry>
<entry>C</entry>
</row>
<row>
<entry>X3</entry>
<entry>D</entry>
</row>
</tbody>
</tgroup>
<table id="hd44780-connections-keypad-direct.mapping">
<title>HD44780: Default Keystrokes</title>
<tgroup cols="2">
<tbody>
<row>
<entry>X0</entry>
<entry>A</entry>
</row>
<row>
<entry>X1</entry>
<entry>B</entry>
</row>
<row>
<entry>X2</entry>
<entry>C</entry>
</row>
<row>
<entry>X3</entry>
<entry>D</entry>
</row>
</tbody>
</tgroup>
</table>
</sect5>
@@ -212,7 +217,7 @@ Using a matrix, we can connect much more keys. To simplify the drawing here,
we replace all switches with an @ symbol:
</para>
<figure>
<figure id="hd44780-connections-keypad-matrix.single-circuit">
<title>HD44780: Single Matrix Key</title>
<screen>
<![CDATA[
@@ -238,7 +243,7 @@ we replace all switches with an @ symbol:
We connect the matrix of keys like this:
</para>
<figure>
<figure id="hd44780-connections-keypad-matrix.complete-circuit">
<title>HD44780: Complete Key Matrix</title>
<screen>
<![CDATA[
@@ -272,7 +277,7 @@ connected, with X and Y lines connected as show. To be more precise, it
assumes this:
</para>
<table>
<table id="hd44780-connections-keypad-matrix.mapping">
<title>HD44780: Keypad Layout</title>
<tgroup cols="5">
<tbody>
@@ -332,7 +337,7 @@ If you want to use just one return line, for example with the serialLpt
wiring, it looks (completely drawn) like this:
</para>
<figure>
<figure id="hd44780-connections-keypad-matrix.1line-circuit">
<title>HD44780: One Return Line</title>
<screen>
<![CDATA[
@@ -357,12 +362,12 @@ Y3 o---|<---o o---+----o return line
</figure>
<tip>
<para>
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.
</para>
<para>
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.
</para>
</tip>
</sect5>
@@ -379,7 +384,7 @@ this. The extension uses one output pin, you cannot use that pin for other
functions anymore. The wiring looks like this:
</para>
<figure>
<figure id="hd44780-connections-backlight.circuit">
<title>HD44780: Backlight Wiring</title>
<screen>
<![CDATA[
@@ -401,7 +406,7 @@ LPT Sub-D connector | 4k7 |
|
=== GND
Note: 4k7 means 4,7 kohm.
Note: 4k7 means 4,7 kOhm.
The BC327 transistor has the following connections:
_____
@@ -418,21 +423,21 @@ The BC327 transistor has the following connections:
</figure>
<caution>
<para>
Sometimes the backlight connections are not on the 'main' connector, but on
the side. If that is the case, there is usually NO RESISTOR present to limit
the current through the LEDs. Therefor you should then add a resistor after
the transistor of about 10 ohm (see display documentation).
</para>
<para>
Sometimes the backlight connections are not on the 'main' connector, but on
the side. If that is the case, there is usually NO RESISTOR present to limit
the current through the LEDs. Therefor you should then add a resistor after
the transistor of about 10 ohm (see display documentation).
</para>
</caution>
<tip>
<para>
If you want the backlight to light a bit while it's switched 'off', you can
add a resistor bypassing the transistor from e to c, with a value of, say
47ohm or 22ohm. (My 4x20 has an internal resistor of 6ohm, so with 47 ohm
extra it lights at only 1/9th. I like this. Joris.)
</para>
<para>
If you want the backlight to light a bit while it's switched 'off', you can
add a resistor bypassing the transistor from e to c, with a value of, say
47ohm or 22ohm. (My 4x20 has an internal resistor of 6ohm, so with 47 ohm
extra it lights at only 1/9th. I like this. Joris.)
</para>
</tip>
</sect4>
@@ -446,7 +451,7 @@ extra it lights at only 1/9th. I like this. Joris.)
This is originally based on "lcdtext" (by Matthias Prinke).
</para>
<table>
<table id="hd44780-4-bit.base-mapping">
<title>HD44780: 4-bit Pinouts (1)</title>
<tgroup cols="2">
<thead>
@@ -505,7 +510,7 @@ wire D5 (pin 7) to the enable line (pin 6) of the third LCD. Then for
displays four to seven use:
</para>
<table>
<table id="hd44780-4-bit.multi-mapping">
<title>HD44780: 4-bit Pinouts (2)</title>
<tgroup cols="2">
<thead>
@@ -539,7 +544,7 @@ displays four to seven use:
The optional keypad can be connected as follows:
</para>
<table>
<table id="hd44780-4-bit.keypad-mapping">
<title>HD44780: 4-bit Keypad Pinouts</title>
<tgroup cols="2">
<thead>
@@ -626,7 +631,7 @@ The optional backlight wiring should be connected to D5, pin 7.
This type of connection should work with winamp.
</para>
<table>
<table id="hd44780-8-bit-winamp.base-mapping">
<title>HD44780: "Winamp" wiring</title>
<tgroup cols="2">
<thead>
@@ -707,7 +712,7 @@ connected to this line.
The optional keypad can be connected as follows:
</para>
<table>
<table id="hd44780-8-bit-winamp.keypad-mapping">
<title>HD44780: "Winamp" wiring - Keypad</title>
<tgroup cols="2">
<thead>
@@ -757,7 +762,6 @@ The optional keypad can be connected as follows:
<entry>INIT (16)</entry>
<entry>Y9</entry>
</row>
<row>
<entry>nACK (10)</entry>
<entry>X0</entry>
@@ -815,7 +819,7 @@ winamp or ext8bit wirings, because it only sends 4 bits at a time.
The LCD connections are:
</para>
<table>
<table id="hd44780-8-bit-lcdtime.base-mapping">
<title>HD44780: "lcdtime" wiring</title>
<tgroup cols="2">
<thead>
@@ -893,7 +897,7 @@ connections.
The optional keypad can be connected as follows:
</para>
<table>
<table id="hd44780-8-bit-lcdtime.keypad-mapping">
<title>HD44780: "lcdtime" wiring - keypad</title>
<tgroup cols="2">
<thead>
@@ -943,7 +947,6 @@ The optional keypad can be connected as follows:
<entry>nSEL (17)</entry>
<entry>Y9</entry>
</row>
<row>
<entry>nACK (10)</entry>
<entry>X0</entry>
@@ -1013,7 +1016,7 @@ the shift register, a 4094. Do not forget to connect the 5V to pin 16 and
GND to pin 8 of the IC.
</para>
<figure>
<figure id="hd44780-seriallpt.simple-circuit">
<title>HD44780: Serial LPT wiring ('simple')</title>
<screen>
<![CDATA[
@@ -1073,7 +1076,7 @@ The second possible wiring is with 2 output lines. This one is a bit more
complex. If you do not understand the schematic, do not build it.
</para>
<figure>
<figure id="hd44780-seriallpt.complex-circuit">
<title>HD44780: Serial LPT wiring ('complex')</title>
<screen>
<![CDATA[
@@ -1149,7 +1152,7 @@ serialLpt wiring supports a keypad. The 3 wires version supports
7 x 5 = 35 keys.
</para>
<table>
<table id="hd44780-seriallpt-keypad.mapping">
<title>HD44780: Serial LPT - Keypad return lines</title>
<tgroup cols="2">
<tbody>
@@ -1183,7 +1186,7 @@ If you only have 1 return line, you can buffer it with two remaining
buffers from the 74HCT14:
</para>
<figure>
<figure id="hd44780-seriallpt-keypad.circuit">
<title>HD44780: Serial LPT - Keypad return lines buffered</title>
<screen>
<![CDATA[
@@ -1211,7 +1214,7 @@ that. The BL output below should be connected to the BL input in the
<link linkend="hd44780-connections-backlight">backlight section</link>
</para>
<figure>
<figure id="hd44780-seriallpt-backlight.circuit">
<title>HD44780: Serial LPT - Backlight extra circuit</title>
<screen>
<![CDATA[
@@ -1535,6 +1538,39 @@ This means that you can take these schematics and use it as a basis for your own
e.g. for a graphic LCD
</para>
<sect4 id="hd44780-lcd2usb-config">
<title>Special config options</title>
<para>
Besides the standard configuration options for <code>hd44780</code> displays, the
<code>lcd2usb</code> connection type supports two additional options:
<command>Contrast=</command> to set the display's contrast and
<command>Brightness=</command> to set the display's brightness.
Both options expect a number in the range from <literal>0</literal> to <literal>1000</literal>.
</para>
</sect4>
<sect4 id="hd44780-lcd2usb-status">
<title>Status</title>
<para>
The <code>lcd2usb</code> connection type has been written to support displaysi
with one and two HD44780 controllers.
Owing to the lack of a 2-controller display, it has only been tested with a
1-controller display.
If you happen to have a 2-controller display connected to LCD2USB,
please report to the mailing list.
<tip>
<para>
In order to make the <code>lcd2usb</code> connection type work with a 2-controller display
you may need to set the <command>vSpan=</command> config option accordingly.
</para>
</tip>
Although the LCD2USB sports two keys, they are currently not supported by
<package>LCDproc</package>. Patches to fix the situation are very welcome.
</para>
</sect4>
</sect3>
@@ -1547,7 +1583,7 @@ If you have an I<superscript>2</superscript>C port available that is supported b
port expander there (PCF8574P in this example).
</para>
<figure>
<figure id="hd44780-i2c.circuit">
<title>HD44780: PCF8574P port expander on I2C bus</title>
<screen>
<![CDATA[
@@ -1597,7 +1633,7 @@ port expander there (PCF8574P in this example).
<sect4 id="hd44780-i2c-config">
<title>Configuration</title>
<figure>
<figure id="hd44780-i2c-config.example">
<title>HD44780: Configuration for I<superscript>2</superscript>C with port expander</title>
<screen>
<![CDATA[
@@ -1629,7 +1665,7 @@ a device that needs a 2-byte command, and it will be stripped
off the address.
</para>
<figure>
<figure id="hd44780-i2c-config.portexpander-address">
<title>HD44780: Examples of I<superscript>2</superscript>C port expander adresses</title>
<screen>
<![CDATA[
@@ -1650,9 +1686,10 @@ port=0xa0..0xa7 PCA9554A with A[012]=0..7
<title>Compiling</title>
<para>
Make sure that the HD44780 files are built when you run configure. This
can be done by specifying "--enable-drivers=all" or by
"--enable-drivers=hd44780".
Make sure that the HD44780 files are built when you run <command>./configure</command>.
This can be done by specifying <option>--enable-drivers=all</option> or by including
<code>hd44780</code> in the list of enabled drivers
(e.g. <option>--enable-drivers=hd44780</option>).
</para>
</sect2>
@@ -1790,8 +1827,8 @@ can be done by specifying "--enable-drivers=all" or by
<para>
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
<filename>server/drivers/hd44780-drivers.h</filename>
which contains the actual translation code.
<filename>server/drivers/hd44780-drivers.h</filename> in <package>LCDproc</package>'s
source directory which contains the actual translation code.
</para>
</tip>
@@ -1922,16 +1959,24 @@ can be done by specifying "--enable-drivers=all" or by
<varlistentry>
<term>
<command>vspan=</command>
<command>vSpan=</command>
<arg choice="plain">
<replaceable>HEIGHT</replaceable>
<literal>,</literal>&hellip;
</arg>
</term>
<listitem><para>
For multiple combined displays: how many lines does each display have.
E.g. <literal>Vrspan=2,2</literal> means you have two displays and
The "vertical span" when using multiple displays or multi-controller displays.
It is a comma separated list of the heights of each display. In multi-controller
displays it lists the number of lines each controller is responsible for.
</para>
<para>
E.g. <code>VSpan=2,2</code> means you have two displays and
each has two lines.
</para>
<para>
The sum of the <replaceable>HEIGHT</replaceable>s must match the total height
given in <code>Size=</code>.
</para></listitem>
</varlistentry>
@@ -1987,7 +2032,7 @@ can be done by specifying "--enable-drivers=all" or by
<arg choice="plain"><replaceable>SECONDS</replaceable></arg>
</term>
<listitem><para>
Some displays (e.g. <emphasis>vdr-wakeup</emphasis>) need a message from the driver to that it
Some displays (e.g. <code>vdr-wakeup</code>) need a message from the driver to that it
is still alive. When set to a value bigger then <literal>0</literal> the character in the
upper left corner is updated every <replaceable>SECONDS</replaceable> seconds.
Default: <literal>0</literal>.
@@ -2009,29 +2054,26 @@ can be done by specifying "--enable-drivers=all" or by
<varlistentry>
<term>
<command>KeyMatrix_4_1=</command>
<command>DirectKey_<replaceable>NUM</replaceable>=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMatrix_4_2=</command>
<command>KeyMatrix_<replaceable>X</replaceable>_<replaceable>Y</replaceable>=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMatrix_4_3=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMatrix_4_4=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
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
</para></listitem>
<listitem>
<para>
If you have a keypad you can assign keystrings to the keys.
See documentation for used terms and how to wire it.
</para>
<para>
To map, for example, the directly connected key <literal>4</literal>
to the string <literal>Enter</literal>, use <code>KeyDirect_4=Enter</code>.
For matrix keys use the <replaceable>X</replaceable> and
<replaceable>Y</replaceable> coordinates of the key;
e.g. <code>KeyMatrix_1_3=Enter</code>.
</para>
</listitem>
</varlistentry>
</variablelist>
docs/lcdproc-user/drivers/irman.docbook
+1 -1
View File
@@ -11,7 +11,7 @@ and/or clients that can handle input.
The keys are mapped according to the following table:
<table>
<table id="irman-howto.mapping">
<title>Mapping between LCDproc keys and IrMan commands</title>
<tgroup cols="2">
<thead>
docs/lcdproc-user/drivers/lircin.docbook
+13 -14
View File
@@ -7,6 +7,7 @@ that works with LIRC to control the LCDproc server
(<application>LCDd</application>)
and/or clients that can handle input.
</para>
<para>
Of course you need a working LIRC setup. Refer to the
<ulink url="http://www.lirc.org">LIRC project</ulink> for more
@@ -21,6 +22,7 @@ Basically all you need is a running <application>lircd</application>.
And of course you have to start <application>lircd</application>
as root.
</para>
<para>
Also, make sure that the permission of <filename>/dev/lircd</filename>
are correct.
@@ -45,27 +47,26 @@ Then simply run make.
<title>Configure LCDd to Use the lirc Driver</title>
<para>
First of all you need to activate the driver by adding a Driver=lirc line
First of all you need to activate the driver by adding a <code>Driver=lirc</code> line
to your <filename>LCDd.conf</filename>
</para>
<example>
<example id="lirc-configuration.example">
<title><filename>LCDd.conf</filename>: Activate the lirc driver</title>
<programlisting>
Driver=mtxorb
Driver=lirc
Driver=mtxorb
Driver=lirc
</programlisting>
</example>
<para>
This activates the mtxorb driver as the output driver and the lirc driver
as the input driver.
This activates the <code>mtxorb</code> driver as the output driver
and the <code>lirc</code> driver as the input driver.
</para>
<para>
Then you have to modify the [lirc] section of your
Then you have to modify the <code>[lirc]</code> section of your
<filename>LCDd.conf</filename>.
</para>
@@ -134,11 +135,11 @@ No matter which file you use, you have to add at least the following
lines to the file:
</para>
<example>
<example id="lircrc.example">
<title><filename>~/.lircrc</filename>: Specify the associations from buttons to keys
for the lirc driver</title>
<programlisting>
<programlisting>
begin
prog = lcdd
button = 2
@@ -174,8 +175,6 @@ begin
button = 0
config = Enter
end
</programlisting>
</example>
@@ -192,7 +191,7 @@ and <literal>Enter</literal> are necessary.
</para>
<para>
<!-- TOTO: is this still true with 0.5 ? -->
<!-- TODO: is this still true with 0.5 ? -->
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.
docs/lcdproc-user/drivers/pylcd.docbook
+1 -1
View File
@@ -78,7 +78,7 @@ 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.
</para>
<example>
<example id="pyramid-ledoutput.example">
<title>How to use the LED output from the client</title>
<programlisting>
telnet localhost 13666
docs/lcdproc-user/drivers/serialPOS.docbook
+29 -25
View File
@@ -5,21 +5,20 @@
This section talks about using LCDproc with a point of sale ("POS") character-display.
</para>
<para>
The serialPOS-driver is currently working with the AEDEX emulation protocol,
The <code>serialPOS</code> driver is currently working with the AEDEX emulation protocol,
but can be extended to work with various other protocols.
</para>
<para>
The driver should operate most character POS displays with a serial (rs232) input.
The driver should operate most character POS displays with a serial (RS-232) input.
Because these displays use a standardized protocol, if the protocol is
supported by your display, it should work as expected.
Feedback is welcome.
Feedback is welcome.
<table><title>serialPOS: Emulation Protocol Status</title>
<tgroup cols="5">
<table id="serialPOS-howto.status">
<title>serialPOS: Emulation Protocol Status</title>
<tgroup cols="4">
<thead>
<row>
<entry>Protocol</entry>
@@ -74,7 +73,8 @@ supported by your display, it should work as expected.
</tbody>
</tgroup>
</table>
() feature not tested.
<literal>(</literal>&hellip;<literal>)</literal>: Feature not tested.
</para>
<sect2 id="serialPOS-connections">
@@ -82,19 +82,23 @@ supported by your display, it should work as expected.
<para>
Connecting the display should consist of simply plugging it into your computer's
rs232 port. Because these displays typically support full rs232, no additional
wiring is needed. If you do not have this port (many newer computers do not), you
can use a USB to serial adapter with the appropriate driver.
</para>
<para>
If your display supports a "pass-through" function, but you do not have
another rs232 device connected to the pass-through port, you may experience hangs
if an improperly formatted command sneaks through.
This is because the display is waiting for the pass-through
device to accept the data and a blocking state is created within the device.
You can either connect another rs232 device, or rewire the display to send the pass-
through commands back to your computer.
RS-232 port. Because these displays typically support full RS-232, no additional
wiring is needed. If your computer does not have such a port (many newer computers don't),
you can use a USB to serial adapter with the appropriate driver.
</para>
<note>
<para>
If your display supports a <emphasis>pass-through</emphasis> function,
but you do not have another RS-232 device connected to the pass-through port,
you may experience hangs if an improperly formatted command sneaks through.
This is because the display is waiting for the pass-through device to accept
the data and a blocking state is created within the device.
You can either connect another RS-232 device, or rewire the display to send the
pass-through commands back to your computer.
</para>
</note>
</sect2>
<!-- ## Serial POS driver ## -->
@@ -112,8 +116,8 @@ through commands back to your computer.
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Device to use in serial mode. Usual values are <filename>/dev/ttyS0</filename> or <filename>/dev/cu.usbserial</filename>
[default: <filename>/dev/lcd</filename>].
Device to use in serial mode. Usual values are <filename>/dev/ttyS0</filename> or
<filename>/dev/cu.usbserial</filename>. Default is <filename>/dev/lcd</filename>.
</para></listitem>
</varlistentry>
@@ -128,7 +132,7 @@ through commands back to your computer.
</term>
<listitem><para>
Specifies the size of the VFD in characters.
[default: <literal>16x2</literal>]
If not given, it defaults to <literal>16x2</literal>.
</para></listitem>
</varlistentry>
@@ -149,7 +153,7 @@ through commands back to your computer.
</term>
<listitem><para>
Set the communication protocol to use with the POS display.
If not given [default <literal>AEDEX</literal>].
If not specified it defaults to <literal>AEDEX</literal>.
Currently, only AEDEX is supported.
</para></listitem>
</varlistentry>
@@ -169,7 +173,7 @@ through commands back to your computer.
</term>
<listitem><para>
Set the the baud rate communication with the POS display.
If not given [default <literal>9600</literal>].
If not given the default of <literal>9600</literal> is used.
</para></listitem>
</varlistentry>
</variablelist>
docs/lcdproc-user/drivers/serialVFD.docbook
+15 -12
View File
@@ -14,12 +14,13 @@ It is also known to work on FUTABA VFDs.
<para>
The driver should operate most of NEC, Futaba and Noritake 7x5 dot VFDs with
serial(rs232) and/or parallel interface. See the following table for testing-status.
Feedback is welcome.
serial(RS-232) and/or parallel interface. See the following table for testing-status.
Feedback is welcome.
<table><title>serialVFD: Display Status</title>
<tgroup cols="5">
<table id="serialVFD-howto.status">
<title>serialVFD: Display Status</title>
<tgroup cols="6">
<thead>
<row>
<entry>Display</entry>
@@ -112,19 +113,21 @@ The driver should operate most of NEC, Futaba and Noritake 7x5 dot VFDs with
</tbody>
</tgroup>
</table>
() feature not tested.
<literal>(</literal>&hellip;<literal>)</literal>: Feature not tested.
</para>
<para>
If your display isn't working 100% satisfactorily you can add a new device with modified hardware
commands to the driver if you want. To do that you have to add a new section to the display-
commands to the driver if you want. To do that you have to add a new section to the display
<command>Type=</command>-switch-case in <filename>./server/drivers/serialVFD-displays.c</filename>
and to write a new "load"function with the correct commands for the display.(Try which display-<command>Type=</command>
works best with your display, copy, rename and modify this function that is the easiest way I guess.)
and to write a new "load" function with the correct commands for the display.
(Try which display <command>Type=</command> works best with your display,
then copy, rename and modify this function to your needs - that is the easiest way I guess.)
</para>
<para>
On this page you may find pictures and datasheets of the VFDs:
On Malte Poeggel's page you may find pictures and datasheets of the VFDs:
<ulink url="http://www.maltepoeggel.de/html/vfd/index.html"></ulink>
</para>
@@ -143,7 +146,7 @@ the display show everything correctly.
<warning>
<para>
Always cross-check with your datasheet, before connecting your display!
Displays of same manufacturer may have different pin assignments!
Different displays of even the same manufacturer may have different pin assignments!
</para></warning>
<para>
@@ -161,7 +164,7 @@ serialport. The signal has to be inverted. I use the following
circuit to do that job.
</para>
<figure>
<figure id="serialVFD-serial-connections.circuit">
<title>serialVFD: Serial Inverter</title>
<screen>
<![CDATA[
@@ -232,7 +235,7 @@ The blue connector (6pin in a row) (the important one!):
<tip>
<para>
Hold the display in that position where you can read
the "KD Rev 2.1" marking normally!
the <literal>KD Rev 2.1</literal> marking normally!
</para>
</tip>
docs/lcdproc-user/drivers/t6963.docbook
+1 -1
View File
@@ -10,7 +10,7 @@ displays that can often act as a screen.
<sect2 id="t6963-connections">
<title>Connections</title>
<table>
<table id="t6963-connections.mapping">
<title>T6963 wiring schematic</title>
<tgroup cols="2">
<thead>
docs/lcdproc-user/how-to-obtain.docbook
+3 -3
View File
@@ -37,11 +37,11 @@ Internet.
</sect1>
<sect1 id="tar">
<title>Download Last Day's CVS Version of LCDproc as a Tarball</title>
<title>Download Yesterday's CVS Version of LCDproc as a Tarball</title>
<para>
There are nightly distributions of the CVS branches of LCDproc. You can download them from
<ulink url="http://lcdproc.sourceforge.net/nightly/">http://lcdproc.sourceforge.net/nightly/</ulink>
<ulink url="http://lcdproc.sourceforge.net/nightly/"></ulink>
</para>
<para>
@@ -114,7 +114,7 @@ which is in the unstable and testing distributions.
</para>
<para>
Provided apt-get is configured properly. You should be able to install the package running:
Provided apt-get is configured properly, you should be able to install the package running:
</para>
<screen>
docs/lcdproc-user/introduction.docbook
+18 -16
View File
@@ -11,21 +11,22 @@ After reading this document you will be able to set up your own LCDproc'ed syste
</para>
<note><para>
Please note that this document is still "under construction". We hope to finish it
until the final release of LCDproc, which will probably take place in May or June 2002.
Please note that this document is still under construction". We hope to finish it
until the final release of LCDproc &smile;.
If you run into any trouble feel free to write to the LCDproc mailing list.
See <ulink url="http://lcdproc.omnipotent.net/mail.php3">http://lcdproc.omnipotent.net/mail.php3</ulink>
See <ulink url="http://lcdproc.omnipotent.net/mail.php3"></ulink>
for details on how to subscribe to the list.
</para>
<para>
Therefore you might want to have a look at <ulink url="http://lcdproc.sourceforge.net/docs/">http://lcdproc.sourceforge.net/docs/</ulink>,
to get the latest version of this document (, unless you want to generate it yourself from the
Therefore you might want to have a look at <ulink url="http://lcdproc.sourceforge.net/docs/"></ulink>,
to get the latest version of this document (unless you want to generate it yourself from the
docbook files in the CVS).
</para></note>
<para>
This document was written for LCDproc 0.4.3. At the time of writing there had already
been the "LCDproc User's Guide" written by William W. Ferrel in 1999. His version covered
This document was originally written for LCDproc 0.4.3, but has been dramatically updated since.
At the time of writing there had already been the "LCDproc User's Guide" written by
William W. Ferrel in 1999. His version covered
an early version of LCDproc and therefore concentrated on Matrix Orbital displays.
</para>
@@ -45,12 +46,12 @@ document. The authors of those are listed below every such document.
<title>What is LCDproc?</title>
<para>
LCDproc is a client/server suite including drivers for all kinds of
<package>LCDproc</package> is a client/server suite including drivers for all kinds of
nifty LCD displays.
</para>
<para>
The server 'LCDd' makes it possible to display text and other data on
an LCD display. As well LCDd can handle certain input devices.
The server <application>LCDd</application> makes it possible to display text and
other data on an LCD display. As well LCDd can handle certain input devices.
</para>
<para>
Support for devices is added by drivers. We distinguish between output
@@ -66,10 +67,10 @@ HD44780, STV5730, T6963, SED1520 and SED1330.
There are input (only) drivers for LIRC and joysticks.
</para>
<para>
Clients can connect to LCDd through common sockets.
Clients can connect to LCDd through common TCP sockets.
</para>
<para>
Various clients are available. The "main" client
Various clients are available. The <emphasis>main</emphasis> client
<application>lcdproc</application>, which is shipped with the LCDproc
distribution, can display things like CPU load, system load, memory
usage, uptime, and a lot more.
@@ -134,10 +135,11 @@ As it is rather simple to write an LCDproc client, you can find various
clients on the Internet.
</para>
<para>
Unfortunately we cannot provide a list of LCDproc clients (yet). So, have
fun searching <ulink url="http://www.google.com">google</ulink> or
<ulink url="http://freshmeat.net">freshmeat</ulink>. Simply type 'lcdproc'
for the keyword.
Unfortunately we cannot provide a list of LCDproc clients here. So, take a look at the
<ulink url="http://www.lcdproc.org/clients.php3">Clients page on LCDproc's web site</ulink>
or have fun searching <ulink url="http://www.google.com">Google</ulink> or
<ulink url="http://freshmeat.net">freshmeat</ulink>. Simply use <literal>lcdproc</literal>
as the search pattern.
</para>
</sect1>
docs/lcdproc-user/running.docbook
+2 -2
View File
@@ -51,7 +51,7 @@ Running <command>LCDd -h</command> gives you an overview of the currently availa
command line options.
</para>
<example>
<example id="lcdd-commandline-options.example">
<title><command>LCDd -h</command></title>
<screen> <![CDATA[
@@ -98,7 +98,7 @@ Running <command>lcdproc -h</command> gives you an overview of the currently ava
command line options.
</para>
<example>
<example id="lcdproc-commandline-optionsi.example">
<title><command>lcdproc -h</command></title>
<screen> <![CDATA[