Flexible character LCD library for AVR Microcontrollers

Go to file

Collin J. Doering 3a38d3ff18 Update README.md and doxygen front page Use README.md as the front page of the documentation generated by doxygen. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>		2016-01-12 04:54:49 -05:00
.gitignore	First pass setting up doxygen documentation	2015-10-15 01:23:11 -04:00
ansi_escapes.h	First pass setting up doxygen documentation	2015-10-15 01:23:11 -04:00
doxygen.conf	Update README.md and doxygen front page	2016-01-12 04:54:49 -05:00
lcd_instr.h	Refactor, tidy and comment	2015-10-26 05:13:40 -04:00
lcdLib.c	Completed scrollUp and scrollDown functions	2015-10-28 04:53:46 -04:00
lcdLib.h	Read support implemented	2015-10-28 04:30:40 -04:00
lcdLibConfig.h	Support both 5x8 and 5x10 fonts	2015-10-26 22:30:44 -04:00
LICENSE	Restructure project and ready for publishing	2015-10-28 05:55:49 -04:00
README.md	Update README.md and doxygen front page	2016-01-12 04:54:49 -05:00

Flexible character LCD library for AVR Microcontrollers

Features

Supports both 8-bit and 4-bit modes of LCD's
Configurable, so it should work on most devices, albeit with some tweaking
Read/Write the character LCD
Control the display using ANSI and ASCII escapes
Read/Write custom characters to memory and/or the LCD display (not fully implemented)

This project wouldn't be possible without the following great open source tools:

AVR-GCC, AVR-libc, and AVR-binutils which form the compiler toolchain that makes open source development for AVR microcontrollers possible.
avrdude to do in system programming of the AVR microcontrollers
doxygen to generate documentation.
Gnu Emacs, because how else would I enter text?

Code licensed under GPLv3. Please see the LICENSE file for full details.

Clone this repository and modify lcdLibConfig.h to your needs. See the documentation for more details.

git clone http://git.rekahsoft.ca/lcdLib.git
doxygen doxygen.conf # If you want to generate offline documentation

No interface is given to read/write custom characters, though it can be done manually using the lower level plumbing function writeLCDInstr.
No examples of using the library are currently given but do exist in the git history. They have been split out into their own repository's and soon will be re-added as git submodules. Util that time look into the git history.