docs/lcdproc-user/drivers/CFontz.docbook

   1 <sect1 id="CFontz-howto">
   2 <title>The CFontz Driver</title>
   3
   4 <para>
   5 This section talks about using LCDproc with LCD displays that use the
   6 CFontz chipset.
   7 </para>
   8
   9 <!-- ## CrystalFontz driver (for CF632 &amp; CF634) ## -->
  10 <sect2 id="CFontz-config">
  11 <title>Configuration in LCDd.conf</title>
  12
  13 <sect3 id="CFontz-config-section">
  14 <title>[CFontz]</title>
  15
  16 <variablelist>
  17 <varlistentry>
  18   <term>
  19     <command>Device=</command>
  20     <arg choice="plain"><replaceable>DEVICE</replaceable></arg>
  21   </term>
  22   <listitem><para>
  23     Select the serial output device to use.
  24     If not given, default is <filename>/dev/lcd</filename>.
  25   </para></listitem>
  26 </varlistentry>
  27
  28 <varlistentry>
  29   <term>
  30     <command>Size=</command>
  31     <arg choice="plain">
  32       <replaceable>WIDTH</replaceable>
  33       <literal>x</literal>
  34       <replaceable>HEIGHT</replaceable>
  35     </arg>
  36   </term>
  37   <listitem><para>
  38     Set the LCD's dimensions in terms of characters per line and lines.
  39     If not given, it defaults to <literal>20x4</literal>.
  40   </para></listitem>
  41 </varlistentry>
  42
  43 <varlistentry>
  44   <term>
  45     <command>Contrast=</command>
  46     <arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
  47   </term>
  48   <listitem><para>
  49     Set the initial contrast.
  50     Legal values for <replaceable>CONTRAST</replaceable> are in the range
  51     between <literal>0</literal> and <literal>1000</literal>.
  52     If not given, it defaults to <literal>140</literal>.
  53   </para></listitem>
  54 </varlistentry>
  55
  56 <varlistentry>
  57   <term>
  58     <command>Brightness=</command>
  59     <arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
  60   </term>
  61   <listitem><para>
  62     Set the initial brightness.
  63     Legal values for <replaceable>BRIGHTNESS</replaceable> range from
  64     <literal>0</literal> to <literal>1000</literal>.
  65     If not given, it defaults to <literal>1000</literal>.
  66   </para></listitem>
  67 </varlistentry>
  68
  69 <varlistentry>
  70   <term>
  71     <command>OffBrightness=</command>
  72     <arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
  73   </term>
  74   <listitem><para>
  75     Set the initial off-brightness.
  76     This value is used when the display is normally
  77     switched off in case LCDd is inactive.
  78     Legal values <replaceable>BRIGHTNESS</replaceable> are in the range
  79     from <literal>0</literal> to <literal>1000</literal>.
  80     The default is <literal>0</literal>.
  81   </para></listitem>
  82 </varlistentry>
  83
  84 <varlistentry>
  85   <term>
  86     <command>Speed=</command>
  87     <arg choice="plain">
  88     <group choice="req">
  89       <arg choice="plain"><literal>1200</literal></arg>
  90       <arg choice="plain"><literal>2400</literal></arg>
  91       <arg choice="plain"><literal><emphasis>9600</emphasis></literal></arg>
  92       <arg choice="plain"><literal>19200</literal></arg>
  93       <arg choice="plain"><literal>115200</literal></arg>
  94     </group>
  95     </arg>
  96   </term>
  97   <listitem><para>
  98     Set the the baud rate to use when communicating with the LCD.
  99     It defaults to <literal>9600</literal> if not specified.
 100   </para></listitem>
 101 </varlistentry>
 102
 103 <varlistentry>
 104   <term>
 105     <command>NewFirmware=</command>
 106     <arg choice="plain">
 107     <group choice="req">
 108       <arg choice="plain"><literal>yes</literal></arg>
 109       <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
 110     </group>
 111     </arg>
 112   </term>
 113   <listitem><para>
 114     Set the firmware version (<emphasis>New</emphasis> means >= 2.0) [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
 115   </para></listitem>
 116 </varlistentry>
 117
 118 <varlistentry>
 119   <term>
 120     <command>Reboot=</command>
 121     <arg choice="plain">
 122     <group choice="req">
 123       <arg choice="plain"><literal>yes</literal></arg>
 124       <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
 125     </group>
 126     </arg>
 127   </term>
 128   <listitem><para>
 129     Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
 130     normally you shouldn't need this
 131   </para></listitem>
 132 </varlistentry>
 133 </variablelist>
 134
 135 </sect3>
 136
 137 </sect2>
 138
 139 </sect1>