rekahsoft
/
avr-lcd-lib
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
avr-lcd-lib/README.md

61 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
# Flexible character LCD library for AVR Microcontrollers
* [Features](#features)
* [Tools](#tools)
* [License](#license)
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 09:54:49 +00:00
* [Usage](#usage)
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
* [Issues](#issues)
* [Road Map](#road-map)
## Features <a name="features"></a>
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 09:54:49 +00:00
- 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)
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
## Tools <a name="tools"></a>
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 09:54:49 +00:00
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?
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
## License <a name="license"></a>
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 09:54:49 +00:00
Code licensed under [GPLv3][]. Please see the LICENSE file for full details.
## Usage <a name="usage"></a>
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
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 09:54:49 +00:00
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
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
## Issues <a name="issues"></a>
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 09:54:49 +00:00
- 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.
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
## Road Map <a name="road-map"></a>
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 09:54:49 +00:00
- 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
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
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 09:54:49 +00:00
[AVR-libc]: http://www.nongnu.org/avr-libc/
[avrdude]: http://savannah.nongnu.org/projects/avrdude
[doxygen]: http://www.stack.nl/~dimitri/doxygen/
Restructure project and ready for publishing Move current UART echo program that was being used to test the library into an exmaples folder. Also ready another example 'digital_thermometer'. All examples will have unique Makefiles and lcdLibConfig.h's but use symbolic links to the libraries to limit repetition. Included the boilerplate for a README as well as a GPLv3 LICENSE file. Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
2015-10-28 09:55:49 +00:00
[Gnu Emacs]: http://www.gnu.org/software/emacs/
[GPLv3]: https://www.gnu.org/licenses/gpl.html