Add README.MD

master
Markus Koch 2018-01-03 16:26:16 +01:00 committed by GitHub
parent ac4d778679
commit 242dff0ea8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions

21
README.md 100644
View File

@ -0,0 +1,21 @@
# HCS12SS59T AVR Library
An AVR C Library for the HCS12SS59T vacuum fluorescent display.
## Files
* ```hcs12ss59t.h```, ```hcs12ss59t.c```: Display library (only basic functionality)
* ```vfd_fun.c```, ```vfd_fun.h```, ```main.c```: Demo code. ```vfd_fun``` just provides some transition effects.
## Usage
0) Include ```hcs12ss59t.h```, and add ```hcs12ss59t.c``` to your source file list
1) Call ```hcs12ss59t_init()```
2) Call ```hcs12ss59t_set_text(<12 ch. ASCII string>)``` to ASCII text or ```hcs12ss59t_set_buffer()``` to set the raw data according to the display's codes.
3) Call ```hcs12ss59t_set_brightness(<0 - 15>)``` to adjust the brightness
## Compiling the demo
1) Check the processor and clock speed in the Makefile
2) Run ```make```, this will generate the main.hex file
3) Run ```make program``` or flash the hex file manually
## Hardware
Thanks to qrti for his research into this display. You can find info on how to connect and drive the display on his GitHub project. It also includes an Arduino library.
https://github.com/qrti/VFD-HCS-12SS59T