Main Page   Modules   Data Structures   File List   Data Fields   Globals  

vt100.h

Go to the documentation of this file.
00001 /*! \file vt100.h \brief VT100 terminal function library. */
00002 //*****************************************************************************
00003 //
00004 // File Name    : 'vt100.h'
00005 // Title        : VT100 terminal function library
00006 // Author       : Pascal Stang - Copyright (C) 2002
00007 // Created      : 2002.08.27
00008 // Revised      : 2002.08.27
00009 // Version      : 0.1
00010 // Target MCU   : Atmel AVR Series
00011 // Editor Tabs  : 4
00012 //
00013 // NOTE: This code is currently below version 1.0, and therefore is considered
00014 // to be lacking in some functionality or documentation, or may not be fully
00015 // tested.  Nonetheless, you can expect most functions to work.
00016 //
00017 // This code is distributed under the GNU Public License
00018 //      which can be found at http://www.gnu.org/licenses/gpl.txt
00019 //
00020 //*****************************************************************************
00021 
00022 #ifndef VT100_H
00023 #define VT100_H
00024 
00025 #include "global.h"
00026 
00027 // constants/macros/typdefs
00028 // text attributes
00029 #define VT100_ATTR_OFF      0
00030 #define VT100_BOLD          1
00031 #define VT100_USCORE        4
00032 #define VT100_BLINK         5
00033 #define VT100_REVERSE       7
00034 #define VT100_BOLD_OFF      21
00035 #define VT100_USCORE_OFF    24
00036 #define VT100_BLINK_OFF     25
00037 #define VT100_REVERSE_OFF   27
00038 
00039 // functions
00040 
00041 // vt100Init() initializes terminal and vt100 library
00042 //      Run this init routine once before using any other vt100 function.
00043 void vt100Init(void);
00044 
00045 // vt100ClearScreen() clears the terminal screen
00046 void vt100ClearScreen(void);
00047 
00048 // vt100SetAttr() sets the text attributes like BOLD or REVERSE
00049 //      Text written to the terminal after this function is called will have
00050 //      the desired attribuutes.
00051 void vt100SetAttr(u08 attr);
00052 
00053 // vt100SetCursorMode() sets the cursor to visible or invisible
00054 void vt100SetCursorMode(u08 visible);
00055 
00056 // vt100SetCursorPos() sets the cursor position
00057 //      All text which is written to the terminal after a SetCursorPos command
00058 //      will begin at the new location of the cursor.
00059 void vt100SetCursorPos(u08 line, u08 col);
00060 
00061 #endif

Generated on Sun Feb 22 19:12:31 2004 for Procyon AVRlib by doxygen1.3-rc2