====== serdisplib ======

This driver controls all displays supported by the [[http://serdisplib.sourceforge.net|serdisplib]] project.

The serdisplib supports displays connected to parallel port, serial port (RS232), I2C and USB (depending on the displays). Not all versions of serdisplib supports every connection type, consult their [[http://serdisplib.sourceforge.net|webpage]].

For details about serdisplib itself, supported displays, connections and wiring, installation and so on go to the [[http://serdisplib.sourceforge.net|serdisplib project page]].

----

===== Display Section =====

<code>
Display <name> {
    Driver     'serdisplib'
    Model      <string>
    Port       <string>
    Options    <string>
    Font       <string>
    Contrast   <number>
    Backlight  <0|1>
    Reverse    <0|1>
    Rotate     <0..3>
    Foreground <color>
    Background <color>
    Basecolor  <color>
}
</code>


----

===== Parameters: =====

|**Driver**|'serdisplib'|
|**Model**|display model/driver for serdisplib, e.g. 'OPTREX323'|
|**Port**|port where the display is connected in serdisplib notation, e.g. 'PAR:/dev/parports/0' or 'USB:060c/04eb'|
|**Options**|serdisplib options, e.g. 'WIRING=1;INVERT=YES'|
|**Font**|font size, specified as <width>x<height> (only '5x8' and '6x8' supported at the moment)|
|**Contrast**|initial contrast value, 0..10|
|**Backlight**|initial backlight state, 0 (off) or 1 (on)|
|**Reverse**|initial display inversion, 0 (normal) or 1 (inverted)|
|**Rotate**|initial display rotation, 0 (0 normal) to 3 (270 degree)|
|**Foreground**|color of active pixels (RRGGBBAA or RRGGBB), default is opaque black '000000ff' (see [[:colors]] for details)|
|**Background**|color of inactive pixels (RRGGBBAA or RRGGBB), default is transparent 'ffffff00' (see [[:colors]] for details)|
|**Basecolor**|color of virtual backlight (RRGGBB), default is white 'ffffff' (see [[:colors]] for details)|

----

===== Plugins: =====

The driver provides the following functions:

|**LCD::Contrast(n)**|sets the display contrast (0..10)|
|**LCD::Backlight(n)**|sets the backlight state, 0 (off) or 1 (on)|
|**LCD::Reverse(n)**|sets the display inversion, 0 (normal) or 1 (inverted)|
|**LCD::Rotate(n)**|sets the rotation, 0 (0 normal) to 3 (270 degree)|

----

===== Example =====

<code>
Display Optrex323 {
    Driver  'serdisplib'
    Model   'OPTREX323'
    Port    'PAR:/dev/parports/0'
    Options ''
}
</code>


----