serdisplib Documentation

General information

serdisplib is a library to drive displays.

This documentation is valid for serdisplib >= V. 2.01.
Version 2.x supersedes and combines V. 1.97.x and experimental branch V. 1.98 (which has been available via SVN only but has never been released as an official version).
All extra features of V. 1.98 are now integrated into V. 2.01+, but client/server extensions are still experimental and are not compiled by default as these are subject to change.

Supported displays

• http://serdisplib.sourceforge.net/#displays

Features

• Coding language: c
• Header files compliant with c++-code
• Accessing the output device (parallel, serial port, ...) using ioctl-calls or direct-IO
• Each pixel can be set or cleared separately
• Optimised data-flow between library and display
• abstract software layer for certain display functions (eg: setting contrast)
• Support for colour displays (since version 1.96)
• Support for usb-based displays (since version 1.97)
• Support for OLED displays (since version 1.97.6)
• Support for output via libSDL (since version 1.97.9)
• Support for output via framebuffer (since version 2.00)
• Support for general purpose input/output (GPIs/GPOs) (since version 2.00)

API reference

Core API

• serdisp_connect.h ... accessing an output device
• serdisp_control.h ... accessing and controlling a display
• serdisp_colour.h ... drawing on a display

Extended API (useful functions and helpers, but may be subject to changes)

• serdisp_gpevents.h ... general purpose input/output, event-handling
• serdisp_messages.h ... messages, error handling, useful defines
• serdisp_tools.h ... common routines and little helpers

Additional reference

• Passing Options
• Customisable Wiring
  
  
• Some examples
  
  
• API changes
• Deprecated functions
  
  

Project information

• Authors involved and contributing (AUTHORS)
• GNU General Public License, Version 2 (COPYING)
• How to compile, package, and use the library (README)
• Collected pinouts for certain displays / display-modules (PINOUTS)
• History of changes (HISTORY)

Archived documentation

• serdisplib version <= v 1.97
• serdisplib version <= v 1.95
• serdisplib version <= v 1.94
• serdisplib version <= v 1.92