#
# $Id: README.Drivers,v 1.4 2001/03/09 13:08:11 ltoetsch Exp $
#

How to write new display drivers for lcd4linux

If you plan to write a new display driver for lcd4linux, you should follow
this guidelines:

* use Skeleton.c as a start point.
  You might also have a look at Text.c

* create a new sourcefile <drivername>.c and add it to the bottom of
  Makefile.am

* add an entry to configure.in

* there's no need for a <drivername>.h

* create one (or more) unique display names (your driver will be selected by
  this name in the 'Display'-line of lcd4linux.conf).

* include "display.h" in your driver, to get the LCD structure and various 
  BAR_ definitions

* include "cfg.h" if you need to access settings in the config file.

* create a LCD table at the bottom of your driver, and fill it with the
  appropriate values. Take care that you specify the correct bar capabilities
  of your display or driver:

  BAR_L:  horizontal bars headed left
  BAR_R:  horizontal bars headed right
  BAR_H2: driver supports horizontal dual-bars
  BAR_U:  vertical bars bottom-up
  BAR_D:  vertical bars top-down
  BAR_V2: driver supports vertical dual-bars

* edit display.c and create a reference to your LCD table:

     external LCD YourDriver[];

* extend the FAMILY table in display.c with your driver:

     FAMILY Driver[] = {
       { "Skeleton",      Skeleton },
       { "MatrixOrbital", MatrixOrbital },
       { "YourFamily",    YourDriver },
       { "" }
     };

* write the correspondig init(), clear(), put(), bar(), quit() and
  flush()-functions. There's no need to use a framebuffer and display its
  contents with the flush()- call (as in MatrixOrbital.c), you can directly
  write to the display in the put()- and bar()-functions, and use an empty
  flush()-function. But if you have a limited number of user-defined
  characters, and therefore you have to do some sort of 'character reduction'
  or similar stuff, you will have to use a framebuffer and the flush()-call. 
ue='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/debian/lcd4linux.git/log/?id=928b0e09a5725abfd53421f19e5e53845e7aa100&amp;follow=1'>root</a>/<a href='/debian/lcd4linux.git/log/nph-png?id=928b0e09a5725abfd53421f19e5e53845e7aa100&amp;follow=1'>nph-png</a> (<a href='/debian/lcd4linux.git/log/nph-png?id=928b0e09a5725abfd53421f19e5e53845e7aa100'>unfollow</a>)</div><div class='content'><table class='list nowrap'><tr class='nohover'><th class='left'>Age</th><th class='left'>Commit message (<a href='/debian/lcd4linux.git/log/nph-png?id=928b0e09a5725abfd53421f19e5e53845e7aa100&amp;showmsg=1&amp;follow=1'>Expand</a>)</th><th class='left'>Author</th><th class='left'>Files</th><th class='left'>Lines</th></tr>
<tr><td><span title='2004-01-18 09:01:45 +0000'>2004-01-18</span></td><td><a href='/debian/lcd4linux.git/commit/timer.c?id=6c86643d7e174294488e42c5f0404f5a6244668f&amp;follow=1'>[lcd4linux @ 2004-01-18 09:01:45 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-61</span>/<span class='insertions'>+220</span></td></tr>
<tr><td><span title='2004-01-18 06:54:08 +0000'>2004-01-18</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_proc_stat.c?id=9fdad968332d4a70090cf813f0620e3c5d66a0ef&amp;follow=1'>[lcd4linux @ 2004-01-18 06:54:08 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-27</span>/<span class='insertions'>+76</span></td></tr>
<tr><td><span title='2004-01-16 11:12:26 +0000'>2004-01-16</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_xmms.c?id=78edc6d12b0f0017cf88d8dca930ee2c41f99948&amp;follow=1'>[lcd4linux @ 2004-01-16 11:12:26 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-49</span>/<span class='insertions'>+128</span></td></tr>
<tr><td><span title='2004-01-16 10:09:49 +0000'>2004-01-16</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_xmms.c?id=235ee4da33d591b4fb0ca1bf97ede8bfb2235c98&amp;follow=1'>[lcd4linux @ 2004-01-16 10:09:49 by mkeil]</a></td><td>mkeil</td><td>1</td><td><span class='deletions'>-12</span>/<span class='insertions'>+29</span></td></tr>
<tr><td><span title='2004-01-16 07:26:25 +0000'>2004-01-16</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_proc_stat.c?id=5f79f653ec112d7dd631c8bdd78ed540b3151385&amp;follow=1'>[lcd4linux @ 2004-01-16 07:26:25 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-196</span>/<span class='insertions'>+146</span></td></tr>
<tr><td><span title='2004-01-16 05:04:53 +0000'>2004-01-16</span></td><td><a href='/debian/lcd4linux.git/commit/system.c?id=914a4213848bda638bbe14b0fd7b873b8bdeeb32&amp;follow=1'>[lcd4linux @ 2004-01-16 05:04:53 by reinelt]</a></td><td>reinelt</td><td>10</td><td><span class='deletions'>-32</span>/<span class='insertions'>+326</span></td></tr>
<tr><td><span title='2004-01-15 07:47:03 +0000'>2004-01-15</span></td><td><a href='/debian/lcd4linux.git/commit/widget_text.h?id=4d0255d6a1eddbf57178f7170838c20c6b2f5573&amp;follow=1'>[lcd4linux @ 2004-01-15 07:47:02 by reinelt]</a></td><td>reinelt</td><td>7</td><td><span class='deletions'>-100</span>/<span class='insertions'>+210</span></td></tr>
<tr><td><span title='2004-01-15 04:32:14 +0000'>2004-01-15</span></td><td><a href='/debian/lcd4linux.git/commit/ChangeLog?id=7df743f2d1c161624ca70a061e9ef82e2daad475&amp;follow=1'>[lcd4linux @ 2004-01-15 04:32:14 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+101</span></td></tr>
<tr><td><span title='2004-01-15 04:29:45 +0000'>2004-01-15</span></td><td><a href='/debian/lcd4linux.git/commit/widget_text.h?id=4c7a9fc77fda570b656f18d8ee59eb560df87ad2&amp;follow=1'>[lcd4linux @ 2004-01-15 04:29:45 by reinelt]</a></td><td>reinelt</td><td>10</td><td><span class='deletions'>-335</span>/<span class='insertions'>+719</span></td></tr>
<tr><td><span title='2004-01-14 11:33:00 +0000'>2004-01-14</span></td><td><a href='/debian/lcd4linux.git/commit/widget_text.c?id=b8448093e2f554744fa5911b2c96174b78f4ae0f&amp;follow=1'>[lcd4linux @ 2004-01-14 11:33:00 by reinelt]</a></td><td>reinelt</td><td>15</td><td><span class='deletions'>-160</span>/<span class='insertions'>+607</span></td></tr>
<tr><td><span title='2004-01-13 10:03:01 +0000'>2004-01-13</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_sample.c?id=b626a0b1272e703d01a8001ddd7bab7b3cd5b6e3&amp;follow=1'>[lcd4linux @ 2004-01-13 10:03:01 by reinelt]</a></td><td>reinelt</td><td>8</td><td><span class='deletions'>-23</span>/<span class='insertions'>+458</span></td></tr>
<tr><td><span title='2004-01-13 08:18:20 +0000'>2004-01-13</span></td><td><a href='/debian/lcd4linux.git/commit/widget_text.c?id=0b18f5b46afcb30ba2bc3e813eb170463a84b073&amp;follow=1'>[lcd4linux @ 2004-01-13 08:18:07 by reinelt]</a></td><td>reinelt</td><td>12</td><td><span class='deletions'>-154</span>/<span class='insertions'>+469</span></td></tr>
<tr><td><span title='2004-01-12 03:51:01 +0000'>2004-01-12</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.c?id=3d4765569e009b6bb02add493d5abfe727709ec5&amp;follow=1'>[lcd4linux @ 2004-01-12 03:51:01 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-15</span>/<span class='insertions'>+44</span></td></tr>
<tr><td><span title='2004-01-11 18:26:02 +0000'>2004-01-11</span></td><td><a href='/debian/lcd4linux.git/commit/widget_text.c?id=81017f73686edcfdb61be27996f8001182cc8c98&amp;follow=1'>[lcd4linux @ 2004-01-11 18:26:02 by reinelt]</a></td><td>reinelt</td><td>10</td><td><span class='deletions'>-79</span>/<span class='insertions'>+158</span></td></tr>
<tr><td><span title='2004-01-11 09:26:15 +0000'>2004-01-11</span></td><td><a href='/debian/lcd4linux.git/commit/widget.c?id=d6a1b51232a42b9593789b10366577a03c9e2c41&amp;follow=1'>[lcd4linux @ 2004-01-11 09:26:15 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-19</span>/<span class='insertions'>+67</span></td></tr>
<tr><td><span title='2004-01-10 20:22:33 +0000'>2004-01-10</span></td><td><a href='/debian/lcd4linux.git/commit/widget_text.c?id=866b24820cd9220f001b5ac18be8e881ec341cee&amp;follow=1'>[lcd4linux @ 2004-01-10 20:22:33 by reinelt]</a></td><td>reinelt</td><td>13</td><td><span class='deletions'>-210</span>/<span class='insertions'>+554</span></td></tr>
<tr><td><span title='2004-01-10 17:45:26 +0000'>2004-01-10</span></td><td><a href='/debian/lcd4linux.git/commit/plugin.c?id=a5a10e14a47d027a579058f54ac278029cdb2afc&amp;follow=1'>[lcd4linux @ 2004-01-10 17:45:26 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-5</span>/<span class='insertions'>+15</span></td></tr>
<tr><td><span title='2004-01-10 17:36:56 +0000'>2004-01-10</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_i2c_sensors.c?id=cc72fe8df8ab12f9db93f37d4e509696242b5a0b&amp;follow=1'>[lcd4linux @ 2004-01-10 17:36:56 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-10</span>/<span class='insertions'>+207</span></td></tr>
<tr><td><span title='2004-01-10 17:34:40 +0000'>2004-01-10</span></td><td><a href='/debian/lcd4linux.git/commit/widget.h?id=c2307e1e80dde20fcf1aabcda9a3819459af4ed1&amp;follow=1'>[lcd4linux @ 2004-01-10 17:34:40 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-176</span>/<span class='insertions'>+138</span></td></tr>
<tr><td><span title='2004-01-10 10:20:22 +0000'>2004-01-10</span></td><td><a href='/debian/lcd4linux.git/commit/drv_MatrixOrbital.c?id=ac9acd61f24e6881bb1956ab74fd7d4fd04ceb6b&amp;follow=1'>[lcd4linux @ 2004-01-10 10:20:22 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-14</span>/<span class='insertions'>+605</span></td></tr>
<tr><td><span title='2004-01-09 17:03:07 +0000'>2004-01-09</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.c?id=117fa6f13e164c7eb5edaee955cabe2666718845&amp;follow=1'>[lcd4linux @ 2004-01-09 17:03:06 by reinelt]</a></td><td>reinelt</td><td>10</td><td><span class='deletions'>-51</span>/<span class='insertions'>+420</span></td></tr>
<tr><td><span title='2004-01-09 04:16:06 +0000'>2004-01-09</span></td><td><a href='/debian/lcd4linux.git/commit/wifi.c?id=c8d1a94e34b59f94c8bf7af1a5dde282515a2e19&amp;follow=1'>[lcd4linux @ 2004-01-09 04:16:06 by reinelt]</a></td><td>reinelt</td><td>28</td><td><span class='deletions'>-193</span>/<span class='insertions'>+332</span></td></tr>
<tr><td><span title='2004-01-08 06:00:28 +0000'>2004-01-08</span></td><td><a href='/debian/lcd4linux.git/commit/cfg.c?id=28ae14208cef01ae0ca6293b88968ec31bec855e&amp;follow=1'>[lcd4linux @ 2004-01-08 06:00:28 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-8</span>/<span class='insertions'>+14</span></td></tr>
<tr><td><span title='2004-01-08 05:28:12 +0000'>2004-01-08</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.c?id=81dbc5fd7b41af8ba7f02da82d762ebb46aab8f0&amp;follow=1'>[lcd4linux @ 2004-01-08 05:28:12 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-42</span>/<span class='insertions'>+198</span></td></tr>
<tr><td><span title='2004-01-07 10:15:41 +0000'>2004-01-07</span></td><td><a href='/debian/lcd4linux.git/commit/libtool?id=895982032e2b237e9810dd11b7c70a66e1a9c34c&amp;follow=1'>[lcd4linux @ 2004-01-07 10:15:41 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-184</span>/<span class='insertions'>+436</span></td></tr>
<tr><td><span title='2004-01-06 23:01:37 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/evaluator.c?id=a52cd7cec845dcb9e7a069b6ff4a2a0e88679ea7&amp;follow=1'>[lcd4linux @ 2004-01-06 23:01:37 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-4</span>/<span class='insertions'>+7</span></td></tr>
<tr><td><span title='2004-01-06 22:33:14 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/wifi.h?id=3c737870508ceba11eede58553a51b5e6034b3c0&amp;follow=1'>[lcd4linux @ 2004-01-06 22:33:13 by reinelt]</a></td><td>reinelt</td><td>14</td><td><span class='deletions'>-472</span>/<span class='insertions'>+542</span></td></tr>
<tr><td><span title='2004-01-06 21:14:51 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/debian/templates?id=3db97df907f48d9f3cd388f2679db2d23c9941e8&amp;follow=1'>[lcd4linux @ 2004-01-06 21:14:51 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-14</span>/<span class='insertions'>+7</span></td></tr>
<tr><td><span title='2004-01-06 18:22:41 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/debian/copyright?id=85163d5ca22b6b6576cc41b5c668a77049261053&amp;follow=1'>[lcd4linux @ 2004-01-06 18:22:41 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+13</span></td></tr>
<tr><td><span title='2004-01-06 17:56:43 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/ltmain.sh?id=141e509812150592940b467bf87f8920902e2723&amp;follow=1'>[lcd4linux @ 2004-01-06 17:56:43 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-1000</span>/<span class='insertions'>+2045</span></td></tr>
<tr><td><span title='2004-01-06 17:37:00 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/ChangeLog?id=5d41d10f2ddbe8bf5c6df351fcf161829b5156fd&amp;follow=1'>[lcd4linux @ 2004-01-06 17:37:00 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+20</span></td></tr>
<tr><td><span title='2004-01-06 17:33:45 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_sample.c?id=c564fdeab0968112111210ff6a99579a5d8b1b6e&amp;follow=1'>[lcd4linux @ 2004-01-06 17:33:45 by reinelt]</a></td><td>reinelt</td><td>6</td><td><span class='deletions'>-28</span>/<span class='insertions'>+298</span></td></tr>
<tr><td><span title='2004-01-06 15:19:16 +0000'>2004-01-06</span></td><td><a href='/debian/lcd4linux.git/commit/plugin.c?id=cb6a389538ce70ec014dbfe89dd0c4651c54422a&amp;follow=1'>[lcd4linux @ 2004-01-06 15:19:12 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-104</span>/<span class='insertions'>+136</span></td></tr>
<tr><td><span title='2004-01-05 11:57:38 +0000'>2004-01-05</span></td><td><a href='/debian/lcd4linux.git/commit/processor.c?id=769d5b11f35d1a464581d5f8111ad0ed3c78b408&amp;follow=1'>[lcd4linux @ 2004-01-05 11:57:38 by reinelt]</a></td><td>reinelt</td><td>7</td><td><span class='deletions'>-8</span>/<span class='insertions'>+168</span></td></tr>
<tr><td><span title='2004-01-02 14:20:15 +0000'>2004-01-02</span></td><td><a href='/debian/lcd4linux.git/commit/debian/templates?id=e960f9103cb38626e9709e2310fe8d4c73855812&amp;follow=1'>[lcd4linux @ 2004-01-02 14:20:15 by reinelt]</a></td><td>reinelt</td><td>10</td><td><span class='deletions'>-0</span>/<span class='insertions'>+201</span></td></tr>
<tr><td><span title='2004-01-02 14:18:54 +0000'>2004-01-02</span></td><td><a href='/debian/lcd4linux.git/commit/TODO?id=707a9814c936000490f2234110e0a85685415610&amp;follow=1'>[lcd4linux @ 2004-01-02 14:18:54 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-0</span>/<span class='insertions'>+101</span></td></tr>
<tr><td><span title='2003-12-19 06:27:33 +0000'>2003-12-19</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_xmms.c?id=55600afb5eb32a15dde4d8ec6a2a03446f6906ff&amp;follow=1'>[lcd4linux @ 2003-12-19 06:27:33 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-8</span>/<span class='insertions'>+119</span></td></tr>