mmdolze
f59af2e241
options in the config file because: * <arg> can only be used within <cmdsynopsis>. * <cmdsynopsis> does not allow text outside <command> and <arg>. * <arg> does not allow decorating elements like <literal> or <emphasis>. This fixes #2803057. Add shortcut entities for commonly used parameters (yes/no, size). Remove Debian patch which is obsoleted by above changes.
184 lines
5.2 KiB
Plaintext
184 lines
5.2 KiB
Plaintext
<sect1 id="serialPOS-howto">
|
|
<title>The serialPOS Driver</title>
|
|
|
|
<para>
|
|
This section talks about using LCDproc with a point of sale ("POS") character-display.
|
|
</para>
|
|
|
|
<para>
|
|
The <code>serialPOS</code> driver is currently working with the AEDEX emulation protocol,
|
|
and may support Epson ESC/POS and Logic Controls. It can be extended to work with various
|
|
other protocol displays.
|
|
</para>
|
|
|
|
<para>
|
|
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.
|
|
|
|
<table id="serialPOS-howto.status">
|
|
<title>serialPOS: Emulation Protocol Status</title>
|
|
<tgroup cols="4">
|
|
<thead>
|
|
<row>
|
|
<entry>Protocol</entry>
|
|
<entry>Display tested</entry>
|
|
<entry>Currently Supported</entry>
|
|
<entry>Remark</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>AEDEX</entry>
|
|
<entry>Emax</entry>
|
|
<entry>Yes</entry>
|
|
<entry> </entry>
|
|
</row>
|
|
<row>
|
|
<entry>IEE</entry>
|
|
<entry> </entry>
|
|
<entry>No</entry>
|
|
<entry> </entry>
|
|
</row>
|
|
<row>
|
|
<entry>Epson</entry>
|
|
<entry>No</entry>
|
|
<entry>Yes</entry>
|
|
<entry> </entry>
|
|
</row>
|
|
<row>
|
|
<entry>Emax</entry>
|
|
<entry> </entry>
|
|
<entry>No</entry>
|
|
<entry> </entry>
|
|
</row>
|
|
<row>
|
|
<entry>IBM</entry>
|
|
<entry> </entry>
|
|
<entry>No</entry>
|
|
<entry> </entry>
|
|
</row>
|
|
<row>
|
|
<entry>Logic Controls</entry>
|
|
<entry>No</entry>
|
|
<entry>Yes</entry>
|
|
<entry> </entry>
|
|
</row>
|
|
<row>
|
|
<entry>Ultimate</entry>
|
|
<entry> </entry>
|
|
<entry>No</entry>
|
|
<entry> </entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
|
|
<literal>(</literal>…<literal>)</literal>: Feature not tested.
|
|
</para>
|
|
|
|
<sect2 id="serialPOS-connections">
|
|
<title>Connecting The Display</title>
|
|
|
|
<para>
|
|
Connecting the display should consist of simply plugging it into your computer's
|
|
RS-232 serial 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 a driver provided by the adapter manufacturer.
|
|
</para>
|
|
<para>
|
|
If your display supports a <emphasis>pass-through</emphasis> function, you can connect
|
|
an RS-232 keyboard or terminal to the pass-through port. This will allow you to input
|
|
keystrokes to LCDproc and control features and menus. Use the pass-through keyboard's
|
|
arrow, delete, and return keys by default.
|
|
</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 display.
|
|
You can either connect another RS-232 device or use a wire to jumper the CTS and RTS
|
|
pins together within the display.
|
|
</para>
|
|
</note>
|
|
|
|
</sect2>
|
|
|
|
<!-- ## Serial POS driver ## -->
|
|
<sect2 id="serialPOS-config">
|
|
<title>Configuration in LCDd.conf</title>
|
|
|
|
<sect3 id="serialPOS-config-section">
|
|
<title>[serialPOS]</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Device</property> =
|
|
<parameter><replaceable>DEVICE</replaceable></parameter>
|
|
</term>
|
|
<listitem><para>
|
|
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>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Size</property> = ¶meters.size;
|
|
</term>
|
|
<listitem><para>
|
|
Specifies the size of the VFD in characters.
|
|
If not given, it defaults to <literal>16x2</literal>.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Type</property> =
|
|
{
|
|
<parameter><literal>IEE</literal></parameter> |
|
|
<emphasis><parameter><literal>AEDEX</literal></parameter></emphasis> |
|
|
<parameter><literal>Epson</literal></parameter> |
|
|
<parameter><literal>Emax</literal></parameter> |
|
|
<parameter><literal>IBM</literal></parameter> |
|
|
<parameter><literal>LogicControls</literal></parameter> |
|
|
<parameter><literal>Ultimate</literal></parameter>
|
|
}
|
|
</term>
|
|
<listitem><para>
|
|
Set the communication protocol to use with the POS display.
|
|
If not specified it defaults to <literal>AEDEX</literal>.
|
|
Currently, only AEDEX is supported.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Speed</property> =
|
|
{
|
|
<parameter><literal>1200</literal></parameter> |
|
|
<parameter><literal>2400</literal></parameter> |
|
|
<emphasis><parameter><literal>9600</literal></parameter></emphasis> |
|
|
<parameter><literal>19200</literal></parameter> |
|
|
<parameter><literal>115200</literal></parameter>
|
|
}
|
|
</term>
|
|
<listitem><para>
|
|
Set the the baud rate communication with the POS display.
|
|
If not given the default of <literal>9600</literal> is used.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|
|
|