00001 /** \file 00002 * This file is used for the doxygen documentation. 00003 */ 00004 00005 /** 00006 \dir guilogger 00007 00008 A tool to customize online gnuplot windows online. 00009 00010 \b Features \n 00011 00012 The sentence above means that you sent your different data "channels" 00013 (a channel is more or less a variable observed over time equipped with a label) 00014 per pipe to the guilogger. 00015 Guilogger provides a seperate window where you can choose which of the channels 00016 should be displayed in which window. According to your selection your data will 00017 be plotted online. \n 00018 Furthermore guilogger gives the opportunity to save your data "channels" in a file 00019 together with the labels you selected for the channels. \n 00020 To do something useful with these logfiles guilogger allows you to watch them again 00021 and navigate trough the logfile. Once you found a valuable figure you can use the 00022 gnuplot commands generated by guilogger. Copy this command in a console where gnuplot 00023 is running and you receive your figure and can save it to disk. \n 00024 00025 Here you can see a screenshot of the guilogger window with 9 channels. 00026 The used labels range from "x[0]" to "y[2]". The top three boxes after the word "Channels" 00027 are useless at the moment. 00028 \image html screenshot.jpg 00029 \image latex screenshot.ps "Screenshot of the guilogger window with 9 channels. Labels range from x[0] to y[2]." 00030 00031 00032 00033 \b Usage \n 00034 You start guilogger by typing \c guilogger and the right parameters. 00035 For working in pipe mode you type <tt> -m pipe</tt>. An additional 00036 \c -l enables the logging to a file. With <tt> -d value </tt> you 00037 setup a delay of length \c value.\n 00038 One can also you can view a logfile with <tt> guilogger -m file -f filename.log</tt> 00039 where filename.log is the name of the logfile. 00040 Guilogger can also read from serial port with <tt> guilogger -m serial -p portnumber</tt>. 00041 This information is summarized in the parameter listing, which you can get by typing 00042 <tt> guilogger --help </tt>\n 00043 00044 guilogger parameter listing \n 00045 <tt> -m [mode] </tt> mode = serial | pipe | file \n 00046 <tt> -p [port] </tt> port = serial port to read from \n 00047 <tt> -f [file] </tt> input file; only viwewing, no streaming \n 00048 <tt> -l </tt> turns logging on \n 00049 <tt> -d [delay] </tt> delay for piped input, should be a natural number \n 00050 <tt> --help </tt> displays this message. \n 00051 00052 */ 00053 00054 00055
1.4.5