diff --git a/doc/html/12x16__horizontal__LSB__1_8h.html b/doc/html/12x16__horizontal__LSB__1_8h.html index 38ad004..cf6b54b 100644 --- a/doc/html/12x16__horizontal__LSB__1_8h.html +++ b/doc/html/12x16__horizontal__LSB__1_8h.html @@ -1,10 +1,13 @@ - - + + + + glcd: 12x16_horizontal_LSB_1.h File Reference - - - - + + + + +

12x16_horizontal_LSB_1.h File Reference

-

-Go to the source code of this file. - - - - +

Go to the source code of this file.

+

Variables

const uint8_t font_12x16[] PROGMEM
+ +

Variables

const char font_12x16[] PROGMEM
-


Variable Documentation

- +

Variable Documentation

+
- +
const uint8_t font_12x16 [] PROGMEM const char font_12x16 [] PROGMEM
-

-

-

-
Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/8x8__horizontal__LSB__1_8h.html b/doc/html/8x8__horizontal__LSB__1_8h.html index da52b47..4cae802 100644 --- a/doc/html/8x8__horizontal__LSB__1_8h.html +++ b/doc/html/8x8__horizontal__LSB__1_8h.html @@ -1,10 +1,13 @@ - - + + + + glcd: 8x8_horizontal_LSB_1.h File Reference - - - - + + + + +

8x8_horizontal_LSB_1.h File Reference

-

-Go to the source code of this file. - - - - +

Go to the source code of this file.

+

Variables

const uint8_t font_8x8[] PROGMEM
+ +

Variables

const char font_8x8[] PROGMEM
-


Variable Documentation

- +

Variable Documentation

+
- +
const uint8_t font_8x8 [] PROGMEM const char font_8x8 [] PROGMEM
-

-

-

-
Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/adc_8c.html b/doc/html/adc_8c.html index 4457421..b7887c3 100644 --- a/doc/html/adc_8c.html +++ b/doc/html/adc_8c.html @@ -1,10 +1,13 @@ - - + + + + glcd: include/adc.c File Reference - - - - + + + + +
-

include/adc.c File Reference

#include "adc.h"
+

include/adc.c File Reference

#include "adc.h"
- - - - + +

Functions

uint16_t readADC (uint8_t channel)

Functions

uint16_t readADC (uint8_t channel)
-

Function Documentation

- +

Function Documentation

+
- + - + - +
uint16_t readADC uint16_t readADC ( uint8_t  channel channel  ) 
-

-

-

-
Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/adc_8h.html b/doc/html/adc_8h.html index 7ff66cb..e183143 100644 --- a/doc/html/adc_8h.html +++ b/doc/html/adc_8h.html @@ -1,10 +1,13 @@ - - + + + + glcd: include/adc.h File Reference - - - - + + + + +
-

include/adc.h File Reference

#include <avr/io.h>
-#include <util/delay.h>
-#include <inttypes.h>
- -

-Go to the source code of this file. - - - - - - +

include/adc.h File Reference

#include <avr/io.h>
+#include <util/delay.h>
+#include <inttypes.h>
+

Go to the source code of this file.

+

Defines

#define ADC_H   ADC_H

Functions

uint16_t readADC (uint8_t channel)
+ + + + +

Defines

#define ADC_H   ADC_H
#define ADC_READ_CYCELS   5

Functions

uint16_t readADC (uint8_t channel)
-


Define Documentation

- +

Define Documentation

+
- +
#define ADC_H   ADC_H #define ADC_H   ADC_H
-

-

-

-


Function Documentation

- +
+
- + + +
uint16_t readADC #define ADC_READ_CYCELS   5
+
+
+ +
+
+

Function Documentation

+ +
+
+ + + - + - +
uint16_t readADC ( uint8_t  channel channel  ) 
-

-

-

-


Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/button_8h.html b/doc/html/button_8h.html index 8a1389b..76a721e 100644 --- a/doc/html/button_8h.html +++ b/doc/html/button_8h.html @@ -1,10 +1,13 @@ - - + + + + glcd: button.h File Reference - - - - + + + + +
-

button.h File Reference

#include <avr/pgmspace.h>
- -

-Go to the source code of this file. - - - +

button.h File Reference

#include <avr/pgmspace.h>
+

Go to the source code of this file.

+

Variables

const uint8_t bitmap[] PROGMEM
+ +

Variables

const uint8_t bitmap[] PROGMEM
-


Variable Documentation

- +

Variable Documentation

+
- +
const uint8_t bitmap [] PROGMEM const uint8_t bitmap [] PROGMEM
-

-

-

-
Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/doxygen.css b/doc/html/doxygen.css index 74c22a2..9ca3caf 100644 --- a/doc/html/doxygen.css +++ b/doc/html/doxygen.css @@ -1,363 +1,341 @@ -BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { - font-family: Geneva, Arial, Helvetica, sans-serif; +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; } -BODY,TD { - font-size: 90%; -} -H1 { + +/* @group Heading Levels */ + +h1 { text-align: center; - font-size: 160%; + font-size: 150%; } -H2 { + +h2 { font-size: 120%; } -H3 { + +h3 { font-size: 100%; } -CAPTION { - font-weight: bold + +dt { + font-weight: bold; } -DIV.qindex { - width: 100%; + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +div.qindex, div.navtab{ background-color: #e8eef2; border: 1px solid #84b0c7; text-align: center; margin: 2px; padding: 2px; - line-height: 140%; } -DIV.navpath { + +div.qindex, div.navpath { width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; line-height: 140%; } -DIV.navtab { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; + +div.navtab { + margin-right: 15px; } -TD.navtab { - font-size: 70%; -} -A.qindex { - text-decoration: none; - font-weight: bold; - color: #1A419D; -} -A.qindex:visited { - text-decoration: none; - font-weight: bold; - color: #1A419D -} -A.qindex:hover { + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; text-decoration: none; - background-color: #ddddff; } -A.qindexHL { - text-decoration: none; + +.contents a:visited { + color: #1b77c5; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { font-weight: bold; background-color: #6666cc; color: #ffffff; border: 1px double #9295C2; } -A.qindexHL:hover { - text-decoration: none; - background-color: #6666cc; - color: #ffffff; -} -A.qindexHL:visited { - text-decoration: none; - background-color: #6666cc; - color: #ffffff -} -A.el { - text-decoration: none; - font-weight: bold -} -A.elRef { - font-weight: bold -} -A.code:link { - text-decoration: none; - font-weight: normal; - color: #0000FF -} -A.code:visited { - text-decoration: none; - font-weight: normal; - color: #0000FF -} -A.codeRef:link { - font-weight: normal; - color: #0000FF -} -A.codeRef:visited { - font-weight: normal; - color: #0000FF -} -A:hover { - text-decoration: none; - background-color: #f2f2ff -} -DL.el { - margin-left: -1cm -} -.fragment { - font-family: monospace, fixed; - font-size: 95%; -} -PRE.fragment { - border: 1px solid #CCCCCC; - background-color: #f5f5f5; - margin-top: 4px; - margin-bottom: 4px; - margin-left: 2px; - margin-right: 8px; - padding-left: 6px; - padding-right: 6px; - padding-top: 4px; - padding-bottom: 4px; -} -DIV.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px + +.contents a.qindexHL:visited { + color: #ffffff; } -DIV.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: bold; +a.el { + font-weight: bold; } -DIV.groupText { - margin-left: 16px; - font-style: italic; - font-size: 90% + +a.elRef { } -BODY { + +a.code { +} + +a.codeRef { +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + padding: 4px 6px; + margin: 4px 8px 4px 2px; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { background: white; color: black; margin-right: 20px; margin-left: 20px; } -TD.indexkey { + +td.indexkey { background-color: #e8eef2; font-weight: bold; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; } -TD.indexvalue { - background-color: #e8eef2; - font-style: italic; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; - border: 1px solid #CCCCCC; -} -TR.memlist { - background-color: #f0f0f0; -} -P.formulaDsp { - text-align: center; -} -IMG.formulaDsp { -} -IMG.formulaInl { - vertical-align: middle; -} -SPAN.keyword { color: #008000 } -SPAN.keywordtype { color: #604020 } -SPAN.keywordflow { color: #e08000 } -SPAN.comment { color: #800000 } -SPAN.preprocessor { color: #806020 } -SPAN.stringliteral { color: #002080 } -SPAN.charliteral { color: #008080 } -SPAN.vhdldigit { color: #ff00ff } -SPAN.vhdlchar { color: #000000 } -SPAN.vhdlkeyword { color: #700070 } -SPAN.vhdllogic { color: #ff0000 } -.mdescLeft { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; +td.indexvalue { + background-color: #e8eef2; + border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; } -.mdescRight { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; + +tr.memlist { + background-color: #f0f0f0; } -.memItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; + +p.formulaDsp { + text-align: center; } -.memItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; + +img.formulaDsp { + } -.memTemplItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; + +img.formulaInl { + vertical-align: middle; } -.memTemplItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; } -.memTemplParams { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - color: #606060; - background-color: #FAFAFA; - font-size: 80%; + +div.center img { + border: 0px; } -.search { + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { color: #003399; font-weight: bold; } -FORM.search { + +form.search { margin-bottom: 0px; margin-top: 0px; } -INPUT.search { + +input.search { font-size: 75%; color: #000080; font-weight: normal; background-color: #e8eef2; } -TD.tiny { + +td.tiny { font-size: 75%; } -a { - color: #1A41A8; -} -a:visited { - color: #2A3798; -} -.dirtab { + +.dirtab { padding: 4px; border-collapse: collapse; border: 1px solid #84b0c7; } -TH.dirtab { + +th.dirtab { background: #e8eef2; font-weight: bold; } -HR { - height: 1px; + +hr { + height: 0; border: none; - border-top: 1px solid black; + border-top: 1px solid #666; } -/* Style for detailed member documentation */ +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #FAFAFA; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memTemplParams { + color: #606060; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + .memtemplate { font-size: 80%; color: #606060; font-weight: normal; margin-left: 3px; -} -.memnav { +} + +.memnav { background-color: #e8eef2; border: 1px solid #84b0c7; text-align: center; @@ -365,69 +343,156 @@ HR { margin-right: 15px; padding: 2px; } + .memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; - -moz-border-radius: 8px 8px 8px 8px; + padding: 0; + margin-bottom: 10px; } + .memname { white-space: nowrap; font-weight: bold; } -.memdoc{ - padding-left: 10px; + +.memproto, .memdoc { + border: 1px solid #84b0c7; } + .memproto { + padding: 0; background-color: #d5e1e8; - width: 100%; - border-width: 1px; - border-style: solid; - border-color: #84b0c7; font-weight: bold; - -moz-border-radius: 8px 8px 8px 8px; + -webkit-border-top-left-radius: 8px; + -webkit-border-top-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -moz-border-radius-topleft: 8px; + -moz-border-radius-topright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + } + +.memdoc { + padding: 2px 5px; + background-color: #eef3f5; + border-top-width: 0; + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; +} + .paramkey { text-align: right; } + .paramtype { white-space: nowrap; } + .paramname { color: #602020; - font-style: italic; white-space: nowrap; } -/* End Styling for detailed member documentation */ +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ /* for the tree view */ + .ftvtree { font-family: sans-serif; - margin:0.5em; -} -.directory { - font-size: 9pt; - font-weight: bold; -} -.directory h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} -.directory > h3 { - margin-top: 0; -} -.directory p { - margin: 0px; - white-space: nowrap; -} -.directory div { - display: none; - margin: 0px; -} -.directory img { - vertical-align: -30%; + margin: 0.5em; } +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +address { + font-style: normal; + color: #333; +} diff --git a/doc/html/files.html b/doc/html/files.html index 10e000a..99d513f 100644 --- a/doc/html/files.html +++ b/doc/html/files.html @@ -1,10 +1,13 @@ - - + + + + glcd: File Index - - - - + + + + + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/lc7981_8c.html b/doc/html/lc7981_8c.html index d7de1ae..a16826a 100644 --- a/doc/html/lc7981_8c.html +++ b/doc/html/lc7981_8c.html @@ -1,10 +1,13 @@ - - + + + + glcd: include/lc7981.c File Reference - - - - + + + + +
-

include/lc7981.c File Reference

#include "lc7981.h"
+

include/lc7981.c File Reference

#include "lc7981.h"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +

Functions

void lcd_init (uint8_t mode)
 lcd_init set the to default values.
void lcd_write_command (uint8_t cmd, uint8_t data)
 Writes a command and a data byte to the lcd.
uint8_t lcd_read_byte ()
 Reads a byte from the display memory.
void lcd_strobe ()
 Generates the strobe signal for writing data.
void lcd_clear ()
 Clears the display by setting the whole memory to 0.
void lcd_write_text (char *txt)
 Outputs text in at the current cursor position.
void lcd_gotoxy (uint8_t x, uint8_t y)
 Set the display cursor to a specific location.
void lcd_plot_pixel (uint8_t x, uint8_t y, uint8_t set)
 set or unset a pixel at the specified location
void lcd_plot_bitmap (uint8_t x_off, uint8_t y_off, const uint8_t *bitmap, uint8_t w, uint8_t h)
 This function will plot a bitmap with the upper left corner to the given coordinates.
void lcd_plot_char (uint8_t x_off, uint8_t y_off, uint8_t c, uint8_t fw, uint8_t fh, const uint8_t *font)
 Plots a single character in graphicmode.
void lcd_plot_text (uint8_t x_off, uint8_t y_off, const char *text, uint8_t fw, uint8_t fh, const uint8_t *font)
 Plots a text using lcd_plot_char.
void lcd_plot_pgmtext (uint8_t x_off, uint8_t y_off, const char *text, uint8_t fw, uint8_t fh, const uint8_t *font)

Variables

uint8_t lcd_mode
 Currently used mode, can be text or graphic.
uint8_t lcd_curline
 Current line. Used for scrolling in text mode.

Functions

void lcd_init (uint8_t mode)
 lcd_init set the to default values.
void lcd_clear ()
 Clears the display by setting the whole memory to 0.
void lcd_write_text (char *txt)
 Outputs text in at the current cursor position.
void lcd_gotoxy (uint8_t x, uint8_t y)
 Set the display cursor to a specific location.
void lcd_plot_pixel (uint8_t x, uint8_t y, uint8_t set)
 set or unset a pixel at the specified location
void lcd_plot_bitmap (uint8_t x_off, uint8_t y_off, PGM_P bitmap, uint8_t w, uint8_t h)
 This function will plot a bitmap with the upper left corner to the given coordinates.
void lcd_plot_char (uint8_t x_off, uint8_t y_off, uint8_t c, uint8_t fw, uint8_t fh, PGM_P font)
 Plots a single character in graphicmode.
void lcd_plot_text (uint8_t x_off, uint8_t y_off, const char *text, uint8_t fw, uint8_t fh, PGM_P font)
 Plots a text using lcd_plot_char.
void lcd_plot_pgmtext (uint8_t x_off, uint8_t y_off, PGM_P text, uint8_t fw, uint8_t fh, PGM_P font)

Variables

uint8_t lcd_mode
 Currently used mode, can be text or graphic.
uint8_t lcd_curline
 Current line. Used for scrolling in text mode.
-

Function Documentation

- +

Function Documentation

+
- + - + - +
void lcd_clear void lcd_clear (  )  [inline]
-

-Clears the display by setting the whole memory to 0. -

+

Clears the display by setting the whole memory to 0.

-

- +

+
- + @@ -102,59 +88,57 @@ Clears the display by setting the whole memory to 0. - +
void lcd_gotoxy void lcd_gotoxy ( uint8_t  x,
) [inline]
-

-Set the display cursor to a specific location. -

-Right now this does only work in text mode, since there's no need for it now in graphics mode.
- If the x and y values are to big, the function does nothing.

-

Parameters:
+

Set the display cursor to a specific location.

+

Right now this does only work in text mode, since there's no need for it now in graphics mode.
+ If the x and y values are to big, the function does nothing.

+
Parameters:
x the horizontal cursorposition (starts at 0)
y the vertical cursorposition (starts at 0)
+
-

- + +

- + - + - +
void lcd_init void lcd_init ( uint8_t  mode mode  ) 
-

-lcd_init set the to default values. -

-

Parameters:
+

lcd_init set the to default values.

+
Parameters:
mode LCD_TEXT for text mode and LCD_GRAPHIC for graphic mode
+
-

- + +

- + @@ -168,7 +152,7 @@ lcd_init set the to default values. - + @@ -186,23 +170,21 @@ lcd_init set the to default values. - +
void lcd_plot_bitmap void lcd_plot_bitmap ( uint8_t  x_off,
const uint8_t * PGM_P  bitmap,
)
-

-This function will plot a bitmap with the upper left corner to the given coordinates. -

-
- If the bitmap doesn't fit on the display at this location, nothing is drawn at all.
- Unset pixels are treated as transparent
- This function is by far the most tricky piece of code in this project,
- 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:
+

This function will plot a bitmap with the upper left corner to the given coordinates.

+


+ If the bitmap doesn't fit on the display at this location, nothing is drawn at all.
+ Unset pixels are treated as transparent
+ This function is by far the most tricky piece of code in this project,
+ 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:
@@ -210,17 +192,19 @@ This function will plot a bitmap with the upper left corner to the given coordin
x_off horizontal position of the bitmap
y_off vertical position of the bitmap
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.
- +

This function is dedicated to Greta, one of the most important persons in my life so far.
+

+
-

- + +

- + @@ -252,29 +236,27 @@ This function is dedicated to Greta, one of the most important persons in my lif - + - +
void lcd_plot_char void lcd_plot_char ( uint8_t  x_off,
const uint8_t * PGM_P  font 
) [inline]
-

-Plots a single character in graphicmode. -

-Each character of the font is stored linewise.
- This means for a 8x8 Pixel font the 8 bytes are needed.
- The first byte is the first line and the last byte is the last line.
- The next 8byte are the next character.
-
- If the position is too close to the display edge so it can't be displayed completely,
- It won't be displayed at all.

-

Parameters:
+

Plots a single character in graphicmode.

+

Each character of the font is stored linewise.
+ This means for a 8x8 Pixel font the 8 bytes are needed.
+ The first byte is the first line and the last byte is the last line.
+ The next 8byte are the next character.
+
+ If the position is too close to the display edge so it can't be displayed completely,
+ It won't be displayed at all.

+
Parameters:
@@ -283,16 +265,17 @@ Each character of the font is stored linewise.
x_off horizontal position of the character
y_off vertical position of the character
fh height of the font
font pointer to the flash area where the font is stored
+
-

- + +

- + @@ -306,7 +289,7 @@ Each character of the font is stored linewise.
- + @@ -324,28 +307,26 @@ Each character of the font is stored linewise.
- + - +
void lcd_plot_pgmtext void lcd_plot_pgmtext ( uint8_t  x_off,
const char * PGM_P  text,
const uint8_t * PGM_P  font 
)
-

-

-

- + +

- + @@ -365,31 +346,30 @@ Each character of the font is stored linewise.
- +
void lcd_plot_pixel void lcd_plot_pixel ( uint8_t  x,
)
-

-set or unset a pixel at the specified location -

-

Parameters:
+

set or unset a pixel at the specified location

+
Parameters:
x horizontal position of the pixel (starts at 0)
y horizontal position of the pixel (starts at 0)
set can be PIXEL_ON or PIXEL_OFF
+
-

- + +

- + @@ -421,22 +401,20 @@ set or unset a pixel at the specified location - + - +
void lcd_plot_text void lcd_plot_text ( uint8_t  x_off,
const uint8_t * PGM_P  font 
)
-

-Plots a text using lcd_plot_char. -

-

Parameters:
+

Plots a text using lcd_plot_char.

+
Parameters:
@@ -445,158 +423,73 @@ Plots a text using lcd_plot_char.
x_off horizontal position of the character
y_off vertical position of the character
fh height of the font
font pointer to the flash area where the font is stored
+
-
See also:
lcd_plot_char
+
See also:
lcd_plot_char
-

- + +

- - - - - - -
uint8_t lcd_read_byte (  )  [inline]
-
-
- -

-Reads a byte from the display memory. -

-lcd_gotoxy can be used to set the location. Important : lcd_gotoxy doesn't work in graphics mode yet.

-

Returns:
the byte which has been read
-
See also:
lcd_gotoxy
- -
-

- -

-
- - - - - - - - -
void lcd_strobe (  )  [inline]
-
-
- -

-Generates the strobe signal for writing data. -

-This function is meant for internal usage only. -

-

- -

-
- - - - - - - - - - - - - - - - - - -
void lcd_write_command (uint8_t  cmd,
uint8_t  data 
) [inline]
-
-
- -

-Writes a command and a data byte to the lcd. -

-

Parameters:
- - - -
cmd the command byte
data the data that is going to be written after the command
-
- -
-

- -

-
- - - + - + - +
void lcd_write_text void lcd_write_text ( char *  txt txt  ) 
-

-Outputs text in at the current cursor position. -

-If a \n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ...

Parameters:
+

Outputs text in at the current cursor position.

+

If a \n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ...

+
Parameters:
txt the text
+
-

-


Variable Documentation

- + +

Variable Documentation

+
- +
uint8_t lcd_curline uint8_t lcd_curline
-

-Current line. Used for scrolling in text mode. -

+

Current line. Used for scrolling in text mode.

-

- + +

- +
uint8_t lcd_mode uint8_t lcd_mode
-

-Currently used mode, can be text or graphic. -

+

Currently used mode, can be text or graphic.

-

-


Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/lc7981_8h.html b/doc/html/lc7981_8h.html index 5cedbfd..6e74250 100644 --- a/doc/html/lc7981_8h.html +++ b/doc/html/lc7981_8h.html @@ -1,10 +1,13 @@ - - + + + + glcd: include/lc7981.h File Reference - - - - + + + + +
-

include/lc7981.h File Reference

#include <avr/io.h>
-#include <util/delay.h>
-#include <avr/pgmspace.h>
+

include/lc7981.h File Reference

#include <avr/io.h>
+#include <util/delay.h>
+#include <avr/pgmspace.h>
-

-Go to the source code of this file. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

Go to the source code of this file.

+

Defines

#define LC7981_H_   LC7981_H_
 protects this file from beeing double included
#define LCD_CTRL   PORTA
 Port used for control signals.
#define LCD_CRTL_DDR   DDRA
 Data-Direction-Register for the control signals.
#define LCD_RS   PA4
 Register-Select Pin of the Display.
#define LCD_RW   PA2
 Read-Write-select Pin.
#define LCD_EN   PA0
 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)
 lcd_init set the to default values.
void lcd_clear ()
 Clears the display by setting the whole memory to 0.
void lcd_write_text (char *txt)
 Outputs text in at the current cursor position.
void lcd_gotoxy (uint8_t x, uint8_t y)
 Set the display cursor to a specific location.
void lcd_plot_pixel (uint8_t x, uint8_t y, uint8_t set)
 set or unset a pixel at the specified location
void lcd_plot_bitmap (uint8_t x, uint8_t y, const uint8_t *bitmap, uint8_t w, uint8_t h)
 This function will plot a bitmap with the upper left corner to the given coordinates.
void lcd_plot_char (uint8_t x_off, uint8_t y_off, uint8_t c, uint8_t fw, uint8_t fh, const uint8_t *font)
 Plots a single character in graphicmode.
void lcd_plot_text (uint8_t x_off, uint8_t y_off, const char *text, uint8_t fw, uint8_t fh, const uint8_t *font)
 Plots a text using lcd_plot_char.
void lcd_strobe ()
 Generates the strobe signal for writing data.
void lcd_write_command (uint8_t cmd, uint8_t data)
 Writes a command and a data byte to the lcd.
uint8_t lcd_read_byte ()
 Reads a byte from the display memory.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Defines

#define LC7981_H_   LC7981_H_
 protects this file from beeing double included
#define LCD_CTRL   PORTA
 Port used for control signals.
#define LCD_CRTL_DDR   DDRA
 Data-Direction-Register for the control signals.
#define LCD_RS   PA4
 Register-Select Pin of the Display.
#define LCD_RW   PA2
 Read-Write-select Pin.
#define LCD_EN   PA0
 Strobe Pin.
#define LCD_DATA   PORTD
 Port used for data.
#define LCD_DATA_PIN   PIND
 Port used for reading the 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)
 lcd_init set the to default values.
void lcd_clear ()
 Clears the display by setting the whole memory to 0.
void lcd_write_text (char *txt)
 Outputs text in at the current cursor position.
void lcd_gotoxy (uint8_t x, uint8_t y)
 Set the display cursor to a specific location.
void lcd_plot_pixel (uint8_t x, uint8_t y, uint8_t set)
 set or unset a pixel at the specified location
void lcd_plot_bitmap (uint8_t x, uint8_t y, PGM_P bitmap, uint8_t w, uint8_t h)
 This function will plot a bitmap with the upper left corner to the given coordinates.
void lcd_plot_char (uint8_t x_off, uint8_t y_off, uint8_t c, uint8_t fw, uint8_t fh, PGM_P font)
 Plots a single character in graphicmode.
void lcd_plot_text (uint8_t x_off, uint8_t y_off, const char *text, uint8_t fw, uint8_t fh, PGM_P font)
 Plots a text using lcd_plot_char.
void lcd_plot_pgmtext (uint8_t x_off, uint8_t y_off, PGM_P text, uint8_t fw, uint8_t fh, PGM_P font)
static void lcd_strobe ()
 Generates the strobe signal for writing data.
static void lcd_write_command (uint8_t cmd, uint8_t data)
 Writes a command and a data byte to the lcd.
static uint8_t lcd_read_byte ()
 Reads a byte from the display memory.
-


Define Documentation

- +

Define Documentation

+
- +
#define LC7981_H_   LC7981_H_ #define LC7981_H_   LC7981_H_
-

-protects this file from beeing double included -

+

protects this file from beeing double included

-

- +

+
- +
#define LCD_CRTL_DDR   DDRA #define LCD_CRTL_DDR   DDRA
-

-Data-Direction-Register for the control signals. -

+

Data-Direction-Register for the control signals.

-

- + +

- +
#define LCD_CTRL   PORTA #define LCD_CTRL   PORTA
-

-Port used for control signals. -

+

Port used for control signals.

-

- + +

- +
#define LCD_DATA   PORTD #define LCD_DATA   PORTD
-

-Port used for data. -

+

Port used for data.

-

- + +

- +
#define LCD_DATA_DDR   DDRD #define LCD_DATA_DDR   DDRD
-

-Data-Direction-Register for Data. -

+

Data-Direction-Register for data.

-

- + +

- +
#define LCD_EN   PA0 #define LCD_DATA_PIN   PIND
-

-Strobe Pin. -

+

Port used for reading the data.

-

- + +

- + + +
#define lcd_en_high #define LCD_EN   PA0
+
+
+ +

Strobe Pin.

+ +
+
+ +
+
+ + +   - + - +
#define lcd_en_high (  )    (LCD_CTRL |= (1 << LCD_EN))   (LCD_CTRL |= (1 << LCD_EN))
-

-Set the strobe pin high. -

+

Set the strobe pin high.

-

- + +

- +   - + - +
#define lcd_en_low #define lcd_en_low (  )    (LCD_CTRL &= ~(1 << LCD_EN))   (LCD_CTRL &= ~(1 << LCD_EN))
-

-Set the strobe pin low. -

+

Set the strobe pin low.

-

- + +

- +
#define LCD_GRAPHIC   1 #define LCD_GRAPHIC   1
-

-Constant for graphic mode. -

+

Constant for graphic mode.

-

- + +

- +
#define LCD_GRAPHIC_HEIGHT   80 #define LCD_GRAPHIC_HEIGHT   80
-

-Vertical display size in pixels. -

+

Vertical display size in pixels.

-

- + +

- +
#define LCD_GRAPHIC_WIDTH   160 #define LCD_GRAPHIC_WIDTH   160
-

-Horizontal display size in pixels. -

+

Horizontal display size in pixels.

-

- + +

- +
#define LCD_RS   PA4 #define LCD_RS   PA4
-

-Register-Select Pin of the Display. -

+

Register-Select Pin of the Display.

-

- + +

- +   - + - +
#define lcd_rs_high #define lcd_rs_high (  )    (LCD_CTRL |= (1 << LCD_RS))   (LCD_CTRL |= (1 << LCD_RS))
-

-Set the Register-Select pin high. -

+

Set the Register-Select pin high.

-

- + +

- +   - + - +
#define lcd_rs_low #define lcd_rs_low (  )    (LCD_CTRL &= ~(1 << LCD_RS))   (LCD_CTRL &= ~(1 << LCD_RS))
-

-Set the Register-Select pin low. -

+

Set the Register-Select pin low.

-

- + +

- +
#define LCD_RW   PA2 #define LCD_RW   PA2
-

-Read-Write-select Pin. -

+

Read-Write-select Pin.

-

- + +

- +   - + - +
#define lcd_rw_high #define lcd_rw_high (  )    (LCD_CTRL |= (1 << LCD_RW))   (LCD_CTRL |= (1 << LCD_RW))
-

-Set the Read-Write-Select pin high. -

+

Set the Read-Write-Select pin high.

-

- + +

- +   - + - +
#define lcd_rw_low #define lcd_rw_low (  )    (LCD_CTRL &= ~(1 << LCD_RW))   (LCD_CTRL &= ~(1 << LCD_RW))
-

-Set the Register-Select pin low. -

+

Set the Register-Select pin low.

-

- + +

- +
#define LCD_TEXT   0 #define LCD_TEXT   0
-

-Constant for text mode. -

+

Constant for text mode.

-

- + +

- +
#define LCD_TEXT_COLUMNS   26 #define LCD_TEXT_COLUMNS   26
-

-Number of columns in text mode. -

+

Number of columns in text mode.

-

- + +

- +
#define LCD_TEXT_LINES   10 #define LCD_TEXT_LINES   10
-

-Number of lines in text mode. -

+

Number of lines in text mode.

-

- + +

- +
#define PIXEL_OFF   0 #define PIXEL_OFF   0
-

-see lcd_plot_pixel -

+

see lcd_plot_pixel

-

- + +

- +
#define PIXEL_ON   1 #define PIXEL_ON   1
-

-see lcd_plot_pixel -

+

see lcd_plot_pixel

-

-


Function Documentation

- + +

Function Documentation

+
- + - + - +
void lcd_clear void lcd_clear (  )  [inline]
-

-Clears the display by setting the whole memory to 0. -

+

Clears the display by setting the whole memory to 0.

-

- + +

- + @@ -569,59 +516,57 @@ Clears the display by setting the whole memory to 0. - +
void lcd_gotoxy void lcd_gotoxy ( uint8_t  x,
) [inline]
-

-Set the display cursor to a specific location. -

-Right now this does only work in text mode, since there's no need for it now in graphics mode.
- If the x and y values are to big, the function does nothing.

-

Parameters:
+

Set the display cursor to a specific location.

+

Right now this does only work in text mode, since there's no need for it now in graphics mode.
+ If the x and y values are to big, the function does nothing.

+
Parameters:
x the horizontal cursorposition (starts at 0)
y the vertical cursorposition (starts at 0)
+
-

- + +

- + - + - +
void lcd_init void lcd_init ( uint8_t  mode mode  ) 
-

-lcd_init set the to default values. -

-

Parameters:
+

lcd_init set the to default values.

+
Parameters:
mode LCD_TEXT for text mode and LCD_GRAPHIC for graphic mode
+
-

- + +

- + @@ -635,7 +580,7 @@ lcd_init set the to default values. - + @@ -653,23 +598,21 @@ lcd_init set the to default values. - +
void lcd_plot_bitmap void lcd_plot_bitmap ( uint8_t  x_off,
const uint8_t * PGM_P  bitmap,
)
-

-This function will plot a bitmap with the upper left corner to the given coordinates. -

-
- If the bitmap doesn't fit on the display at this location, nothing is drawn at all.
- Unset pixels are treated as transparent
- This function is by far the most tricky piece of code in this project,
- 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:
+

This function will plot a bitmap with the upper left corner to the given coordinates.

+


+ If the bitmap doesn't fit on the display at this location, nothing is drawn at all.
+ Unset pixels are treated as transparent
+ This function is by far the most tricky piece of code in this project,
+ 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:
@@ -677,17 +620,19 @@ This function will plot a bitmap with the upper left corner to the given coordin
x_off horizontal position of the bitmap
y_off vertical position of the bitmap
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.
- +

This function is dedicated to Greta, one of the most important persons in my life so far.
+

+
-

- + +

- + @@ -719,29 +664,27 @@ This function is dedicated to Greta, one of the most important persons in my lif - + - +
void lcd_plot_char void lcd_plot_char ( uint8_t  x_off,
const uint8_t * PGM_P  font 
) [inline]
-

-Plots a single character in graphicmode. -

-Each character of the font is stored linewise.
- This means for a 8x8 Pixel font the 8 bytes are needed.
- The first byte is the first line and the last byte is the last line.
- The next 8byte are the next character.
-
- If the position is too close to the display edge so it can't be displayed completely,
- It won't be displayed at all.

-

Parameters:
+

Plots a single character in graphicmode.

+

Each character of the font is stored linewise.
+ This means for a 8x8 Pixel font the 8 bytes are needed.
+ The first byte is the first line and the last byte is the last line.
+ The next 8byte are the next character.
+
+ If the position is too close to the display edge so it can't be displayed completely,
+ It won't be displayed at all.

+
Parameters:
@@ -750,16 +693,68 @@ Each character of the font is stored linewise.
x_off horizontal position of the character
y_off vertical position of the character
fh height of the font
font pointer to the flash area where the font is stored
+
-

- + +

- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void lcd_plot_pixel void lcd_plot_pgmtext (uint8_t  x_off,
uint8_t  y_off,
PGM_P  text,
uint8_t  fw,
uint8_t  fh,
PGM_P  font 
)
+
+
+ +
+
+ +
+
+ + + @@ -779,31 +774,30 @@ Each character of the font is stored linewise.
- +
void lcd_plot_pixel ( uint8_t  x,
)
-

-set or unset a pixel at the specified location -

-

Parameters:
+

set or unset a pixel at the specified location

+
Parameters:
x horizontal position of the pixel (starts at 0)
y horizontal position of the pixel (starts at 0)
set can be PIXEL_ON or PIXEL_OFF
+
-

- + +

- + @@ -835,22 +829,20 @@ set or unset a pixel at the specified location - + - +
void lcd_plot_text void lcd_plot_text ( uint8_t  x_off,
const uint8_t * PGM_P  font 
)
-

-Plots a text using lcd_plot_char. -

-

Parameters:
+

Plots a text using lcd_plot_char.

+
Parameters:
@@ -859,62 +851,60 @@ Plots a text using lcd_plot_char.
x_off horizontal position of the character
y_off vertical position of the character
fh height of the font
font pointer to the flash area where the font is stored
+
-
See also:
lcd_plot_char
+
See also:
lcd_plot_char
-

- + +

- + - + - +
uint8_t lcd_read_byte static uint8_t lcd_read_byte (  )  [inline] [inline, static]
-

-Reads a byte from the display memory. -

-lcd_gotoxy can be used to set the location. Important : lcd_gotoxy doesn't work in graphics mode yet.

-

Returns:
the byte which has been read
-
See also:
lcd_gotoxy
+

Reads a byte from the display memory.

+

lcd_gotoxy can be used to set the location. Important : lcd_gotoxy doesn't work in graphics mode yet.

+
Returns:
the byte which has been read
+
See also:
lcd_gotoxy
-

- + +

- + - + - +
void lcd_strobe static void lcd_strobe (  )  [inline] [inline, static]
-

-Generates the strobe signal for writing data. -

-This function is meant for internal usage only. +

Generates the strobe signal for writing data.

+

This function is meant for internal usage only.

+
-

- + +

- + @@ -928,54 +918,53 @@ This function is meant for internal usage only. - +
void lcd_write_command static void lcd_write_command ( uint8_t  cmd,
) [inline] [inline, static]
-

-Writes a command and a data byte to the lcd. -

-

Parameters:
+

Writes a command and a data byte to the lcd.

+
Parameters:
cmd the command byte
data the data that is going to be written after the command
+
-

- + +

- + - + - +
void lcd_write_text void lcd_write_text ( char *  txt txt  ) 
-

-Outputs text in at the current cursor position. -

-If a \n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ...

Parameters:
+

Outputs text in at the current cursor position.

+

If a \n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ...

+
Parameters:
txt the text
+
-

-


Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/main_8c.html b/doc/html/main_8c.html index cc7c146..2ad720b 100644 --- a/doc/html/main_8c.html +++ b/doc/html/main_8c.html @@ -1,10 +1,13 @@ - - + + + + glcd: main.c File Reference - - - - + + + + +
-

main.c File Reference

#include <avr/io.h>
-#include <stdlib.h>
-#include "include/lc7981.h"
-#include "include/adc.h"
-#include "button.h"
-#include "12x16_horizontal_LSB_1.h"
-#include "include/touch.h"
-#include "writing_demo.h"
+

main.c File Reference

#include <avr/io.h>
+#include <stdlib.h>
+#include "include/lc7981.h"
+#include "include/adc.h"
+#include "button.h"
+#include "12x16_horizontal_LSB_1.h"
+#include "include/touch.h"
+#include "writing_demo.h"
- - - - + +

Functions

int main ()

Functions

int main ()
-

Function Documentation

- +

Function Documentation

+
- + - + - +
int main int main (  ) 
-

-

-

-
Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/tabs.css b/doc/html/tabs.css index 95f00a9..a444163 100644 --- a/doc/html/tabs.css +++ b/doc/html/tabs.css @@ -32,7 +32,7 @@ DIV.tabs A float : left; background : url("tab_r.gif") no-repeat right top; border-bottom : 1px solid #84B0C7; - font-size : x-small; + font-size : 80%; font-weight : bold; text-decoration : none; } @@ -57,7 +57,7 @@ DIV.tabs SPAN white-space : nowrap; } -DIV.tabs INPUT +DIV.tabs #MSearchBox { float : right; display : inline; @@ -66,7 +66,7 @@ DIV.tabs INPUT DIV.tabs TD { - font-size : x-small; + font-size : 80%; font-weight : bold; text-decoration : none; } @@ -99,4 +99,7 @@ DIV.navpath background : none; border : none; border-bottom : 1px solid #84B0C7; + text-align : center; + margin : 2px; + padding : 2px; } diff --git a/doc/html/touch_8c.html b/doc/html/touch_8c.html index 23dc9dc..c1fa891 100644 --- a/doc/html/touch_8c.html +++ b/doc/html/touch_8c.html @@ -1,10 +1,13 @@ - - + + + + glcd: include/touch.c File Reference - - - - + + + + +
-

include/touch.c File Reference

#include "touch.h"
+

include/touch.c File Reference

#include "touch.h"
- - - - - - - - - + + + + +

Functions

uint8_t touch_is_pressed ()
 This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC.
int16_t touch_readX ()
int16_t touch_readY ()

Functions

uint8_t touch_is_pressed ()
 This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC.
int16_t touch_readX ()
int16_t touch_readY ()
-

Function Documentation

- +

Function Documentation

+
- + - + - +
uint8_t touch_is_pressed uint8_t touch_is_pressed (  ) 
-

-This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. -

-If the ADC-Value is less then TOUCH_PRESSED_LEVEL, the function will return 1.

Returns:
1 if pressed else 0
+

This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC.

+

If the ADC-Value is less then TOUCH_PRESSED_LEVEL, the function will return 1.

+
Returns:
1 if pressed else 0
-

- +

+
- + - + - +
int16_t touch_readX int16_t touch_readX (  ) 
-

-

-

- + +

- + - + - +
int16_t touch_readY int16_t touch_readY (  ) 
-

-

-

-


Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/touch_8h.html b/doc/html/touch_8h.html index 9aa20f9..02dfe01 100644 --- a/doc/html/touch_8h.html +++ b/doc/html/touch_8h.html @@ -1,10 +1,13 @@ - - + + + + glcd: include/touch.h File Reference - - - - + + + + +
-

include/touch.h File Reference

#include "adc.h"
- -

-Go to the source code of this file. - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

include/touch.h File Reference

#include "adc.h"
+

Go to the source code of this file.

+

Defines

#define TOUCH_H_   TOUCH_H_
 touch.h
#define TOUCH_PORT   PORTA
#define TOUCH_PIN   PINA
#define TOUCH_DDR   DDRA
#define TOUCH_X1   PA1
#define TOUCH_X2   PA3
#define TOUCH_Y1   PA5
#define TOUCH_Y2   PA7
#define TOUCH_PRESSED_LEVEL   1000

Functions

uint8_t touch_is_pressed ()
 This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC.
int16_t touch_readX ()
int16_t touch_readY ()
+ + + + + + + + + + + + + + + +

Defines

#define TOUCH_H_   TOUCH_H_
 touch.h
#define TOUCH_PORT   PORTA
#define TOUCH_PIN   PINA
#define TOUCH_DDR   DDRA
#define TOUCH_X1   PA1
#define TOUCH_X2   PA3
#define TOUCH_Y1   PA5
#define TOUCH_Y2   PA7
#define TOUCH_PRESSED_LEVEL   1000

Functions

uint8_t touch_is_pressed ()
 This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC.
int16_t touch_readX ()
int16_t touch_readY ()
-


Define Documentation

- +

Define Documentation

+
- +
#define TOUCH_DDR   DDRA #define TOUCH_DDR   DDRA
-

-

-

- +

+
- +
#define TOUCH_H_   TOUCH_H_ #define TOUCH_H_   TOUCH_H_
-

-touch.h -

-Created on: 29.05.2009 Author: sebastian +

touch.h

+

Created on: 29.05.2009 Author: sebastian

+
-

- + +

- +
#define TOUCH_PIN   PINA #define TOUCH_PIN   PINA
-

-

-

- + +

- +
#define TOUCH_PORT   PORTA #define TOUCH_PORT   PORTA
-

-

-

- + +

- +
#define TOUCH_PRESSED_LEVEL   1000 #define TOUCH_PRESSED_LEVEL   1000
-

-

-

- + +

- +
#define TOUCH_X1   PA1 #define TOUCH_X1   PA1
-

-

-

- + +

- +
#define TOUCH_X2   PA3 #define TOUCH_X2   PA3
-

-

-

- + +

- +
#define TOUCH_Y1   PA5 #define TOUCH_Y1   PA5
-

-

-

- + +

- +
#define TOUCH_Y2   PA7 #define TOUCH_Y2   PA7
-

-

-

-


Function Documentation

- + +

Function Documentation

+
- + - + - +
uint8_t touch_is_pressed uint8_t touch_is_pressed (  ) 
-

-This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. -

-If the ADC-Value is less then TOUCH_PRESSED_LEVEL, the function will return 1.

Returns:
1 if pressed else 0
+

This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC.

+

If the ADC-Value is less then TOUCH_PRESSED_LEVEL, the function will return 1.

+
Returns:
1 if pressed else 0
-

- + +

- + - + - +
int16_t touch_readX int16_t touch_readX (  ) 
-

-

-

- + +

- + - + - +
int16_t touch_readY int16_t touch_readY (  ) 
-

-

-

-


Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/writing__demo_8c.html b/doc/html/writing__demo_8c.html index bd70cc2..8239cf3 100644 --- a/doc/html/writing__demo_8c.html +++ b/doc/html/writing__demo_8c.html @@ -1,10 +1,13 @@ - - + + + + glcd: writing_demo.c File Reference - - - - + + + + +
-

writing_demo.c File Reference

#include "writing_demo.h"
+

writing_demo.c File Reference

#include "writing_demo.h"
- - - - - + + +

Functions

void writing_demo ()
 particel_demo.c

Functions

void writing_demo ()
 particel_demo.c
-

Function Documentation

- +

Function Documentation

+
- + - + - +
void writing_demo void writing_demo (  ) 
-

-particel_demo.c -

-Created on: 29.05.2009 Author: sebastian +

particel_demo.c

+

Created on: 29.05.2009 Author: sebastian

+
-

-
Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/html/writing__demo_8h.html b/doc/html/writing__demo_8h.html index f173730..74b0b02 100644 --- a/doc/html/writing__demo_8h.html +++ b/doc/html/writing__demo_8h.html @@ -1,10 +1,13 @@ - - + + + + glcd: writing_demo.h File Reference - - - - + + + + +
-

writing_demo.h File Reference

#include <stdlib.h>
-#include "include/lc7981.h"
-#include "include/adc.h"
-#include "include/touch.h"
+

writing_demo.h File Reference

#include <stdlib.h>
+#include "include/lc7981.h"
+#include "include/adc.h"
+#include "include/touch.h"
-

-Go to the source code of this file. - - - - - - - - - +

Go to the source code of this file.

+

Defines

#define WIRTING_DEMO_H_   WIRTING_DEMO_H_
 particel_demo.h

Functions

void writing_demo ()
 particel_demo.c
+ + + + + +

Defines

#define WIRTING_DEMO_H_   WIRTING_DEMO_H_
 particel_demo.h

Functions

void writing_demo ()
 particel_demo.c
-


Define Documentation

- +

Define Documentation

+
- +
#define WIRTING_DEMO_H_   WIRTING_DEMO_H_ #define WIRTING_DEMO_H_   WIRTING_DEMO_H_
-

-particel_demo.h -

-Created on: 29.05.2009 Author: sebastian +

particel_demo.h

+

Created on: 29.05.2009 Author: sebastian

+
-

-


Function Documentation

- +
+

Function Documentation

+
- + - + - +
void writing_demo void writing_demo (  ) 
-

-particel_demo.c -

-Created on: 29.05.2009 Author: sebastian +

particel_demo.c

+

Created on: 29.05.2009 Author: sebastian

+
-

-


Generated on Thu Jun 11 12:17:42 2009 for glcd by  + +
Generated on 18 Dec 2009 for glcd by  -doxygen 1.5.5
+doxygen 1.6.1
diff --git a/doc/latex/12x16__horizontal__LSB__1_8h.tex b/doc/latex/12x16__horizontal__LSB__1_8h.tex index 987a2a9..f073e2d 100644 --- a/doc/latex/12x16__horizontal__LSB__1_8h.tex +++ b/doc/latex/12x16__horizontal__LSB__1_8h.tex @@ -1,15 +1,13 @@ \section{12x16\_\-horizontal\_\-LSB\_\-1.h File Reference} \label{12x16__horizontal__LSB__1_8h}\index{12x16\_\-horizontal\_\-LSB\_\-1.h@{12x16\_\-horizontal\_\-LSB\_\-1.h}} \subsection*{Variables} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item -const uint8\_\-t font\_\-12x16[$\,$] {\bf PROGMEM} -\end{CompactItemize} +const char font\_\-12x16[$\,$] {\bf PROGMEM} +\end{DoxyCompactItemize} \subsection{Variable Documentation} \index{12x16\_\-horizontal\_\-LSB\_\-1.h@{12x16\_\-horizontal\_\-LSB\_\-1.h}!PROGMEM@{PROGMEM}} \index{PROGMEM@{PROGMEM}!12x16_horizontal_LSB_1.h@{12x16\_\-horizontal\_\-LSB\_\-1.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const uint8\_\-t font\_\-12x16 [$\,$] {\bf PROGMEM}}\label{12x16__horizontal__LSB__1_8h_f0367e5a8f2e1931348909f7875e3236} - - +\subsubsection[{PROGMEM}]{\setlength{\rightskip}{0pt plus 5cm}const char font\_\-12x16 [$\,$] {\bf PROGMEM}}\label{12x16__horizontal__LSB__1_8h_a3be0ed5f5cfb107eadc59d0b6b3771af} diff --git a/doc/latex/8x8__horizontal__LSB__1_8h.tex b/doc/latex/8x8__horizontal__LSB__1_8h.tex index 9847871..5784f2d 100644 --- a/doc/latex/8x8__horizontal__LSB__1_8h.tex +++ b/doc/latex/8x8__horizontal__LSB__1_8h.tex @@ -1,15 +1,13 @@ \section{8x8\_\-horizontal\_\-LSB\_\-1.h File Reference} \label{8x8__horizontal__LSB__1_8h}\index{8x8\_\-horizontal\_\-LSB\_\-1.h@{8x8\_\-horizontal\_\-LSB\_\-1.h}} \subsection*{Variables} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item -const uint8\_\-t font\_\-8x8[$\,$] {\bf PROGMEM} -\end{CompactItemize} +const char font\_\-8x8[$\,$] {\bf PROGMEM} +\end{DoxyCompactItemize} \subsection{Variable Documentation} \index{8x8\_\-horizontal\_\-LSB\_\-1.h@{8x8\_\-horizontal\_\-LSB\_\-1.h}!PROGMEM@{PROGMEM}} \index{PROGMEM@{PROGMEM}!8x8_horizontal_LSB_1.h@{8x8\_\-horizontal\_\-LSB\_\-1.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const uint8\_\-t font\_\-8x8 [$\,$] {\bf PROGMEM}}\label{8x8__horizontal__LSB__1_8h_ba6ccc96f4d96e2e7f9062a7a72b4766} - - +\subsubsection[{PROGMEM}]{\setlength{\rightskip}{0pt plus 5cm}const char font\_\-8x8 [$\,$] {\bf PROGMEM}}\label{8x8__horizontal__LSB__1_8h_aea5b8cca94e34368e475868cc6493943} diff --git a/doc/latex/FreeSans.ttf b/doc/latex/FreeSans.ttf deleted file mode 100644 index b550b90..0000000 Binary files a/doc/latex/FreeSans.ttf and /dev/null differ diff --git a/doc/latex/adc_8c.tex b/doc/latex/adc_8c.tex index c9754f7..2250c53 100644 --- a/doc/latex/adc_8c.tex +++ b/doc/latex/adc_8c.tex @@ -1,16 +1,14 @@ \section{include/adc.c File Reference} \label{adc_8c}\index{include/adc.c@{include/adc.c}} -{\tt \#include \char`\"{}adc.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}adc.h\char`\"{}}\par \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item uint16\_\-t {\bf readADC} (uint8\_\-t channel) -\end{CompactItemize} +\end{DoxyCompactItemize} \subsection{Function Documentation} \index{adc.c@{adc.c}!readADC@{readADC}} \index{readADC@{readADC}!adc.c@{adc.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint16\_\-t readADC (uint8\_\-t {\em channel})}\label{adc_8c_812736491523e54e6bf10a142821e7fe} - - +\subsubsection[{readADC}]{\setlength{\rightskip}{0pt plus 5cm}uint16\_\-t readADC (uint8\_\-t {\em channel})}\label{adc_8c_a812736491523e54e6bf10a142821e7fe} diff --git a/doc/latex/adc_8h.tex b/doc/latex/adc_8h.tex index df6b3a1..de0d0b6 100644 --- a/doc/latex/adc_8h.tex +++ b/doc/latex/adc_8h.tex @@ -1,31 +1,32 @@ \section{include/adc.h File Reference} \label{adc_8h}\index{include/adc.h@{include/adc.h}} -{\tt \#include $<$avr/io.h$>$}\par -{\tt \#include $<$util/delay.h$>$}\par -{\tt \#include $<$inttypes.h$>$}\par +{\ttfamily \#include $<$avr/io.h$>$}\par +{\ttfamily \#include $<$util/delay.h$>$}\par +{\ttfamily \#include $<$inttypes.h$>$}\par \subsection*{Defines} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item \#define {\bf ADC\_\-H}~ADC\_\-H -\end{CompactItemize} +\item +\#define {\bf ADC\_\-READ\_\-CYCELS}~5 +\end{DoxyCompactItemize} \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item uint16\_\-t {\bf readADC} (uint8\_\-t channel) -\end{CompactItemize} +\end{DoxyCompactItemize} \subsection{Define Documentation} \index{adc.h@{adc.h}!ADC\_\-H@{ADC\_\-H}} \index{ADC\_\-H@{ADC\_\-H}!adc.h@{adc.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define ADC\_\-H~ADC\_\-H}\label{adc_8h_7d45c6fd49da9ab97ff07bff1c3ddee5} - - +\subsubsection[{ADC\_\-H}]{\setlength{\rightskip}{0pt plus 5cm}\#define ADC\_\-H~ADC\_\-H}\label{adc_8h_a7d45c6fd49da9ab97ff07bff1c3ddee5} +\index{adc.h@{adc.h}!ADC\_\-READ\_\-CYCELS@{ADC\_\-READ\_\-CYCELS}} +\index{ADC\_\-READ\_\-CYCELS@{ADC\_\-READ\_\-CYCELS}!adc.h@{adc.h}} +\subsubsection[{ADC\_\-READ\_\-CYCELS}]{\setlength{\rightskip}{0pt plus 5cm}\#define ADC\_\-READ\_\-CYCELS~5}\label{adc_8h_a4d2b3fe7091279727b389444ac7cd959} \subsection{Function Documentation} \index{adc.h@{adc.h}!readADC@{readADC}} \index{readADC@{readADC}!adc.h@{adc.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint16\_\-t readADC (uint8\_\-t {\em channel})}\label{adc_8h_812736491523e54e6bf10a142821e7fe} - - +\subsubsection[{readADC}]{\setlength{\rightskip}{0pt plus 5cm}uint16\_\-t readADC (uint8\_\-t {\em channel})}\label{adc_8h_a812736491523e54e6bf10a142821e7fe} diff --git a/doc/latex/button_8h.tex b/doc/latex/button_8h.tex index a113f33..ee3dc7d 100644 --- a/doc/latex/button_8h.tex +++ b/doc/latex/button_8h.tex @@ -1,16 +1,14 @@ \section{button.h File Reference} \label{button_8h}\index{button.h@{button.h}} -{\tt \#include $<$avr/pgmspace.h$>$}\par +{\ttfamily \#include $<$avr/pgmspace.h$>$}\par \subsection*{Variables} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item const uint8\_\-t bitmap[$\,$] {\bf PROGMEM} -\end{CompactItemize} +\end{DoxyCompactItemize} \subsection{Variable Documentation} \index{button.h@{button.h}!PROGMEM@{PROGMEM}} \index{PROGMEM@{PROGMEM}!button.h@{button.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const uint8\_\-t bitmap [$\,$] {\bf PROGMEM}}\label{button_8h_1ca6393a353d3dde5511786a4d7cc139} - - +\subsubsection[{PROGMEM}]{\setlength{\rightskip}{0pt plus 5cm}const uint8\_\-t bitmap [$\,$] {\bf PROGMEM}}\label{button_8h_a1ca6393a353d3dde5511786a4d7cc139} diff --git a/doc/latex/doxygen.sty b/doc/latex/doxygen.sty index c7e8ba5..96cf17d 100644 --- a/doc/latex/doxygen.sty +++ b/doc/latex/doxygen.sty @@ -1,33 +1,287 @@ \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{doxygen} -\RequirePackage{calc} + +% Packages used by this style file +\RequirePackage{alltt} \RequirePackage{array} +\RequirePackage{calc} +\RequirePackage{color} +\RequirePackage{fancyhdr} +\RequirePackage{verbatim} + +% Setup fancy headings \pagestyle{fancyplain} -\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}} -\renewcommand{\chaptermark}[1]{\markboth{#1}{}} -\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}} -\lhead[\fancyplain{}{\bfseries\thepage}] - {\fancyplain{}{\bfseries\rightmark}} -\rhead[\fancyplain{}{\bfseries\leftmark}] - {\fancyplain{}{\bfseries\thepage}} -\rfoot[\fancyplain{}{\bfseries\scriptsize Generated on Thu Jun 11 12:17:41 2009 for glcd by Doxygen }]{} -\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated on Thu Jun 11 12:17:41 2009 for glcd by Doxygen }} +\newcommand{\clearemptydoublepage}{% + \newpage{\pagestyle{empty}\cleardoublepage}% +} +\renewcommand{\chaptermark}[1]{% + \markboth{#1}{}% +} +\renewcommand{\sectionmark}[1]{% + \markright{\thesection\ #1}% +} +\lhead[\fancyplain{}{\bfseries\thepage}]{% + \fancyplain{}{\bfseries\rightmark}% +} +\rhead[\fancyplain{}{\bfseries\leftmark}]{% + \fancyplain{}{\bfseries\thepage}% +} +\rfoot[\fancyplain{}{\bfseries\scriptsize% + Generated on Fri Dec 18 12:56:27 2009 for glcd by Doxygen }]{} +\lfoot[]{\fancyplain{}{\bfseries\scriptsize% + Generated on Fri Dec 18 12:56:27 2009 for glcd by Doxygen }} \cfoot{} -\newenvironment{Code} -{\footnotesize} -{\normalsize} + +%---------- Internal commands used in this style file ---------------- + +% Generic environment used by all paragraph-based environments defined +% below. Note that the command \title{...} needs to be defined inside +% those environments! +\newenvironment{DoxyDesc}[1]{% + \begin{list}{}% + {% + \settowidth{\labelwidth}{40pt}% + \setlength{\leftmargin}{\labelwidth}% + \setlength{\parsep}{0pt}% + \setlength{\itemsep}{-4pt}% + \renewcommand{\makelabel}{\entrylabel}% + }% + \item[#1:]% +}{% + \end{list}% +} + +%---------- Commands used by doxygen LaTeX output generator ---------- + +% Used by
 ... 
+\newenvironment{DoxyPre}{% + \small% + \begin{alltt}% +}{% + \end{alltt}% + \normalsize% +} + +% Used by @code ... @endcode +\newenvironment{DoxyCode}{% + \footnotesize% + \verbatim% +}{% + \endverbatim% + \normalsize% +} + +% Used by @example, @include, @includelineno and @dontinclude +\newenvironment{DoxyCodeInclude}{% + \DoxyCode% +}{% + \endDoxyCode% +} + +% Used by @verbatim ... @endverbatim +\newenvironment{DoxyVerb}{% + \footnotesize% + \verbatim% +}{% + \endverbatim% + \normalsize% +} + +% Used by @verbinclude +\newenvironment{DoxyVerbInclude}{% + \DoxyVerb% +}{% + \endDoxyVerb% +} + +% Used by numbered lists (using '-#' or
    ...
) +\newenvironment{DoxyEnumerate}{% + \enumerate% +}{% + \endenumerate% +} + +% Used by bullet lists (using '-', @li, @arg, or ) +\newenvironment{DoxyItemize}{% + \itemize% +}{% + \enditemize% +} + +% Used by description lists (using
...
) +\newenvironment{DoxyDescription}{% + \description% +}{% + \enddescription% +} + +% Used by @image, @dotfile, and @dot ... @enddot +% (only if caption is specified) +\newenvironment{DoxyImage}{% + \begin{figure}[H]% + \begin{center}% +}{% + \end{center}% + \end{figure}% +} + +% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc +% (only if no caption is specified) +\newenvironment{DoxyImageNoCaption}{% +}{% +} + +% Used by @attention +\newenvironment{DoxyAttention}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @author and @authors +\newenvironment{DoxyAuthor}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @date +\newenvironment{DoxyDate}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @invariant +\newenvironment{DoxyInvariant}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @note +\newenvironment{DoxyNote}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @post +\newenvironment{DoxyPostcond}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @pre +\newenvironment{DoxyPrecond}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @remark +\newenvironment{DoxyRemark}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @return +\newenvironment{DoxyReturn}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @since +\newenvironment{DoxySince}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @see +\newenvironment{DoxySeeAlso}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @version +\newenvironment{DoxyVersion}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @warning +\newenvironment{DoxyWarning}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @internal +\newenvironment{DoxyInternal}[1]{% + \begin{DoxyDesc}{#1}% +}{% + \end{DoxyDesc}% +} + +% Used by @par and @paragraph +\newenvironment{DoxyParagraph}[1]{% + \begin{list}{}% + {% + \settowidth{\labelwidth}{40pt}% + \setlength{\leftmargin}{\labelwidth}% + \setlength{\parsep}{0pt}% + \setlength{\itemsep}{-4pt}% + \renewcommand{\makelabel}{\entrylabel}% + }% + \item[#1]% +}{% + \end{list}% +} + +% Used by parameter lists +\newenvironment{DoxyParams}[1]{% + \begin{DoxyDesc}{#1}% + \begin{description}% +}{% + \end{description}% + \end{DoxyDesc}% +} + +% Used by return value lists +\newenvironment{DoxyRetVals}[1]{% + \begin{DoxyDesc}{#1}% + \begin{description}% +}{% + \end{description}% + \end{DoxyDesc}% +} + +% Used by exception lists +\newenvironment{DoxyExceptions}[1]{% + \begin{DoxyDesc}{#1}% + \begin{description}% +}{% + \end{description}% + \end{DoxyDesc}% +} + +% Used by template parameter lists +\newenvironment{DoxyTemplParams}[1]{% + \begin{DoxyDesc}{#1}% + \begin{description}% +}{% + \end{description}% + \end{DoxyDesc}% +} + \newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})} -\newenvironment{DocInclude} -{\footnotesize} -{\normalsize} -\newenvironment{VerbInclude} -{\footnotesize} -{\normalsize} -\newenvironment{Image} -{\begin{figure}[H]} -{\end{figure}} -\newenvironment{ImageNoCaption}{}{} -\newenvironment{CompactList} +\newenvironment{DoxyCompactList} {\begin{list}{}{ \setlength{\leftmargin}{0.5cm} \setlength{\itemsep}{0pt} @@ -35,7 +289,7 @@ \setlength{\topsep}{0pt} \renewcommand{\makelabel}{\hfill}}} {\end{list}} -\newenvironment{CompactItemize} +\newenvironment{DoxyCompactItemize} { \begin{itemize} \setlength{\itemsep}{-3pt} @@ -76,3 +330,22 @@ \addtocounter{secnumdepth}{1} \sloppy \usepackage[T1]{fontenc} +\makeatletter +\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}% + {-3.25ex plus -1ex minus -0.2ex}% + {1.5ex plus 0.2ex}% + {\normalfont\normalsize\bfseries}} +\makeatother +\stepcounter{secnumdepth} +\stepcounter{tocdepth} +\definecolor{comment}{rgb}{0.5,0.0,0.0} +\definecolor{keyword}{rgb}{0.0,0.5,0.0} +\definecolor{keywordtype}{rgb}{0.38,0.25,0.125} +\definecolor{keywordflow}{rgb}{0.88,0.5,0.0} +\definecolor{preprocessor}{rgb}{0.5,0.38,0.125} +\definecolor{stringliteral}{rgb}{0.0,0.125,0.25} +\definecolor{charliteral}{rgb}{0.0,0.5,0.5} +\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0} +\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43} +\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0} +\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0} diff --git a/doc/latex/files.tex b/doc/latex/files.tex index 6617a8c..b393952 100644 --- a/doc/latex/files.tex +++ b/doc/latex/files.tex @@ -1,5 +1,5 @@ \section{File List} -Here is a list of all files with brief descriptions:\begin{CompactList} +Here is a list of all files with brief descriptions:\begin{DoxyCompactList} \item\contentsline{section}{{\bf 12x16\_\-horizontal\_\-LSB\_\-1.h} }{\pageref{12x16__horizontal__LSB__1_8h}}{} \item\contentsline{section}{{\bf 8x8\_\-horizontal\_\-LSB\_\-1.h} }{\pageref{8x8__horizontal__LSB__1_8h}}{} \item\contentsline{section}{{\bf button.h} }{\pageref{button_8h}}{} @@ -12,4 +12,4 @@ Here is a list of all files with brief descriptions:\begin{CompactList} \item\contentsline{section}{include/{\bf lc7981.h} }{\pageref{lc7981_8h}}{} \item\contentsline{section}{include/{\bf touch.c} }{\pageref{touch_8c}}{} \item\contentsline{section}{include/{\bf touch.h} }{\pageref{touch_8h}}{} -\end{CompactList} +\end{DoxyCompactList} diff --git a/doc/latex/lc7981_8c.tex b/doc/latex/lc7981_8c.tex index ab5d370..205481e 100644 --- a/doc/latex/lc7981_8c.tex +++ b/doc/latex/lc7981_8c.tex @@ -1,85 +1,67 @@ \section{include/lc7981.c File Reference} \label{lc7981_8c}\index{include/lc7981.c@{include/lc7981.c}} -{\tt \#include \char`\"{}lc7981.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}lc7981.h\char`\"{}}\par \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item void {\bf lcd\_\-init} (uint8\_\-t mode) -\begin{CompactList}\small\item\em lcd\_\-init set the to default values. \item\end{CompactList}\item -void {\bf lcd\_\-write\_\-command} (uint8\_\-t cmd, uint8\_\-t data) -\begin{CompactList}\small\item\em Writes a command and a data byte to the lcd. \item\end{CompactList}\item -uint8\_\-t {\bf lcd\_\-read\_\-byte} () -\begin{CompactList}\small\item\em Reads a byte from the display memory. \item\end{CompactList}\item -void {\bf lcd\_\-strobe} () -\begin{CompactList}\small\item\em Generates the strobe signal for writing data. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em lcd\_\-init set the to default values. \item\end{DoxyCompactList}\item void {\bf lcd\_\-clear} () -\begin{CompactList}\small\item\em Clears the display by setting the whole memory to 0. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Clears the display by setting the whole memory to 0. \item\end{DoxyCompactList}\item void {\bf lcd\_\-write\_\-text} (char $\ast$txt) -\begin{CompactList}\small\item\em Outputs text in at the current cursor position. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Outputs text in at the current cursor position. \item\end{DoxyCompactList}\item void {\bf lcd\_\-gotoxy} (uint8\_\-t x, uint8\_\-t y) -\begin{CompactList}\small\item\em Set the display cursor to a specific location. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the display cursor to a specific location. \item\end{DoxyCompactList}\item void {\bf lcd\_\-plot\_\-pixel} (uint8\_\-t x, uint8\_\-t y, uint8\_\-t set) -\begin{CompactList}\small\item\em set or unset a pixel at the specified location \item\end{CompactList}\item -void {\bf lcd\_\-plot\_\-bitmap} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, const uint8\_\-t $\ast$bitmap, uint8\_\-t w, uint8\_\-t h) -\begin{CompactList}\small\item\em This function will plot a bitmap with the upper left corner to the given coordinates. \item\end{CompactList}\item -void {\bf lcd\_\-plot\_\-char} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, uint8\_\-t c, uint8\_\-t fw, uint8\_\-t fh, const uint8\_\-t $\ast$font) -\begin{CompactList}\small\item\em Plots a single character in graphicmode. \item\end{CompactList}\item -void {\bf lcd\_\-plot\_\-text} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, const char $\ast$text, uint8\_\-t fw, uint8\_\-t fh, const uint8\_\-t $\ast$font) -\begin{CompactList}\small\item\em Plots a text using lcd\_\-plot\_\-char. \item\end{CompactList}\item -void {\bf lcd\_\-plot\_\-pgmtext} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, const char $\ast$text, uint8\_\-t fw, uint8\_\-t fh, const uint8\_\-t $\ast$font) -\end{CompactItemize} +\begin{DoxyCompactList}\small\item\em set or unset a pixel at the specified location \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-bitmap} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, PGM\_\-P bitmap, uint8\_\-t w, uint8\_\-t h) +\begin{DoxyCompactList}\small\item\em This function will plot a bitmap with the upper left corner to the given coordinates. \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-char} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, uint8\_\-t c, uint8\_\-t fw, uint8\_\-t fh, PGM\_\-P font) +\begin{DoxyCompactList}\small\item\em Plots a single character in graphicmode. \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-text} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, const char $\ast$text, uint8\_\-t fw, uint8\_\-t fh, PGM\_\-P font) +\begin{DoxyCompactList}\small\item\em Plots a text using lcd\_\-plot\_\-char. \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-pgmtext} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, PGM\_\-P text, uint8\_\-t fw, uint8\_\-t fh, PGM\_\-P font) +\end{DoxyCompactItemize} \subsection*{Variables} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item uint8\_\-t {\bf lcd\_\-mode} -\begin{CompactList}\small\item\em Currently used mode, can be text or graphic. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Currently used mode, can be text or graphic. \item\end{DoxyCompactList}\item uint8\_\-t {\bf lcd\_\-curline} -\begin{CompactList}\small\item\em Current line. Used for scrolling in text mode. \item\end{CompactList}\end{CompactItemize} +\begin{DoxyCompactList}\small\item\em Current line. Used for scrolling in text mode. \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection{Function Documentation} \index{lc7981.c@{lc7981.c}!lcd\_\-clear@{lcd\_\-clear}} \index{lcd\_\-clear@{lcd\_\-clear}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-clear ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_35c08b1fa742e650f4873939707b893b} +\subsubsection[{lcd\_\-clear}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-clear ()}\label{lc7981_8c_a35c08b1fa742e650f4873939707b893b} -Clears the display by setting the whole memory to 0. - -\index{lc7981.c@{lc7981.c}!lcd\_\-gotoxy@{lcd\_\-gotoxy}} +Clears the display by setting the whole memory to 0. \index{lc7981.c@{lc7981.c}!lcd\_\-gotoxy@{lcd\_\-gotoxy}} \index{lcd\_\-gotoxy@{lcd\_\-gotoxy}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-gotoxy (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_dbf47a5efdf02367ded1ebf8f9edb5fe} +\subsubsection[{lcd\_\-gotoxy}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-gotoxy (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y})}\label{lc7981_8c_adbf47a5efdf02367ded1ebf8f9edb5fe} -Set the display cursor to a specific location. - -Right now this does only work in text mode, since there's no need for it now in graphics mode. \par +Set the display cursor to a specific location. Right now this does only work in text mode, since there's no need for it now in graphics mode. \par If the x and y values are to big, the function does nothing. -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x}]the horizontal cursorposition (starts at 0) \item[{\em y}]the vertical cursorposition (starts at 0) \end{description} -\end{Desc} + +\begin{DoxyParams}{Parameters} +\item[{\em x}]the horizontal cursorposition (starts at 0) \item[{\em y}]the vertical cursorposition (starts at 0) \end{DoxyParams} \index{lc7981.c@{lc7981.c}!lcd\_\-init@{lcd\_\-init}} \index{lcd\_\-init@{lcd\_\-init}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-init (uint8\_\-t {\em mode})}\label{lc7981_8c_9b18aca098d68e55bd7dd4b83f4f36e9} +\subsubsection[{lcd\_\-init}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-init (uint8\_\-t {\em mode})}\label{lc7981_8c_a9b18aca098d68e55bd7dd4b83f4f36e9} lcd\_\-init set the to default values. - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em mode}]LCD\_\-TEXT for text mode and LCD\_\-GRAPHIC for graphic mode \end{description} -\end{Desc} +\begin{DoxyParams}{Parameters} +\item[{\em mode}]LCD\_\-TEXT for text mode and LCD\_\-GRAPHIC for graphic mode \end{DoxyParams} \index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}} \index{lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-bitmap (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const uint8\_\-t $\ast$ {\em bitmap}, \/ uint8\_\-t {\em w}, \/ uint8\_\-t {\em h})}\label{lc7981_8c_f3b584ee8235c6ed4ebefc50f8a95915} +\subsubsection[{lcd\_\-plot\_\-bitmap}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-bitmap (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ PGM\_\-P {\em bitmap}, \/ uint8\_\-t {\em w}, \/ uint8\_\-t {\em h})}\label{lc7981_8c_a21d8458d8f15ac3799a2f6303b85c136} -This function will plot a bitmap with the upper left corner to the given coordinates. - -\par +This function will plot a bitmap with the upper left corner to the given coordinates. \par If the bitmap doesn't fit on the display at this location, nothing is drawn at all.\par Unset pixels are treated as transparent \par This function is by far the most tricky piece of code in this project,\par @@ -87,20 +69,16 @@ 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\_\-off}]horizontal position of the bitmap \item[{\em y\_\-off}]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} + +\begin{DoxyParams}{Parameters} +\item[{\em x\_\-off}]horizontal position of the bitmap \item[{\em y\_\-off}]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{DoxyParams} This function is dedicated to Greta, one of the most important persons in my life so far.\par \index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-char@{lcd\_\-plot\_\-char}} \index{lcd\_\-plot\_\-char@{lcd\_\-plot\_\-char}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-char (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ uint8\_\-t {\em c}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ const uint8\_\-t $\ast$ {\em font})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_9bbbc52f3cb24a861d11b08e1c14bca2} +\subsubsection[{lcd\_\-plot\_\-char}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-char (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ uint8\_\-t {\em c}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ PGM\_\-P {\em font})}\label{lc7981_8c_a2615737020b222e49a4d9c8d08a54f43} -Plots a single character in graphicmode. - -Each character of the font is stored linewise. \par +Plots a single character in graphicmode. Each character of the font is stored linewise. \par This means for a 8x8 Pixel font the 8 bytes are needed. \par The first byte is the first line and the last byte is the last line. \par The next 8byte are the next character.\par @@ -108,100 +86,50 @@ Each character of the font is stored linewise. \par If the position is too close to the display edge so it can't be displayed completely,\par It won't be displayed at all. -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em c}]the character or it's ascii code \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored \end{description} -\end{Desc} + +\begin{DoxyParams}{Parameters} +\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em c}]the character or it's ascii code \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored \end{DoxyParams} \index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-pgmtext@{lcd\_\-plot\_\-pgmtext}} \index{lcd\_\-plot\_\-pgmtext@{lcd\_\-plot\_\-pgmtext}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pgmtext (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const char $\ast$ {\em text}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ const uint8\_\-t $\ast$ {\em font})}\label{lc7981_8c_cba3fd3277d8785693564bb296d53049} - - +\subsubsection[{lcd\_\-plot\_\-pgmtext}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pgmtext (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ PGM\_\-P {\em text}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ PGM\_\-P {\em font})}\label{lc7981_8c_a0af06316c8d3d3a57b1ddcf949d85a8c} \index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}} \index{lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pixel (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y}, \/ uint8\_\-t {\em set})}\label{lc7981_8c_735111507ed83172f58d5af2953e31c6} +\subsubsection[{lcd\_\-plot\_\-pixel}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pixel (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y}, \/ uint8\_\-t {\em set})}\label{lc7981_8c_a735111507ed83172f58d5af2953e31c6} set or unset a pixel at the specified location - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x}]horizontal position of the pixel (starts at 0) \item[{\em y}]horizontal position of the pixel (starts at 0) \item[{\em set}]can be PIXEL\_\-ON or PIXEL\_\-OFF \end{description} -\end{Desc} +\begin{DoxyParams}{Parameters} +\item[{\em x}]horizontal position of the pixel (starts at 0) \item[{\em y}]horizontal position of the pixel (starts at 0) \item[{\em set}]can be PIXEL\_\-ON or PIXEL\_\-OFF \end{DoxyParams} \index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-text@{lcd\_\-plot\_\-text}} \index{lcd\_\-plot\_\-text@{lcd\_\-plot\_\-text}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-text (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const char $\ast$ {\em text}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ const uint8\_\-t $\ast$ {\em font})}\label{lc7981_8c_324c97a9fc335bb59fb6f2f56d729dd5} +\subsubsection[{lcd\_\-plot\_\-text}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-text (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const char $\ast$ {\em text}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ PGM\_\-P {\em font})}\label{lc7981_8c_a71a77094675e2850e8a4b442fb6a366e} Plots a text using lcd\_\-plot\_\-char. - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em text}]the text that is plotted \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored\end{description} -\end{Desc} -\begin{Desc} -\item[See also:]\doxyref{lcd\_\-plot\_\-char}{p.}{lc7981_8h_9bbbc52f3cb24a861d11b08e1c14bca2} \end{Desc} -\index{lc7981.c@{lc7981.c}!lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}} -\index{lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t lcd\_\-read\_\-byte ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_6334333537ad1d0bd51cba1e80f32e74} - - -Reads a byte from the display memory. - -lcd\_\-gotoxy can be used to set the location. Important : lcd\_\-gotoxy doesn't work in graphics mode yet. - -\begin{Desc} -\item[Returns:]the byte which has been read \end{Desc} -\begin{Desc} -\item[See also:]\doxyref{lcd\_\-gotoxy}{p.}{lc7981_8h_dbf47a5efdf02367ded1ebf8f9edb5fe} \end{Desc} -\index{lc7981.c@{lc7981.c}!lcd\_\-strobe@{lcd\_\-strobe}} -\index{lcd\_\-strobe@{lcd\_\-strobe}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-strobe ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_b4f286d6a313df7a5f692e0b4a9509ad} - - -Generates the strobe signal for writing data. - -This function is meant for internal usage only. \index{lc7981.c@{lc7981.c}!lcd\_\-write\_\-command@{lcd\_\-write\_\-command}} -\index{lcd\_\-write\_\-command@{lcd\_\-write\_\-command}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-command (uint8\_\-t {\em cmd}, \/ uint8\_\-t {\em data})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_b69146a9179fc5b5deef3fc61cf0208c} - - -Writes a command and a data byte to the lcd. - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em cmd}]the command byte \item[{\em data}]the data that is going to be written after the command \end{description} -\end{Desc} +\begin{DoxyParams}{Parameters} +\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em text}]the text that is plotted \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored\end{DoxyParams} +\begin{DoxySeeAlso}{See also} +\doxyref{lcd\_\-plot\_\-char}{p.}{lc7981_8h_a2615737020b222e49a4d9c8d08a54f43} +\end{DoxySeeAlso} \index{lc7981.c@{lc7981.c}!lcd\_\-write\_\-text@{lcd\_\-write\_\-text}} \index{lcd\_\-write\_\-text@{lcd\_\-write\_\-text}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-text (char $\ast$ {\em txt})}\label{lc7981_8c_30251238a49999658455fdb0233757fb} +\subsubsection[{lcd\_\-write\_\-text}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-text (char $\ast$ {\em txt})}\label{lc7981_8c_a30251238a49999658455fdb0233757fb} -Outputs text in at the current cursor position. - -If a $\backslash$n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ... \begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em txt}]the text \end{description} -\end{Desc} +Outputs text in at the current cursor position. If a $\backslash$n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ... +\begin{DoxyParams}{Parameters} +\item[{\em txt}]the text \end{DoxyParams} \subsection{Variable Documentation} \index{lc7981.c@{lc7981.c}!lcd\_\-curline@{lcd\_\-curline}} \index{lcd\_\-curline@{lcd\_\-curline}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t {\bf lcd\_\-curline}}\label{lc7981_8c_76f8e26cf50274635b544f68752b2a0f} +\subsubsection[{lcd\_\-curline}]{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t {\bf lcd\_\-curline}}\label{lc7981_8c_a76f8e26cf50274635b544f68752b2a0f} -Current line. Used for scrolling in text mode. - -\index{lc7981.c@{lc7981.c}!lcd\_\-mode@{lcd\_\-mode}} +Current line. Used for scrolling in text mode. \index{lc7981.c@{lc7981.c}!lcd\_\-mode@{lcd\_\-mode}} \index{lcd\_\-mode@{lcd\_\-mode}!lc7981.c@{lc7981.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t {\bf lcd\_\-mode}}\label{lc7981_8c_a29c0577fe01129f48b5b21301d3ea49} +\subsubsection[{lcd\_\-mode}]{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t {\bf lcd\_\-mode}}\label{lc7981_8c_aa29c0577fe01129f48b5b21301d3ea49} -Currently used mode, can be text or graphic. - +Currently used mode, can be text or graphic. \ No newline at end of file diff --git a/doc/latex/lc7981_8h.tex b/doc/latex/lc7981_8h.tex index 26dd356..24c45f0 100644 --- a/doc/latex/lc7981_8h.tex +++ b/doc/latex/lc7981_8h.tex @@ -1,282 +1,235 @@ \section{include/lc7981.h File Reference} \label{lc7981_8h}\index{include/lc7981.h@{include/lc7981.h}} -{\tt \#include $<$avr/io.h$>$}\par -{\tt \#include $<$util/delay.h$>$}\par -{\tt \#include $<$avr/pgmspace.h$>$}\par +{\ttfamily \#include $<$avr/io.h$>$}\par +{\ttfamily \#include $<$util/delay.h$>$}\par +{\ttfamily \#include $<$avr/pgmspace.h$>$}\par \subsection*{Defines} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item \#define {\bf LC7981\_\-H\_\-}~LC7981\_\-H\_\- -\begin{CompactList}\small\item\em protects this file from beeing double included \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em protects this file from beeing double included \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-CTRL}~PORTA -\begin{CompactList}\small\item\em Port used for control signals. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Port used for control signals. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-CRTL\_\-DDR}~DDRA -\begin{CompactList}\small\item\em Data-Direction-Register for the control signals. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Data-\/Direction-\/Register for the control signals. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-RS}~PA4 -\begin{CompactList}\small\item\em Register-Select Pin of the Display. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Register-\/Select Pin of the Display. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-RW}~PA2 -\begin{CompactList}\small\item\em Read-Write-select Pin. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Read-\/Write-\/select Pin. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-EN}~PA0 -\begin{CompactList}\small\item\em Strobe Pin. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Strobe Pin. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-DATA}~PORTD -\begin{CompactList}\small\item\em Port used for data. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Port used for data. \item\end{DoxyCompactList}\item +\#define {\bf LCD\_\-DATA\_\-PIN}~PIND +\begin{DoxyCompactList}\small\item\em Port used for reading the data. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-DATA\_\-DDR}~DDRD -\begin{CompactList}\small\item\em Data-Direction-Register for Data. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Data-\/Direction-\/Register for data. \item\end{DoxyCompactList}\item \#define {\bf lcd\_\-rs\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RS)) -\begin{CompactList}\small\item\em Set the Register-Select pin high. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the Register-\/Select pin high. \item\end{DoxyCompactList}\item \#define {\bf lcd\_\-rs\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RS)) -\begin{CompactList}\small\item\em Set the Register-Select pin low. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the Register-\/Select pin low. \item\end{DoxyCompactList}\item \#define {\bf lcd\_\-rw\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RW)) -\begin{CompactList}\small\item\em Set the Read-Write-Select pin high. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the Read-\/Write-\/Select pin high. \item\end{DoxyCompactList}\item \#define {\bf lcd\_\-rw\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RW)) -\begin{CompactList}\small\item\em Set the Register-Select pin low. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the Register-\/Select pin low. \item\end{DoxyCompactList}\item \#define {\bf lcd\_\-en\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-EN)) -\begin{CompactList}\small\item\em Set the strobe pin high. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the strobe pin high. \item\end{DoxyCompactList}\item \#define {\bf lcd\_\-en\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-EN)) -\begin{CompactList}\small\item\em Set the strobe pin low. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the strobe pin low. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-TEXT}~0 -\begin{CompactList}\small\item\em Constant for text mode. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Constant for text mode. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-TEXT\_\-LINES}~10 -\begin{CompactList}\small\item\em Number of lines in text mode. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Number of lines in text mode. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-TEXT\_\-COLUMNS}~26 -\begin{CompactList}\small\item\em Number of columns in text mode. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Number of columns in text mode. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-GRAPHIC}~1 -\begin{CompactList}\small\item\em Constant for graphic mode. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Constant for graphic mode. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-GRAPHIC\_\-WIDTH}~160 -\begin{CompactList}\small\item\em Horizontal display size in pixels. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Horizontal display size in pixels. \item\end{DoxyCompactList}\item \#define {\bf LCD\_\-GRAPHIC\_\-HEIGHT}~80 -\begin{CompactList}\small\item\em Vertical display size in pixels. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Vertical display size in pixels. \item\end{DoxyCompactList}\item \#define {\bf PIXEL\_\-ON}~1 -\begin{CompactList}\small\item\em see lcd\_\-plot\_\-pixel \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em see lcd\_\-plot\_\-pixel \item\end{DoxyCompactList}\item \#define {\bf PIXEL\_\-OFF}~0 -\begin{CompactList}\small\item\em see lcd\_\-plot\_\-pixel \item\end{CompactList}\end{CompactItemize} +\begin{DoxyCompactList}\small\item\em see lcd\_\-plot\_\-pixel \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item void {\bf lcd\_\-init} (uint8\_\-t mode) -\begin{CompactList}\small\item\em lcd\_\-init set the to default values. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em lcd\_\-init set the to default values. \item\end{DoxyCompactList}\item void {\bf lcd\_\-clear} () -\begin{CompactList}\small\item\em Clears the display by setting the whole memory to 0. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Clears the display by setting the whole memory to 0. \item\end{DoxyCompactList}\item void {\bf lcd\_\-write\_\-text} (char $\ast$txt) -\begin{CompactList}\small\item\em Outputs text in at the current cursor position. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Outputs text in at the current cursor position. \item\end{DoxyCompactList}\item void {\bf lcd\_\-gotoxy} (uint8\_\-t x, uint8\_\-t y) -\begin{CompactList}\small\item\em Set the display cursor to a specific location. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em Set the display cursor to a specific location. \item\end{DoxyCompactList}\item void {\bf lcd\_\-plot\_\-pixel} (uint8\_\-t x, uint8\_\-t y, uint8\_\-t set) -\begin{CompactList}\small\item\em set or unset a pixel at the specified location \item\end{CompactList}\item -void {\bf lcd\_\-plot\_\-bitmap} (uint8\_\-t x, uint8\_\-t y, const uint8\_\-t $\ast$bitmap, uint8\_\-t w, uint8\_\-t h) -\begin{CompactList}\small\item\em This function will plot a bitmap with the upper left corner to the given coordinates. \item\end{CompactList}\item -void {\bf lcd\_\-plot\_\-char} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, uint8\_\-t c, uint8\_\-t fw, uint8\_\-t fh, const uint8\_\-t $\ast$font) -\begin{CompactList}\small\item\em Plots a single character in graphicmode. \item\end{CompactList}\item -void {\bf lcd\_\-plot\_\-text} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, const char $\ast$text, uint8\_\-t fw, uint8\_\-t fh, const uint8\_\-t $\ast$font) -\begin{CompactList}\small\item\em Plots a text using lcd\_\-plot\_\-char. \item\end{CompactList}\item -void {\bf lcd\_\-strobe} () -\begin{CompactList}\small\item\em Generates the strobe signal for writing data. \item\end{CompactList}\item -void {\bf lcd\_\-write\_\-command} (uint8\_\-t cmd, uint8\_\-t data) -\begin{CompactList}\small\item\em Writes a command and a data byte to the lcd. \item\end{CompactList}\item -uint8\_\-t {\bf lcd\_\-read\_\-byte} () -\begin{CompactList}\small\item\em Reads a byte from the display memory. \item\end{CompactList}\end{CompactItemize} +\begin{DoxyCompactList}\small\item\em set or unset a pixel at the specified location \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-bitmap} (uint8\_\-t x, uint8\_\-t y, PGM\_\-P bitmap, uint8\_\-t w, uint8\_\-t h) +\begin{DoxyCompactList}\small\item\em This function will plot a bitmap with the upper left corner to the given coordinates. \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-char} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, uint8\_\-t c, uint8\_\-t fw, uint8\_\-t fh, PGM\_\-P font) +\begin{DoxyCompactList}\small\item\em Plots a single character in graphicmode. \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-text} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, const char $\ast$text, uint8\_\-t fw, uint8\_\-t fh, PGM\_\-P font) +\begin{DoxyCompactList}\small\item\em Plots a text using lcd\_\-plot\_\-char. \item\end{DoxyCompactList}\item +void {\bf lcd\_\-plot\_\-pgmtext} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, PGM\_\-P text, uint8\_\-t fw, uint8\_\-t fh, PGM\_\-P font) +\item +static void {\bf lcd\_\-strobe} () +\begin{DoxyCompactList}\small\item\em Generates the strobe signal for writing data. \item\end{DoxyCompactList}\item +static void {\bf lcd\_\-write\_\-command} (uint8\_\-t cmd, uint8\_\-t data) +\begin{DoxyCompactList}\small\item\em Writes a command and a data byte to the lcd. \item\end{DoxyCompactList}\item +static uint8\_\-t {\bf lcd\_\-read\_\-byte} () +\begin{DoxyCompactList}\small\item\em Reads a byte from the display memory. \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection{Define Documentation} \index{lc7981.h@{lc7981.h}!LC7981\_\-H\_\-@{LC7981\_\-H\_\-}} \index{LC7981\_\-H\_\-@{LC7981\_\-H\_\-}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LC7981\_\-H\_\-~LC7981\_\-H\_\-}\label{lc7981_8h_e6ff861bd55f4dc46f25f5f6abfca15f} +\subsubsection[{LC7981\_\-H\_\-}]{\setlength{\rightskip}{0pt plus 5cm}\#define LC7981\_\-H\_\-~LC7981\_\-H\_\-}\label{lc7981_8h_ae6ff861bd55f4dc46f25f5f6abfca15f} -protects this file from beeing double included - -\index{lc7981.h@{lc7981.h}!LCD\_\-CRTL\_\-DDR@{LCD\_\-CRTL\_\-DDR}} +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~DDRA}\label{lc7981_8h_4b6c8400da9a1ca3d4d83f3ef1f9c34a} +\subsubsection[{LCD\_\-CRTL\_\-DDR}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-CRTL\_\-DDR~DDRA}\label{lc7981_8h_a4b6c8400da9a1ca3d4d83f3ef1f9c34a} -Data-Direction-Register for the control signals. - -\index{lc7981.h@{lc7981.h}!LCD\_\-CTRL@{LCD\_\-CTRL}} +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~PORTA}\label{lc7981_8h_8e945df7ca614325cafa08258e82a63c} +\subsubsection[{LCD\_\-CTRL}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-CTRL~PORTA}\label{lc7981_8h_a8e945df7ca614325cafa08258e82a63c} -Port used for control signals. - -\index{lc7981.h@{lc7981.h}!LCD\_\-DATA@{LCD\_\-DATA}} +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} +\subsubsection[{LCD\_\-DATA}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-DATA~PORTD}\label{lc7981_8h_a25e9d818788f36ed74d7c4579f87f2a6} -Port used for data. - -\index{lc7981.h@{lc7981.h}!LCD\_\-DATA\_\-DDR@{LCD\_\-DATA\_\-DDR}} +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} +\subsubsection[{LCD\_\-DATA\_\-DDR}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-DATA\_\-DDR~DDRD}\label{lc7981_8h_a0c114e723aa4c162c415fb6d4d963dd7} -Data-Direction-Register for Data. +Data-\/Direction-\/Register for data. \index{lc7981.h@{lc7981.h}!LCD\_\-DATA\_\-PIN@{LCD\_\-DATA\_\-PIN}} +\index{LCD\_\-DATA\_\-PIN@{LCD\_\-DATA\_\-PIN}!lc7981.h@{lc7981.h}} +\subsubsection[{LCD\_\-DATA\_\-PIN}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-DATA\_\-PIN~PIND}\label{lc7981_8h_abd18e47e71697a28fd0ca765cefc7411} -\index{lc7981.h@{lc7981.h}!LCD\_\-EN@{LCD\_\-EN}} + +Port used for reading the 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~PA0}\label{lc7981_8h_1640ffbc0d8ec0f7edb04a2b93918072} +\subsubsection[{LCD\_\-EN}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-EN~PA0}\label{lc7981_8h_a1640ffbc0d8ec0f7edb04a2b93918072} -Strobe Pin. - -\index{lc7981.h@{lc7981.h}!lcd\_\-en\_\-high@{lcd\_\-en\_\-high}} +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} +\subsubsection[{lcd\_\-en\_\-high}]{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-en\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-EN))}\label{lc7981_8h_ae14be306d3620577abc8613d40401b04} -Set the strobe pin high. - -\index{lc7981.h@{lc7981.h}!lcd\_\-en\_\-low@{lcd\_\-en\_\-low}} +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} +\subsubsection[{lcd\_\-en\_\-low}]{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-en\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-EN))}\label{lc7981_8h_ad8dcdb36a9410fd96b2c936b7c9355dd} -Set the strobe pin low. - -\index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC@{LCD\_\-GRAPHIC}} +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} +\subsubsection[{LCD\_\-GRAPHIC}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC~1}\label{lc7981_8h_adfaedf8da8e73d39a98d709b519a3117} -Constant for graphic mode. - -\index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC\_\-HEIGHT@{LCD\_\-GRAPHIC\_\-HEIGHT}} +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} +\subsubsection[{LCD\_\-GRAPHIC\_\-HEIGHT}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC\_\-HEIGHT~80}\label{lc7981_8h_a70265c4f840ef78872243e91c923af2f} -Vertical display size in pixels. - -\index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC\_\-WIDTH@{LCD\_\-GRAPHIC\_\-WIDTH}} +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} +\subsubsection[{LCD\_\-GRAPHIC\_\-WIDTH}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC\_\-WIDTH~160}\label{lc7981_8h_a51e83be6f6929f2a29d5467cd937dfc6} -Horizontal display size in pixels. - -\index{lc7981.h@{lc7981.h}!LCD\_\-RS@{LCD\_\-RS}} +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~PA4}\label{lc7981_8h_4781e073871c6f27f89b9463ad3a4ed1} +\subsubsection[{LCD\_\-RS}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-RS~PA4}\label{lc7981_8h_a4781e073871c6f27f89b9463ad3a4ed1} -Register-Select Pin of the Display. - -\index{lc7981.h@{lc7981.h}!lcd\_\-rs\_\-high@{lcd\_\-rs\_\-high}} +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} +\subsubsection[{lcd\_\-rs\_\-high}]{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rs\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RS))}\label{lc7981_8h_a795b48274d3f80bc744a707b67fd93e9} -Set the Register-Select pin high. - -\index{lc7981.h@{lc7981.h}!lcd\_\-rs\_\-low@{lcd\_\-rs\_\-low}} +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} +\subsubsection[{lcd\_\-rs\_\-low}]{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rs\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RS))}\label{lc7981_8h_a6edb13d59460246fb4cc32ada1c9f4a8} -Set the Register-Select pin low. - -\index{lc7981.h@{lc7981.h}!LCD\_\-RW@{LCD\_\-RW}} +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~PA2}\label{lc7981_8h_26089a10ddd59a0dc7283c19ccc02533} +\subsubsection[{LCD\_\-RW}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-RW~PA2}\label{lc7981_8h_a26089a10ddd59a0dc7283c19ccc02533} -Read-Write-select Pin. - -\index{lc7981.h@{lc7981.h}!lcd\_\-rw\_\-high@{lcd\_\-rw\_\-high}} +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} +\subsubsection[{lcd\_\-rw\_\-high}]{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rw\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RW))}\label{lc7981_8h_ad0ce3cd9b481370ad4de36eff08440c8} -Set the Read-Write-Select pin high. - -\index{lc7981.h@{lc7981.h}!lcd\_\-rw\_\-low@{lcd\_\-rw\_\-low}} +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} +\subsubsection[{lcd\_\-rw\_\-low}]{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rw\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RW))}\label{lc7981_8h_a7f5ebe0ca71b1298a7d3423850cc82b1} -Set the Register-Select pin low. - -\index{lc7981.h@{lc7981.h}!LCD\_\-TEXT@{LCD\_\-TEXT}} +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} +\subsubsection[{LCD\_\-TEXT}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT~0}\label{lc7981_8h_a90a69d37f5c80f3ded970acf2dacf4c0} -Constant for text mode. - -\index{lc7981.h@{lc7981.h}!LCD\_\-TEXT\_\-COLUMNS@{LCD\_\-TEXT\_\-COLUMNS}} +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} +\subsubsection[{LCD\_\-TEXT\_\-COLUMNS}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT\_\-COLUMNS~26}\label{lc7981_8h_a82f0a630f3c41b5233f2ceb07c7dd736} -Number of columns in text mode. - -\index{lc7981.h@{lc7981.h}!LCD\_\-TEXT\_\-LINES@{LCD\_\-TEXT\_\-LINES}} +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} +\subsubsection[{LCD\_\-TEXT\_\-LINES}]{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT\_\-LINES~10}\label{lc7981_8h_a720ef60606ac38ca3a5ab96a9c2b8168} -Number of lines in text mode. - -\index{lc7981.h@{lc7981.h}!PIXEL\_\-OFF@{PIXEL\_\-OFF}} +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} +\subsubsection[{PIXEL\_\-OFF}]{\setlength{\rightskip}{0pt plus 5cm}\#define PIXEL\_\-OFF~0}\label{lc7981_8h_acda2f1b1cf6310700d0d91643c40e068} -see lcd\_\-plot\_\-pixel - -\index{lc7981.h@{lc7981.h}!PIXEL\_\-ON@{PIXEL\_\-ON}} +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} +\subsubsection[{PIXEL\_\-ON}]{\setlength{\rightskip}{0pt plus 5cm}\#define PIXEL\_\-ON~1}\label{lc7981_8h_aeb2d212a26da4a5a4d3231b2773023e5} see lcd\_\-plot\_\-pixel - - \subsection{Function Documentation} \index{lc7981.h@{lc7981.h}!lcd\_\-clear@{lcd\_\-clear}} \index{lcd\_\-clear@{lcd\_\-clear}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-clear ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_35c08b1fa742e650f4873939707b893b} +\subsubsection[{lcd\_\-clear}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-clear ()}\label{lc7981_8h_a35c08b1fa742e650f4873939707b893b} -Clears the display by setting the whole memory to 0. - -\index{lc7981.h@{lc7981.h}!lcd\_\-gotoxy@{lcd\_\-gotoxy}} +Clears the display by setting the whole memory to 0. \index{lc7981.h@{lc7981.h}!lcd\_\-gotoxy@{lcd\_\-gotoxy}} \index{lcd\_\-gotoxy@{lcd\_\-gotoxy}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-gotoxy (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_dbf47a5efdf02367ded1ebf8f9edb5fe} +\subsubsection[{lcd\_\-gotoxy}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-gotoxy (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y})}\label{lc7981_8h_adbf47a5efdf02367ded1ebf8f9edb5fe} -Set the display cursor to a specific location. - -Right now this does only work in text mode, since there's no need for it now in graphics mode. \par +Set the display cursor to a specific location. Right now this does only work in text mode, since there's no need for it now in graphics mode. \par If the x and y values are to big, the function does nothing. -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x}]the horizontal cursorposition (starts at 0) \item[{\em y}]the vertical cursorposition (starts at 0) \end{description} -\end{Desc} + +\begin{DoxyParams}{Parameters} +\item[{\em x}]the horizontal cursorposition (starts at 0) \item[{\em y}]the vertical cursorposition (starts at 0) \end{DoxyParams} \index{lc7981.h@{lc7981.h}!lcd\_\-init@{lcd\_\-init}} \index{lcd\_\-init@{lcd\_\-init}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-init (uint8\_\-t {\em mode})}\label{lc7981_8h_9b18aca098d68e55bd7dd4b83f4f36e9} +\subsubsection[{lcd\_\-init}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-init (uint8\_\-t {\em mode})}\label{lc7981_8h_a9b18aca098d68e55bd7dd4b83f4f36e9} lcd\_\-init set the to default values. - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em mode}]LCD\_\-TEXT for text mode and LCD\_\-GRAPHIC for graphic mode \end{description} -\end{Desc} +\begin{DoxyParams}{Parameters} +\item[{\em mode}]LCD\_\-TEXT for text mode and LCD\_\-GRAPHIC for graphic mode \end{DoxyParams} \index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}} \index{lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-bitmap (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const uint8\_\-t $\ast$ {\em bitmap}, \/ uint8\_\-t {\em w}, \/ uint8\_\-t {\em h})}\label{lc7981_8h_175d691feb304584c8c18e6456e07401} +\subsubsection[{lcd\_\-plot\_\-bitmap}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-bitmap (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ PGM\_\-P {\em bitmap}, \/ uint8\_\-t {\em w}, \/ uint8\_\-t {\em h})}\label{lc7981_8h_aa89be137ee35d3fd7e88782aafb0efdf} -This function will plot a bitmap with the upper left corner to the given coordinates. - -\par +This function will plot a bitmap with the upper left corner to the given coordinates. \par If the bitmap doesn't fit on the display at this location, nothing is drawn at all.\par Unset pixels are treated as transparent \par This function is by far the most tricky piece of code in this project,\par @@ -284,20 +237,16 @@ 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\_\-off}]horizontal position of the bitmap \item[{\em y\_\-off}]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} + +\begin{DoxyParams}{Parameters} +\item[{\em x\_\-off}]horizontal position of the bitmap \item[{\em y\_\-off}]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{DoxyParams} This function is dedicated to Greta, one of the most important persons in my life so far.\par \index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-char@{lcd\_\-plot\_\-char}} \index{lcd\_\-plot\_\-char@{lcd\_\-plot\_\-char}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-char (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ uint8\_\-t {\em c}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ const uint8\_\-t $\ast$ {\em font})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_9bbbc52f3cb24a861d11b08e1c14bca2} +\subsubsection[{lcd\_\-plot\_\-char}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-char (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ uint8\_\-t {\em c}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ PGM\_\-P {\em font})}\label{lc7981_8h_a2615737020b222e49a4d9c8d08a54f43} -Plots a single character in graphicmode. - -Each character of the font is stored linewise. \par +Plots a single character in graphicmode. Each character of the font is stored linewise. \par This means for a 8x8 Pixel font the 8 bytes are needed. \par The first byte is the first line and the last byte is the last line. \par The next 8byte are the next character.\par @@ -305,78 +254,62 @@ Each character of the font is stored linewise. \par If the position is too close to the display edge so it can't be displayed completely,\par It won't be displayed at all. -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em c}]the character or it's ascii code \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored \end{description} -\end{Desc} + +\begin{DoxyParams}{Parameters} +\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em c}]the character or it's ascii code \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored \end{DoxyParams} +\index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-pgmtext@{lcd\_\-plot\_\-pgmtext}} +\index{lcd\_\-plot\_\-pgmtext@{lcd\_\-plot\_\-pgmtext}!lc7981.h@{lc7981.h}} +\subsubsection[{lcd\_\-plot\_\-pgmtext}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pgmtext (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ PGM\_\-P {\em text}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ PGM\_\-P {\em font})}\label{lc7981_8h_a0af06316c8d3d3a57b1ddcf949d85a8c} \index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}} \index{lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pixel (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y}, \/ uint8\_\-t {\em set})}\label{lc7981_8h_735111507ed83172f58d5af2953e31c6} +\subsubsection[{lcd\_\-plot\_\-pixel}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pixel (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y}, \/ uint8\_\-t {\em set})}\label{lc7981_8h_a735111507ed83172f58d5af2953e31c6} set or unset a pixel at the specified location - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x}]horizontal position of the pixel (starts at 0) \item[{\em y}]horizontal position of the pixel (starts at 0) \item[{\em set}]can be PIXEL\_\-ON or PIXEL\_\-OFF \end{description} -\end{Desc} +\begin{DoxyParams}{Parameters} +\item[{\em x}]horizontal position of the pixel (starts at 0) \item[{\em y}]horizontal position of the pixel (starts at 0) \item[{\em set}]can be PIXEL\_\-ON or PIXEL\_\-OFF \end{DoxyParams} \index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-text@{lcd\_\-plot\_\-text}} \index{lcd\_\-plot\_\-text@{lcd\_\-plot\_\-text}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-text (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const char $\ast$ {\em text}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ const uint8\_\-t $\ast$ {\em font})}\label{lc7981_8h_324c97a9fc335bb59fb6f2f56d729dd5} +\subsubsection[{lcd\_\-plot\_\-text}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-text (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const char $\ast$ {\em text}, \/ uint8\_\-t {\em fw}, \/ uint8\_\-t {\em fh}, \/ PGM\_\-P {\em font})}\label{lc7981_8h_a71a77094675e2850e8a4b442fb6a366e} Plots a text using lcd\_\-plot\_\-char. - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em text}]the text that is plotted \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored\end{description} -\end{Desc} -\begin{Desc} -\item[See also:]\doxyref{lcd\_\-plot\_\-char}{p.}{lc7981_8h_9bbbc52f3cb24a861d11b08e1c14bca2} \end{Desc} +\begin{DoxyParams}{Parameters} +\item[{\em x\_\-off}]horizontal position of the character \item[{\em y\_\-off}]vertical position of the character \item[{\em text}]the text that is plotted \item[{\em fw}]width of the font \item[{\em fh}]height of the font \item[{\em font}]pointer to the flash area where the font is stored\end{DoxyParams} +\begin{DoxySeeAlso}{See also} +\doxyref{lcd\_\-plot\_\-char}{p.}{lc7981_8h_a2615737020b222e49a4d9c8d08a54f43} +\end{DoxySeeAlso} \index{lc7981.h@{lc7981.h}!lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}} \index{lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t lcd\_\-read\_\-byte ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_6334333537ad1d0bd51cba1e80f32e74} +\subsubsection[{lcd\_\-read\_\-byte}]{\setlength{\rightskip}{0pt plus 5cm}static uint8\_\-t lcd\_\-read\_\-byte ()\hspace{0.3cm}{\ttfamily [inline, static]}}\label{lc7981_8h_a0f6a62f494f3cd66aa1f4a910bca71a8} -Reads a byte from the display memory. +Reads a byte from the display memory. lcd\_\-gotoxy can be used to set the location. Important : lcd\_\-gotoxy doesn't work in graphics mode yet. -lcd\_\-gotoxy can be used to set the location. Important : lcd\_\-gotoxy doesn't work in graphics mode yet. - -\begin{Desc} -\item[Returns:]the byte which has been read \end{Desc} -\begin{Desc} -\item[See also:]\doxyref{lcd\_\-gotoxy}{p.}{lc7981_8h_dbf47a5efdf02367ded1ebf8f9edb5fe} \end{Desc} +\begin{DoxyReturn}{Returns} +the byte which has been read +\end{DoxyReturn} +\begin{DoxySeeAlso}{See also} +\doxyref{lcd\_\-gotoxy}{p.}{lc7981_8h_adbf47a5efdf02367ded1ebf8f9edb5fe} +\end{DoxySeeAlso} \index{lc7981.h@{lc7981.h}!lcd\_\-strobe@{lcd\_\-strobe}} \index{lcd\_\-strobe@{lcd\_\-strobe}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-strobe ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_b4f286d6a313df7a5f692e0b4a9509ad} +\subsubsection[{lcd\_\-strobe}]{\setlength{\rightskip}{0pt plus 5cm}static void lcd\_\-strobe ()\hspace{0.3cm}{\ttfamily [inline, static]}}\label{lc7981_8h_a32fdf2306d469b45e2a3bfd020403d76} -Generates the strobe signal for writing data. - -This function is meant for internal usage only. \index{lc7981.h@{lc7981.h}!lcd\_\-write\_\-command@{lcd\_\-write\_\-command}} +Generates the strobe signal for writing data. This function is meant for internal usage only. \index{lc7981.h@{lc7981.h}!lcd\_\-write\_\-command@{lcd\_\-write\_\-command}} \index{lcd\_\-write\_\-command@{lcd\_\-write\_\-command}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-command (uint8\_\-t {\em cmd}, \/ uint8\_\-t {\em data})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_b69146a9179fc5b5deef3fc61cf0208c} +\subsubsection[{lcd\_\-write\_\-command}]{\setlength{\rightskip}{0pt plus 5cm}static void lcd\_\-write\_\-command (uint8\_\-t {\em cmd}, \/ uint8\_\-t {\em data})\hspace{0.3cm}{\ttfamily [inline, static]}}\label{lc7981_8h_a31db85f1f48f4802c24218bc165ea4e1} Writes a command and a data byte to the lcd. - -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em cmd}]the command byte \item[{\em data}]the data that is going to be written after the command \end{description} -\end{Desc} +\begin{DoxyParams}{Parameters} +\item[{\em cmd}]the command byte \item[{\em data}]the data that is going to be written after the command \end{DoxyParams} \index{lc7981.h@{lc7981.h}!lcd\_\-write\_\-text@{lcd\_\-write\_\-text}} \index{lcd\_\-write\_\-text@{lcd\_\-write\_\-text}!lc7981.h@{lc7981.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-text (char $\ast$ {\em txt})}\label{lc7981_8h_30251238a49999658455fdb0233757fb} +\subsubsection[{lcd\_\-write\_\-text}]{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-text (char $\ast$ {\em txt})}\label{lc7981_8h_a30251238a49999658455fdb0233757fb} -Outputs text in at the current cursor position. - -If a $\backslash$n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ... \begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em txt}]the text \end{description} -\end{Desc} +Outputs text in at the current cursor position. If a $\backslash$n occurs in the last line of the display, all the other line will be 'scrolled' up. This function is textmode only. The the second line becomes the first, the third the second and so on ... +\begin{DoxyParams}{Parameters} +\item[{\em txt}]the text \end{DoxyParams} diff --git a/doc/latex/main_8c.tex b/doc/latex/main_8c.tex index 196c94c..f453119 100644 --- a/doc/latex/main_8c.tex +++ b/doc/latex/main_8c.tex @@ -1,23 +1,21 @@ \section{main.c File Reference} \label{main_8c}\index{main.c@{main.c}} -{\tt \#include $<$avr/io.h$>$}\par -{\tt \#include $<$stdlib.h$>$}\par -{\tt \#include \char`\"{}include/lc7981.h\char`\"{}}\par -{\tt \#include \char`\"{}include/adc.h\char`\"{}}\par -{\tt \#include \char`\"{}button.h\char`\"{}}\par -{\tt \#include \char`\"{}12x16\_\-horizontal\_\-LSB\_\-1.h\char`\"{}}\par -{\tt \#include \char`\"{}include/touch.h\char`\"{}}\par -{\tt \#include \char`\"{}writing\_\-demo.h\char`\"{}}\par +{\ttfamily \#include $<$avr/io.h$>$}\par +{\ttfamily \#include $<$stdlib.h$>$}\par +{\ttfamily \#include \char`\"{}include/lc7981.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}include/adc.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}button.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}12x16\_\-horizontal\_\-LSB\_\-1.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}include/touch.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}writing\_\-demo.h\char`\"{}}\par \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item int {\bf main} () -\end{CompactItemize} +\end{DoxyCompactItemize} \subsection{Function Documentation} \index{main.c@{main.c}!main@{main}} \index{main@{main}!main.c@{main.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int main ()}\label{main_8c_e66f6b31b5ad750f1fe042a706a4e3d4} - - +\subsubsection[{main}]{\setlength{\rightskip}{0pt plus 5cm}int main ()}\label{main_8c_ae66f6b31b5ad750f1fe042a706a4e3d4} diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex index 9b05bb7..a5e6675 100644 --- a/doc/latex/refman.tex +++ b/doc/latex/refman.tex @@ -1,17 +1,19 @@ \documentclass[a4paper]{book} \usepackage{a4wide} \usepackage{makeidx} -\usepackage{fancyhdr} \usepackage{graphicx} \usepackage{multicol} \usepackage{float} +\usepackage{listings} +\usepackage{color} \usepackage{textcomp} \usepackage{alltt} \usepackage{times} \usepackage[utf8]{inputenc} \usepackage{doxygen} +\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left } \makeindex -\setcounter{tocdepth}{1} +\setcounter{tocdepth}{3} \renewcommand{\footrulewidth}{0.4pt} \begin{document} \begin{titlepage} @@ -19,9 +21,9 @@ \begin{center} {\Large glcd \\[1ex]\large 0.1beta }\\ \vspace*{1cm} -{\large Generated by Doxygen 1.5.5}\\ +{\large Generated by Doxygen 1.6.1}\\ \vspace*{0.5cm} -{\small Thu Jun 11 12:17:41 2009}\\ +{\small Fri Dec 18 12:56:27 2009}\\ \end{center} \end{titlepage} \clearemptydoublepage diff --git a/doc/latex/touch_8c.tex b/doc/latex/touch_8c.tex index a21794c..8d30875 100644 --- a/doc/latex/touch_8c.tex +++ b/doc/latex/touch_8c.tex @@ -1,34 +1,29 @@ \section{include/touch.c File Reference} \label{touch_8c}\index{include/touch.c@{include/touch.c}} -{\tt \#include \char`\"{}touch.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}touch.h\char`\"{}}\par \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item uint8\_\-t {\bf touch\_\-is\_\-pressed} () -\begin{CompactList}\small\item\em This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. \item\end{DoxyCompactList}\item int16\_\-t {\bf touch\_\-readX} () \item int16\_\-t {\bf touch\_\-readY} () -\end{CompactItemize} +\end{DoxyCompactItemize} \subsection{Function Documentation} \index{touch.c@{touch.c}!touch\_\-is\_\-pressed@{touch\_\-is\_\-pressed}} \index{touch\_\-is\_\-pressed@{touch\_\-is\_\-pressed}!touch.c@{touch.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t touch\_\-is\_\-pressed ()}\label{touch_8c_215947ded979abf11d490536508ecafc} +\subsubsection[{touch\_\-is\_\-pressed}]{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t touch\_\-is\_\-pressed ()}\label{touch_8c_a215947ded979abf11d490536508ecafc} -This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. - -If the ADC-Value is less then TOUCH\_\-PRESSED\_\-LEVEL, the function will return 1. \begin{Desc} -\item[Returns:]1 if pressed else 0 \end{Desc} +This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. If the ADC-\/Value is less then TOUCH\_\-PRESSED\_\-LEVEL, the function will return 1. \begin{DoxyReturn}{Returns} +1 if pressed else 0 +\end{DoxyReturn} \index{touch.c@{touch.c}!touch\_\-readX@{touch\_\-readX}} \index{touch\_\-readX@{touch\_\-readX}!touch.c@{touch.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readX ()}\label{touch_8c_dbea78d45cc89e43f7510ebf6eb01ac0} - - +\subsubsection[{touch\_\-readX}]{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readX ()}\label{touch_8c_adbea78d45cc89e43f7510ebf6eb01ac0} \index{touch.c@{touch.c}!touch\_\-readY@{touch\_\-readY}} \index{touch\_\-readY@{touch\_\-readY}!touch.c@{touch.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readY ()}\label{touch_8c_cdce8a6997f2d00dbfcb61be2e67e886} - - +\subsubsection[{touch\_\-readY}]{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readY ()}\label{touch_8c_acdce8a6997f2d00dbfcb61be2e67e886} diff --git a/doc/latex/touch_8h.tex b/doc/latex/touch_8h.tex index 19bfac9..2226171 100644 --- a/doc/latex/touch_8h.tex +++ b/doc/latex/touch_8h.tex @@ -1,11 +1,11 @@ \section{include/touch.h File Reference} \label{touch_8h}\index{include/touch.h@{include/touch.h}} -{\tt \#include \char`\"{}adc.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}adc.h\char`\"{}}\par \subsection*{Defines} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item \#define {\bf TOUCH\_\-H\_\-}~TOUCH\_\-H\_\- -\begin{CompactList}\small\item\em \doxyref{touch.h}{p.}{touch_8h} \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em \doxyref{touch.h}{p.}{touch_8h} \item\end{DoxyCompactList}\item \#define {\bf TOUCH\_\-PORT}~PORTA \item \#define {\bf TOUCH\_\-PIN}~PINA @@ -21,85 +21,62 @@ \#define {\bf TOUCH\_\-Y2}~PA7 \item \#define {\bf TOUCH\_\-PRESSED\_\-LEVEL}~1000 -\end{CompactItemize} +\end{DoxyCompactItemize} \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item uint8\_\-t {\bf touch\_\-is\_\-pressed} () -\begin{CompactList}\small\item\em This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. \item\end{CompactList}\item +\begin{DoxyCompactList}\small\item\em This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. \item\end{DoxyCompactList}\item int16\_\-t {\bf touch\_\-readX} () \item int16\_\-t {\bf touch\_\-readY} () -\end{CompactItemize} +\end{DoxyCompactItemize} \subsection{Define Documentation} \index{touch.h@{touch.h}!TOUCH\_\-DDR@{TOUCH\_\-DDR}} \index{TOUCH\_\-DDR@{TOUCH\_\-DDR}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-DDR~DDRA}\label{touch_8h_7df7927e1c0467a8e462b483a7da62c7} - - +\subsubsection[{TOUCH\_\-DDR}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-DDR~DDRA}\label{touch_8h_a7df7927e1c0467a8e462b483a7da62c7} \index{touch.h@{touch.h}!TOUCH\_\-H\_\-@{TOUCH\_\-H\_\-}} \index{TOUCH\_\-H\_\-@{TOUCH\_\-H\_\-}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-H\_\-~TOUCH\_\-H\_\-}\label{touch_8h_c7d5ec105ddb1a3240d9f8b1dc259974} +\subsubsection[{TOUCH\_\-H\_\-}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-H\_\-~TOUCH\_\-H\_\-}\label{touch_8h_ac7d5ec105ddb1a3240d9f8b1dc259974} -\doxyref{touch.h}{p.}{touch_8h} - -Created on: 29.05.2009 Author: sebastian \index{touch.h@{touch.h}!TOUCH\_\-PIN@{TOUCH\_\-PIN}} +\doxyref{touch.h}{p.}{touch_8h} Created on: 29.05.2009 Author: sebastian \index{touch.h@{touch.h}!TOUCH\_\-PIN@{TOUCH\_\-PIN}} \index{TOUCH\_\-PIN@{TOUCH\_\-PIN}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-PIN~PINA}\label{touch_8h_eccf4c5be8d2e85e37d07d834673ce29} - - +\subsubsection[{TOUCH\_\-PIN}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-PIN~PINA}\label{touch_8h_aeccf4c5be8d2e85e37d07d834673ce29} \index{touch.h@{touch.h}!TOUCH\_\-PORT@{TOUCH\_\-PORT}} \index{TOUCH\_\-PORT@{TOUCH\_\-PORT}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-PORT~PORTA}\label{touch_8h_2ea8f9960f5f713995fd0e1304a33831} - - +\subsubsection[{TOUCH\_\-PORT}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-PORT~PORTA}\label{touch_8h_a2ea8f9960f5f713995fd0e1304a33831} \index{touch.h@{touch.h}!TOUCH\_\-PRESSED\_\-LEVEL@{TOUCH\_\-PRESSED\_\-LEVEL}} \index{TOUCH\_\-PRESSED\_\-LEVEL@{TOUCH\_\-PRESSED\_\-LEVEL}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-PRESSED\_\-LEVEL~1000}\label{touch_8h_7f34b02cb67c42f6d7b862a061496da7} - - +\subsubsection[{TOUCH\_\-PRESSED\_\-LEVEL}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-PRESSED\_\-LEVEL~1000}\label{touch_8h_a7f34b02cb67c42f6d7b862a061496da7} \index{touch.h@{touch.h}!TOUCH\_\-X1@{TOUCH\_\-X1}} \index{TOUCH\_\-X1@{TOUCH\_\-X1}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-X1~PA1}\label{touch_8h_68fb42f50f3eb1acfc00869488260dd8} - - +\subsubsection[{TOUCH\_\-X1}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-X1~PA1}\label{touch_8h_a68fb42f50f3eb1acfc00869488260dd8} \index{touch.h@{touch.h}!TOUCH\_\-X2@{TOUCH\_\-X2}} \index{TOUCH\_\-X2@{TOUCH\_\-X2}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-X2~PA3}\label{touch_8h_f14aca3b903c90c70433d41fdb840a93} - - +\subsubsection[{TOUCH\_\-X2}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-X2~PA3}\label{touch_8h_af14aca3b903c90c70433d41fdb840a93} \index{touch.h@{touch.h}!TOUCH\_\-Y1@{TOUCH\_\-Y1}} \index{TOUCH\_\-Y1@{TOUCH\_\-Y1}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-Y1~PA5}\label{touch_8h_2168431fed386ed4cfec1127b055652a} - - +\subsubsection[{TOUCH\_\-Y1}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-Y1~PA5}\label{touch_8h_a2168431fed386ed4cfec1127b055652a} \index{touch.h@{touch.h}!TOUCH\_\-Y2@{TOUCH\_\-Y2}} \index{TOUCH\_\-Y2@{TOUCH\_\-Y2}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-Y2~PA7}\label{touch_8h_347b052e8cb9e548e2aaebbb9d8ed405} - - +\subsubsection[{TOUCH\_\-Y2}]{\setlength{\rightskip}{0pt plus 5cm}\#define TOUCH\_\-Y2~PA7}\label{touch_8h_a347b052e8cb9e548e2aaebbb9d8ed405} \subsection{Function Documentation} \index{touch.h@{touch.h}!touch\_\-is\_\-pressed@{touch\_\-is\_\-pressed}} \index{touch\_\-is\_\-pressed@{touch\_\-is\_\-pressed}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t touch\_\-is\_\-pressed ()}\label{touch_8h_215947ded979abf11d490536508ecafc} +\subsubsection[{touch\_\-is\_\-pressed}]{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t touch\_\-is\_\-pressed ()}\label{touch_8h_a215947ded979abf11d490536508ecafc} -This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. - -If the ADC-Value is less then TOUCH\_\-PRESSED\_\-LEVEL, the function will return 1. \begin{Desc} -\item[Returns:]1 if pressed else 0 \end{Desc} +This functions set 5V to X1 and GND to Y1, the voltage at X2 is measured via the ADC. If the ADC-\/Value is less then TOUCH\_\-PRESSED\_\-LEVEL, the function will return 1. \begin{DoxyReturn}{Returns} +1 if pressed else 0 +\end{DoxyReturn} \index{touch.h@{touch.h}!touch\_\-readX@{touch\_\-readX}} \index{touch\_\-readX@{touch\_\-readX}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readX ()}\label{touch_8h_dbea78d45cc89e43f7510ebf6eb01ac0} - - +\subsubsection[{touch\_\-readX}]{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readX ()}\label{touch_8h_adbea78d45cc89e43f7510ebf6eb01ac0} \index{touch.h@{touch.h}!touch\_\-readY@{touch\_\-readY}} \index{touch\_\-readY@{touch\_\-readY}!touch.h@{touch.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readY ()}\label{touch_8h_cdce8a6997f2d00dbfcb61be2e67e886} - - +\subsubsection[{touch\_\-readY}]{\setlength{\rightskip}{0pt plus 5cm}int16\_\-t touch\_\-readY ()}\label{touch_8h_acdce8a6997f2d00dbfcb61be2e67e886} diff --git a/doc/latex/writing__demo_8c.tex b/doc/latex/writing__demo_8c.tex index f1d94f0..3c44e97 100644 --- a/doc/latex/writing__demo_8c.tex +++ b/doc/latex/writing__demo_8c.tex @@ -1,19 +1,17 @@ \section{writing\_\-demo.c File Reference} \label{writing__demo_8c}\index{writing\_\-demo.c@{writing\_\-demo.c}} -{\tt \#include \char`\"{}writing\_\-demo.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}writing\_\-demo.h\char`\"{}}\par \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item void {\bf writing\_\-demo} () -\begin{CompactList}\small\item\em particel\_\-demo.c \item\end{CompactList}\end{CompactItemize} +\begin{DoxyCompactList}\small\item\em particel\_\-demo.c \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection{Function Documentation} \index{writing\_\-demo.c@{writing\_\-demo.c}!writing\_\-demo@{writing\_\-demo}} \index{writing\_\-demo@{writing\_\-demo}!writing_demo.c@{writing\_\-demo.c}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void writing\_\-demo ()}\label{writing__demo_8c_bdd925f1d9c8a09b9950c059c51e02d1} +\subsubsection[{writing\_\-demo}]{\setlength{\rightskip}{0pt plus 5cm}void writing\_\-demo ()}\label{writing__demo_8c_abdd925f1d9c8a09b9950c059c51e02d1} -particel\_\-demo.c - -Created on: 29.05.2009 Author: sebastian \ No newline at end of file +particel\_\-demo.c Created on: 29.05.2009 Author: sebastian \ No newline at end of file diff --git a/doc/latex/writing__demo_8h.tex b/doc/latex/writing__demo_8h.tex index 36fe40c..8e7118a 100644 --- a/doc/latex/writing__demo_8h.tex +++ b/doc/latex/writing__demo_8h.tex @@ -1,37 +1,33 @@ \section{writing\_\-demo.h File Reference} \label{writing__demo_8h}\index{writing\_\-demo.h@{writing\_\-demo.h}} -{\tt \#include $<$stdlib.h$>$}\par -{\tt \#include \char`\"{}include/lc7981.h\char`\"{}}\par -{\tt \#include \char`\"{}include/adc.h\char`\"{}}\par -{\tt \#include \char`\"{}include/touch.h\char`\"{}}\par +{\ttfamily \#include $<$stdlib.h$>$}\par +{\ttfamily \#include \char`\"{}include/lc7981.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}include/adc.h\char`\"{}}\par +{\ttfamily \#include \char`\"{}include/touch.h\char`\"{}}\par \subsection*{Defines} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item \#define {\bf WIRTING\_\-DEMO\_\-H\_\-}~WIRTING\_\-DEMO\_\-H\_\- -\begin{CompactList}\small\item\em particel\_\-demo.h \item\end{CompactList}\end{CompactItemize} +\begin{DoxyCompactList}\small\item\em particel\_\-demo.h \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Functions} -\begin{CompactItemize} +\begin{DoxyCompactItemize} \item void {\bf writing\_\-demo} () -\begin{CompactList}\small\item\em particel\_\-demo.c \item\end{CompactList}\end{CompactItemize} +\begin{DoxyCompactList}\small\item\em particel\_\-demo.c \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection{Define Documentation} \index{writing\_\-demo.h@{writing\_\-demo.h}!WIRTING\_\-DEMO\_\-H\_\-@{WIRTING\_\-DEMO\_\-H\_\-}} \index{WIRTING\_\-DEMO\_\-H\_\-@{WIRTING\_\-DEMO\_\-H\_\-}!writing_demo.h@{writing\_\-demo.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define WIRTING\_\-DEMO\_\-H\_\-~WIRTING\_\-DEMO\_\-H\_\-}\label{writing__demo_8h_69a65c026c8b8e97c7b6f99de76ab00d} +\subsubsection[{WIRTING\_\-DEMO\_\-H\_\-}]{\setlength{\rightskip}{0pt plus 5cm}\#define WIRTING\_\-DEMO\_\-H\_\-~WIRTING\_\-DEMO\_\-H\_\-}\label{writing__demo_8h_a69a65c026c8b8e97c7b6f99de76ab00d} -particel\_\-demo.h - -Created on: 29.05.2009 Author: sebastian +particel\_\-demo.h Created on: 29.05.2009 Author: sebastian \subsection{Function Documentation} \index{writing\_\-demo.h@{writing\_\-demo.h}!writing\_\-demo@{writing\_\-demo}} \index{writing\_\-demo@{writing\_\-demo}!writing_demo.h@{writing\_\-demo.h}} -\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void writing\_\-demo ()}\label{writing__demo_8h_bdd925f1d9c8a09b9950c059c51e02d1} +\subsubsection[{writing\_\-demo}]{\setlength{\rightskip}{0pt plus 5cm}void writing\_\-demo ()}\label{writing__demo_8h_abdd925f1d9c8a09b9950c059c51e02d1} -particel\_\-demo.c - -Created on: 29.05.2009 Author: sebastian \ No newline at end of file +particel\_\-demo.c Created on: 29.05.2009 Author: sebastian \ No newline at end of file diff --git a/include/lc7981.c b/include/lc7981.c index 157cb47..a9c9120 100644 --- a/include/lc7981.c +++ b/include/lc7981.c @@ -76,68 +76,9 @@ void lcd_init(uint8_t mode) { lcd_clear(); } -/** - * Writes a command and a data byte to the lcd. - * - * @param cmd the command byte - * @param data the data that is going to be written after the command - */ -void lcd_write_command(uint8_t cmd, uint8_t data) { - _delay_us(30); - lcd_rw_low(); - lcd_rs_high(); - LCD_DATA = cmd; - _delay_us(1); - lcd_strobe(); - - lcd_rs_low(); - LCD_DATA = data; - _delay_us(1); - lcd_strobe(); - -} - -/** - * Reads a byte from the display memory. - * lcd_gotoxy can be used to set the location. - * Important : lcd_gotoxy doesn't work in graphics mode yet. - * - * @return the byte which has been read - * @see lcd_gotoxy - */ -uint8_t lcd_read_byte() { -uint8_t i,data; - - for(i = 0; i < 2; i++) { - _delay_us(30); - lcd_rw_low(); - lcd_rs_high(); - LCD_DATA = 0x0D; - _delay_us(1); - lcd_en_high(); - - LCD_DATA_DDR = 0x00; - lcd_rs_low(); - lcd_rw_high(); - _delay_us(1); - data = (uint8_t) LCD_DATA_PIN; - lcd_en_low(); - LCD_DATA_DDR = 0xFF; - } - return data; -} -/** - * Generates the strobe signal for writing data. - * This function is meant for internal usage only. - */ -void lcd_strobe() { - lcd_en_high(); - _delay_us(1); - lcd_en_low(); -} /** * Clears the display by setting the whole memory to 0. diff --git a/include/lc7981.h b/include/lc7981.h index 1c83849..4980927 100644 --- a/include/lc7981.h +++ b/include/lc7981.h @@ -77,13 +77,84 @@ void lcd_gotoxy(uint8_t x, uint8_t y); void lcd_plot_pixel(uint8_t x, uint8_t y, uint8_t set); void lcd_plot_bitmap(uint8_t x, uint8_t y, PGM_P bitmap, uint8_t w, uint8_t h); - void lcd_plot_char(uint8_t x_off, uint8_t y_off, uint8_t c, uint8_t fw, uint8_t fh, PGM_P font); +void lcd_plot_char(uint8_t x_off, uint8_t y_off, uint8_t c, uint8_t fw, uint8_t fh, PGM_P font); void lcd_plot_text(uint8_t x_off, uint8_t y_off, const char *text, uint8_t fw, uint8_t fh, PGM_P font); void lcd_plot_pgmtext(uint8_t x_off, uint8_t y_off, PGM_P text, uint8_t fw, uint8_t fh, PGM_P font); -void lcd_strobe(); -void lcd_write_command(uint8_t cmd, uint8_t data); -uint8_t lcd_read_byte(); +static inline void lcd_strobe(); +static inline void lcd_write_command(uint8_t cmd, uint8_t data); +static inline uint8_t lcd_read_byte(); + + +// Static inline functions, that can be used in the library and in the main programm + + +/** + * Generates the strobe signal for writing data. + * This function is meant for internal usage only. + */ +static inline void lcd_strobe() { + lcd_en_high(); + _delay_us(1); + lcd_en_low(); + +} + + +/** + * Writes a command and a data byte to the lcd. + * + * @param cmd the command byte + * @param data the data that is going to be written after the command + */ +static inline void lcd_write_command(uint8_t cmd, uint8_t data) { + _delay_us(30); + lcd_rw_low(); + lcd_rs_high(); + LCD_DATA = cmd; + _delay_us(1); + lcd_strobe(); + + lcd_rs_low(); + LCD_DATA = data; + _delay_us(1); + lcd_strobe(); + +} + +/** + * Reads a byte from the display memory. + * lcd_gotoxy can be used to set the location. + * Important : lcd_gotoxy doesn't work in graphics mode yet. + * + * @return the byte which has been read + * @see lcd_gotoxy + */ +static inline uint8_t lcd_read_byte() { +uint8_t i,data; + + for(i = 0; i < 2; i++) { + _delay_us(30); + lcd_rw_low(); + lcd_rs_high(); + LCD_DATA = 0x0D; + _delay_us(1); + lcd_en_high(); + + LCD_DATA_DDR = 0x00; + lcd_rs_low(); + lcd_rw_high(); + _delay_us(1); + data = (uint8_t) LCD_DATA_PIN; + lcd_en_low(); + LCD_DATA_DDR = 0xFF; + } + return data; +} + + + + #endif /* LC7981_H_ */