docs/lcdproc-user/drivers/serialPOS.docbook

   1 <sect1 id="serialPOS-howto">
   2 <title>The serialPOS Driver</title>
   3
   4 <para>
   5 This section talks about using LCDproc with a point of sale ("POS") character-display.
   6 </para>
   7
   8 <para>
   9 The <code>serialPOS</code> driver is currently working with the AEDEX emulation protocol,
  10 but can be extended to work with various other protocols.
  11 </para>
  12
  13 <para>
  14 The driver should operate most character POS displays with a serial (RS-232) input.
  15 Because these displays use a standardized protocol, if the protocol is
  16 supported by your display, it should work as expected.
  17 Feedback is welcome.
  18
  19 <table id="serialPOS-howto.status">
  20 <title>serialPOS: Emulation Protocol Status</title>
  21 <tgroup cols="4">
  22   <thead>
  23     <row>
  24       <entry>Protocol</entry>
  25       <entry>Display tested</entry>
  26       <entry>Currently Supported</entry>
  27       <entry>Remark</entry>
  28     </row>
  29   </thead>
  30   <tbody>
  31     <row>
  32       <entry>AEDEX</entry>
  33       <entry>Emax</entry>
  34       <entry>Yes</entry>
  35       <entry> </entry>
  36     </row>
  37     <row>
  38       <entry>IEE</entry>
  39       <entry> </entry>
  40       <entry>No</entry>
  41       <entry> </entry>
  42     </row>
  43     <row>
  44       <entry>Epson</entry>
  45       <entry> </entry>
  46       <entry>No</entry>
  47       <entry> </entry>
  48     </row>
  49     <row>
  50       <entry>Emax</entry>
  51       <entry> </entry>
  52       <entry>No</entry>
  53       <entry> </entry>
  54     </row>
  55     <row>
  56       <entry>IBM</entry>
  57       <entry> </entry>
  58       <entry>No</entry>
  59       <entry> </entry>
  60     </row>
  61     <row>
  62       <entry>Logic Controls</entry>
  63       <entry> </entry>
  64       <entry>No</entry>
  65       <entry> </entry>
  66     </row>
  67     <row>
  68       <entry>Ultimate</entry>
  69       <entry> </entry>
  70       <entry>No</entry>
  71       <entry> </entry>
  72     </row>
  73   </tbody>
  74 </tgroup>
  75 </table>
  76
  77 <literal>(</literal>&hellip;<literal>)</literal>: Feature not tested.
  78 </para>
  79
  80 <sect2 id="serialPOS-connections">
  81 <title>Connecting The Display</title>
  82
  83 <para>
  84 Connecting the display should consist of simply plugging it into your computer's
  85 RS-232 port.  Because these displays typically support full RS-232, no additional
  86 wiring is needed. If your computer does not have such a port (many newer computers don't),
  87 you can use a USB to serial adapter with the appropriate driver.
  88 </para>
  89
  90 <note>
  91   <para>
  92   If your display supports a <emphasis>pass-through</emphasis> function,
  93   but you do not have another RS-232 device connected to the pass-through port,
  94   you may experience hangs if an improperly formatted command sneaks through.
  95   This is because the display is waiting for the pass-through device to accept
  96   the data and a blocking state is created within the device.
  97   You can either connect another RS-232 device, or rewire the display to send the
  98   pass-through commands back to your computer.
  99   </para>
 100 </note>
 101
 102 </sect2>
 103
 104 <!-- ## Serial POS driver ## -->
 105 <sect2 id="serialPOS-config">
 106 <title>Configuration in LCDd.conf</title>
 107
 108 <sect3 id="serialPOS-config-section">
 109 <title>[serialPOS]</title>
 110
 111 <variablelist>
 112
 113 <varlistentry>
 114   <term>
 115     <command>Device=</command>
 116     <arg choice="plain"><replaceable>DEVICE</replaceable></arg>
 117   </term>
 118   <listitem><para>
 119     Device to use in serial mode. Usual values are <filename>/dev/ttyS0</filename> or
 120     <filename>/dev/cu.usbserial</filename>. Default is <filename>/dev/lcd</filename>.
 121   </para></listitem>
 122 </varlistentry>
 123
 124 <varlistentry>
 125   <term>
 126     <command>Size=</command>
 127     <arg choice="plain">
 128       <replaceable>WIDTH</replaceable>
 129       <literal>x</literal>
 130       <replaceable>HEIGHT</replaceable>
 131     </arg>
 132   </term>
 133   <listitem><para>
 134     Specifies the size of the VFD in characters.
 135     If not given, it defaults to <literal>16x2</literal>.
 136   </para></listitem>
 137 </varlistentry>
 138
 139 <varlistentry>
 140   <term>
 141     <command>Type=</command>
 142     <arg choice="plain">
 143     <group choice="req">
 144       <arg choice="plain"><literal>IEE</literal></arg>
 145       <arg choice="plain"><literal><emphasis>AEDEX</emphasis></literal></arg>
 146       <arg choice="plain"><literal>Epson</literal></arg>
 147       <arg choice="plain"><literal>Emax</literal></arg>
 148       <arg choice="plain"><literal>IBM</literal></arg>
 149       <arg choice="plain"><literal>LogicControls</literal></arg>
 150       <arg choice="plain"><literal>Ultimate</literal></arg>
 151     </group>
 152     </arg>
 153   </term>
 154   <listitem><para>
 155     Set the communication protocol to use with the POS display.
 156     If not specified it defaults to <literal>AEDEX</literal>.
 157     Currently, only AEDEX is supported.
 158   </para></listitem>
 159 </varlistentry>
 160
 161 <varlistentry>
 162   <term>
 163     <command>Speed=</command>
 164     <arg choice="plain">
 165     <group choice="req">
 166       <arg choice="plain"><literal>1200</literal></arg>
 167       <arg choice="plain"><literal>2400</literal></arg>
 168       <arg choice="plain"><literal><emphasis>9600</emphasis></literal></arg>
 169       <arg choice="plain"><literal>19200</literal></arg>
 170       <arg choice="plain"><literal>115200</literal></arg>
 171     </group>
 172     </arg>
 173   </term>
 174   <listitem><para>
 175     Set the the baud rate communication with the POS display.
 176     If not given the default of <literal>9600</literal> is used.
 177   </para></listitem>
 178 </varlistentry>
 179 </variablelist>
 180
 181 </sect3>
 182
 183 </sect2>
 184
 185 </sect1>
 186