Flexible character LCD library for AVR Microcontrollers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Collin J. Doering 3a38d3ff18 Update README.md and doxygen front page 3 years ago
.gitignore First pass setting up doxygen documentation 4 years ago
LICENSE Restructure project and ready for publishing 4 years ago
README.md Update README.md and doxygen front page 3 years ago
ansi_escapes.h First pass setting up doxygen documentation 4 years ago
doxygen.conf Update README.md and doxygen front page 3 years ago
lcdLib.c Completed scrollUp and scrollDown functions 4 years ago
lcdLib.h Read support implemented 4 years ago
lcdLibConfig.h Support both 5x8 and 5x10 fonts 4 years ago
lcd_instr.h Refactor, tidy and comment 4 years ago

README.md

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)

Tools

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?

License

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

Usage

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

Issues

  • 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.

Road Map

  • Add support for reading/writing custom characters to memory/display
  • Add examples projects utilizing lcdLib as git submodules
  • Finish documenting functions
  • Put the doxygen generated documentation for this library online