#
# $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. 
ion>
<option value='committer'>committer</option>
<option value='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='/lcd4linux.git/log/?h=master&amp;id=a67cbe4975c81ecab2d1e2ed087d410534439c00&amp;follow=1'>root</a>/<a href='/lcd4linux.git/log/debug.h?h=master&amp;id=a67cbe4975c81ecab2d1e2ed087d410534439c00&amp;follow=1'>debug.h</a> (<a href='/lcd4linux.git/log/debug.h?h=master&amp;id=a67cbe4975c81ecab2d1e2ed087d410534439c00'>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='/lcd4linux.git/log/debug.h?h=master&amp;id=a67cbe4975c81ecab2d1e2ed087d410534439c00&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='2007-06-17 06:10:11 +0000'>2007-06-17</span></td><td><a href='/lcd4linux.git/commit/drv_X11.c?h=master&amp;id=0802e1b84e35ccd55158189fe0d892fd9dfdbf07&amp;follow=1'>buttons for X11 driver (thanks to Volker Gering)</a></td><td>michael</td><td>1</td><td><span class='deletions'>-8</span>/<span class='insertions'>+49</span></td></tr>
<tr><td><span title='2007-06-17 06:08:00 +0000'>2007-06-17</span></td><td><a href='/lcd4linux.git/commit/plugin_uname.c?h=master&amp;id=d3c68fc20d892252aa243d2e697386ec54065142&amp;follow=1'>Apple has no utsbuf.domainname (thanks to Volker Gering)</a></td><td>michael</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2007-06-17 06:06:19 +0000'>2007-06-17</span></td><td><a href='/lcd4linux.git/commit/evaluator.c?h=master&amp;id=2fcc2950e43cba7cd677057cde39c2766848616f&amp;follow=1'>strndup() replacement</a></td><td>michael</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+24</span></td></tr>
<tr><td><span title='2007-06-17 05:51:15 +0000'>2007-06-17</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.c?h=master&amp;id=d6c3787acf186f58e3fda571e77f73bea7324f40&amp;follow=1'>better usage output by Volker Gering</a></td><td>michael</td><td>1</td><td><span class='deletions'>-4</span>/<span class='insertions'>+20</span></td></tr>
<tr><td><span title='2007-06-08 04:45:16 +0000'>2007-06-08</span></td><td><a href='/lcd4linux.git/commit/drv_Image.c?h=master&amp;id=684bc9f48bbd560618bb2c07f5482d28d1519644&amp;follow=1'>Image driver libgd dependancy fix</a></td><td>michael</td><td>5</td><td><span class='deletions'>-6</span>/<span class='insertions'>+31</span></td></tr>
<tr><td><span title='2007-06-04 04:11:31 +0000'>2007-06-04</span></td><td><a href='/lcd4linux.git/commit/plugin_mpd.c?h=master&amp;id=775475883e63c7486c3ec043d10f62502cf40826&amp;follow=1'>big MPD patch from Robert Buchholz</a></td><td>michael</td><td>1</td><td><span class='deletions'>-79</span>/<span class='insertions'>+86</span></td></tr>
<tr><td><span title='2007-05-19 11:43:32 +0000'>2007-05-19</span></td><td><a href='/lcd4linux.git/commit/plugins.m4?h=master&amp;id=cbde4d3f9281906feb5e051e6fa74ab065bd77c0&amp;follow=1'>gps plugin, code by michu / www.neophob.com</a></td><td>michael</td><td>7</td><td><span class='deletions'>-0</span>/<span class='insertions'>+580</span></td></tr>
<tr><td><span title='2007-05-17 05:23:46 +0000'>2007-05-17</span></td><td><a href='/lcd4linux.git/commit/drivers.m4?h=master&amp;id=93d751a7c3d5c6c1db576460a7f08bd80a0f3bb9&amp;follow=1'>compile error on m68k fixed (debian bug 405898)</a></td><td>michael</td><td>3</td><td><span class='deletions'>-10</span>/<span class='insertions'>+170</span></td></tr>
<tr><td><span title='2007-05-04 11:35:52 +0000'>2007-05-04</span></td><td><a href='/lcd4linux.git/commit/drv_LUIse.c?h=master&amp;id=db6911f350d69aa5fe72254c3104b5e8e3082b32&amp;follow=1'>typo in LUIse driver fixed</a></td><td>michael</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2007-05-02 05:10:55 +0000'>2007-05-02</span></td><td><a href='/lcd4linux.git/commit/plugin_mpd.c?h=master&amp;id=c909270be37026e4877acf556af0556f7d1356c6&amp;follow=1'>some compiler warnings fixed</a></td><td>michael</td><td>6</td><td><span class='deletions'>-8</span>/<span class='insertions'>+14</span></td></tr>
<tr><td><span title='2007-04-30 05:32:03 +0000'>2007-04-30</span></td><td><a href='/lcd4linux.git/commit/svn_version.h?h=master&amp;id=b8b8a6a2cf8726a86bc2ba58fc502ce5a4ac2b1d&amp;follow=1'>LCD4Linux-0.10.1-RC2</a></td><td>michael</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2007-04-30 05:29:22 +0000'>2007-04-30</span></td><td><a href='/lcd4linux.git/commit/ChangeLog?h=master&amp;id=416c593124a6b66e3c6c2c5615a7d3a6d1438897&amp;follow=1'>ChangeLog updated</a></td><td>michael</td><td>1</td><td><span class='deletions'>-1782</span>/<span class='insertions'>+3099</span></td></tr>
<tr><td><span title='2007-04-30 05:25:46 +0000'>2007-04-30</span></td><td><a href='/lcd4linux.git/commit/svn2cl.sh?h=master&amp;id=059c8eb1711ededdb8a8984b688811530b2e9f58&amp;follow=1'>svn2cl moved and optimized</a></td><td>michael</td><td>1</td><td><span class='deletions'>-6</span>/<span class='insertions'>+0</span></td></tr>