Changes between Version 4 and Version 5 of tankplayer


Ignore:
Timestamp:
02/27/12 16:43:32 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • tankplayer

    v4 v5  
    103103Function: Playback               
    104104 
    105 Defines the n seconds delay that the GetFromDir should be checked for new tank files. Note that this only effects checks when no tanks are being played back. 
     105Defines the n seconds delay that the !GetFromDir should be checked for new tank files. Note that this only effects checks when no tanks are being played back. 
    106106{{{ 
    107107Default:  1                              
    108108}}} 
    109109 
    110 '''GetFromDir [dir]'''[[BR]] 
     110'''!GetFromDir [dir]'''[[BR]] 
    111111Processed by: tankplayer_config[[BR]] 
    112112Function: Playback       
    113113         
    114 Defines the directory  dir where to find tank files. This cannot be used in conjunction with WaveFile mode of running. If you set this parameter, then you may also set the OpenWait, OpenTries, CheckPeriod, and SaveDataFiles. 
    115 {{{ 
    116 Default:  none                           
    117 }}} 
    118  
    119 '''InterMessageDelayMillisecs [n_msecs]'''[[BR]] 
     114Defines the directory  dir where to find tank files. This cannot be used in conjunction with !WaveFile mode of running. If you set this parameter, then you may also set the !OpenWait, !OpenTries, !CheckPeriod, and !SaveDataFiles. 
     115{{{ 
     116Default:  none                           
     117}}} 
     118 
     119'''!InterMessageDelayMillisecs [n_msecs]'''[[BR]] 
    120120Processed by: tankplayer_config [[BR]] 
    121121Function: Playback       
     
    126126}}} 
    127127 
    128 HeartBeatInt nsec                       tankplayer_config       Earthworm setup          
     128'''!HeartBeatInt [nsec]'''      [[BR]] 
     129Processed by: tankplayer_config         [[BR]] 
     130Function: Earthworm setup 
     131                 
    129132Defines the number of seconds nsec between TYPE_HEARTBEAT messages issued by tankplayer. 
    130  
    131 Default:  none                          Calnet:  HeartBeatInt 15 
    132  IgnoreTBVersionNumbers switch          tankplayer_config       Playback 
     133{{{ 
     134Default:  none                           
     135Calnet:  HeartBeatInt 15 
     136}}} 
     137 
     138'''!IgnoreTBVersionNumbers [switch]'''  [[BR]] 
     139Processed by: tankplayer_config [[BR]] 
     140Function: Playback 
     141 
    133142Prevents tankplayer from objecting to tracebuf2 packets that don't have the correct version field. Not recommended. 
     143{{{ 
    134144Default: 0      False 
    135  LogFile switch                         tankplayer_config       output           
    136 Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, tankplayer will write a daily log file(s) called tankplayerxx.log_yymmdd where xx is tankplayer's module id (set with "MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 
    137  
    138 Default:  none 
    139  MyModuleId mod_id                      tankplayer_config       Earthworm setup          
     145}}} 
     146 
     147'''!LogFile [switch]''' [[BR]] 
     148Processed by: tankplayer_config         [[BR]] 
     149Function: output         
     150         
     151Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, tankplayer will write a daily log file(s) called tankplayerxx.log_yymmdd where xx is tankplayer's module id (set with "!MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 
     152{{{ 
     153Default:  none 
     154}}} 
     155 
     156'''!MyModuleId [mod_id]'''      [[BR]] 
     157Processed by: tankplayer_config [[BR]] 
     158Function: Earthworm setup 
     159                 
    140160Sets the module id for labeling all outgoing messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. Tankplayer also places this module id in the module id field of each waveform message header before it puts the message into shared memory. 
    141  
     161{{{ 
    142162Default:  none                           
    143163Example:  MyModuleId MOD_ADSEND_A 
    144 OpenTries n                     tankplayer_config       Playback                 
    145 Defines the number  n of times to retry opening a tank file found in the GetFromDir directory. The purpose of this parameter is that sometimes if a copy is used to move the file, it will not be finished writing by the time the tankplayer module gets to it. For that reason, the OpenTries number of open attempts is made to open the file for updating (even though it is just being read from). This assures the file can be read exclusively by the tankplayer module. If the file is not readable after 5 tries it is not attempted. Between each try, the program waits OpenWait milliseconds. 
    146  
    147 Default:  5                              
    148 OpenWait n                      tankplayer_config       Playback                 
    149 Defines the number  n  milliseconds to pause before retrying an open of a file in the GetFromDir directory. 
    150  
     164}}} 
     165 
     166'''!OpenTries [n]'''    [[BR]] 
     167Processed by: tankplayer_config         [[BR]] 
     168Function: Playback 
     169                 
     170Defines the number  n of times to retry opening a tank file found in the !GetFromDir directory. The purpose of this parameter is that sometimes if a copy is used to move the file, it will not be finished writing by the time the tankplayer module gets to it. For that reason, the OpenTries number of open attempts is made to open the file for updating (even though it is just being read from). This assures the file can be read exclusively by the tankplayer module. If the file is not readable after 5 tries it is not attempted. Between each try, the program waits !OpenWait milliseconds. 
     171{{{ 
     172Default:  5 
     173}}} 
     174                                 
     175'''!OpenWait [n]'''     [[BR]] 
     176Processed by: tankplayer_config [[BR]] 
     177Function: Playback               
     178 
     179Defines the number  n  milliseconds to pause before retrying an open of a file in the !GetFromDir directory. 
     180{{{ 
    151181Default:  200                            
    152  
    153  Pause nsec                             tankplayer_config       Playback                 
     182}}} 
     183 
     184'''!Pause [nsec]'''     [[BR]] 
     185Processed by: tankplayer_config [[BR]] 
     186Function: Playback               
     187 
    154188Defines the integer number of seconds nsec to pause after completing the playback of one waveform file before starting the playback of the next. Tankplayer will continue to issue its heartbeat while it is in pause-mode. 
    155  
     189{{{ 
    156190Default:  none 
    157191Example:  Pause 15 
    158  PlayMsgType type                       tankplayer_config       Playback                 
     192}}} 
     193 
     194'''!PlayMsgType [type]'''       [[BR]] 
     195Processed by: tankplayer_config [[BR]] 
     196Function: Playback       
     197         
    159198Tells tankplayer what type of message the waveform file(s) contain. type is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. By the message-type, tankplayer knows the format of the waveform message; currently tankplayer only knows how to read and manipulate TYPE_ADBUF TYPE_TRACEBUF, and TYPE_TRACEBUF2 waveform messages. 
    160  
     199{{{ 
    161200Default:  none 
    162201Example:  PlayMsgType TYPE_TRACEBUF2 
    163  RingName ring                          tankplayer_config       Earthworm setup          
     202}}} 
     203 
     204'''!RingName [ring]'''  [[BR]] 
     205Processed by: tankplayer_config [[BR]] 
     206Function: Earthworm setup                
     207 
    164208Tells tankplayer which shared memory region to use for output. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. 
    165  
     209{{{ 
    166210Default:  none                          Calnet:  RingName WAVE_RING 
    167  
    168 SaveDataFiles n                         tankplayer_config       Playback                 
    169 If  n  is set to 1, then the tankfiles found in the GetFromDir directory are saved to GetFromDir/save. If n is set to 0, the tank files are deleted.. 
    170  
    171 Default:  1                              
    172 SendLate xsec                   tankplayer_config       Playback                 
     211}}} 
     212 
     213'''!SaveDataFiles [n]'''        [[BR]] 
     214Processed by: tankplayer_config [[BR]] 
     215Function: Playback               
     216 
     217If  n  is set to 1, then the tankfiles found in the !GetFromDir directory are saved to !GetFromDir/save. If n is set to 0, the tank files are deleted.. 
     218{{{ 
     219Default:  1      
     220}}} 
     221                         
     222'''!SendLate [xsec]'''  [[BR]] 
     223Processed by: tankplayer_config [[BR]] 
     224Function: Playback 
     225                 
    173226Defines the integer number of seconds xsec before current time to label the packets with. This is useful for carlsubtrig usage and tuning. 
    174  
     227{{{ 
    175228Default:  none, this is an optional setting. 
    176229Example:  SendLate 45 
    177  StartUpDelay xsec                      tankplayer_config       Playback                 
     230}}} 
     231 
     232'''!StartUpDelay [xsec]'''      [[BR]] 
     233Processed by: tankplayer_config [[BR]] 
     234Function: Playback 
     235                 
    178236Defines the integer number of seconds xsec to wait on startup before beginning the playback of the first waveform file. Tankplayer will continue to issue its heartbeat while it is in startup-delay mode. 
    179  
     237{{{ 
    180238Default:  none 
    181239Example:  StartUpDelay 45 
    182  WaveFile path-file                     tankplayer_config       Playback                 
    183 Gives the name path-file of one waveform file that tankplayer should play back. path-file is a character string up to 45 characters long. Up to 50 "WaveFile" commands may be issued. Tankplayer will play the files in the order that they were listed in the configuration file, pausing between files by amount of time set in the "Pause" command. All files must contain the same type of waveform message (specified in the "PlayMsgType" command). 
    184  
     240}}} 
     241 
     242'''!WaveFile [path-file]'''     [[BR]] 
     243Processed  by: tankplayer_config        [[BR]] 
     244Function: Playback               
     245 
     246Gives the name path-file of one waveform file that tankplayer should play back. path-file is a character string up to 45 characters long. Up to 50 "!WaveFile" commands may be issued. Tankplayer will play the files in the order that they were listed in the configuration file, pausing between files by amount of time set in the "Pause" command. All files must contain the same type of waveform message (specified in the "!PlayMsgType" command). 
     247{{{ 
    185248Default:  none 
    186249Example:  WaveFile  event1.waves 
     250}}} 
     251 
    187252== Helpful Hints ==