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.
189 lines
6.0 KiB
Plaintext
189 lines
6.0 KiB
Plaintext
<sect1 id="CFontzPacket-howto">
|
|
<title>The CFontzPacket Driver</title>
|
|
|
|
<para>
|
|
<ulink url="http://www.cwcrystalfontz.com/">CrystalFontz</ulink> offers a wide
|
|
range of character and graphical LCD modules.
|
|
The <code>CFontzPacket</code> driver supports the modules that communicate
|
|
with the host computer using a packet-based communications protocol
|
|
with 16-bit CRC (hence the driver name).
|
|
</para>
|
|
|
|
<para>
|
|
Currently this line of modules comprises the models:
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>CFA-631</term>
|
|
<listitem>
|
|
<itemizedlist>
|
|
<listitem><para>20x2 character LCD with backlight</para></listitem>
|
|
<listitem><para>keypad with 4 keys: Up, Down, enter & Escape</para></listitem>
|
|
<listitem><para>USB connection for data and power</para></listitem>
|
|
<listitem><para>mounting bracket to fit into 3,5" drive bays</para></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>CFA-633</term>
|
|
<listitem>
|
|
<itemizedlist>
|
|
<listitem><para>16x2 character LCDi with backlight</para></listitem>
|
|
<listitem><para>keypad with 6 keys: 4 directions, Enter & Escape</para></listitem>
|
|
<listitem><para>serial or USB connection</para></listitem>
|
|
<listitem><para>mounting bracket to fit into 5,25" drive bays</para></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>CFA-635</term>
|
|
<listitem>
|
|
<itemizedlist>
|
|
<listitem><para>20x4 characters LCDi with backlight</para></listitem>
|
|
<listitem><para>keypad with 6 keys: 4 directions, Enter & Escape</para></listitem>
|
|
<listitem><para>USB connection for data and power</para></listitem>
|
|
<listitem><para>four bi-color LEDs to show status information</para></listitem>
|
|
<listitem><para>optional mounting bracket to fit into 5,25" drive bays</para></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
<!-- ## CrystalFontz packet driver (for CF631, CF633 & CF635) ## -->
|
|
<sect2 id="CFontzPacket-config">
|
|
<title>Configuration in LCDd.conf</title>
|
|
|
|
<sect3 id="CFontzPacket-config-section">
|
|
<title>[CFontzPacket]</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<property>Model</property> =
|
|
{
|
|
<parameter><literal>631</literal></parameter> |
|
|
<emphasis><parameter><literal>633</literal></parameter></emphasis> |
|
|
<parameter><literal>635</literal></parameter>
|
|
}
|
|
</term>
|
|
<listitem><para>
|
|
Select the LCD model that is connected.
|
|
Legal values for this option are <literal>631</literal>,
|
|
<literal>633</literal>, or <literal>635</literal>,
|
|
with the default being <literal>633</literal>.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Device</property> =
|
|
<parameter><replaceable>DEVICE</replaceable></parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Select the output device to use.
|
|
It may be a serial device or a USB device in serial emulation mode.
|
|
If not given, it defaults to <filename>/dev/lcd</filename>.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Mac OS X users may need to use one of the <filename>/dev/cu</filename>
|
|
devices instead of the <filename>/dev/tty</filename> ones.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Size</property> = ¶meters.size;
|
|
</term>
|
|
<listitem><para>
|
|
Select the LCD size [default: depending on model: 635: <literal>20x4</literal>,
|
|
631: <literal>20x2</literal>,
|
|
633: <literal>16x2</literal>]
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Contrast</property> =
|
|
<parameter><replaceable>CONTRAST</replaceable></parameter>
|
|
</term>
|
|
<listitem><para>
|
|
Set the initial contrast.
|
|
Legal values for <replaceable>CONTRAST</replaceable> are <literal>0</literal> - <literal>1000</literal>.
|
|
If not specified, it defaults to <literal>560</literal>.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Brightness</property> =
|
|
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
|
|
</term>
|
|
<listitem><para>
|
|
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>OffBrightness</property> =
|
|
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
|
|
</term>
|
|
<listitem><para>
|
|
Set the initial off-brightness [default: <literal>0</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
|
|
This value is used when the display is normally
|
|
switched off in case LCDd is inactive
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Speed</property> =
|
|
{
|
|
<parameter><literal>1200</literal></parameter> |
|
|
<parameter><literal>2400</literal></parameter> |
|
|
<parameter><literal>9600</literal></parameter> |
|
|
<parameter><literal>19200</literal></parameter> |
|
|
<parameter><literal>115200</literal></parameter>
|
|
}
|
|
</term>
|
|
<listitem><para>
|
|
Set the the baud rate for communication with the LCD.
|
|
If not specified, the default depends on the model: it is <literal>9600</literal>
|
|
for the CFA633 and <literal>115200</literal> for the CFA631 and CFA635.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>NewFirmware</property> = ¶meters.yesnodef;
|
|
</term>
|
|
<listitem><para>
|
|
Set the firmware version (<emphasis>New</emphasis> means >= 2.0) [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
|
Currently this flag is not in use, there is no such thing as NewFirmware. ;=)
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<property>Reboot</property> = ¶meters.yesnodef;
|
|
</term>
|
|
<listitem><para>
|
|
Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
|
I want to reboot the LCD to make sure we start from a known state
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|