#
# $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. 
thor</option>
<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/?id=317e100ae6b7f70b3650a9eef5102c93ea5c7d77&amp;showmsg=1&amp;follow=1'>root</a>/<a href='/lcd4linux.git/log/CodingStyle?id=317e100ae6b7f70b3650a9eef5102c93ea5c7d77&amp;showmsg=1&amp;follow=1'>CodingStyle</a> (<a href='/lcd4linux.git/log/CodingStyle?id=317e100ae6b7f70b3650a9eef5102c93ea5c7d77&amp;showmsg=1'>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/CodingStyle?id=317e100ae6b7f70b3650a9eef5102c93ea5c7d77&amp;follow=1'>Collapse</a>)</th><th class='left'>Author</th><th class='left'>Files</th><th class='left'>Lines</th></tr>
<tr class='logheader'><td><span title='2008-04-10 14:55:23 +0000'>2008-04-10</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugin_sample.c?id=1780538c9814f3852f7816900a9b3f89b8cd69d9&amp;follow=1'>Add the year 2008 to the copyright</a></td><td>michux</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@870 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-04-10 14:45:45 +0000'>2008-04-10</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugins.m4?id=5228b499ae2aaf77a7203a33a6a3216854fbe479&amp;follow=1'>Add basic FIFO plugin</a></td><td>michux</td><td>4</td><td><span class='deletions'>-0</span>/<span class='insertions'>+197</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@869 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-04-04 10:10:39 +0000'>2008-04-04</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/Makefile.in?id=e52b948730d08edbe20fee98b8ac860d620c467b&amp;follow=1'>fixed autoconf</a></td><td>michux</td><td>2</td><td><span class='deletions'>-0</span>/<span class='insertions'>+3</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@868 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-04-04 10:01:03 +0000'>2008-04-04</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugins.m4?id=d17bf7e52e5e26e74aa5c032176cc791ae3c1158&amp;follow=1'>update autoconf</a></td><td>michux</td><td>5</td><td><span class='deletions'>-2392</span>/<span class='insertions'>+438</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@867 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-04-04 08:42:02 +0000'>2008-04-04</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugins.m4?id=a8bc5d3f8cd0c2063f60ccc242131e48675b6971&amp;follow=1'>Add asterisk plugin, thanks to  mcarey@yostengineering.com</a></td><td>michux</td><td>3</td><td><span class='deletions'>-1</span>/<span class='insertions'>+197</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@866 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-04-03 16:05:38 +0000'>2008-04-03</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/drv.c?id=497d74d41093e636b4827f16f1807ef484a984d5&amp;follow=1'>fix typo, close #114</a></td><td>michux</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@865 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-04-03 15:59:11 +0000'>2008-04-03</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugin_mpd.c?id=8943d88a35cfd2f595c6c704e73fc78ac74c6d8a&amp;follow=1'>update charset for Crystalfontz Model 632 and 634</a></td><td>michux</td><td>2</td><td><span class='deletions'>-3</span>/<span class='insertions'>+87</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@864 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-03-05 21:41:25 +0000'>2008-03-05</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugin_mpd.c?id=f8e1cb6dfad58e737503840353ba9713409907b7&amp;follow=1'>improve error messages</a></td><td>michux</td><td>1</td><td><span class='deletions'>-7</span>/<span class='insertions'>+13</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@863 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-03-03 22:57:16 +0000'>2008-03-03</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugin_mpd.c?id=86bf4cf15d18dc2ef7fd9e65e1e0d7f49d60480b&amp;follow=1'>reformat plugin_mpd - use c style comments</a></td><td>michux</td><td>1</td><td><span class='deletions'>-8</span>/<span class='insertions'>+8</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@862 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-03-03 17:04:12 +0000'>2008-03-03</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/plugin_button_exec.c?id=98f6c48487f4bde508484191ef700ed1b238eff9&amp;follow=1'>correct code format (indent)</a></td><td>michux</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+2</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@861 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>
<tr class='logheader'><td><span title='2008-03-03 17:03:00 +0000'>2008-03-03</span></td><td class='logsubject'><a href='/lcd4linux.git/commit/widget_text.c?id=4e6b809f540d17425d59df4cde3dfdab58960b06&amp;follow=1'>correct code format (indent)</a></td><td>michux</td><td>5</td><td><span class='deletions'>-184</span>/<span class='insertions'>+185</span></td></tr>
<tr class='nohover-highlight'><td/><td colspan='5' class='logmsg'>
git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@860 3ae390bd-cb1e-0410-b409-cd5a39f66f1f


</td></tr>