<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Procyon AVRlib: glcd.h Source File</title>
<link href="dox.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>glcd.h</h1><a href="glcd_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file glcd.h \brief Graphic LCD API functions. */</span>
00002 <span class="comment">//*****************************************************************************</span>
00003 <span class="comment">//</span>
00004 <span class="comment">// File Name : 'glcd.h'</span>
00005 <span class="comment">// Title : Graphic LCD API functions</span>
00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2002</span>
00007 <span class="comment">// Date : 5/30/2002</span>
00008 <span class="comment">// Revised : 5/30/2002</span>
00009 <span class="comment">// Version : 0.5</span>
00010 <span class="comment">// Target MCU : Atmel AVR</span>
00011 <span class="comment">// Editor Tabs : 4</span>
00012 <span class="comment">//</span>
00013 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span>
00014 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span>
00015 <span class="comment">// tested. Nonetheless, you can expect most functions to work.</span>
00016 <span class="comment">//</span><span class="comment"></span>
00017 <span class="comment">/// \ingroup driver_hw</span>
00018 <span class="comment">/// \defgroup glcd Graphic LCD API (application programmer's interface) (glcd.c)</span>
00019 <span class="comment">/// \code #include "glcd.h" \endcode</span>
00020 <span class="comment">/// \par Overview</span>
00021 <span class="comment">/// This library (or API) allows you to draw dots, lines, boxes, circles,</span>
00022 <span class="comment">/// and text on most monochrome graphic LCDs. An easily expandable font file</span>
00023 <span class="comment">/// (5x7-pixel characters) is provided for all basic ASCII characters</span>
00024 <span class="comment">/// (0x20-0x7F hex, 32-127 decimal). An expandable graphic font file is</span>
00025 <span class="comment">/// provided for defining specialty characters or custom icons. Because this</span>
00026 <span class="comment">/// library is designed to work with many different kinds of LCDs, it needs a</span>
00027 <span class="comment">/// graphic LCD driver such as ks0108.c to enable it to talk to the LCD.</span>
00028 <span class="comment">///</span>
00029 <span class="comment">/// \note For full text-output functionality, you may wish to use the rprintf</span>
00030 <span class="comment">/// functions along with this driver.</span>
00031 <span class="comment"></span><span class="comment">//</span>
00032 <span class="comment">// This code is distributed under the GNU Public License</span>
00033 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span>
00034 <span class="comment">//</span>
00035 <span class="comment">//*****************************************************************************</span>
00036
00037 <span class="preprocessor">#ifndef GLCD_H</span>
00038 <span class="preprocessor"></span><span class="preprocessor">#define GLCD_H</span>
00039 <span class="preprocessor"></span>
00040 <span class="preprocessor">#ifndef WIN32</span>
00041 <span class="preprocessor"></span><span class="comment">// AVR specific includes</span>
00042 <span class="preprocessor"> #include <avr/io.h></span>
00043 <span class="preprocessor">#endif</span>
00044 <span class="preprocessor"></span>
00045 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span>
00046
00047 <span class="preprocessor">#define LINE1 0</span>
00048 <span class="preprocessor"></span><span class="preprocessor">#define LINE2 1</span>
00049 <span class="preprocessor"></span><span class="preprocessor">#define LINE3 2</span>
00050 <span class="preprocessor"></span><span class="preprocessor">#define LINE4 3</span>
00051 <span class="preprocessor"></span><span class="preprocessor">#define LINE5 4</span>
00052 <span class="preprocessor"></span><span class="preprocessor">#define LINE6 5</span>
00053 <span class="preprocessor"></span><span class="preprocessor">#define LINE7 6</span>
00054 <span class="preprocessor"></span><span class="preprocessor">#define LINE8 7</span>
00055 <span class="preprocessor"></span>
00056 <span class="preprocessor">#define ON 1</span>
00057 <span class="preprocessor"></span><span class="preprocessor">#define OFF 0</span>
00058 <span class="preprocessor"></span>
00059 <span class="comment">// API-level interface commands</span>
00060 <span class="comment">// ***** Public Functions *****</span>
00061 <span class="comment"></span>
00062 <span class="comment">//! set a dot on the display (x is horiz 0:127, y is vert 0:63)</span>
00063 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="glcd_8c.html#a0">glcdSetDot</a>(u08 x, u08 y);
00064 <span class="comment"></span>
00065 <span class="comment">//! clear a dot on the display (x is horiz 0:127, y is vert 0:63)</span>
00066 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="glcd_8c.html#a1">glcdClearDot</a>(u08 x, u08 y);
00067 <span class="comment"></span>
00068 <span class="comment">//! draw line</span>
00069 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="glcd_8c.html#a2">glcdLine</a>(u08 x1, u08 y1, u08 x2, u08 y2);
00070 <span class="comment"></span>
00071 <span class="comment">//! draw rectangle (coords????)</span>
00072 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="glcd_8c.html#a3">glcdRectangle</a>(u08 x, u08 y, u08 a, u08 b);
00073 <span class="comment"></span>
00074 <span class="comment">//! draw circle of <radius> at <xcenter,ycenter></span>
00075 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="glcd_8c.html#a4">glcdCircle</a>(u08 xcenter, u08 ycenter, u08 radius);
00076 <span class="comment"></span>
00077 <span class="comment">//! write a standard ascii charater (values 20-127)</span>
00078 <span class="comment"></span><span class="comment">// to the display at current position</span>
00079 <span class="keywordtype">void</span> <a class="code" href="glcd_8c.html#a5">glcdWriteChar</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c);
00080 <span class="comment"></span>
00081 <span class="comment">//! write a special graphic character/icon</span>
00082 <span class="comment"></span><span class="comment">// to the display at current position</span>
00083 <span class="keywordtype">void</span> <a class="code" href="glcd_8c.html#a6">glcdWriteCharGr</a>(u08 grCharIndex);
00084
00085 <span class="comment">// ***** Private Functions ***** (or depricated)</span>
00086 <span class="keywordtype">void</span> glcdPutStr(u08 *data);
00087
00088 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:06 2006 for Procyon AVRlib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|