File: serialPOS.docbook

package info (click to toggle)
lcdproc 0.5.9-8
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,088 kB
  • sloc: ansic: 59,645; sh: 1,740; perl: 681; makefile: 417
file content (183 lines) | stat: -rw-r--r-- 5,290 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<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>&hellip;<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> = &parameters.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>