add basic console docs

elaborate on contributions
This commit is contained in:
trsaunders 2012-08-13 21:42:24 +01:00
parent f833dc27c0
commit 53704f7b36
2 changed files with 23 additions and 1 deletions

20
docs/console.txt Normal file
View File

@ -0,0 +1,20 @@
The console module acts as a BaseSequentialStream at a user defined area of the LCD.
Requirements:
The console code requires a lld that has vertical scroll implemented.
It is also necessary to enable the scroll code:
#define GDISP_NEED_SCROLL TRUE
Usage:
#include "console.h"
/* Define a console object */
GLCDConsole CON1;
/* initialise the console to take up the entire screen */
lcdConsoleInit(&CON1, 0, 0, 320, 240, &fontLarger, Black, White);
/* print something */
chprintf((BaseSequentialStream *)&CON1, "Hello the time is %d\nGoodbye.", chTimeNow());

View File

@ -10,6 +10,8 @@ Date NickName RealName Contribution
30.07.2012 inmarket Andrew Hannam halext implementation
- dxli Dongxu Li lcdDrawEllipse() filled option
- benwilliam - fastMath & lcdDrawEllipse()
- Badger Thomas Saunders console implementation, FSMC
- Badger Thomas Saunders console implementation
FSMC for STM32F1 and F4
lld orientation fixes for S6D1121 and SSD1189
- Abhishek Abhishek Kakkar font rendering, S6D1121 GPIO