#
# $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. 
<option value='grep'>log msg</option>
<option value='author'>author</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='/dtv-scan-tables.git/log/?id=6d019038cd04e837d9dd58701202c15924c1c654&amp;follow=1'>root</a>/<a href='/dtv-scan-tables.git/log/isdb-t?id=6d019038cd04e837d9dd58701202c15924c1c654&amp;follow=1'>isdb-t</a>/<a href='/dtv-scan-tables.git/log/isdb-t/br-pa-Parauapebas?id=6d019038cd04e837d9dd58701202c15924c1c654&amp;follow=1'>br-pa-Parauapebas</a> (<a href='/dtv-scan-tables.git/log/isdb-t/br-pa-Parauapebas?id=6d019038cd04e837d9dd58701202c15924c1c654'>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='/dtv-scan-tables.git/log/isdb-t/br-pa-Parauapebas?id=6d019038cd04e837d9dd58701202c15924c1c654&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='2019-09-22 17:10:09 -0300'>2019-09-22</span></td><td><a href='/dtv-scan-tables.git/commit/isdb-t/br-to-Tocantinopolis?id=f07bde777d4d4e25e46cd6a916ddf43dcd762ea0&amp;follow=1'>isdb-t: update tables</a></td><td>Mauro Carvalho Chehab</td><td>2210</td><td><span class='deletions'>-13522</span>/<span class='insertions'>+148049</span></td></tr>
<tr><td><span title='2019-09-22 11:06:02 -0300'>2019-09-22</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-s/Yamal-402-54.9E?id=cf4a49bf57c937000fe543d2bdd0d5dfbd0f3fef&amp;follow=1'>dvb-s: update all tables from LyngSat</a></td><td>Mauro Carvalho Chehab</td><td>151</td><td><span class='deletions'>-4470</span>/<span class='insertions'>+5108</span></td></tr>
<tr><td><span title='2019-08-12 09:32:17 -0300'>2019-08-12</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-t/ke-Nairobi?id=3196ef2598df7f1f578f86d62187f54f2ecbe104&amp;follow=1'>ke-Nairobi: fix delivery system for two DVB-T2 channels</a></td><td>Mauro Carvalho Chehab</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2019-08-12 09:32:17 -0300'>2019-08-12</span></td><td><a href='/dtv-scan-tables.git/commit/Makefile?id=ae12a359f6de47b79ecb90ae57db7970dc5fe041&amp;follow=1'>Makefile: fix dvbv3/dvbv5 output</a></td><td>Mauro Carvalho Chehab</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2019-08-12 09:03:37 -0300'>2019-08-12</span></td><td><a href='/dtv-scan-tables.git/commit/Makefile?id=3ccfafaa520247eeb72d7eeae047324de2fe7c32&amp;follow=1'>Improve Makefile to avoid "Argument list too long" error</a></td><td>James Le Cuirot</td><td>1</td><td><span class='deletions'>-6</span>/<span class='insertions'>+10</span></td></tr>
<tr><td><span title='2019-03-25 20:38:44 +0100'>2019-03-25</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-c/cz-UPC?id=1c187978d479a2f941c9c4fb10d8b2612d5fde3c&amp;follow=1'>UPC Czech Republic: added mux 538 MHz with 256 QAM</a></td><td>Josef Schlehofer</td><td>1</td><td><span class='deletions'>-5</span>/<span class='insertions'>+13</span></td></tr>
<tr><td><span title='2019-03-25 20:38:44 +0100'>2019-03-25</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-c/cz-UPC?id=c6bf0a9cde1a3c610a377ac7baece2f260bc3999&amp;follow=1'>UPC Czech Republic: added more muxes and change QAM/256 on 626 MHz</a></td><td>Josef Schlehofer</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+19</span></td></tr>
<tr><td><span title='2019-03-25 20:37:00 +0100'>2019-03-25</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-s/Astra-19.2E?id=9bf775ae268f2e992d6ea57625bcf41f197eed59&amp;follow=1'>Update Astra-19.2E</a></td><td>CvH</td><td>1</td><td><span class='deletions'>-4</span>/<span class='insertions'>+5</span></td></tr>
<tr><td><span title='2019-03-14 16:33:15 -0300'>2019-03-14</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-s/Intelsat-907-27.5W?id=811c902f5b040a5675dcb9cdfcd8323da761c73d&amp;follow=1'>Intelsat-907-27.5W: update from current LyngSat data</a></td><td>Mauro Carvalho Chehab</td><td>1</td><td><span class='deletions'>-24</span>/<span class='insertions'>+197</span></td></tr>
<tr><td><span title='2019-03-14 16:32:18 -0300'>2019-03-14</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-s/Intelsat-905-24.5W?id=d784993e34a4bfa0fbd056f8b804ace2c2409107&amp;follow=1'>Intelsat-905-24.5W: update from current LyngSat data</a></td><td>Mauro Carvalho Chehab</td><td>1</td><td><span class='deletions'>-18</span>/<span class='insertions'>+711</span></td></tr>
<tr><td><span title='2019-03-14 16:30:19 -0300'>2019-03-14</span></td><td><a href='/dtv-scan-tables.git/commit/dvb-s/Yamal-402-54.9E?id=13fe49b3be2b64ae63d65fe73d2da4f4deb33eda&amp;follow=1'>Add missing satellites</a></td><td>Mauro Carvalho Chehab</td><td>219</td><td><span class='deletions'>-2</span>/<span class='insertions'>+61017</span></td></tr>