diff --git a/doc/html/button_8h-source.html b/doc/html/button_8h-source.html index c37fb0c..3079414 100644 --- a/doc/html/button_8h-source.html +++ b/doc/html/button_8h-source.html @@ -9,7 +9,6 @@
@@ -50,7 +49,7 @@ 00035 0x00,0x00,0x00,0x00}; 00036 -
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/button_8h.html b/doc/html/button_8h.html index cf5f266..d379c1d 100644 --- a/doc/html/button_8h.html +++ b/doc/html/button_8h.html @@ -9,7 +9,6 @@
@@ -41,7 +40,7 @@

-

Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/files.html b/doc/html/files.html index d355754..58b8052 100644 --- a/doc/html/files.html +++ b/doc/html/files.html @@ -9,7 +9,6 @@
@@ -24,12 +23,11 @@

File List

Here is a list of all files with brief descriptions: -
button.h [code]
main.c
uplaod_repo.py
include/lc7981.c
include/lc7981.h [code]
-
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/globals.html b/doc/html/globals.html index 58f9c79..0438b85 100644 --- a/doc/html/globals.html +++ b/doc/html/globals.html @@ -9,7 +9,6 @@
@@ -126,7 +125,7 @@ Here is a list of all functions, variables, defines, enums, and typedefs with li : button.h -
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/globals_defs.html b/doc/html/globals_defs.html index 30defd1..7320a08 100644 --- a/doc/html/globals_defs.html +++ b/doc/html/globals_defs.html @@ -9,7 +9,6 @@
@@ -78,7 +77,7 @@ : lc7981.h -
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/globals_func.html b/doc/html/globals_func.html index 378a5ae..f44c418 100644 --- a/doc/html/globals_func.html +++ b/doc/html/globals_func.html @@ -9,7 +9,6 @@
@@ -63,7 +62,7 @@ : main.c -
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/globals_vars.html b/doc/html/globals_vars.html index 3db2f58..6be2827 100644 --- a/doc/html/globals_vars.html +++ b/doc/html/globals_vars.html @@ -9,7 +9,6 @@
@@ -40,7 +39,7 @@ : button.h -
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/index.html b/doc/html/index.html index 79022c9..9ca2a82 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -9,7 +9,6 @@
@@ -18,7 +17,7 @@

glcd Documentation

0.1beta

-
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/lc7981_8c.html b/doc/html/lc7981_8c.html index f2645dd..6a2b0e6 100644 --- a/doc/html/lc7981_8c.html +++ b/doc/html/lc7981_8c.html @@ -9,7 +9,6 @@
@@ -194,6 +193,15 @@ This function will plot a bitmap with the upper left corner to the given coordin don't worry if you don't understand it at first sight.
And if you know a better way to do this, tell me.

+

Parameters:
+ + + + + + +
x horizontal position of the bitmap
y vertical position of the bitmap
bitmap pointer to the bitmap in pgmspace
w width of the bitmap
h height of the bitmap
+
This function is dedicated to Greta, one of the most important persons in my life so far.
Even though I can't remember her actual name.
@@ -381,7 +389,7 @@ Currently used mode, can be text or graphic.

-

Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/lc7981_8h-source.html b/doc/html/lc7981_8h-source.html index d7f9b21..c15c5a5 100644 --- a/doc/html/lc7981_8h-source.html +++ b/doc/html/lc7981_8h-source.html @@ -9,7 +9,6 @@
@@ -37,45 +36,45 @@ 00022 */ 00023 00024 #ifndef LC7981_H_ -00025 #define LC7981_H_ LC7981_H_ +00025 #define LC7981_H_ LC7981_H_ 00026 -00027 #include <avr/io.h> +00027 #include <avr/io.h> 00028 #include <util/delay.h> 00029 #include <avr/pgmspace.h> 00030 -00031 #define LCD_CTRL PORTC -00032 #define LCD_CRTL_DDR DDRC -00033 #define LCD_RS PC4 -00034 #define LCD_RW PC2 -00035 #define LCD_EN PC0 +00031 #define LCD_CTRL PORTC +00032 #define LCD_CRTL_DDR DDRC +00033 #define LCD_RS PC4 +00034 #define LCD_RW PC2 +00035 #define LCD_EN PC0 00036 -00037 +00037 00038 -00039 #define LCD_DATA PORTD -00040 #define LCD_DATA_DDR DDRD +00039 #define LCD_DATA PORTD +00040 #define LCD_DATA_DDR DDRD 00041 -00042 // Macros for (un)setting the control pins -00043 #define lcd_rs_high() (LCD_CTRL |= (1 << LCD_RS)) -00044 #define lcd_rs_low() (LCD_CTRL &= ~(1 << LCD_RS)) +00042 // Macros for (un)setting the control pins +00043 #define lcd_rs_high() (LCD_CTRL |= (1 << LCD_RS)) +00044 #define lcd_rs_low() (LCD_CTRL &= ~(1 << LCD_RS)) 00045 -00046 #define lcd_rw_high() (LCD_CTRL |= (1 << LCD_RW)) -00047 #define lcd_rw_low() (LCD_CTRL &= ~(1 << LCD_RW)) +00046 #define lcd_rw_high() (LCD_CTRL |= (1 << LCD_RW)) +00047 #define lcd_rw_low() (LCD_CTRL &= ~(1 << LCD_RW)) 00048 -00049 #define lcd_en_high() (LCD_CTRL |= (1 << LCD_EN)) -00050 #define lcd_en_low() (LCD_CTRL &= ~(1 << LCD_EN)) +00049 #define lcd_en_high() (LCD_CTRL |= (1 << LCD_EN)) +00050 #define lcd_en_low() (LCD_CTRL &= ~(1 << LCD_EN)) 00051 -00052 -00053 #define LCD_TEXT 0 -00054 #define LCD_TEXT_LINES 10 -00055 #define LCD_TEXT_COLUMNS 26 +00052 +00053 #define LCD_TEXT 0 +00054 #define LCD_TEXT_LINES 10 +00055 #define LCD_TEXT_COLUMNS 26 00056 -00057 #define LCD_GRAPHIC 1 -00058 #define LCD_GRAPHIC_WIDTH 160 -00059 #define LCD_GRAPHIC_HEIGHT 80 -00060 #define PIXEL_ON 1 -00061 #define PIXEL_OFF 0 +00057 #define LCD_GRAPHIC 1 +00058 #define LCD_GRAPHIC_WIDTH 160 +00059 #define LCD_GRAPHIC_HEIGHT 80 +00060 #define PIXEL_ON 1 +00061 #define PIXEL_OFF 0 00062 -00063 void lcd_init(uint8_t mode); +00063 void lcd_init(uint8_t mode); 00064 inline void lcd_clear(); 00065 00066 void lcd_write_text(char *txt); @@ -91,7 +90,7 @@ 00076 00077 #endif /* LC7981_H_ */ -
Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/lc7981_8h.html b/doc/html/lc7981_8h.html index 96e499c..632dc16 100644 --- a/doc/html/lc7981_8h.html +++ b/doc/html/lc7981_8h.html @@ -9,7 +9,6 @@
@@ -25,48 +24,70 @@

Defines

#define LC7981_H_   LC7981_H_ + protects this file from beeing double included
#define LCD_CTRL   PORTC + Port used for control signals.
#define LCD_CRTL_DDR   DDRC + Data-Direction-Register for the control signals.
#define LCD_RS   PC4 + Register-Select Pin of the Display.
#define LCD_RW   PC2 + Read-Write-select Pin.
#define LCD_EN   PC0 + Strobe Pin.
#define LCD_DATA   PORTD + Port used for data.
#define LCD_DATA_DDR   DDRD + Data-Direction-Register for Data.
#define lcd_rs_high()   (LCD_CTRL |= (1 << LCD_RS)) + Set the Register-Select pin high.
#define lcd_rs_low()   (LCD_CTRL &= ~(1 << LCD_RS)) + Set the Register-Select pin low.
#define lcd_rw_high()   (LCD_CTRL |= (1 << LCD_RW)) + Set the Read-Write-Select pin high.
#define lcd_rw_low()   (LCD_CTRL &= ~(1 << LCD_RW)) + Set the Register-Select pin low.
#define lcd_en_high()   (LCD_CTRL |= (1 << LCD_EN)) + Set the strobe pin high.
#define lcd_en_low()   (LCD_CTRL &= ~(1 << LCD_EN)) + Set the strobe pin low.
#define LCD_TEXT   0 + Constant for text mode.
#define LCD_TEXT_LINES   10 + Number of lines in text mode.
#define LCD_TEXT_COLUMNS   26 + Number of columns in text mode.
#define LCD_GRAPHIC   1 + Constant for graphic mode.
#define LCD_GRAPHIC_WIDTH   160 + Horizontal display size in pixels.
#define LCD_GRAPHIC_HEIGHT   80 + Vertical display size in pixels.
#define PIXEL_ON   1 + see lcd_plot_pixel
#define PIXEL_OFF   0 + see lcd_plot_pixel

Functions

void lcd_init (uint8_t mode) @@ -107,6 +128,8 @@
+

+protects this file from beeing double included

@@ -122,6 +145,8 @@
+

+Data-Direction-Register for the control signals.

@@ -137,6 +162,8 @@
+

+Port used for control signals.

@@ -152,6 +179,8 @@
+

+Port used for data.

@@ -167,6 +196,8 @@
+

+Data-Direction-Register for Data.

@@ -182,6 +213,8 @@
+

+Strobe Pin.

@@ -202,6 +235,8 @@
+

+Set the strobe pin high.

@@ -222,6 +257,8 @@
+

+Set the strobe pin low.

@@ -237,6 +274,8 @@
+

+Constant for graphic mode.

@@ -252,6 +291,8 @@
+

+Vertical display size in pixels.

@@ -267,6 +308,8 @@
+

+Horizontal display size in pixels.

@@ -282,6 +325,8 @@
+

+Register-Select Pin of the Display.

@@ -302,6 +347,8 @@
+

+Set the Register-Select pin high.

@@ -322,6 +369,8 @@
+

+Set the Register-Select pin low.

@@ -337,6 +386,8 @@
+

+Read-Write-select Pin.

@@ -357,6 +408,8 @@
+

+Set the Read-Write-Select pin high.

@@ -377,6 +430,8 @@
+

+Set the Register-Select pin low.

@@ -392,6 +447,8 @@
+

+Constant for text mode.

@@ -407,6 +464,8 @@
+

+Number of columns in text mode.

@@ -422,6 +481,8 @@
+

+Number of lines in text mode.

@@ -437,6 +498,8 @@
+

+see lcd_plot_pixel

@@ -452,6 +515,8 @@
+

+see lcd_plot_pixel

@@ -597,6 +662,15 @@ This function will plot a bitmap with the upper left corner to the given coordin don't worry if you don't understand it at first sight.
And if you know a better way to do this, tell me.

+

Parameters:
+ + + + + + +
x horizontal position of the bitmap
y vertical position of the bitmap
bitmap pointer to the bitmap in pgmspace
w width of the bitmap
h height of the bitmap
+
This function is dedicated to Greta, one of the most important persons in my life so far.
Even though I can't remember her actual name.
@@ -749,7 +823,7 @@ Writes a command and a data byte to the lcd.

-

Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/html/main_8c.html b/doc/html/main_8c.html index a3f4341..4a64563 100644 --- a/doc/html/main_8c.html +++ b/doc/html/main_8c.html @@ -9,7 +9,6 @@
@@ -46,7 +45,7 @@

-

Generated on Sun May 17 17:59:55 2009 for glcd by  +
Generated on Sun May 17 18:34:49 2009 for glcd by  doxygen 1.5.5
diff --git a/doc/latex/doxygen.sty b/doc/latex/doxygen.sty index 5d8752b..5148526 100644 --- a/doc/latex/doxygen.sty +++ b/doc/latex/doxygen.sty @@ -10,8 +10,8 @@ {\fancyplain{}{\bfseries\rightmark}} \rhead[\fancyplain{}{\bfseries\leftmark}] {\fancyplain{}{\bfseries\thepage}} -\rfoot[\fancyplain{}{\bfseries\scriptsize Generated on Sun May 17 17:59:55 2009 for glcd by Doxygen }]{} -\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated on Sun May 17 17:59:55 2009 for glcd by Doxygen }} +\rfoot[\fancyplain{}{\bfseries\scriptsize Generated on Sun May 17 18:34:49 2009 for glcd by Doxygen }]{} +\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated on Sun May 17 18:34:49 2009 for glcd by Doxygen }} \cfoot{} \newenvironment{Code} {\footnotesize} diff --git a/doc/latex/files.tex b/doc/latex/files.tex index df2c22d..046322b 100644 --- a/doc/latex/files.tex +++ b/doc/latex/files.tex @@ -2,7 +2,6 @@ Here is a list of all files with brief descriptions:\begin{CompactList} \item\contentsline{section}{{\bf button.h} }{\pageref{button_8h}}{} \item\contentsline{section}{{\bf main.c} }{\pageref{main_8c}}{} -\item\contentsline{section}{{\bf uplaod\_\-repo.py} }{\pageref{uplaod__repo_8py}}{} \item\contentsline{section}{include/{\bf lc7981.c} }{\pageref{lc7981_8c}}{} \item\contentsline{section}{include/{\bf lc7981.h} }{\pageref{lc7981_8h}}{} \end{CompactList} diff --git a/doc/latex/lc7981_8c.tex b/doc/latex/lc7981_8c.tex index 3ad7a1c..35f1c22 100644 --- a/doc/latex/lc7981_8c.tex +++ b/doc/latex/lc7981_8c.tex @@ -81,6 +81,11 @@ This function will plot a bitmap with the upper left corner to the given coordin And if you know a better way to do this, tell me.\par +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em x}]horizontal position of the bitmap \item[{\em y}]vertical position of the bitmap \item[{\em bitmap}]pointer to the bitmap in pgmspace \item[{\em w}]width of the bitmap \item[{\em h}]height of the bitmap\end{description} +\end{Desc} This function is dedicated to Greta, one of the most important persons in my life so far.\par Even though I can't remember her actual name.\par \index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}} diff --git a/doc/latex/lc7981_8h.tex b/doc/latex/lc7981_8h.tex index fd1ae9f..e2de085 100644 --- a/doc/latex/lc7981_8h.tex +++ b/doc/latex/lc7981_8h.tex @@ -7,49 +7,49 @@ \begin{CompactItemize} \item \#define {\bf LC7981\_\-H\_\-}~LC7981\_\-H\_\- -\item +\begin{CompactList}\small\item\em protects this file from beeing double included \item\end{CompactList}\item \#define {\bf LCD\_\-CTRL}~PORTC -\item +\begin{CompactList}\small\item\em Port used for control signals. \item\end{CompactList}\item \#define {\bf LCD\_\-CRTL\_\-DDR}~DDRC -\item +\begin{CompactList}\small\item\em Data-Direction-Register for the control signals. \item\end{CompactList}\item \#define {\bf LCD\_\-RS}~PC4 -\item +\begin{CompactList}\small\item\em Register-Select Pin of the Display. \item\end{CompactList}\item \#define {\bf LCD\_\-RW}~PC2 -\item +\begin{CompactList}\small\item\em Read-Write-select Pin. \item\end{CompactList}\item \#define {\bf LCD\_\-EN}~PC0 -\item +\begin{CompactList}\small\item\em Strobe Pin. \item\end{CompactList}\item \#define {\bf LCD\_\-DATA}~PORTD -\item +\begin{CompactList}\small\item\em Port used for data. \item\end{CompactList}\item \#define {\bf LCD\_\-DATA\_\-DDR}~DDRD -\item +\begin{CompactList}\small\item\em Data-Direction-Register for Data. \item\end{CompactList}\item \#define {\bf lcd\_\-rs\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RS)) -\item +\begin{CompactList}\small\item\em Set the Register-Select pin high. \item\end{CompactList}\item \#define {\bf lcd\_\-rs\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RS)) -\item +\begin{CompactList}\small\item\em Set the Register-Select pin low. \item\end{CompactList}\item \#define {\bf lcd\_\-rw\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RW)) -\item +\begin{CompactList}\small\item\em Set the Read-Write-Select pin high. \item\end{CompactList}\item \#define {\bf lcd\_\-rw\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RW)) -\item +\begin{CompactList}\small\item\em Set the Register-Select pin low. \item\end{CompactList}\item \#define {\bf lcd\_\-en\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-EN)) -\item +\begin{CompactList}\small\item\em Set the strobe pin high. \item\end{CompactList}\item \#define {\bf lcd\_\-en\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-EN)) -\item +\begin{CompactList}\small\item\em Set the strobe pin low. \item\end{CompactList}\item \#define {\bf LCD\_\-TEXT}~0 -\item +\begin{CompactList}\small\item\em Constant for text mode. \item\end{CompactList}\item \#define {\bf LCD\_\-TEXT\_\-LINES}~10 -\item +\begin{CompactList}\small\item\em Number of lines in text mode. \item\end{CompactList}\item \#define {\bf LCD\_\-TEXT\_\-COLUMNS}~26 -\item +\begin{CompactList}\small\item\em Number of columns in text mode. \item\end{CompactList}\item \#define {\bf LCD\_\-GRAPHIC}~1 -\item +\begin{CompactList}\small\item\em Constant for graphic mode. \item\end{CompactList}\item \#define {\bf LCD\_\-GRAPHIC\_\-WIDTH}~160 -\item +\begin{CompactList}\small\item\em Horizontal display size in pixels. \item\end{CompactList}\item \#define {\bf LCD\_\-GRAPHIC\_\-HEIGHT}~80 -\item +\begin{CompactList}\small\item\em Vertical display size in pixels. \item\end{CompactList}\item \#define {\bf PIXEL\_\-ON}~1 -\item +\begin{CompactList}\small\item\em see lcd\_\-plot\_\-pixel \item\end{CompactList}\item \#define {\bf PIXEL\_\-OFF}~0 -\end{CompactItemize} +\begin{CompactList}\small\item\em see lcd\_\-plot\_\-pixel \item\end{CompactList}\end{CompactItemize} \subsection*{Functions} \begin{CompactItemize} \item @@ -79,111 +79,155 @@ uint8\_\-t {\bf lcd\_\-read\_\-byte} () \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LC7981\_\-H\_\-~LC7981\_\-H\_\-}\label{lc7981_8h_e6ff861bd55f4dc46f25f5f6abfca15f} +protects this file from beeing double included + \index{lc7981.h@{lc7981.h}!LCD\_\-CRTL\_\-DDR@{LCD\_\-CRTL\_\-DDR}} \index{LCD\_\-CRTL\_\-DDR@{LCD\_\-CRTL\_\-DDR}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-CRTL\_\-DDR~DDRC}\label{lc7981_8h_4b6c8400da9a1ca3d4d83f3ef1f9c34a} +Data-Direction-Register for the control signals. + \index{lc7981.h@{lc7981.h}!LCD\_\-CTRL@{LCD\_\-CTRL}} \index{LCD\_\-CTRL@{LCD\_\-CTRL}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-CTRL~PORTC}\label{lc7981_8h_8e945df7ca614325cafa08258e82a63c} +Port used for control signals. + \index{lc7981.h@{lc7981.h}!LCD\_\-DATA@{LCD\_\-DATA}} \index{LCD\_\-DATA@{LCD\_\-DATA}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-DATA~PORTD}\label{lc7981_8h_25e9d818788f36ed74d7c4579f87f2a6} +Port used for data. + \index{lc7981.h@{lc7981.h}!LCD\_\-DATA\_\-DDR@{LCD\_\-DATA\_\-DDR}} \index{LCD\_\-DATA\_\-DDR@{LCD\_\-DATA\_\-DDR}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-DATA\_\-DDR~DDRD}\label{lc7981_8h_0c114e723aa4c162c415fb6d4d963dd7} +Data-Direction-Register for Data. + \index{lc7981.h@{lc7981.h}!LCD\_\-EN@{LCD\_\-EN}} \index{LCD\_\-EN@{LCD\_\-EN}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-EN~PC0}\label{lc7981_8h_1640ffbc0d8ec0f7edb04a2b93918072} +Strobe Pin. + \index{lc7981.h@{lc7981.h}!lcd\_\-en\_\-high@{lcd\_\-en\_\-high}} \index{lcd\_\-en\_\-high@{lcd\_\-en\_\-high}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-en\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-EN))}\label{lc7981_8h_e14be306d3620577abc8613d40401b04} +Set the strobe pin high. + \index{lc7981.h@{lc7981.h}!lcd\_\-en\_\-low@{lcd\_\-en\_\-low}} \index{lcd\_\-en\_\-low@{lcd\_\-en\_\-low}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-en\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-EN))}\label{lc7981_8h_d8dcdb36a9410fd96b2c936b7c9355dd} +Set the strobe pin low. + \index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC@{LCD\_\-GRAPHIC}} \index{LCD\_\-GRAPHIC@{LCD\_\-GRAPHIC}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC~1}\label{lc7981_8h_dfaedf8da8e73d39a98d709b519a3117} +Constant for graphic mode. + \index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC\_\-HEIGHT@{LCD\_\-GRAPHIC\_\-HEIGHT}} \index{LCD\_\-GRAPHIC\_\-HEIGHT@{LCD\_\-GRAPHIC\_\-HEIGHT}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC\_\-HEIGHT~80}\label{lc7981_8h_70265c4f840ef78872243e91c923af2f} +Vertical display size in pixels. + \index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC\_\-WIDTH@{LCD\_\-GRAPHIC\_\-WIDTH}} \index{LCD\_\-GRAPHIC\_\-WIDTH@{LCD\_\-GRAPHIC\_\-WIDTH}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC\_\-WIDTH~160}\label{lc7981_8h_51e83be6f6929f2a29d5467cd937dfc6} +Horizontal display size in pixels. + \index{lc7981.h@{lc7981.h}!LCD\_\-RS@{LCD\_\-RS}} \index{LCD\_\-RS@{LCD\_\-RS}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-RS~PC4}\label{lc7981_8h_4781e073871c6f27f89b9463ad3a4ed1} +Register-Select Pin of the Display. + \index{lc7981.h@{lc7981.h}!lcd\_\-rs\_\-high@{lcd\_\-rs\_\-high}} \index{lcd\_\-rs\_\-high@{lcd\_\-rs\_\-high}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rs\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RS))}\label{lc7981_8h_795b48274d3f80bc744a707b67fd93e9} +Set the Register-Select pin high. + \index{lc7981.h@{lc7981.h}!lcd\_\-rs\_\-low@{lcd\_\-rs\_\-low}} \index{lcd\_\-rs\_\-low@{lcd\_\-rs\_\-low}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rs\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RS))}\label{lc7981_8h_6edb13d59460246fb4cc32ada1c9f4a8} +Set the Register-Select pin low. + \index{lc7981.h@{lc7981.h}!LCD\_\-RW@{LCD\_\-RW}} \index{LCD\_\-RW@{LCD\_\-RW}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-RW~PC2}\label{lc7981_8h_26089a10ddd59a0dc7283c19ccc02533} +Read-Write-select Pin. + \index{lc7981.h@{lc7981.h}!lcd\_\-rw\_\-high@{lcd\_\-rw\_\-high}} \index{lcd\_\-rw\_\-high@{lcd\_\-rw\_\-high}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rw\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RW))}\label{lc7981_8h_d0ce3cd9b481370ad4de36eff08440c8} +Set the Read-Write-Select pin high. + \index{lc7981.h@{lc7981.h}!lcd\_\-rw\_\-low@{lcd\_\-rw\_\-low}} \index{lcd\_\-rw\_\-low@{lcd\_\-rw\_\-low}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rw\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RW))}\label{lc7981_8h_7f5ebe0ca71b1298a7d3423850cc82b1} +Set the Register-Select pin low. + \index{lc7981.h@{lc7981.h}!LCD\_\-TEXT@{LCD\_\-TEXT}} \index{LCD\_\-TEXT@{LCD\_\-TEXT}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT~0}\label{lc7981_8h_90a69d37f5c80f3ded970acf2dacf4c0} +Constant for text mode. + \index{lc7981.h@{lc7981.h}!LCD\_\-TEXT\_\-COLUMNS@{LCD\_\-TEXT\_\-COLUMNS}} \index{LCD\_\-TEXT\_\-COLUMNS@{LCD\_\-TEXT\_\-COLUMNS}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT\_\-COLUMNS~26}\label{lc7981_8h_82f0a630f3c41b5233f2ceb07c7dd736} +Number of columns in text mode. + \index{lc7981.h@{lc7981.h}!LCD\_\-TEXT\_\-LINES@{LCD\_\-TEXT\_\-LINES}} \index{LCD\_\-TEXT\_\-LINES@{LCD\_\-TEXT\_\-LINES}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT\_\-LINES~10}\label{lc7981_8h_720ef60606ac38ca3a5ab96a9c2b8168} +Number of lines in text mode. + \index{lc7981.h@{lc7981.h}!PIXEL\_\-OFF@{PIXEL\_\-OFF}} \index{PIXEL\_\-OFF@{PIXEL\_\-OFF}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define PIXEL\_\-OFF~0}\label{lc7981_8h_cda2f1b1cf6310700d0d91643c40e068} +see lcd\_\-plot\_\-pixel + \index{lc7981.h@{lc7981.h}!PIXEL\_\-ON@{PIXEL\_\-ON}} \index{PIXEL\_\-ON@{PIXEL\_\-ON}!lc7981.h@{lc7981.h}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define PIXEL\_\-ON~1}\label{lc7981_8h_eb2d212a26da4a5a4d3231b2773023e5} +see lcd\_\-plot\_\-pixel + \subsection{Function Documentation} @@ -236,6 +280,11 @@ This function will plot a bitmap with the upper left corner to the given coordin And if you know a better way to do this, tell me.\par +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em x}]horizontal position of the bitmap \item[{\em y}]vertical position of the bitmap \item[{\em bitmap}]pointer to the bitmap in pgmspace \item[{\em w}]width of the bitmap \item[{\em h}]height of the bitmap\end{description} +\end{Desc} This function is dedicated to Greta, one of the most important persons in my life so far.\par Even though I can't remember her actual name.\par \index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}} diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex index 3bbbe3d..0a008a3 100644 --- a/doc/latex/refman.tex +++ b/doc/latex/refman.tex @@ -21,7 +21,7 @@ \vspace*{1cm} {\large Generated by Doxygen 1.5.5}\\ \vspace*{0.5cm} -{\small Sun May 17 17:59:55 2009}\\ +{\small Sun May 17 18:34:49 2009}\\ \end{center} \end{titlepage} \clearemptydoublepage @@ -29,17 +29,12 @@ \tableofcontents \clearemptydoublepage \pagenumbering{arabic} -\chapter{Namespace Index} -\input{namespaces} \chapter{File Index} \input{files} -\chapter{Namespace Documentation} -\input{namespaceuplaod__repo} \chapter{File Documentation} \input{button_8h} \include{lc7981_8c} \include{lc7981_8h} \include{main_8c} -\include{uplaod__repo_8py} \printindex \end{document} diff --git a/glcd.doxyfile b/glcd.doxyfile index c634cb3..ef0079e 100644 --- a/glcd.doxyfile +++ b/glcd.doxyfile @@ -542,7 +542,7 @@ RECURSIVE = NO # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = uplaod_repo.py # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/include/lc7981.c b/include/lc7981.c index f44dc10..6f7b5c8 100644 --- a/include/lc7981.c +++ b/include/lc7981.c @@ -275,8 +275,15 @@ uint8_t xr; * don't worry if you don't understand it at first sight. \n * And if you know a better way to do this, tell me.\n * + * @param x horizontal position of the bitmap + * @param y vertical position of the bitmap + * @param bitmap pointer to the bitmap in pgmspace + * @param w width of the bitmap + * @param h height of the bitmap + * * This function is dedicated to Greta, one of the most important persons in my life so far.\n * Even though I can't remember her actual name.\n + * */ void lcd_plot_bitmap(uint8_t x_off, uint8_t y_off, const uint8_t *bitmap, uint8_t w, uint8_t h) { uint8_t x,y,cur,curs,sr,dr; diff --git a/include/lc7981.h b/include/lc7981.h index 9adb916..e626cd0 100644 --- a/include/lc7981.h +++ b/include/lc7981.h @@ -22,43 +22,43 @@ */ #ifndef LC7981_H_ -#define LC7981_H_ LC7981_H_ +#define LC7981_H_ LC7981_H_ //!< protects this file from beeing double included #include #include #include -#define LCD_CTRL PORTC -#define LCD_CRTL_DDR DDRC -#define LCD_RS PC4 -#define LCD_RW PC2 -#define LCD_EN PC0 +#define LCD_CTRL PORTC //!< Port used for control signals +#define LCD_CRTL_DDR DDRC //!< Data-Direction-Register for the control signals +#define LCD_RS PC4 //!< Register-Select Pin of the Display +#define LCD_RW PC2 //!< Read-Write-select Pin +#define LCD_EN PC0 //!< Strobe Pin -#define LCD_DATA PORTD -#define LCD_DATA_DDR DDRD +#define LCD_DATA PORTD //!< Port used for data +#define LCD_DATA_DDR DDRD //!< Data-Direction-Register for Data // Macros for (un)setting the control pins -#define lcd_rs_high() (LCD_CTRL |= (1 << LCD_RS)) -#define lcd_rs_low() (LCD_CTRL &= ~(1 << LCD_RS)) +#define lcd_rs_high() (LCD_CTRL |= (1 << LCD_RS)) //!< Set the Register-Select pin high +#define lcd_rs_low() (LCD_CTRL &= ~(1 << LCD_RS)) //!< Set the Register-Select pin low -#define lcd_rw_high() (LCD_CTRL |= (1 << LCD_RW)) -#define lcd_rw_low() (LCD_CTRL &= ~(1 << LCD_RW)) +#define lcd_rw_high() (LCD_CTRL |= (1 << LCD_RW)) //!< Set the Read-Write-Select pin high +#define lcd_rw_low() (LCD_CTRL &= ~(1 << LCD_RW)) //!< Set the Register-Select pin low -#define lcd_en_high() (LCD_CTRL |= (1 << LCD_EN)) -#define lcd_en_low() (LCD_CTRL &= ~(1 << LCD_EN)) +#define lcd_en_high() (LCD_CTRL |= (1 << LCD_EN)) //!< Set the strobe pin high +#define lcd_en_low() (LCD_CTRL &= ~(1 << LCD_EN)) //!< Set the strobe pin low -#define LCD_TEXT 0 -#define LCD_TEXT_LINES 10 -#define LCD_TEXT_COLUMNS 26 +#define LCD_TEXT 0 //!< Constant for text mode +#define LCD_TEXT_LINES 10 //!< Number of lines in text mode +#define LCD_TEXT_COLUMNS 26 //!< Number of columns in text mode -#define LCD_GRAPHIC 1 -#define LCD_GRAPHIC_WIDTH 160 -#define LCD_GRAPHIC_HEIGHT 80 -#define PIXEL_ON 1 -#define PIXEL_OFF 0 +#define LCD_GRAPHIC 1 //!< Constant for graphic mode +#define LCD_GRAPHIC_WIDTH 160 //!< Horizontal display size in pixels +#define LCD_GRAPHIC_HEIGHT 80 //!< Vertical display size in pixels +#define PIXEL_ON 1 //!< see lcd_plot_pixel +#define PIXEL_OFF 0 //!< see lcd_plot_pixel void lcd_init(uint8_t mode); inline void lcd_clear();